vrvControlToolkit::DtDrawControlObject Class Reference

DtDrawControlObject is the base class from which all Draw Control Objects are derived. More...

Inheritance diagram for vrvControlToolkit::DtDrawControlObject:

Classes
class	DtEnvironmentProcessPublisherCreator
	Creator for creating the environment process publisher for a draw control object. More...

Public Member Functions
	DtDrawControlObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
	Parameterized constructor.
virtual	~DtDrawControlObject ()
	Virtual destructor.
virtual unsigned	id () const
	id accessor
virtual void	setId (unsigned id)
	id mutator
virtual const DtGlobalObjectDesignator &	globalId () const
virtual void	setVisible (bool yesNo)
virtual bool	visible () const
virtual bool	flashing () const
virtual void	setFlashing (bool yesNo)
virtual const DtVdcColor &	color () const
virtual void	setColor (const DtVdcColor &color)
virtual void	setRemoteGraphicSet (const std::string &setName)
virtual void	update ()=0
	update the internal publisher and tick

Static Public Member Functions
static void	setPublisherCreator (DtEnvironmentProcessPublisherCreator *creator)

Protected Attributes
unsigned	myId
DtEnvironmentProcessPublisher *	myPublisher
bool	myVisible
DtVdcColor	myEmptyColor

Static Protected Attributes
static DtEnvironmentProcessPublisherCreator *	thePublisherCreator

Private Member Functions
	DtDrawControlObject ()
	Default constructor.
	DtDrawControlObject (const DtDrawControlObject &orig)
	Copy constructor Private and unimplemented.
DtDrawControlObject &	operator= (const DtDrawControlObject &rhs)
	Assignment operator Private and unimplemented.

Detailed Description

DtDrawControlObject is the base class from which all Draw Control Objects are derived.

DtDrawControlObject defines the interface and storage that is common to all Stealth Draw Control Objects. This includes a local id (that should be unique to the sender - see the DtStealthRemoteDrawer class for an id generator) and a DtStealthDrawControlPdu that is used to send the object on the network to remote stealths. The local id is combined with the sender id of the application / federate sending the draw object to create the object's full id.

It is important to note that Draw Control Objects are not true objects in the DIS / HLA-RPR sense; they are sent as data interactions, and will only be seen by listeners that are in the exercise / federation at the time they are sent.

Constructor & Destructor Documentation

vrvControlToolkit::DtDrawControlObject::DtDrawControlObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		const DtString &	objName
	)

Parameterized constructor.

Parameters

id	(locally) unique id to use for this object

virtual vrvControlToolkit::DtDrawControlObject::~DtDrawControlObject ( )

virtual

Virtual destructor.

vrvControlToolkit::DtDrawControlObject::DtDrawControlObject ( )

private

Default constructor.

Private and unimplemented. You must construct a DtDrawControlObject with an id

vrvControlToolkit::DtDrawControlObject::DtDrawControlObject ( const DtDrawControlObject &  orig )

private

Copy constructor Private and unimplemented.

Not copyable.

Member Function Documentation

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

private

Assignment operator Private and unimplemented.

Not copyable.

virtual unsigned vrvControlToolkit::DtDrawControlObject::id ( ) const

virtual

id accessor

Returns

The (local) id of this draw object

virtual void vrvControlToolkit::DtDrawControlObject::setId ( unsigned  id )

virtual

id mutator

This is useful for assigning a unique Id after cloning an object using the copy constructor.

Parameters

id	A (locally unique) id for this draw object

virtual const DtGlobalObjectDesignator& vrvControlToolkit::DtDrawControlObject::globalId ( ) const

virtual

virtual void vrvControlToolkit::DtDrawControlObject::setVisible ( bool  yesNo )

virtual

virtual bool vrvControlToolkit::DtDrawControlObject::visible ( ) const

virtual

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

virtual

Reimplemented in vrvControlToolkit::DtLine3DObject, vrvControlToolkit::DtLine2DObject, vrvControlToolkit::DtCylinderObject, vrvControlToolkit::DtTriangle2DObject, vrvControlToolkit::DtEllipseRectangleBase, vrvControlToolkit::DtEllipsoidCuboidBase, vrvControlToolkit::DtAttributeGroupObject, vrvControlToolkit::DtText3DObject, vrvControlToolkit::DtArea3DObject, and vrvControlToolkit::DtText2DObject.

virtual void vrvControlToolkit::DtDrawControlObject::setFlashing ( bool  yesNo )

virtual

Reimplemented in vrvControlToolkit::DtLine3DObject, vrvControlToolkit::DtLine2DObject, vrvControlToolkit::DtCylinderObject, vrvControlToolkit::DtTriangle2DObject, vrvControlToolkit::DtEllipseRectangleBase, vrvControlToolkit::DtEllipsoidCuboidBase, vrvControlToolkit::DtAttributeGroupObject, vrvControlToolkit::DtText3DObject, vrvControlToolkit::DtArea3DObject, and vrvControlToolkit::DtText2DObject.

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

virtual

Reimplemented in vrvControlToolkit::DtCylinderObject, vrvControlToolkit::DtTriangle2DObject, vrvControlToolkit::DtLine3DObject, vrvControlToolkit::DtEllipseRectangleBase, vrvControlToolkit::DtLine2DObject, vrvControlToolkit::DtEllipsoidCuboidBase, vrvControlToolkit::DtText3DObject, vrvControlToolkit::DtAttributeGroupObject, vrvControlToolkit::DtArea3DObject, and vrvControlToolkit::DtText2DObject.

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

virtual

Reimplemented in vrvControlToolkit::DtCylinderObject, vrvControlToolkit::DtLine3DObject, vrvControlToolkit::DtTriangle2DObject, vrvControlToolkit::DtLine2DObject, vrvControlToolkit::DtEllipseRectangleBase, vrvControlToolkit::DtEllipsoidCuboidBase, vrvControlToolkit::DtText3DObject, vrvControlToolkit::DtAttributeGroupObject, vrvControlToolkit::DtArea3DObject, and vrvControlToolkit::DtText2DObject.

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

virtual

Reimplemented in vrvControlToolkit::DtLine3DObject, vrvControlToolkit::DtAttributeGroupObject, vrvControlToolkit::DtLine2DObject, vrvControlToolkit::DtCylinderObject, vrvControlToolkit::DtTriangle2DObject, vrvControlToolkit::DtEllipseRectangleBase, vrvControlToolkit::DtArea3DObject, vrvControlToolkit::DtEllipsoidCuboidBase, vrvControlToolkit::DtText3DObject, and vrvControlToolkit::DtText2DObject.

virtual void vrvControlToolkit::DtDrawControlObject::update ( )

pure virtual

update the internal publisher and tick

Pure virtual function used to force any changes to the draw control objects to be sent to the network.

Implemented in vrvControlToolkit::DtLine3DObject, vrvControlToolkit::DtAttributeGroupObject, vrvControlToolkit::DtLine2DObject, vrvControlToolkit::DtCylinderObject, vrvControlToolkit::DtTriangle2DObject, vrvControlToolkit::DtEllipseRectangleBase, vrvControlToolkit::DtArea3DObject, vrvControlToolkit::DtText3DObject, vrvControlToolkit::DtText2DObject, vrvControlToolkit::DtAttributeGroupTemplateObject, vrvControlToolkit::DtCuboidObject, and vrvControlToolkit::DtEllipsoidObject.

static void vrvControlToolkit::DtDrawControlObject::setPublisherCreator ( DtEnvironmentProcessPublisherCreator *  creator )

static

Member Data Documentation

unsigned vrvControlToolkit::DtDrawControlObject::myId

protected

DtEnvironmentProcessPublisher* vrvControlToolkit::DtDrawControlObject::myPublisher

protected

bool vrvControlToolkit::DtDrawControlObject::myVisible

protected

DtVdcColor vrvControlToolkit::DtDrawControlObject::myEmptyColor

protected

DtEnvironmentProcessPublisherCreator* vrvControlToolkit::DtDrawControlObject::thePublisherCreator

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvDrawControl/DtDrawControlObject.h