makVrv::DtDiGuyCharacterModel Class Reference

Di Guy based Character model. More...

Inheritance diagram for makVrv::DtDiGuyCharacterModel:

Public Member Functions
	DtDiGuyCharacterModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtDiGuyCharacterModel ()
	DTOR.
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
	Virtual Functions to be implemented, add this model to the scene.
virtual void	removeFromScene ()
	Virtual Functions to be implemented, remove this model from the scene.
virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of a control vertex in the model.
virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of a vertex in the model.
virtual std::string	className () const
	Get the class name of the model instance owner.
virtual void	setCharacterModel (const std::string &appearanceName)
	Override the character model in the model definition.
virtual void	setDefaultAppearance (const std::string &appearanceName)
	Override the character model in the model definition.
virtual void	setAppearance (const std::string &appearanceName)
	Override the character model in the model definition.
virtual void	setHeadAppearance (const std::string &appearanceName)
	Override the character model in the model definition.
virtual void	setDesiredAction (const std::string &action, float speed)
	Set the action to attempt.
virtual void	forceAction (const std::string &action, float speed)
	Force an action.
virtual void	forceTemporaryAction (const std::string &action, double duration)
	Force an action for a specific amount of time.
virtual void	setSpeed (float speed)
	Set the speed of the character.
virtual bool	weaponDeployed () const
	Get whether the weapon is deployed.
virtual void	setWeaponDeployed (bool deployed)
	Set whether the weapon is deployed.
void	setFullUpdateNeeded (bool updated)
	Set if the model has been fully updated, set to true if the diguy character or scenario has been updated.
bool	fullUpdateNeeded () const
	Check to see if the model needs a full update.
virtual void	die (const std::string &deathAction)
	Tell the character to 'die.
virtual void	revive (const std::string &aliveAction)
	Revive a previously dead character.
virtual void	setPaused (bool paused)
	Set the paused state.
bool	paused () const
	Get if the model is paused.
diguyCharacter *	character ()
	Get the character.
virtual void	setPosture (int posture)
	Set the posture of the model.
bool	autoGenerateActions () const
	Get if the character will need to auto generate actions.
void	setObjectToMove (DtSceneObject *sceneObject)
	Sets the attachable scene object to move.
virtual void	setSolid (bool isSolid)
	Set whether or not other scene objects can ground clamp to this model.
virtual void	setModelScalingEnabled (bool b)
	Indicate whether or not this model may be model-scaled Default is false.
Public Member Functions inherited from makVrv::DtCharacterModel
	DtCharacterModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtCharacterModel ()
Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtModel ()
	DTOR.
virtual void	setModelDefinition (const std::string &str)
	Set the model definition.
virtual void	saveModelToFile (const std::string &filename)
unsigned int	transformSize () const
	Get the number of position/orientations this model has.
virtual void	removePosition (int vtx)
	Remove a transform at the given position.
const DtVector &	position (int vtx=0) const
	Get the Position of a given point.
const DtTaitBryan &	orientation (int vtx=0) const
	Get the Orientation of a given point.
virtual void	enableColorBlending (bool b)
	Enable / disable color blending for this model.
virtual void	setBlendColor (float r, float g, float b, float a)
	Set color to use if color blending is enabled.
virtual void	getBlendColor (float &r, float &g, float &b, float &a)
	Returns the blend color.
virtual bool	colorBlendingEnabled () const
	Returns whether or not blending is enabled.
virtual void	setColor (float r, float g, float b, float a)
	set the model's color
virtual int	modelSet () const
	Get the model set this model is part of.
const DtVector &	boundingBoxExtents () const
	Get the bounding box extents of the model instance.
void	getBoundingBoxExtents (double &x, double &y, double &z) const
	Get the bounding box extents of the model instance.
const DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance.
void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume.
bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume.
DtDe &	de ()
	Get the DtDe object.
virtual void	setModelInstance (DtModelInstance *modelInstance)
	Internally set the model instance pointer.
virtual void	setVisible (bool isVisible)
	Set the visible state of the model.
virtual bool	visible () const
	Get the visible state of the model.
DtUniqueID	parentSceneObjectID () const
	Parent of the model.
virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
	Called when a scene object added the model as a prop.
virtual void	addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)
	Called when a scene object added the model with the given model set and visualizer type.
virtual void	removedFromSceneObject ()
	Called when the model was removed from a scene object.
virtual DtModelInstance *	modelInstance ()
	Get the model instance.
virtual const DtModelInstance *	modelInstance () const
	Get the model instance.
int	visualizerType () const
	The visualizer type determines which channel-specific group node this model will be parented to, and consequently, which observer setting will cause it to be rendered in which channel.

Protected Member Functions
void	slot_modelInstanceToBeDestroyed (DtModelInstance *, DtModel *)
	Signal emitted when the model instance is going to be destroyed.
void	slot_modelInstanceCreated (DtModelInstance *, DtModel *)
	Signal emitted when the model instance is created.

Protected Attributes
diguyCharacter *	myCharacter
DtOsgSceneConnector *	mySceneConnector
DtSceneObject *	myObjectToMove
bool	myGenerateAutomaticActionFlag
bool	myWeaponDeployedFlag
bool	myFullUpdateFlag

Additional Inherited Members
Public Types inherited from makVrv::DtCharacterModel
enum	Posture { Upright, Crouched, Prone, Sitting }
Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)>	signal_modelToBeDestroyed
	Signal emitted when the model is to be destroyed.
boost::signal< void(DtModel *)>	signal_modelChanged
boost::signal< bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested
	Signal when the visibility has been requested, if any slot returns false, it will not change.
boost::signal< void(DtModelInstance *, DtModel *)>	signal_modelInstanceCreated
	Signal emitted when the model instance is created.
boost::signal< void(DtModelInstance *, DtModel *)>	signal_modelInstanceToBeDestroyed
	Signal emitted when the model instance is to be destroyed.
Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Detailed Description

Di Guy based Character model.

Constructor & Destructor Documentation

makVrv::DtDiGuyCharacterModel::DtDiGuyCharacterModel	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtDiGuyCharacterModel::~DtDiGuyCharacterModel ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtDiGuyCharacterModel::addToScene ( const DtUniqueID &  sceneObjectId, int  modelSet, int  visualizerType  )

virtual

Virtual Functions to be implemented, add this model to the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtDiGuyCharacterModel::removeFromScene ( )

virtual

Virtual Functions to be implemented, remove this model from the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtDiGuyCharacterModel::setPosition ( int  vtx, const DtVector &  position  )

virtual

Set the position of a control vertex in the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtDiGuyCharacterModel::setOrientation ( int  vtx, const DtTaitBryan &  orientation  )

virtual

Set the orientation of a vertex in the model.

Reimplemented from makVrv::DtModel.

virtual std::string makVrv::DtDiGuyCharacterModel::className ( ) const

virtual

Get the class name of the model instance owner.

This is used to control how model instances are created.

Reimplemented from makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setCharacterModel ( const std::string &  appearanceName )

virtual

Override the character model in the model definition.

This is necessary when explicitly setting the character via custom network messages.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setDefaultAppearance ( const std::string &  appearanceName )

virtual

Override the character model in the model definition.

This is necessary when explicitly setting the character via custom network messages.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setAppearance ( const std::string &  appearanceName )

virtual

Override the character model in the model definition.

This is necessary when explicitly setting the character via custom network messages.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setHeadAppearance ( const std::string &  appearanceName )

virtual

Override the character model in the model definition.

This is necessary when explicitly setting the character via custom network messages.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setDesiredAction ( const std::string &  action, float  speed  )

virtual

Set the action to attempt.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::forceAction ( const std::string &  action, float  speed  )

virtual

Force an action.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::forceTemporaryAction ( const std::string &  action, double  duration  )

virtual

Force an action for a specific amount of time.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setSpeed ( float  speed )

virtual

Set the speed of the character.

Implements makVrv::DtCharacterModel.

virtual bool makVrv::DtDiGuyCharacterModel::weaponDeployed ( ) const

virtual

Get whether the weapon is deployed.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setWeaponDeployed ( bool  deployed )

virtual

Set whether the weapon is deployed.

Implements makVrv::DtCharacterModel.

void makVrv::DtDiGuyCharacterModel::setFullUpdateNeeded

(

bool

updated

)

Set if the model has been fully updated, set to true if the diguy character or scenario has been updated.

bool makVrv::DtDiGuyCharacterModel::fullUpdateNeeded

(

)

const

Check to see if the model needs a full update.

virtual void makVrv::DtDiGuyCharacterModel::die ( const std::string &  deathAction )

virtual

Tell the character to 'die.

Dead characters perform their death action then disable most dynamic behavior (saving CPU cycles).

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::revive ( const std::string &  aliveAction )

virtual

Revive a previously dead character.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDiGuyCharacterModel::setPaused ( bool  paused )

virtual

Set the paused state.

Implements makVrv::DtCharacterModel.

bool makVrv::DtDiGuyCharacterModel::paused

(

)

const

Get if the model is paused.

diguyCharacter* makVrv::DtDiGuyCharacterModel::character

(

)

Get the character.

virtual void makVrv::DtDiGuyCharacterModel::setPosture ( int  posture )

virtual

Set the posture of the model.

Implements makVrv::DtCharacterModel.

bool makVrv::DtDiGuyCharacterModel::autoGenerateActions

(

)

const

Get if the character will need to auto generate actions.

Until explicitly set via setDesiredAction or forceAction this is true and the motion model will generate actions.

void makVrv::DtDiGuyCharacterModel::setObjectToMove

(

DtSceneObject *

sceneObject

)

Sets the attachable scene object to move.

virtual void makVrv::DtDiGuyCharacterModel::setSolid ( bool  isSolid )

virtual

Set whether or not other scene objects can ground clamp to this model.

Implements makVrv::DtModel.

virtual void makVrv::DtDiGuyCharacterModel::setModelScalingEnabled ( bool  b )

virtual

Indicate whether or not this model may be model-scaled Default is false.

Implements makVrv::DtCharacterModel.

void makVrv::DtDiGuyCharacterModel::slot_modelInstanceToBeDestroyed ( DtModelInstance *  , DtModel *    )

protected

Signal emitted when the model instance is going to be destroyed.

void makVrv::DtDiGuyCharacterModel::slot_modelInstanceCreated ( DtModelInstance *  , DtModel *    )

protected

Signal emitted when the model instance is created.

Member Data Documentation

diguyCharacter* makVrv::DtDiGuyCharacterModel::myCharacter

protected

DtOsgSceneConnector* makVrv::DtDiGuyCharacterModel::mySceneConnector

protected

DtSceneObject* makVrv::DtDiGuyCharacterModel::myObjectToMove

protected

bool makVrv::DtDiGuyCharacterModel::myGenerateAutomaticActionFlag

protected

bool makVrv::DtDiGuyCharacterModel::myWeaponDeployedFlag

protected

bool makVrv::DtDiGuyCharacterModel::myFullUpdateFlag

protected

---

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

• include/vrvDiGuy/DtDiGuyCharacterModel.h