VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtCigiAnimationEntity Class Reference

A DtCigiAnimationEntity is a CIGI entity that loads an animation model. More...

Inheritance diagram for makVrv::DtCigiAnimationEntity:
Inheritance graph
[legend]

Public Member Functions

 DtCigiAnimationEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
 Constructor. More...
 
virtual ~DtCigiAnimationEntity ()
 Destructor. More...
 
virtual void init ()
 Calls down to DtCigiBaseEntity::init(), creates an animation system model, provides a model definition, and adds the model to the scene object. More...
 
virtual void uninit ()
 Calls down DtCigiBaseEntity::uninit() and then deletes the animation model. More...
 
virtual void restart ()
 Calls down to DtCigiBaseEntity::restart(), and then restores the animation's state (started, paused, etc.) More...
 
virtual void stop ()
 Stop the animation. More...
 
virtual void start ()
 Start the animation. More...
 
virtual void pause ()
 Pause the animation. More...
 
virtual void resume ()
 Resume the animation. More...
 
virtual void setLoopMode (bool loopOn)
 Set the loop mode of the animation. More...
 
virtual void setReverseAnimation (bool reverse)
 Set the direction of the animation. More...
 
virtual int animationState ()
 Get the current animation state in Cigi Mappings not osg. More...
 
- Public Member Functions inherited from makVrv::DtCigiBaseEntity
 DtCigiBaseEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
 Constructor takes a DtCigiConnection, scene interface, and the CIGI entity ID/type. More...
 
virtual ~DtCigiBaseEntity ()
 Destructor. More...
 
virtual DtUniqueID uniqueId () const
 Returns the element ID of the entity's scene object. More...
 
virtual DtUniqueID elementId () const
 Returns the element ID of the entity's scene object. More...
 
virtual int cigiId () const
 Returns the CIGI Id of the CIGI entity. More...
 
virtual void restartRequest ()
 This is called to request that the entity be restarted. More...
 
virtual int entityType () const
 Get the entity type the entity was created with. More...
 
virtual bool extendedEntityTypeOn () const
 Get whether the entity has extended type on. More...
 
virtual void setExtendedEntityTypeOn (bool onOff)
 Set whether this entity uses extended entity type. More...
 
virtual void setExtendedEntityType (DtEntityType &entityType)
 Set the extended type. More...
 
virtual void setVisible (bool yesNo)
 Set whether the entity is visible. More...
 
virtual bool isVisible () const
 Get the current visibility. More...
 
virtual void setDeadReckoningOn (bool onOff)
 Turns dead-reckoning on/off. More...
 
virtual bool isDeadReckoning () const
 Determine if the entity is ACTUALLY dead reckoning. More...
 
virtual void setPosition (const DtGeodeticCoord &pos, bool force=false)
 Set the entity's geodetic position. More...
 
virtual const DtGeodeticCoord & position () const
 Returns the last position set by a CIGI entity control message. More...
 
virtual const DtGeodeticCoord & previousPosition () const
 Returns the entity's position that was set previously. More...
 
virtual const DtVectorlocalPosition () const
 Returns the last computed local position set. More...
 
virtual void setOrientation (const DtTaitBryan &orientation, bool force=false)
 Set the entity's orientation. More...
 
virtual const DtTaitBryan & orientation () const
 Returns the last orientation set by a CIGI entity control message. More...
 
virtual const DtTaitBryan & localOrientation () const
 Returns the computed last local orientation. More...
 
virtual const DtTaitBryan & geocentricOrientation () const
 Get the last computed geocentric orientation. More...
 
virtual void setLinearRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)
 Sets the entity's linear rate. More...
 
virtual const DtVectorlinearRate () const
 Get the last set linear rate. More...
 
virtual void setAngularRate (const DtVector &rate, bool useWorldCoordinates, bool force=false)
 Set's the entity's angular rate. More...
 
virtual const DtVectorangularRate () const
 Get the last set angular rate. More...
 
virtual void slot_deadReckoningAllowed (bool allowed)
 Called when IG-wide extrapolation is turned on or off. More...
 
virtual void setAlpha (int alpha)
 Sets the entity's alpha value. More...
 
virtual int alpha () const
 Returns the entity's alpha value. More...
 
virtual void setInheritAlpha (bool inherit)
 Set whether the entity should inherit alpha from its parent. More...
 
virtual bool isInheritingAlpha () const
 Determine if the entity is inheriting alpha. More...
 
virtual void slot_alphaChanged (int alpha, DtUniqueID id)
 Slot so we can check if the parent's alpha has changed. More...
 
virtual void slot_entityToBeDeleted (int cigiEntityId)
 Connected to the signal raised by the entity manager when an entity is removed, this is used to insure that signals connected to an embarkation parent are managed correctly if/when that parent is deleted. More...
 
virtual void setGroundClampingOn (DtGroundClampingUpdater::GroundClampingMode clampType)
 Turns ground clamping on/off. More...
 
virtual
DtGroundClampingUpdater::GroundClampingMode 
groundClampingType () const
 Get the current ground clamping type. More...
 
virtual void setArtPartTranslation (int partId, float xOffset, float yOffset, float zOffset, bool xEnable, bool yEnable, bool zEnable)
 Set the relative position of an articulated part. More...
 
virtual bool getArtPartTranslation (int partId, DtVector &translation)
 Get the art part translation from a specified CIGI part id. More...
 
virtual void setArtPartOrientation (int partId, float yaw, float pitch, float roll, bool yawEnable, bool pitchEnable, bool rollEnable)
 Set the orientation of an articulated part. More...
 
virtual bool getArtPartOrientation (int partId, DtTaitBryan &orientation)
 Returns false if the part id is not found. More...
 
virtual void setArtPartLinearRate (int partId, float xRate, float yRate, float zRate)
 Set the linear rate of an articulated part. More...
 
virtual bool getArtPartLinearRate (int partId, DtVector &rate)
 Get the art part translation rate from a specified CIGI part id. More...
 
virtual bool getArtPartTranslationAndRate (int partId, DtVector &translation, DtVector &rate)
 Get the art part translation and rate from a specified CIGI part id. More...
 
virtual void setArtPartAngularRate (int partId, float yawRate, float pitchRate, float rollRate)
 Set the angular rate of an articulated part. More...
 
virtual bool getArtPartAngularRate (int partId, DtVector &rate)
 Returns false if the part id is not found. More...
 
virtual bool getArtPartOrientationAndRate (int partId, DtTaitBryan &orientation, DtVector &rate)
 Returns false if the part id is not found. More...
 
virtual void setArtPartEnable (int partId, bool trueFalse)
 Enable/disable an articulated part. More...
 
virtual DtSceneObjectAgent * findSceneObjectAgent ()
 
virtual void setRelativeTo (DtCigiBaseEntity *parent)
 Attachment control. More...
 
virtual void setRelativePosition (const DtVector &pos)
 Sets the entity's relative position (if attached). More...
 
virtual void setRelativeOrientation (const DtTaitBryan &orient)
 Sets the entity's relative orientation (relative to the parent's body coordinates) if attached. More...
 
virtual bool isEmbarked () const
 Determine if the entity is attached to a parent entity. More...
 
virtual int embarkedParentId () const
 Get the CIGI ID of the entity to which we are attached. More...
 
virtual const DtVectorrelativePosition () const
 Returns the last relative offset position. More...
 
virtual const DtTaitBryan & relativeOrientation () const
 Returns the last relative orientation. More...
 
virtual void addCollisionSegmentID (unsigned int segmentId)
 Methods for adding a removing collision segment IDs that are associated with this entity. More...
 
virtual void removeCollisionSegmentID (unsigned int segmentId)
 
virtual void delayedStartEmbarked ()
 When an embarked entity is restarted, it needs to be reattached to its parent at the start of the next frame (after all other entities have been restarted). More...
 

Protected Attributes

DtAnimationModelAgent * myAnimationModel
 
bool myLooping
 
bool myReversed
 
osg::Sequence::SequenceMode mySequenceMode
 
- 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
 
DtCigiConnectionmyConnection
 
DtAgentManagerInterfacemySceneInterface
 
int myEntityId
 
int myEntityType
 
bool myExtendedEntityTypeOn
 
DtEntityType * myExtendedEntityType
 
DtCigiBaseEntitymyParent
 
int myEmbarkedParentID
 
bool myInheritAlpha
 
int myAlpha
 
bool myVisiblity
 
bool myPositionSet
 
bool myOrientationSet
 
std::map< int, DtTaitBryan > myLastArtPartOrientation
 
std::map< int, DtVectormyLastArtPartTranslation
 
std::map< int, DtVectormyArtPartAngularRate
 
std::map< int, DtVectormyArtPartLinearRate
 
std::list< unsigned intmyCollisionSegmentIdList
 List for Collision Detection Segment IDs from collision segment detection definition packets. More...
 
DtSignalConnectionManager mySignalConnections
 

Additional Inherited Members

- Public Types inherited from makVrv::DtCigiBaseEntity
enum  AnimationStateGroup { Stop = 0, Pause = 1, Play = 2, Continue = 3 }
 AnimationStateGroup in Cigi Order. More...
 
- Public Attributes inherited from makVrv::DtCigiBaseEntity
boost::signalslib::signal
< void(int, DtUniqueID)> 
signal_alphaChanged
 Emitted when this entity's alpha has changed. More...
 
- Protected Member Functions inherited from makVrv::DtCigiBaseEntity
virtual void startDeadReckoning ()
 Create and set up Dead Reckoning updater. More...
 
virtual void endDeadReckoning ()
 Remove the Dead Reckoning updater. More...
 
virtual void startEmbarked ()
 Create and set up Embarkation updater. More...
 
virtual void endEmbarked ()
 Remove the Embarkation updater. More...
 
virtual void startGroundClamping ()
 Create and set up Ground Clamping updater; uses buildGroundClampingUpdater() to create the updater agents. More...
 
virtual void buildGroundClampingUpdater ()
 Create and intialize the ground clamping updater agents. More...
 
virtual void endGroundClamping ()
 Remove the Ground Clamping updater. More...
 
virtual bool isGroundClamping () const
 Returns false if ground clamping type is DtGroundClampingUpdater::ClampNone true otherwise. More...
 
virtual void getExtrapolatedValuesAndRestart ()
 Request position and orientation values from the render thread if this entity is dead reckoned. More...
 
virtual void queryExtrapolatedPositionAndOrientation (DtUniqueID drAgentId, bool relative)
 This is the render thread-run method that collects dead reckoned position and orientation. More...
 
virtual void returnExtrapolatedPositionAndOrientation (const DtVector &resultPos, const DtTaitBryan &resultOri, bool relative, bool invokeRestart)
 This method returns the position and orientation collected from the render thread in the connection thread. More...
 
virtual DtDeadReckonUpdaterfindDRUpdaterInRenderThread (DtUniqueID drAgentId) const
 Helper function called by queryExtrapolatedPositionAndOrientation to look up the the dead reckon updater object given its agent id. More...
 

Detailed Description

A DtCigiAnimationEntity is a CIGI entity that loads an animation model.

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::DtCigiAnimationEntity::~DtCigiAnimationEntity ( )
virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtCigiAnimationEntity::init ( )
virtual

Calls down to DtCigiBaseEntity::init(), creates an animation system model, provides a model definition, and adds the model to the scene object.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiAnimationEntity::uninit ( )
virtual

Calls down DtCigiBaseEntity::uninit() and then deletes the animation model.

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiAnimationEntity::restart ( )
virtual

Calls down to DtCigiBaseEntity::restart(), and then restores the animation's state (started, paused, etc.)

Reimplemented from makVrv::DtCigiBaseEntity.

virtual void makVrv::DtCigiAnimationEntity::stop ( )
virtual

Stop the animation.

virtual void makVrv::DtCigiAnimationEntity::start ( )
virtual

Start the animation.

virtual void makVrv::DtCigiAnimationEntity::pause ( )
virtual

Pause the animation.

virtual void makVrv::DtCigiAnimationEntity::resume ( )
virtual

Resume the animation.

virtual void makVrv::DtCigiAnimationEntity::setLoopMode ( bool  loopOn)
virtual

Set the loop mode of the animation.

virtual void makVrv::DtCigiAnimationEntity::setReverseAnimation ( bool  reverse)
virtual

Set the direction of the animation.

virtual int makVrv::DtCigiAnimationEntity::animationState ( )
virtual

Get the current animation state in Cigi Mappings not osg.

Member Data Documentation

DtAnimationModelAgent* makVrv::DtCigiAnimationEntity::myAnimationModel
protected
bool makVrv::DtCigiAnimationEntity::myLooping
protected
bool makVrv::DtCigiAnimationEntity::myReversed
protected
osg::Sequence::SequenceMode makVrv::DtCigiAnimationEntity::mySequenceMode
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)