makVrv::DtCigiCharacterEntity Class Reference

A DtCigiCharacterEntity is a CIGI base entity that loads a character (Di Guy) model.

Inheritance diagram for makVrv::DtCigiCharacterEntity:

Classes
struct	gestureData

Public Member Functions
	DtCigiCharacterEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
virtual	~DtCigiCharacterEntity ()
virtual void	init ()
virtual void	uninit ()
virtual void	restart ()
virtual void	setPosition (const DtGeodeticCoord &pos, bool force=false)
virtual void	setOrientation (const DtTaitBryan &orientation, bool force=false)
virtual void	setCharacterPaused (bool paused)
virtual void	setCharacterActionSpeed (float speed)
virtual void	unforceAction ()
virtual void	setCharacterAction (const std::string &action)
virtual void	setCharacterAction (const std::string &action, bool paused, double speed, bool usePositioning, const DtVector &offset)
virtual void	setCharacterPosture (DtCharacterModel::Posture posture)
virtual void	setWeaponState (EntityStateListener::WeaponState state)
virtual EntityStateListener::WeaponState	weaponState () const
virtual void	setAlive (bool alive)
virtual bool	alive () const
virtual void	executeGesture (const std::string &gestureName, int reps, float duration, float channelAWeight)
virtual void	endGesture (const std::string &gestureName, float rampDown)
virtual void	setItemAppearance (const std::string &itemAppearance)
virtual const std::string &	itemAppearance () const
virtual void	setHeadAppearance (const std::string &headAppearance)
virtual const std::string &	headAppearance () const
virtual void	setCharacterScale (const DtVector &scale)
virtual const DtVector &	characterScale () const
virtual void	setCharacterWeight (float characterWeight)
virtual float	characterWeight () const
virtual void	setWaterlineOriginOffset (float offset)
virtual void	startEmbarked ()
virtual void	endEmbarked ()
virtual void	setArtPartTranslation (int partId, float xOffset, float yOffset, float zOffset, bool xEnable, bool yEnable, bool zEnable)
virtual void	setArtPartOrientation (int partId, float yaw, float pitch, float roll, bool yawEnable, bool pitchEnable, bool rollEnable)
virtual void	setArtPartLinearRate (int partId, float xRate, float yRate, float zRate)
virtual void	setArtPartAngularRate (int partId, float yawRate, float pitchRate, float rollRate)
virtual void	setArtPartEnable (int partId, bool trueFalse)
virtual void	setIsAmphibious (bool isAmphibious)
virtual bool	isAmphibious () const
virtual bool	gestureInitialRepetitions (const std::string &gestureName, int &reps) const
virtual bool	gestureInitialDuration (const std::string &gestureName, float &duration) const
virtual bool	gestureChannelAWeight (const std::string &gestureName, float &weight) const
Public Member Functions inherited from makVrv::DtCigiBaseEntity
	DtCigiBaseEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
virtual	~DtCigiBaseEntity ()
virtual DtUniqueID	uniqueId () const
virtual DtUniqueID	elementId () const
virtual int	cigiId () const
virtual void	restartRequest ()
virtual int	entityType () const
virtual bool	extendedEntityTypeOn () const
virtual void	setExtendedEntityTypeOn (bool onOff)
virtual void	setExtendedEntityType (DtEntityType &entityType)
virtual void	setVisible (bool yesNo)
virtual bool	isVisible () const
virtual void	setDeadReckoningOn (bool onOff)
virtual bool	isDeadReckoning () const
virtual const DtGeodeticCoord &	position () const
virtual const DtGeodeticCoord &	previousPosition () const
virtual const DtVector &	localPosition () const
virtual const DtTaitBryan &	orientation () const
virtual const DtTaitBryan &	localOrientation () const
virtual const DtTaitBryan &	geocentricOrientation () const
virtual void	setLinearRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)
virtual const DtVector &	linearRate () const
virtual void	setAngularRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)
virtual const DtVector &	angularRate () const
virtual void	slot_deadReckoningAllowed (bool allowed)
virtual void	setAlpha (int alpha)
virtual int	alpha () const
virtual void	setInheritAlpha (bool inherit)
virtual bool	isInheritingAlpha () const
virtual void	slot_alphaChanged (int alpha, DtUniqueID id)
virtual void	slot_entityToBeDeleted (int cigiEntityId)
virtual void	setGroundClampingOn (DtGroundClampingUpdater::GroundClampingMode clampType)
virtual DtGroundClampingUpdater::GroundClampingMode	groundClampingType () const
virtual bool	getArtPartTranslation (int partId, DtVector &translation)
virtual bool	getArtPartOrientation (int partId, DtTaitBryan &orientation)
virtual bool	getArtPartLinearRate (int partId, DtVector &rate)
virtual bool	getArtPartTranslationAndRate (int partId, DtVector &translation, DtVector &rate)
virtual bool	getArtPartAngularRate (int partId, DtVector &rate)
virtual bool	getArtPartOrientationAndRate (int partId, DtTaitBryan &orientation, DtVector &rate)
virtual DtSceneObjectAgent *	findSceneObjectAgent ()
virtual void	setRelativeTo (DtCigiBaseEntity *parent)
virtual void	setRelativePosition (const DtVector &pos)
virtual void	setRelativeOrientation (const DtTaitBryan &orient)
virtual bool	isEmbarked () const
virtual int	embarkedParentId () const
virtual const DtVector &	relativePosition () const
virtual const DtTaitBryan &	relativeOrientation () const
virtual void	addCollisionSegmentID (unsigned int segmentId)
virtual void	removeCollisionSegmentID (unsigned int segmentId)
virtual void	delayedStartEmbarked ()

Protected Types
typedef struct makVrv::DtCigiCharacterEntity::gestureData	GestureData
typedef boost::unordered_map < std::string, GestureData >	GestureDataMap

Protected Member Functions
virtual void	startDeadReckoning ()
virtual void	endDeadReckoning ()
virtual void	startGroundClamping ()
virtual void	endGroundClamping ()
Protected Member Functions inherited from makVrv::DtCigiBaseEntity
virtual void	buildGroundClampingUpdater ()
virtual bool	isGroundClamping () const
virtual void	getExtrapolatedValuesAndRestart ()
virtual void	queryExtrapolatedPositionAndOrientation (DtUniqueID drAgentId, bool relative)
virtual void	returnExtrapolatedPositionAndOrientation (const DtVector &resultPos, const DtTaitBryan &resultOri, bool relative, bool invokeRestart)
virtual DtDeadReckonUpdater *	findDRUpdaterInRenderThread (DtUniqueID drAgentId) const

Protected Attributes
DtCharacterModelAgent *	myCharacterModel
EntityStateListener::WeaponState	myWeaponState
bool	myAlive
std::string	myCharacterAction
bool	myCharacterPaused
float	myCharacterActionSpeed
bool	myCharacterActionUsesPositioning
DtVector	myCharacterActionOffset
DtCharacterModel::Posture	myPosture
float	myWaterlineOriginOffset
std::string	myItemAppearance
std::string	myHeadAppearance
DtVector	myCharacterScale
float	myCharacterWeight
bool	myIsAmphibious
GestureDataMap	myGestureDataMap
DtSurfaceClampingUpdaterAgent *	mySurfaceClampingUpdaterAgent
DtWaterClampingUpdaterAgent *	myWaterClampingUpdaterAgent
Protected Attributes inherited from makVrv::DtCigiBaseEntity
DtSceneObjectAgent *	mySceneObject
DtModelAgent *	myModel
std::string	myEntityModelDefName
DtDeadReckonUpdaterAgent *	myDeadReckonUpdaterAgent
DtGroundClampingUpdaterAgent *	myGroundClampingUpdaterAgent
DtEmbarkationUpdaterAgent *	myEmbarkationUpdaterAgent
bool	myDeadReckoningOn
bool	myEmbarked
DtGroundClampingUpdater::GroundClampingMode	myGroundClampingType
DtGeodeticCoord	myLastPosition
DtVector	myLastLocalPosition
DtTaitBryan	myLastOrientation
DtTaitBryan	myLastLocalOrientation
DtTaitBryan	myLastGeocentricOrientation
DtVector	myLastRelativePosition
DtTaitBryan	myLastRelativeOrientation
DtVector	myLastVelocity
bool	myLastVelocityWorldCoordinates
DtVector	myLastAngularVelocity
bool	myLastAngularVelocityWorldCoordinates
DtCigiConnection &	myConnection
DtAgentManagerInterface &	mySceneInterface
int	myEntityId
int	myEntityType
bool	myExtendedEntityTypeOn
DtEntityType *	myExtendedEntityType
DtCigiBaseEntity *	myParent
int	myEmbarkedParentID
bool	myInheritAlpha
int	myAlpha
bool	myVisiblity
bool	myPositionSet
bool	myOrientationSet
std::map< int, DtTaitBryan >	myLastArtPartOrientation
std::map< int, DtVector >	myLastArtPartTranslation
std::map< int, DtVector >	myArtPartAngularRate
std::map< int, DtVector >	myArtPartLinearRate
std::list< unsigned int >	myCollisionSegmentIdList
DtSignalConnectionManager	mySignalConnections

Additional Inherited Members
Public Types inherited from makVrv::DtCigiBaseEntity
enum	AnimationStateGroup { Stop = 0, Pause = 1, Play = 2, Continue = 3 }
Public Attributes inherited from makVrv::DtCigiBaseEntity
boost::signalslib::signal < void(int, DtUniqueID)>	signal_alphaChanged

Member Typedef Documentation

typedef struct makVrv::DtCigiCharacterEntity::gestureData makVrv::DtCigiCharacterEntity::GestureData

protected

typedef boost::unordered_map<std::string, GestureData> makVrv::DtCigiCharacterEntity::GestureDataMap

protected

Constructor & Destructor Documentation

makVrv::DtCigiCharacterEntity::DtCigiCharacterEntity	(	DtCigiConnection &	connection,
		DtAgentManagerInterface &	sceneInterface,
		int	entityId,
		int	entityType
	)

Constructor.

virtual makVrv::DtCigiCharacterEntity::~DtCigiCharacterEntity ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtCigiCharacterEntity::init ( )

virtual

Calls down to DtCigiBaseEntity::init(), creates an character model, provides a model definition to it, and adds it to the scene object created in DtCigiBaseEntity::init(). It also provides default values to the character model's character action, paused state, action speed, posture, and weapon deployment. It also creates a surface and water clamping updater, as character models are amphibious (will float in water as well as walk on land).

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::uninit ( )

virtual

Calls down to DtCigiBaseEntity::uninit(), and then deletes the character model created in init(). It also deletes the surface and water clamping updaters.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::restart ( )

virtual

Calls down to DtCigiBaseEntity::restart(), then reinintializes art parts and alive state.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setPosition ( const DtGeodeticCoord &  pos, bool  force = false  )

virtual

Set the entity's geodetic position.

Parameters

[in]	pos	is the position set from the CIGI entity control message.
[in]	force	is a flag to force handling even if position has not changed.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setOrientation ( const DtTaitBryan &  orientation, bool  force = false  )

virtual

Set the entity's orientation.

Parameters

[in]	orientation	is the orientation set from the CIGI entity control message.
[in]	force	is a flag to force handling even if orientation has not changed.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setCharacterPaused ( bool  paused )

virtual

Set paused state without specifying an action.

virtual void makVrv::DtCigiCharacterEntity::setCharacterActionSpeed ( float  speed )

virtual

Change action speed of an existing action.

virtual void makVrv::DtCigiCharacterEntity::unforceAction ( )

virtual

If a character action has been given earlier, it overrides any posture / weapon state settings. This needs to be called to go back to using posture/weapon state instead of explicit animation.

virtual void makVrv::DtCigiCharacterEntity::setCharacterAction ( const std::string &  action )

virtual

Set a character action. Will used saved previous paused, speed, and offset.

virtual void makVrv::DtCigiCharacterEntity::setCharacterAction ( const std::string &  action, bool  paused, double  speed, bool  usePositioning, const DtVector &  offset  )

virtual

Fully set a character action. Sets the action to perform, the speed, whether the action is paused or not, and how much offset to apply over the course of the action.

virtual void makVrv::DtCigiCharacterEntity::setCharacterPosture ( DtCharacterModel::Posture  posture )

virtual

Set a character's posture.

virtual void makVrv::DtCigiCharacterEntity::setWeaponState ( EntityStateListener::WeaponState  state )

virtual

Set whether the character's weapon is deployed. Note that not all postures or animations will support a deployed weapon.

virtual EntityStateListener::WeaponState makVrv::DtCigiCharacterEntity::weaponState ( ) const

virtual

Get whether the character's weapon is deployed.

virtual void makVrv::DtCigiCharacterEntity::setAlive ( bool  alive )

virtual

Set whether the character is alive. The transition from alive to not alive will result in an animation; and from not alive to alive the entity will be restored to its last state.

virtual bool makVrv::DtCigiCharacterEntity::alive ( ) const

virtual

Get whether the character is alive.

virtual void makVrv::DtCigiCharacterEntity::executeGesture ( const std::string &  gestureName, int  reps, float  duration, float  channelAWeight  )

virtual

Execute the specified gesture reps - how many times the gesture should be repeated; default is 1 if no duration is specified, or best fit if there is a duration specified duration - how long the gesture should be executed; default is such that no time scaling occurs channelAWeight - the weight given to channel A of the gesture; ignored if the gesture does not have multiple channels Note that if a gesture with the same name is already executing, this is ignored.

virtual void makVrv::DtCigiCharacterEntity::endGesture ( const std::string &  gestureName, float  rampDown  )

virtual

Stop the named gesture from executing. Rampdown - the max amount of time spent trying to smooth over any motion seams; set to 0.5 for a smooth transition, set to 0 for an immediate abort.

virtual void makVrv::DtCigiCharacterEntity::setItemAppearance ( const std::string &  itemAppearance )

virtual

Set the appearance of the entity's currently held item.

virtual const std::string& makVrv::DtCigiCharacterEntity::itemAppearance ( ) const

virtual

Get the appearance of the entity's currently held item, if set.

virtual void makVrv::DtCigiCharacterEntity::setHeadAppearance ( const std::string &  headAppearance )

virtual

Set the appearance of the entity's current head.

virtual const std::string& makVrv::DtCigiCharacterEntity::headAppearance ( ) const

virtual

Get the appearance of the entity's current head.

virtual void makVrv::DtCigiCharacterEntity::setCharacterScale ( const DtVector &  scale )

virtual

Set the character scale.

virtual const DtVector& makVrv::DtCigiCharacterEntity::characterScale ( ) const

virtual

virtual void makVrv::DtCigiCharacterEntity::setCharacterWeight ( float  characterWeight )

virtual

Set the character weight.

virtual float makVrv::DtCigiCharacterEntity::characterWeight ( ) const

virtual

Get the character weight.

virtual void makVrv::DtCigiCharacterEntity::setWaterlineOriginOffset ( float  offset )

virtual

Set the amount that a bouyant entity's origin is offset from the waterline.

virtual void makVrv::DtCigiCharacterEntity::startEmbarked ( )

virtual

Override to prevent amphibious behavior when embarked.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::endEmbarked ( )

virtual

Override to restore amphibious behavior when disembarked.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setArtPartTranslation ( int  partId, float  xOffset, float  yOffset, float  zOffset, bool  xEnable, bool  yEnable, bool  zEnable  )

virtual

Set the relative position of an articulated part.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setArtPartOrientation ( int  partId, float  yaw, float  pitch, float  roll, bool  yawEnable, bool  pitchEnable, bool  rollEnable  )

virtual

Set the orientation of an articulated part.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setArtPartLinearRate ( int  partId, float  xRate, float  yRate, float  zRate  )

virtual

Set the linear rate of an articulated part.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setArtPartAngularRate ( int  partId, float  yawRate, float  pitchRate, float  rollRate  )

virtual

Set the angular rate of an articulated part.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setArtPartEnable ( int  partId, bool  trueFalse  )

virtual

Enable/disable an articulated part.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::setIsAmphibious ( bool  isAmphibious )

virtual

This is used by the buoyancy model to indicate if checks need to be made for being over water. When false (default) use assumes responsibility for keeping entity over land (note that the test for land is expensive, so keep this false unless you need it for an amphibious entity)

virtual bool makVrv::DtCigiCharacterEntity::isAmphibious ( ) const

virtual

This is used by the buoyancy model to indicate if checks need to be made for being over water. When false (default) use assumes responsibility for keeping entity over land (note that the test for land is expensive, so keep this false unless you need it for an amphibious entity)

virtual bool makVrv::DtCigiCharacterEntity::gestureInitialRepetitions ( const std::string &  gestureName, int &  reps  ) const

virtual

The repetition count this gesture was started with (< 0. means use gesture default) returns false if the gesture isn't found.

virtual bool makVrv::DtCigiCharacterEntity::gestureInitialDuration ( const std::string &  gestureName, float &  duration  ) const

virtual

The duration (in seconds) the gesture was started with (< 0. means use gesture default) returns false if the gesture isn't found.

virtual bool makVrv::DtCigiCharacterEntity::gestureChannelAWeight ( const std::string &  gestureName, float &  weight  ) const

virtual

The weight assigned to the 'A' channel (for a multi-channel gesture) returns false if the gesture isn't found.

virtual void makVrv::DtCigiCharacterEntity::startDeadReckoning ( )

protectedvirtual

Override to specify the correct motion model.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::endDeadReckoning ( )

protectedvirtual

Remove the Dead Reckoning updater.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::startGroundClamping ( )

protectedvirtual

Override to work with surface clamping updater, because character's are amphibious.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiCharacterEntity::endGroundClamping ( )

protectedvirtual

Remove the ground clamping updater.

Reimplemented from makVrv::DtCigiBaseEntity.

Member Data Documentation

DtCharacterModelAgent* makVrv::DtCigiCharacterEntity::myCharacterModel

protected

EntityStateListener::WeaponState makVrv::DtCigiCharacterEntity::myWeaponState

protected

bool makVrv::DtCigiCharacterEntity::myAlive

protected

std::string makVrv::DtCigiCharacterEntity::myCharacterAction

protected

bool makVrv::DtCigiCharacterEntity::myCharacterPaused

protected

float makVrv::DtCigiCharacterEntity::myCharacterActionSpeed

protected

bool makVrv::DtCigiCharacterEntity::myCharacterActionUsesPositioning

protected

DtVector makVrv::DtCigiCharacterEntity::myCharacterActionOffset

protected

DtCharacterModel::Posture makVrv::DtCigiCharacterEntity::myPosture

protected

float makVrv::DtCigiCharacterEntity::myWaterlineOriginOffset

protected

std::string makVrv::DtCigiCharacterEntity::myItemAppearance

protected

std::string makVrv::DtCigiCharacterEntity::myHeadAppearance

protected

DtVector makVrv::DtCigiCharacterEntity::myCharacterScale

protected

float makVrv::DtCigiCharacterEntity::myCharacterWeight

protected

bool makVrv::DtCigiCharacterEntity::myIsAmphibious

protected

GestureDataMap makVrv::DtCigiCharacterEntity::myGestureDataMap

protected

DtSurfaceClampingUpdaterAgent* makVrv::DtCigiCharacterEntity::mySurfaceClampingUpdaterAgent

protected

DtWaterClampingUpdaterAgent* makVrv::DtCigiCharacterEntity::myWaterClampingUpdaterAgent

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCigi/DtCigiCharacterEntity.h