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.
DtDIGuyObjectStateRepository &	operator= (const DtDIGuyObjectStateRepository &orig)
	Assignment Operator.
virtual DtStateRepository *	clone (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 DtEntityIdentifier &	entityIdentifier () 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 DtString &	type () const
virtual void	setBodyAppearance (const DtString &val)
	Set/Get body appearance.
virtual const DtString &	bodyAppearance () 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 DtString &	headAppearance () const
	Set/Get head appearance (only supported in DI-Guy 13 and later)
virtual void	setBodyWeight (double val)
	Set/Get body weight.
virtual double	bodyWeight () const
	Set/Get body weight.
virtual void	setItemAppearance (const DtString &val)
	Set/Get item appearance (only supported in DI-Guy 13 and later)
virtual const DtString &	itemAppearance () 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 DtString &	accessoryAppearance (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)
	Set/Get action.
virtual void	setAction (const DtString &val, bool paused, double speed=0.0, bool useActionPositioning=false, const DtVector &offset=DtVector(0, 0, 0))
	Set/Get action.
virtual const DtString &	action () const
	Set/Get action.
virtual bool	useActionPositioning () const
	Set/Get action.
virtual const DtVector &	actionOffset () 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 DtDiGuyPixelData &	shapeVariation (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 DtDiGuyLinkShapeMap &	shapeVariations () const
	Set/Get share variations (only supported in DI-Guy 13 and later)
virtual DtDiGuyLinkShapeMap &	shapeVariations ()
	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 DtVector &	characterScale () 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)
virtual unsigned int	rank () const
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
virtual void	setRank (unsigned int val)
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
virtual unsigned int	unit () const
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
virtual void	setUnit (unsigned int val)
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
virtual unsigned int	personalUnit () const
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
virtual void	setPersonalUnit (unsigned int val)
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
virtual const DtString &	name () const
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
virtual void	setName (DtString val)
	Set/Get patch values for Rank, Unit, Personal Unit, and Name.
Public Member Functions inherited from DtStateRepository
	DtStateRepository ()
	default constructor
	DtStateRepository (const DtStateRepository &orig)
	copy constructor
virtual	~DtStateRepository ()
	destructor
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator
virtual void	setGlobalId (const DtGlobalObjectDesignator &id)
	Get/Set global identifier, or name.
virtual const DtGlobalObjectDesignator &	globalId () const
virtual unsigned int	numberOfAttributeRecords () const
virtual void	setAttributeRecords (const DtAttributeRecordSet &records)
	The following functions are related to the extendability part of DIS 7.
virtual void	setAttributeRecords (const DtStandardVariableRecordPtrVector &records)
	Replace the attribute record set with the records in the given vector.
virtual const DtAttributeRecordSet &	attributeRecordSet () const
	Return the attribute record set.
virtual DtAttributeRecordSet &	attributeRecordSet ()
	Return the attribute record set.
virtual const DtStandardVariableRecordPtrVector &	attributeRecords () const
	Return the attribute records Any changes to the returned record(s) will modify the records in the recordSet.
virtual const DtStandardVariableRecordPtrVector &	attributeRecords (unsigned int recordType) const
	Return the attribute records of the given type (all records if type is 0) Any changes to the returned record(s) will modify the records in the recordSet.
virtual DtStandardVariableRecord *	attributeRecord (unsigned int recordType) const
	Return the (first) attribute record of the given type (first record if type is 0) Any changes to the returned record will modify the record in the recordSet.
virtual int	removeAttributeRecord (unsigned int recordType, bool removeAll=true)
	Remove and discard the first record of the given record type (if there is one) or all them.
virtual DtStandardVariableRecordPtrVector &	getAttributeRecords (unsigned int recordType, DtStandardVariableRecordPtrVector &vec) const
	Get the attribute records of the given type (all if type is 0) Any changes to the returned record(s) will modify the records in the recordSet.
virtual DtStandardVariableRecordPtrVector &	getAttributeRecords (DtStandardVariableRecordPtrVector &vec) const
	Get the attribute records Any changes to the returned record(s) will modify the records in the recordSet.
virtual void	addAttributeRecord (DtStandardVariableRecord *record)
	Add a clone of given record to the attribute record set.
virtual void	addAttributeRecord (std::auto_ptr< DtStandardVariableRecord > record)
	Add the given record to the attribute record set.
virtual void	clearAttributeRecords ()
	Clear all records.
virtual DtStateRepositoryExtension *	stateRepositoryExtension (DtString srExtName) const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.
virtual std::vector< DtString >	stateRepositoryExtensionNames () const
	Returns a set of the registered state repository extension names.
virtual void	setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.
virtual const std::map < DtString, DtStateRepositoryExtension * >	stateRepositoryExtensions () const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.

Static Public Member Functions
static DtDIGuyObjectStateRepository *	create ()
	Create a DtDIGuyObjectStateRepository.
Static Public Member Functions inherited from DtStateRepository
static bool	addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
	The following functions are for extending state repositories through State Repository Extension classes.

Protected Attributes
DtEntityIdentifier	myEntityIdentifier
DtGlobalObjectDesignator	myObjectIdentifier
DtString	myAction
bool	myActionPaused
double	myActionSpeed
bool	myVisible
DtString	myBodyAppearance
DtString	myHeadAppearance
DtString	myItemAppearance
std::vector< DtString >	myAccessoryAppearance
DtString	myType
DtDiGuyLinkShapeMap	myShapeVariations
DtVector	myCharacterScale
bool	myIsShapeVariationsDirty
bool	myUseActionPositioningFlag
DtVector	myActionOffset
double	myBodyWeight
unsigned int	myUnit
unsigned int	myPersonalUnit
unsigned int	myRank
DtString	myName

Additional Inherited Members
Public Types inherited from DtStateRepository
typedef std::map< DtString, DtStateRepositoryExtension * >	DtStateRepositoryExtensionMap
Public Attributes inherited from DtStateRepository
DtGlobalObjectDesignator	myGlobalId
DtAttributeRecordSet	myAttributeRecords
DtStandardVariableRecordPtrVector	myReturnedRecords
DtStateRepositoryExtensionMap	myStateRepositoryExtensionMap
Static Public Attributes inherited from DtStateRepository
static std::map< DtString, DtSrExtCreatorFnc >	theStateRepositoryExtensionCreatorMap

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 const DtVector& DtDIGuyObjectStateRepository::actionOffset ( ) 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 double DtDIGuyObjectStateRepository::bodyWeight ( ) const

virtual

Set/Get body weight.

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

Create a DtDIGuyObjectStateRepository.

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 DtString& DtDIGuyObjectStateRepository::name ( ) const

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

virtual const DtGlobalObjectDesignator& DtDIGuyObjectStateRepository::objectIdentifier ( ) const

virtual

Get the HostObjectIdentifier.".

DtDIGuyObjectStateRepository& DtDIGuyObjectStateRepository::operator=

(

const DtDIGuyObjectStateRepository &

orig

)

Assignment Operator.

virtual unsigned int DtDIGuyObjectStateRepository::personalUnit ( ) const

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

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 unsigned int DtDIGuyObjectStateRepository::rank ( ) const

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

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 )

virtual

Set/Get action.

virtual void DtDIGuyObjectStateRepository::setAction ( const DtString &  val, bool  paused, double  speed = 0.0, bool  useActionPositioning = false, const DtVector &  offset = DtVector(0, 0, 0)  )

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::setBodyWeight ( double  val )

virtual

Set/Get body weight.

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::setName ( DtString  val )

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

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

virtual

Set the HostObjectIdentifier.

virtual void DtDIGuyObjectStateRepository::setPersonalUnit ( unsigned int  val )

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

virtual void DtDIGuyObjectStateRepository::setRank ( unsigned int  val )

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

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::setUnit ( unsigned int  val )

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

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

virtual unsigned int DtDIGuyObjectStateRepository::unit ( ) const

virtual

Set/Get patch values for Rank, Unit, Personal Unit, and Name.

virtual bool DtDIGuyObjectStateRepository::useActionPositioning ( ) const

virtual

Set/Get action.

Member Data Documentation

std::vector<DtString> DtDIGuyObjectStateRepository::myAccessoryAppearance

protected

DtString DtDIGuyObjectStateRepository::myAction

protected

DtVector DtDIGuyObjectStateRepository::myActionOffset

protected

bool DtDIGuyObjectStateRepository::myActionPaused

protected

double DtDIGuyObjectStateRepository::myActionSpeed

protected

DtString DtDIGuyObjectStateRepository::myBodyAppearance

protected

double DtDIGuyObjectStateRepository::myBodyWeight

protected

DtVector DtDIGuyObjectStateRepository::myCharacterScale

protected

DtEntityIdentifier DtDIGuyObjectStateRepository::myEntityIdentifier

protected

DtString DtDIGuyObjectStateRepository::myHeadAppearance

protected

bool DtDIGuyObjectStateRepository::myIsShapeVariationsDirty

mutableprotected

DtString DtDIGuyObjectStateRepository::myItemAppearance

protected

DtString DtDIGuyObjectStateRepository::myName

protected

DtGlobalObjectDesignator DtDIGuyObjectStateRepository::myObjectIdentifier

protected

unsigned int DtDIGuyObjectStateRepository::myPersonalUnit

protected

unsigned int DtDIGuyObjectStateRepository::myRank

protected

DtDiGuyLinkShapeMap DtDIGuyObjectStateRepository::myShapeVariations

protected

DtString DtDIGuyObjectStateRepository::myType

protected

unsigned int DtDIGuyObjectStateRepository::myUnit

protected

bool DtDIGuyObjectStateRepository::myUseActionPositioningFlag

protected

bool DtDIGuyObjectStateRepository::myVisible

protected

---

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

• diGuyObjectStateRepository.h