A special human character model. More...

Inheritance diagram for makVrv::DtCharacterModel:

Public Types
enum	Posture { Upright, Crouched, Prone, Sitting }

Public Member Functions
	DtCharacterModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtCharacterModel ()
Distributed functions.
virtual void	setCharacterModel (const std::string &appearanceName)=0
	Override the character model in the model definition.
virtual void	setDefaultAppearance (const std::string &appearanceName)=0
	Override the character model in the model definition.
virtual void	setAppearance (const std::string &appearanceName)=0
	Override the character model in the model definition.
virtual void	setHeadAppearance (const std::string &appearanceName)=0
	Override the character model in the model definition.
virtual void	setItemAppearance (const std::string &appearanceName)=0
	Override the character model in the model definition.
virtual void	beginAppearanceEffect (const std::string &effect, const std::string &overrideLink, float overrideScale, const DtVector &overrideOffset, float overrideDuration)=0
	Override the character model in the model definition.
virtual void	endAppearanceEffect (int instantly, const std::string &effect, const std::string &overrideLink)=0
	Override the character model in the model definition.
virtual void	executeGesture (const std::string &gestureName, int reps, float overallDuration, float channelAWeight)=0
	Override the character model in the model definition.
virtual void	endGesture (const std::string &gestureName, float rampDown)=0
	Override the character model in the model definition.
virtual void	setEnableAnimationSmoothing (bool)=0
	Sets whether or not to use DI-Guy use_guides for positioning and orientation.
virtual void	setDesiredAction (const std::string &action, float speed)=0
	Set the action to attempt.
virtual void	forceAction (const std::string &action, float speed, int autoChooseTransitionBehavior)=0
	Force an action.
virtual void	forceTemporaryAction (const std::string &action, double duration)=0
	Force an action for a specific amount of time.
virtual void	setSpeed (float speed)=0
	Set the speed of the character.
virtual void	setPosture (int posture)=0
	Set the posture of the model.
virtual bool	weaponDeployed () const =0
	Get whether the weapon is deployed.
virtual void	setWeaponDeployed (bool deployed)=0
	Set whether the weapon is deployed.
virtual void	die (const std::string &deathAction)=0
	Tell the character to 'die.
virtual void	revive (const std::string &aliveAction)=0
	Revive a previously dead character.
virtual void	setPaused (bool paused)=0
	Set that the character is paused.
virtual std::string	className () const
	Get the class name of the model instance owner.
virtual void	setModelScalingEnabled (bool b)=0
	Indicate whether or not this model may be model-scaled Default is false.
virtual void	setEmbarked (bool b)=0
	Override the character model in the model definition.
virtual void	setScale (const DtVector &scale)=0
	Override the character model in the model definition.
virtual void	setPartOrientation (int partNumber, const DtTaitBryan &orientation, const DtVector &rotationalVelocity)=0
	Rotate the part.
virtual void	setPartTranslation (int partNumber, const DtVector &translation, const DtVector &velocity)=0
	translate the part.
virtual void	setPartVisibility (int partNumber, bool visible)=0
	control part visibility, not connected yet.
virtual void	setFlamesPresent (bool val)=0
	Override the character model in the model definition.
virtual void	setEnginePlume (bool val)=0
	Override the character model in the model definition.
virtual void	setEngineSmoke (bool val)=0
	Override the character model in the model definition.
virtual void	setTrailState (bool val)=0
	Override the character model in the model definition.
virtual void	setLightState (unsigned int light, unsigned int lightState)=0
	Override the character model in the model definition.
virtual void	fireWeapon ()=0
	Override the character model in the model definition.
virtual void	setSelected (bool value)=0
	Override the character model in the model definition.
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	setPosition (int vtx, const DtVector &position)
	Set the position of a control vertex in the model.
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	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of a vertex in the model.
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 void	enableLighting (bool l)
	set whether the model is lit; this may not be an option on all models
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.
virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the minimum and maximum X,Y,Z components of the bounding box.
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	setElementId (DtUniqueID id)
	Called when the element ID of the model's parent object is set.
virtual void	removedFromSceneObject ()
	Called when the model was removed from a scene object.
virtual void	setIsSupportModel (bool isSupport)=0
	Is this model part of the support group? (determines whether or not other scene objects can ground clamp to this model)
virtual void	setSolid (bool isSolid)
	Set whether or not other this model is drawn filled in.
virtual bool	isProp ()
	Return whether or not this model was added as a prop.
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.

Additional Inherited Members
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
Protected Member Functions inherited from makVrv::DtModel
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0
	Virtual Functions to be implemented, add this model to the scene.
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop.
virtual void	removeFromScene ()=0
	Virtual Functions to be implemented, remove this model from the scene.
virtual void	initializeModelInstance ()
	Push any state maintained by the model to the model instance.
void	slot_modelInstanceChanged (DtModelInstance *instance)
	Called when the model instance changed.
Protected Attributes inherited from makVrv::DtModel
DtDe &	myDe
const DtUniqueID	myUniqueId
bool	myColorBlendingEnabled

Detailed Description

A special human character model.

Member Enumeration Documentation

enum makVrv::DtCharacterModel::Posture

Enumerator:

Upright
Crouched
Prone
Sitting

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtCharacterModel::~DtCharacterModel ( )

virtual

Member Function Documentation

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

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setItemAppearance ( const std::string & appearanceName )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::beginAppearanceEffect	(	const std::string &	effect,
		const std::string &	overrideLink,
		float	overrideScale,
		const DtVector &	overrideOffset,
		float	overrideDuration
	)

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::endAppearanceEffect	(	int	instantly,
		const std::string &	effect,
		const std::string &	overrideLink
	)

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setEnableAnimationSmoothing ( bool )

pure virtual

Sets whether or not to use DI-Guy use_guides for positioning and orientation.

Note this will only have an effect if use_guides is set to 1. The default, if use_guides is 1, to use position smoothing

Implemented in makVrv::DtDummyCharacterModel, and makVrv::DtDiGuyCharacterModel.

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

pure virtual

Set the action to attempt.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::forceAction	(	const std::string &	action,
		float	speed,
		int	autoChooseTransitionBehavior
	)

pure virtual

Force an action.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Force an action for a specific amount of time.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Set the speed of the character.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Set the posture of the model.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Get whether the weapon is deployed.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Set whether the weapon is deployed.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Tell the character to 'die.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Revive a previously dead character.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

pure virtual

Set that the character is paused.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual std::string makVrv::DtCharacterModel::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::DtModel.

Reimplemented in makVrv::DtDummyCharacterModel, and makVrv::DtDiGuyCharacterModel.

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

pure virtual

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setEmbarked ( bool b )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setScale ( const DtVector & scale )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setPartOrientation	(	int	partNumber,
		const DtTaitBryan &	orientation,
		const DtVector &	rotationalVelocity
	)

pure virtual

Rotate the part.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setPartTranslation	(	int	partNumber,
		const DtVector &	translation,
		const DtVector &	velocity
	)

pure virtual

translate the part.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setPartVisibility	(	int	partNumber,
		bool	visible
	)

pure virtual

control part visibility, not connected yet.

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setFlamesPresent ( bool val )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setEnginePlume ( bool val )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setEngineSmoke ( bool val )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setTrailState ( bool val )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setLightState	(	unsigned int	light,
		unsigned int	lightState
	)

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::fireWeapon ( )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

virtual void makVrv::DtCharacterModel::setSelected ( bool value )

pure virtual

Override the character model in the model definition.

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

Implemented in makVrv::DtDiGuyCharacterModel, and makVrv::DtDummyCharacterModel.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtCharacterModel.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation