VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtDIGuyObjectStateRepository Class Reference

Instances of DtDIGuyObjectStateRepository are used to store state data for DIGuyObject objects. More...

+ Inheritance diagram for DtDIGuyObjectStateRepository:
+ Collaboration diagram for DtDIGuyObjectStateRepository:

Public Member Functions

 DtDIGuyObjectStateRepository ()
 Constructor.
virtual ~DtDIGuyObjectStateRepository ()
 Destructor.
 DtDIGuyObjectStateRepository (const DtDIGuyObjectStateRepository &orig)
 Copy Constructor.
DtDIGuyObjectStateRepositoryoperator= (const DtDIGuyObjectStateRepository &orig)
 Assignment Operator.
virtual DtStateRepositoryclone (bool copy) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Print data to the DtInfo stream.
virtual void printDataToStream (std::ostream &stream) const
 Print data to the specified stream.
virtual void setEntityIdentifier (const DtEntityIdentifier &val)
 Set the EntityIdentifier.
virtual const DtEntityIdentifierentityIdentifier () const
 Get the EntityIdentifier.".
virtual void setObjectIdentifier (const DtGlobalObjectDesignator &val)
 Set the HostObjectIdentifier.
virtual const
DtGlobalObjectDesignator
objectIdentifier () const
 Get the HostObjectIdentifier.".
virtual void setType (const DtString &newType, const DtString &newAppearance)
 When updating type, it will typically make sense to also update the Appearance.
virtual void setType (const DtString &val)
virtual const DtStringtype () const
virtual void setBodyAppearance (const DtString &val)
 Set/Get body appearance.
virtual const DtStringbodyAppearance () const
 Set/Get body appearance.
virtual void setHeadAppearance (const DtString &val)
 Set/Get head appearance (only supported in DI-Guy 13 and later)
virtual const DtStringheadAppearance () const
 Set/Get head appearance (only supported in DI-Guy 13 and later)
virtual void setItemAppearance (const DtString &val)
 Set/Get item appearance (only supported in DI-Guy 13 and later)
virtual const DtStringitemAppearance () const
 Set/Get item appearance (only supported in DI-Guy 13 and later)
virtual bool setAccessoryAppearance (unsigned int index, const DtString &val)
 Set/Get accessory appearance (only supported in DI-Guy 13 and later) If the index is larger than the count, this will do nothing and return false.
virtual const DtStringaccessoryAppearance (unsigned int index) const
 Set/Get accessory appearance (only supported in DI-Guy 13 and later) If the index is larger than the count, this will do nothing and return false.
virtual void setAccessoryAppearanceCount (unsigned int index)
 Set/Get the accessory appearance count (only supported in DI-Guy 13 and later).
virtual unsigned int accessoryAppearanceCount () const
 Set/Get the accessory appearance count (only supported in DI-Guy 13 and later).
virtual void setAction (const DtString &val, bool paused, double speed=0.0)
 Set/Get action.
virtual void setAction (const DtString &val)
 Set/Get action.
virtual const DtStringaction () const
 Set/Get action.
virtual void setActionPaused (bool paused)
 Set/Get action pause state.
virtual bool isActionPaused () const
 Set/Get action pause state.
virtual double actionSpeed () const
 Set/Get action speed.
virtual void setActionSpeed (double speed)
 Set/Get action speed.
virtual void setVisible (bool visibile)
 Set/Get visible state.
virtual bool isVisible () const
 Set/Get visible state.
virtual void addShapeVariation (unsigned int linkIndex, unsigned int shapeIndex, const DtDiGuyPixelData &pixelData)
 Set/Get share variations (only supported in DI-Guy 13 and later)
virtual void removeShapeVariation (unsigned int linkIndex, unsigned int shapeIndex)
 Set/Get share variations (only supported in DI-Guy 13 and later)
virtual const DtDiGuyPixelDatashapeVariation (unsigned int linkIndex, unsigned int shapeIndex, bool &dataIsValid) const
 Set/Get share variations (only supported in DI-Guy 13 and later)
virtual bool getShapeVariation (unsigned int linkIndex, unsigned int shapeIndex, DtDiGuyPixelData &pixelData) const
 Set/Get share variations (only supported in DI-Guy 13 and later)
virtual void setShapeVariations (const DtDiGuyLinkShapeMap &variations)
 Set/Get share variations (only supported in DI-Guy 13 and later)
virtual const DtDiGuyLinkShapeMapshapeVariations () const
 Set/Get share variations (only supported in DI-Guy 13 and later)
virtual DtDiGuyLinkShapeMapshapeVariations ()
 Set/Get share variations (only supported in DI-Guy 13 and later)
virtual bool isShapeVariationsDirty () const
 Indicates if the shape variations have been modified since last network update.
virtual void clearShapeVariationsDirty () const
 Clears dirty flag.
virtual const DtVectorcharacterScale () const
 Set/Get character scale (only supported in DI-Guy 13 and later)
virtual void setCharacterScale (const DtVector &scale)
 Set/Get character scale (only supported in DI-Guy 13 and later)
- Public Member Functions inherited from DtStateRepository
 DtStateRepository ()
 default constructor
 DtStateRepository (const DtStateRepository &orig)
 copy constructor
virtual ~DtStateRepository ()
 destructor
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator
virtual void setGlobalId (const DtString &id)
 Get/Set global identifier, or name.
virtual const DtStringglobalId () const
virtual void setLocalId (const DtObjectId &id)
 Get/Set local identifier, or handle.
virtual const DtObjectIdlocalId () const
virtual bool publishesAttribute (const RTI::AttributeHandle &val) const
 Returns true if the attribute is published.
virtual void setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
 Set the attribute with the given handle.
virtual const char * getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle.
virtual void setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
 Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject.
virtual const char * getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
 Get a pointer to attribute value for the attribute with the given name.
virtual const char * getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it.

Static Public Member Functions

static
DtDIGuyObjectStateRepository
create ()
 Create a DtDIGuyObjectStateRepository.

Protected Attributes

DtEntityIdentifier myEntityIdentifier
DtGlobalObjectDesignator myObjectIdentifier
DtString myAction
bool myActionPaused
double myActionSpeed
bool myVisible
DtString myBodyAppearance
DtString myHeadAppearance
DtString myItemAppearance
std::vector< DtStringmyAccessoryAppearance
DtString myType
DtDiGuyLinkShapeMap myShapeVariations
DtVector myCharacterScale
bool myIsShapeVariationsDirty

Additional Inherited Members

- Public Attributes inherited from DtStateRepository
DtString myGlobalId
DtObjectId myLocalId
std::map< RTI::AttributeHandle,
DtGenericAttributeInfo * > 
myAttributesByHandle
 Attributes by handle.

Detailed Description

Instances of DtDIGuyObjectStateRepository are used to store state data for DIGuyObject objects.

Constructor & Destructor Documentation

DtDIGuyObjectStateRepository::DtDIGuyObjectStateRepository ( )

Constructor.

virtual DtDIGuyObjectStateRepository::~DtDIGuyObjectStateRepository ( )
virtual

Destructor.

DtDIGuyObjectStateRepository::DtDIGuyObjectStateRepository ( const DtDIGuyObjectStateRepository orig)

Copy Constructor.

Member Function Documentation

virtual const DtString& DtDIGuyObjectStateRepository::accessoryAppearance ( unsigned int  index) const
virtual

Set/Get accessory appearance (only supported in DI-Guy 13 and later) If the index is larger than the count, this will do nothing and return false.

virtual unsigned int DtDIGuyObjectStateRepository::accessoryAppearanceCount ( ) const
virtual

Set/Get the accessory appearance count (only supported in DI-Guy 13 and later).

virtual const DtString& DtDIGuyObjectStateRepository::action ( ) const
virtual

Set/Get action.

virtual double DtDIGuyObjectStateRepository::actionSpeed ( ) const
virtual

Set/Get action speed.

virtual void DtDIGuyObjectStateRepository::addShapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex,
const DtDiGuyPixelData pixelData 
)
virtual

Set/Get share variations (only supported in DI-Guy 13 and later)

virtual const DtString& DtDIGuyObjectStateRepository::bodyAppearance ( ) const
virtual

Set/Get body appearance.

virtual const DtVector& DtDIGuyObjectStateRepository::characterScale ( ) const
virtual

Set/Get character scale (only supported in DI-Guy 13 and later)

virtual void DtDIGuyObjectStateRepository::clearShapeVariationsDirty ( ) const
virtual

Clears dirty flag.

virtual DtStateRepository* DtDIGuyObjectStateRepository::clone ( bool  copy) const
virtual

Return a copy/empty object of the same type as this.

Reimplemented from DtStateRepository.

static DtDIGuyObjectStateRepository* DtDIGuyObjectStateRepository::create ( )
static
virtual const DtEntityIdentifier& DtDIGuyObjectStateRepository::entityIdentifier ( ) const
virtual

Get the EntityIdentifier.".

virtual bool DtDIGuyObjectStateRepository::getShapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex,
DtDiGuyPixelData pixelData 
) const
virtual

Set/Get share variations (only supported in DI-Guy 13 and later)

virtual const DtString& DtDIGuyObjectStateRepository::headAppearance ( ) const
virtual

Set/Get head appearance (only supported in DI-Guy 13 and later)

virtual bool DtDIGuyObjectStateRepository::isActionPaused ( ) const
virtual

Set/Get action pause state.

virtual bool DtDIGuyObjectStateRepository::isShapeVariationsDirty ( ) const
virtual

Indicates if the shape variations have been modified since last network update.

virtual bool DtDIGuyObjectStateRepository::isVisible ( ) const
virtual

Set/Get visible state.

virtual const DtString& DtDIGuyObjectStateRepository::itemAppearance ( ) const
virtual

Set/Get item appearance (only supported in DI-Guy 13 and later)

virtual const DtGlobalObjectDesignator& DtDIGuyObjectStateRepository::objectIdentifier ( ) const
virtual

Get the HostObjectIdentifier.".

DtDIGuyObjectStateRepository& DtDIGuyObjectStateRepository::operator= ( const DtDIGuyObjectStateRepository orig)

Assignment Operator.

virtual void DtDIGuyObjectStateRepository::printData ( ) const
virtual

Print data to the DtInfo stream.

Reimplemented from DtStateRepository.

virtual void DtDIGuyObjectStateRepository::printDataToStream ( std::ostream &  stream) const
virtual

Print data to the specified stream.

Reimplemented from DtStateRepository.

virtual void DtDIGuyObjectStateRepository::removeShapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex 
)
virtual

Set/Get share variations (only supported in DI-Guy 13 and later)

virtual bool DtDIGuyObjectStateRepository::setAccessoryAppearance ( unsigned int  index,
const DtString val 
)
virtual

Set/Get accessory appearance (only supported in DI-Guy 13 and later) If the index is larger than the count, this will do nothing and return false.

virtual void DtDIGuyObjectStateRepository::setAccessoryAppearanceCount ( unsigned int  index)
virtual

Set/Get the accessory appearance count (only supported in DI-Guy 13 and later).

virtual void DtDIGuyObjectStateRepository::setAction ( const DtString val,
bool  paused,
double  speed = 0.0 
)
virtual

Set/Get action.

virtual void DtDIGuyObjectStateRepository::setAction ( const DtString val)
virtual

Set/Get action.

virtual void DtDIGuyObjectStateRepository::setActionPaused ( bool  paused)
virtual

Set/Get action pause state.

virtual void DtDIGuyObjectStateRepository::setActionSpeed ( double  speed)
virtual

Set/Get action speed.

virtual void DtDIGuyObjectStateRepository::setBodyAppearance ( const DtString val)
virtual

Set/Get body appearance.

virtual void DtDIGuyObjectStateRepository::setCharacterScale ( const DtVector scale)
virtual

Set/Get character scale (only supported in DI-Guy 13 and later)

virtual void DtDIGuyObjectStateRepository::setEntityIdentifier ( const DtEntityIdentifier val)
virtual

Set the EntityIdentifier.

virtual void DtDIGuyObjectStateRepository::setHeadAppearance ( const DtString val)
virtual

Set/Get head appearance (only supported in DI-Guy 13 and later)

virtual void DtDIGuyObjectStateRepository::setItemAppearance ( const DtString val)
virtual

Set/Get item appearance (only supported in DI-Guy 13 and later)

virtual void DtDIGuyObjectStateRepository::setObjectIdentifier ( const DtGlobalObjectDesignator val)
virtual

Set the HostObjectIdentifier.

virtual void DtDIGuyObjectStateRepository::setShapeVariations ( const DtDiGuyLinkShapeMap variations)
virtual

Set/Get share variations (only supported in DI-Guy 13 and later)

virtual void DtDIGuyObjectStateRepository::setType ( const DtString newType,
const DtString newAppearance 
)
virtual

When updating type, it will typically make sense to also update the Appearance.

Prefer the setType form that also updates appearance.

virtual void DtDIGuyObjectStateRepository::setType ( const DtString val)
virtual
virtual void DtDIGuyObjectStateRepository::setVisible ( bool  visibile)
virtual

Set/Get visible state.

virtual const DtDiGuyPixelData& DtDIGuyObjectStateRepository::shapeVariation ( unsigned int  linkIndex,
unsigned int  shapeIndex,
bool dataIsValid 
) const
virtual

Set/Get share variations (only supported in DI-Guy 13 and later)

virtual const DtDiGuyLinkShapeMap& DtDIGuyObjectStateRepository::shapeVariations ( ) const
virtual

Set/Get share variations (only supported in DI-Guy 13 and later)

virtual DtDiGuyLinkShapeMap& DtDIGuyObjectStateRepository::shapeVariations ( )
virtual

Set/Get share variations (only supported in DI-Guy 13 and later)

virtual const DtString& DtDIGuyObjectStateRepository::type ( ) const
virtual

Member Data Documentation

std::vector<DtString> DtDIGuyObjectStateRepository::myAccessoryAppearance
protected
DtString DtDIGuyObjectStateRepository::myAction
protected
bool DtDIGuyObjectStateRepository::myActionPaused
protected
double DtDIGuyObjectStateRepository::myActionSpeed
protected
DtString DtDIGuyObjectStateRepository::myBodyAppearance
protected
DtVector DtDIGuyObjectStateRepository::myCharacterScale
protected
DtEntityIdentifier DtDIGuyObjectStateRepository::myEntityIdentifier
protected
DtString DtDIGuyObjectStateRepository::myHeadAppearance
protected
bool DtDIGuyObjectStateRepository::myIsShapeVariationsDirty
mutableprotected
DtString DtDIGuyObjectStateRepository::myItemAppearance
protected
DtGlobalObjectDesignator DtDIGuyObjectStateRepository::myObjectIdentifier
protected
DtDiGuyLinkShapeMap DtDIGuyObjectStateRepository::myShapeVariations
protected
DtString DtDIGuyObjectStateRepository::myType
protected
bool DtDIGuyObjectStateRepository::myVisible
protected

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

Document ID: Generated on Fri Dec 2 02:42:08 EST 2016 from SVN revision 171416
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)