An instance of an attribute group (and corresponding attribute values)

DtAttributeGroupObject represents an attribute group that can be positioned and displayed in the 3D scene. A color can be specified; and the group can flash, if desired.

Inheritance diagram for vrvControlToolkit::DtAttributeGroupObject:

[legend]

Public Member Functions
	DtAttributeGroupObject (DtExerciseConn exConn, unsigned id, DtAttributeGroupTemplateObject pTemplate, const DtVdc3DAttachPoint &attachment, const DtVector32 &enuOffset=DtVector32::zero(), DtVdcColor color=DtVdcColor::DtVdcWhite, bool flashing=false)

virtual	~DtAttributeGroupObject ()

virtual DtAttributeGroupTemplateObject *	attributeGroupTemplate () const

virtual const DtVdc3DAttachPoint &	attachment () const

virtual void	setAttachment (const DtVdc3DAttachPoint &attachment)

virtual const DtVector32 &	offset () const

virtual void	setOffset (const DtVector32 &enuOffset)

virtual const DtVdcColor &	color () const

virtual void	setColor (const DtVdcColor &color)

virtual bool	flashing () const

virtual void	setFlashing (bool flashing)

virtual DtString	bmpAttributeValue (const DtString &attName) const

virtual void	setBmpAttributeValue (const DtString &attName, const DtString &filename)

virtual double	numericAttributeValue (const DtString &attName) const

virtual void	setNumericAttributeValue (const DtString &attName, double xVal)

virtual double	valueBarAttributeValue (const DtString &attName) const

virtual void	setValueBarAttributeValue (const DtString &attName, double xVal)

virtual double	graphAttributeValueX (const DtString &attName) const

virtual void	setGraphAttributeValueX (const DtString &attName, double xVal)

virtual double	graphAttributeValueY (const DtString &attName) const

virtual void	setGraphAttributeValueY (const DtString &attName, double yVal)

virtual DtVdcAttributeValueMap &	attributeValueMap ()

virtual void	setRemoteGraphicSet (const std::string &setName)

virtual void	update ()

Public Member Functions inherited from vrvControlToolkit::DtDrawControlObject
	DtDrawControlObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)

virtual	~DtDrawControlObject ()

virtual unsigned	id () const

virtual void	setId (unsigned id)

virtual const DtGlobalObjectDesignator &	globalId () const

virtual void	setVisible (bool yesNo)

virtual bool	visible () const

Protected Member Functions
virtual void	createAttributes ()

virtual void	destroyAttributes ()

virtual void	copyAttributes (const DtVdcAttributeValueMap &valueMap)

Protected Attributes
DtEnvironmentalPointRecord	myPointRecord

Dt3DGraphicalObjectStateRecord	myGraphicObjectStateRecord

DtAttributeStateRecord	myAttributeStateRecord

DtVdc3DAttachPoint	myAttachment

DtVector32	myEnuOffset

DtVdcColor	myColor

bool	myFlashing

DtAttributeGroupTemplateObject *	myAttributeGroupTemplate

DtVdcAttributeValueMap	myValueMap

Protected Attributes inherited from vrvControlToolkit::DtDrawControlObject
unsigned	myId

DtEnvironmentProcessPublisher *	myPublisher

bool	myVisible

DtVdcColor	myEmptyColor

Private Member Functions
	DtAttributeGroupObject ()

	DtAttributeGroupObject (const DtAttributeGroupObject &orig)

DtAttributeGroupObject &	operator= (const DtAttributeGroupObject &rhs)

Additional Inherited Members
Static Public Member Functions inherited from vrvControlToolkit::DtDrawControlObject
static void	setPublisherCreator (DtEnvironmentProcessPublisherCreator *creator)

Static Protected Attributes inherited from vrvControlToolkit::DtDrawControlObject
static DtEnvironmentProcessPublisherCreator *	thePublisherCreator

Constructor & Destructor Documentation

vrvControlToolkit::DtAttributeGroupObject::DtAttributeGroupObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		DtAttributeGroupTemplateObject *	pTemplate,
		const DtVdc3DAttachPoint &	attachment,
		const DtVector32 &	enuOffset = `DtVector32::zero()`,
		DtVdcColor	color = `DtVdcColor::DtVdcWhite`,
		bool	flashing = `false`
	)

Construct the attribute group Draw Control Object.

Parameters

id	Passed to DtDrawControlObject base (see)
template	A pointer to the attribute group template that this group is based on
attachment	DtVdc3DAttachPoint indicating how the group object is positioned in 3D
enuOffset	a 3D vector indicating an east/north/up offset (in meters) from the base attachment
color	The color of the group object
flashing	A boolean parameter indicating whether or not the group object should be flashing

virtual vrvControlToolkit::DtAttributeGroupObject::~DtAttributeGroupObject ( )

virtual

vrvControlToolkit::DtAttributeGroupObject::DtAttributeGroupObject ( )

private

Default constructor.

Private and not implemented - you must supply an id, template, and attachment parameters to construct the attribute group

vrvControlToolkit::DtAttributeGroupObject::DtAttributeGroupObject ( const DtAttributeGroupObject & orig )

private

Copy constructor.

Private and not implemented - not copyable.

Member Function Documentation

DtAttributeGroupObject& vrvControlToolkit::DtAttributeGroupObject::operator= ( const DtAttributeGroupObject & rhs )

private

Assignment operator.

Private and not implemented - not copyable.

virtual DtAttributeGroupTemplateObject* vrvControlToolkit::DtAttributeGroupObject::attributeGroupTemplate ( ) const

virtual

attribute group template accessor

Get the attribute group template that this group is using

Returns: attribute group

virtual const DtVdc3DAttachPoint& vrvControlToolkit::DtAttributeGroupObject::attachment ( ) const

virtual

attachment accessor

Get the attribute group's attachment information

Returns: DtVdc3DAttachPoint, which contains the attachment type and associated data

virtual void vrvControlToolkit::DtAttributeGroupObject::setAttachment ( const DtVdc3DAttachPoint & attachment )

virtual

attachment mutator

Set the attribute group's attachment information

Parameters

attachment

virtual const DtVector32& vrvControlToolkit::DtAttributeGroupObject::offset ( ) const

virtual

offset accessor

Get the attribute group's east/north/up offset from the attach point

Returns: [X, Y, Z] offset

virtual void vrvControlToolkit::DtAttributeGroupObject::setOffset ( const DtVector32 & enuOffset )

virtual

enuOffset mutator

Set the attribute group's east/north/up offset from the attach point

Parameters

enuOffset [X, Y, Z]

virtual const DtVdcColor& vrvControlToolkit::DtAttributeGroupObject::color ( ) const

virtual

color accessor

Get the color assigned to the attribute group

Returns: Instance of DtVdcColor

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtAttributeGroupObject::setColor ( const DtVdcColor & color )

virtual

color mutator

Set the color to use when drawing the attribute group

Parameters

color The DtVdcColor to use

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual bool vrvControlToolkit::DtAttributeGroupObject::flashing ( ) const

virtual

flashing accessor

Get the boolean that indicates whether or not the attribute group should flash

Returns: true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtAttributeGroupObject::setFlashing ( bool flashing )

virtual

flashing mutator

Set the boolean that indicates whether or not the attribute group should flash

Parameters

flashing true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual DtString vrvControlToolkit::DtAttributeGroupObject::bmpAttributeValue ( const DtString & attName ) const

virtual

bmp attribute value accessor

Get the filename of the bitmap to use for the specified attribute in this attribute group

Returns: The .bmp filename. If the attribute is not a BmpAttribute, this returns DtString::nullString()

virtual void vrvControlToolkit::DtAttributeGroupObject::setBmpAttributeValue	(	const DtString &	attName,
		const DtString &	filename
	)

virtual

bmp attribute value mutator

Set the filename of the bitmap to display for the specified attribute in this attribute group. If the attribute is not a bmp attribute, this call has no effect

Parameters

attId	Id of the attribute template that the attribute corresponds to
filename	Filename of the bitmap to display

virtual double vrvControlToolkit::DtAttributeGroupObject::numericAttributeValue ( const DtString & attName ) const

virtual

numeric attribute value accessor

Get the numeric value used for the specified attribute in this attribute group

Returns: The floating point number that will be displayed as part of the attribute for this attribute group. If the attribute is not a numeric attribute, this will return 0.

virtual void vrvControlToolkit::DtAttributeGroupObject::setNumericAttributeValue	(	const DtString &	attName,
		double	xVal
	)

virtual

numeric attribute value mutator

Set the numeric value to display for the specified attribute in this attribute group. If the attribute is not a numeric attribute, this call has no effect

Parameters

attId	Id of the attribute template that the attribute corresponds to
xVal	The numeric value to display

virtual double vrvControlToolkit::DtAttributeGroupObject::valueBarAttributeValue ( const DtString & attName ) const

virtual

value bar attribute value accessor

Get the value bar value used for the specified attribute in this attribute group

Returns: The floating point number that will be used to determine how much of the value bar displayed as part of the attribute for this attribute group will be filled in. Note that this is actually just a pseudonym for numericAttributeValue(), as each attribute type uses the same internal value field

virtual void vrvControlToolkit::DtAttributeGroupObject::setValueBarAttributeValue	(	const DtString &	attName,
		double	xVal
	)

virtual

value bar attribute value mutator

Set the value bar value to display for the specified attribute in this attribute group. The value specified will be used to determine how much of the value bar displayed as part of the attribute for this attribute group will be filled in. Note that this is actually just a pseudonym for setNumericAttributeValue(), as each attribute type uses the same internal value field

Parameters

attId	Id of the attribute template that the attribute corresponds to
xVal	The numeric value that determines the value bar appearance

virtual double vrvControlToolkit::DtAttributeGroupObject::graphAttributeValueX ( const DtString & attName ) const

virtual

graph attribute x-value accessor

Get the last x-coordinate given for the specified attribute in this attribute group. A graph attribute actually displays a line graph using the last 10 x and y values given; only the last of each is available from the sending side of the API.

Returns: The last floating point graph x-value specified. Note that this is actually just a pseudonym for numericAttributeValue(), as each attribute type uses the same internal value field

virtual void vrvControlToolkit::DtAttributeGroupObject::setGraphAttributeValueX	(	const DtString &	attName,
		double	xVal
	)

virtual

graph attribute x-value mutator

Set the x-coordinate on the next point displayed in the specified attribute in this attribute group. A graph attribute actually displays a line graph using the last 10 x and y values given. Note that this is actually just a pseudonym for setNumericAttributeValue(), as each attribute type uses the same internal value field

Parameters

attId	Id of the attribute template that the attribute corresponds to
xVal	The x-coordinate of the next x,y point in the graph

virtual double vrvControlToolkit::DtAttributeGroupObject::graphAttributeValueY ( const DtString & attName ) const

virtual

graph attribute y-value accessor

Get the last y-coordinate given for the specified attribute in this attribute group. A graph attribute actually displays a line graph using the last 10 x and y values given; only the last of each is available from the sending side of the API.

Returns: The last floating point graph y-value specified.

virtual void vrvControlToolkit::DtAttributeGroupObject::setGraphAttributeValueY	(	const DtString &	attName,
		double	yVal
	)

virtual

graph attribute y-value mutator

Set the y-coordinate on the next point displayed in the specified attribute in this attribute group. A graph attribute actually displays a line graph using the last 10 x and y values given.

Parameters

attId	Id of the attribute template that the attribute corresponds to
yVal	The y-coordinate of the next x,y point in the graph

virtual DtVdcAttributeValueMap& vrvControlToolkit::DtAttributeGroupObject::attributeValueMap ( )

virtual

atribute value map accessor

Get the attrbute value map. This is an std::map, indexed by attribute template id and containing DtAttributeValue*s; so you can access the attribute value directly (and the DtSdcAttributeUpdatePdu used to update it) directly (but this is not normally needed if you use the specific attribute value mutators provided.

Returns: A reference to the attribute value map (a DtAttributeValueMap)

virtual void vrvControlToolkit::DtAttributeGroupObject::setRemoteGraphicSet ( const std::string & setName )

virtual

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtAttributeGroupObject::update ( )

virtual

update the internal attribute group pdu

Make sure the internal pdu reflects the actual state of the attribute group object's members. This is necessary because some members can be modified directly (which make the interface easier to use). DtStealthRemoteDrawer::update() calls this, so the user doesn't need to; but if the user is accessing the pdu directly (via the pdu() accessor) this should be called before using the pdu.

Implements vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtAttributeGroupObject::createAttributes ( )

protectedvirtual

virtual void vrvControlToolkit::DtAttributeGroupObject::destroyAttributes ( )

protectedvirtual

virtual void vrvControlToolkit::DtAttributeGroupObject::copyAttributes ( const DtVdcAttributeValueMap & valueMap )

protectedvirtual

Member Data Documentation

DtEnvironmentalPointRecord vrvControlToolkit::DtAttributeGroupObject::myPointRecord

protected

Dt3DGraphicalObjectStateRecord vrvControlToolkit::DtAttributeGroupObject::myGraphicObjectStateRecord

protected

DtAttributeStateRecord vrvControlToolkit::DtAttributeGroupObject::myAttributeStateRecord

protected

DtVdc3DAttachPoint vrvControlToolkit::DtAttributeGroupObject::myAttachment

protected

DtVector32 vrvControlToolkit::DtAttributeGroupObject::myEnuOffset

protected

DtVdcColor vrvControlToolkit::DtAttributeGroupObject::myColor

protected

bool vrvControlToolkit::DtAttributeGroupObject::myFlashing

protected

DtAttributeGroupTemplateObject* vrvControlToolkit::DtAttributeGroupObject::myAttributeGroupTemplate

protected

DtVdcAttributeValueMap vrvControlToolkit::DtAttributeGroupObject::myValueMap

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvDrawControl/DtAttributeGroupObject.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation