VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
DtSdcObject Class Reference

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

Inheritance diagram for DtSdcObject:
Inheritance graph
[legend]

Public Member Functions

 DtSdcObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
 Parameterized constructor.
virtual ~DtSdcObject ()
 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 DtSdcColorcolor () const
virtual void setColor (const DtSdcColor &color)
virtual void setRemoteGraphicSet (const std::string &setName)
virtual void update ()=0
 update the internal publisher and tick

Protected Attributes

unsigned myId
DtEnvironmentProcessPublisher myPublisher
bool myVisible
DtSdcColor myEmptyColor

Private Member Functions

 DtSdcObject ()
 Default constructor.
 DtSdcObject (const DtSdcObject &orig)
 Copy constructor Private and unimplemented.
DtSdcObjectoperator= (const DtSdcObject &rhs)
 Assignment operator Private and unimplemented.

Detailed Description

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

DtSdcObject 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

DtSdcObject::DtSdcObject ( DtExerciseConn *  exConn,
unsigned  id,
const DtString objName 
)

Parameterized constructor.

Parameters
id(locally) unique id to use for this object
virtual DtSdcObject::~DtSdcObject ( )
virtual

Virtual destructor.

DtSdcObject::DtSdcObject ( )
private

Default constructor.

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

DtSdcObject::DtSdcObject ( const DtSdcObject orig)
private

Copy constructor Private and unimplemented.

Not copyable.

Member Function Documentation

DtSdcObject& DtSdcObject::operator= ( const DtSdcObject rhs)
private

Assignment operator Private and unimplemented.

Not copyable.

virtual unsigned DtSdcObject::id ( ) const
virtual

id accessor

Returns
The (local) id of this draw object
virtual void DtSdcObject::setId ( unsigned  id)
virtual

id mutator

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

Parameters
idA (locally unique) id for this draw object
virtual const DtGlobalObjectDesignator& DtSdcObject::globalId ( ) const
virtual
virtual void DtSdcObject::setVisible ( bool  yesNo)
virtual
virtual bool DtSdcObject::visible ( ) const
virtual
virtual bool DtSdcObject::flashing ( ) const
virtual
virtual void DtSdcObject::setFlashing ( bool  yesNo)
virtual
virtual const DtSdcColor& DtSdcObject::color ( ) const
virtual
virtual void DtSdcObject::setColor ( const DtSdcColor color)
virtual
virtual void DtSdcObject::setRemoteGraphicSet ( const std::string &  setName)
virtual
virtual void DtSdcObject::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 DtSdcTriangle2DObject, DtSdcText3DObject, DtSdcText2DObject, DtSdcLine3DObject, DtSdcLine2DObject, DtSdcEllipsoidObject, DtSdcEllRectBase, DtSdcCylinderObject, DtSdcCuboidObject, DtSdcAttributeGroupTemplateObject, DtSdcAttributeGroupObject, and DtSdcArea3DObject.

Member Data Documentation

unsigned DtSdcObject::myId
protected
DtEnvironmentProcessPublisher DtSdcObject::myPublisher
protected
bool DtSdcObject::myVisible
protected
DtSdcColor DtSdcObject::myEmptyColor
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)