MAKVrExchange::DtLinearSegmentData Class Reference

Represents Linear Segment Parameter Objects. More...

Public Member Functions
	DtLinearSegmentData ()
	CTOR.
	DtLinearSegmentData (const DtLinearSegmentData &original)
	Copy CTOR.
virtual	~DtLinearSegmentData ()
	Virtual DTOR.
virtual DtLinearSegmentData &	operator= (const DtLinearSegmentData &original)
	Assignment operator.
virtual std::ostream &	printDataToStream (std::ostream &stream) const
	Prints the byte array to a stream in hex.
Equality operators.
virtual bool	operator!= (const DtLinearSegmentData &rightOperand) const
virtual bool	operator== (const DtLinearSegmentData &rightOperand) const
Data Exchange Attributes
The Attributes of the Linear Segment Parameters Object.
	DtDEC_ATTRIBUTE (DtU8, SegmentNumber, segmentNumber)
	DtDEC_ATTRIBUTE (DtU8, Modifications, modifications)
	DtDEC_ATTRIBUTE (DtU32, SpecificAppearance, specificAppearance)
	DtDEC_ATTRIBUTE (DtU16, GeneralAppearance, generalAppearance)
	DtDEC_ATTRIBUTE (DtVector, Location, location)
	DtDEC_ATTRIBUTE (DtTaitBryan, Orientation, orientation)
	DtDEC_ATTRIBUTE (DtU16, Length, length)
	DtDEC_ATTRIBUTE (DtU16, Width, width)
	DtDEC_ATTRIBUTE (DtU16, Height, height)
	DtDEC_ATTRIBUTE (DtU16, Depth, depth)
General Appearance Attributes.
virtual void	setGeneralAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
	Set General Appearance Attribute.
virtual DtAppearAttrVal	generalAppearanceAttribute (DtAppearAttribute attr) const
	Get General Appearance Attribute.
	DtDEC_APPEARANCE (General, general, DtU8, PercentComplete, percentComplete, DtAppObjectPercentComplete)
	Set General Appearance Attribute.
	DtDEC_APPEARANCE (General, general, DtDamageState, DamagedAppearance, damagedAppearance, DtAppObjectDamage)
	Set General Appearance Attribute.
	DtDEC_APPEARANCE (General, general, bool, ObjectPreDistributed, objectPreDistributed, DtAppObjectPredistributed)
	Set General Appearance Attribute.
	DtDEC_APPEARANCE (General, general, bool, Deactivated, deactivated, DtAppObjectState)
	Set General Appearance Attribute.
	DtDEC_APPEARANCE (General, general, bool, Smoking, smoking, DtAppObjectSmoking)
	Set General Appearance Attribute.
	DtDEC_APPEARANCE (General, general, bool, Flaming, flaming, DtAppObjectFlaming)
	Set General Appearance Attribute.
Specific Appearance Attributes.
virtual void	setSpecificAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
	Set Specific Appearance Attribute.
virtual DtU32	specificAppearanceAttribute (DtAppearAttribute attr) const
	Get Specific Appearance Attribute.
Tank Ditch / Concertina Wire Attributes.
	DtDEC_APPEARANCE (Specific, specific, DtTankDitchBreachStatus, BreachStatus, breachStatus, DtAppObjectTankDitchBreach)
	Get/Set Segment Breached Returns false if the index is out of bounds.
	DtDEC_APPEARANCE (Specific, specific, DtU8, BreachLength, breachLength, DtAppObjectTankDitchBreachLength)
	Get/Set Segment Breached Returns false if the index is out of bounds.
virtual bool	setSegmentBreached (int index, bool state)
	Get/Set Segment Breached Returns false if the index is out of bounds.
virtual bool	segmentBreached (int index, bool &state) const
	Get/Set Segment Breached Returns false if the index is out of bounds.

Detailed Description

Represents Linear Segment Parameter Objects.

Note: This is not a Portal Object! DtPortalLinearObject is the actual Portal Object which contains DtLinearSegmentData.

Constructor & Destructor Documentation

MAKVrExchange::DtLinearSegmentData::DtLinearSegmentData

(

)

CTOR.

MAKVrExchange::DtLinearSegmentData::DtLinearSegmentData

(

const DtLinearSegmentData &

original

)

Copy CTOR.

virtual MAKVrExchange::DtLinearSegmentData::~DtLinearSegmentData ( )

virtual

Virtual DTOR.

Member Function Documentation

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	General	,
		general	,
		DtU8	,
		PercentComplete	,
		percentComplete	,
		DtAppObjectPercentComplete
	)

Set General Appearance Attribute.

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	General	,
		general	,
		DtDamageState	,
		DamagedAppearance	,
		damagedAppearance	,
		DtAppObjectDamage
	)

Set General Appearance Attribute.

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	General	,
		general	,
		bool	,
		ObjectPreDistributed	,
		objectPreDistributed	,
		DtAppObjectPredistributed
	)

Set General Appearance Attribute.

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	General	,
		general	,
		bool	,
		Deactivated	,
		deactivated	,
		DtAppObjectState
	)

Set General Appearance Attribute.

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	General	,
		general	,
		bool	,
		Smoking	,
		smoking	,
		DtAppObjectSmoking
	)

Set General Appearance Attribute.

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	General	,
		general	,
		bool	,
		Flaming	,
		flaming	,
		DtAppObjectFlaming
	)

Set General Appearance Attribute.

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	Specific	,
		specific	,
		DtTankDitchBreachStatus	,
		BreachStatus	,
		breachStatus	,
		DtAppObjectTankDitchBreach
	)

Get/Set Segment Breached Returns false if the index is out of bounds.

There are 8 SegmentBreached records, so a valid index is >= 0 and <=7

MAKVrExchange::DtLinearSegmentData::DtDEC_APPEARANCE	(	Specific	,
		specific	,
		DtU8	,
		BreachLength	,
		breachLength	,
		DtAppObjectTankDitchBreachLength
	)

Get/Set Segment Breached Returns false if the index is out of bounds.

There are 8 SegmentBreached records, so a valid index is >= 0 and <=7

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU8	,
		SegmentNumber	,
		segmentNumber
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU8	,
		Modifications	,
		modifications
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU32	,
		SpecificAppearance	,
		specificAppearance
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU16	,
		GeneralAppearance	,
		generalAppearance
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtVector	,
		Location	,
		location
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtTaitBryan	,
		Orientation	,
		orientation
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU16	,
		Length	,
		length
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU16	,
		Width	,
		width
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU16	,
		Height	,
		height
	)

MAKVrExchange::DtLinearSegmentData::DtDEC_ATTRIBUTE	(	DtU16	,
		Depth	,
		depth
	)

virtual DtAppearAttrVal MAKVrExchange::DtLinearSegmentData::generalAppearanceAttribute ( DtAppearAttribute  attr ) const

virtual

Get General Appearance Attribute.

virtual bool MAKVrExchange::DtLinearSegmentData::operator!= ( const DtLinearSegmentData &  rightOperand ) const

virtual

virtual DtLinearSegmentData& MAKVrExchange::DtLinearSegmentData::operator= ( const DtLinearSegmentData &  original )

virtual

Assignment operator.

virtual bool MAKVrExchange::DtLinearSegmentData::operator== ( const DtLinearSegmentData &  rightOperand ) const

virtual

virtual std::ostream& MAKVrExchange::DtLinearSegmentData::printDataToStream ( std::ostream &  stream ) const

virtual

Prints the byte array to a stream in hex.

virtual bool MAKVrExchange::DtLinearSegmentData::segmentBreached ( int  index, bool &  state  ) const

virtual

Get/Set Segment Breached Returns false if the index is out of bounds.

There are 8 SegmentBreached records, so a valid index is >= 0 and <=7

virtual void MAKVrExchange::DtLinearSegmentData::setGeneralAppearanceAttribute ( DtAppearAttribute  attr, DtAppearAttrVal  val  )

virtual

Set General Appearance Attribute.

virtual bool MAKVrExchange::DtLinearSegmentData::setSegmentBreached ( int  index, bool  state  )

virtual

Get/Set Segment Breached Returns false if the index is out of bounds.

There are 8 SegmentBreached records, so a valid index is >= 0 and <=7

virtual void MAKVrExchange::DtLinearSegmentData::setSpecificAppearanceAttribute ( DtAppearAttribute  attr, DtAppearAttrVal  val  )

virtual

Set Specific Appearance Attribute.

virtual DtU32 MAKVrExchange::DtLinearSegmentData::specificAppearanceAttribute ( DtAppearAttribute  attr ) const

virtual

Get Specific Appearance Attribute.

---

The documentation for this class was generated from the following file:

• linearSegmentData.h