makVrv::DtDummyCharacterModel Class Reference

Dummy implementation of DtCharacterModel; generates an error message when created. More...

Inheritance diagram for makVrv::DtDummyCharacterModel:

Public Member Functions
	DtDummyCharacterModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtDummyCharacterModel ()
Distributed functions.
virtual void	addToScene (const makVrv::DtUniqueID &, 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	setCharacterModel (const std::string &appearanceName)
	Override the character model in the model definition.
virtual void	setDefaultAppearance (const std::string &appearanceName)
virtual void	setAppearance (const std::string &appearanceName)
virtual void	setHeadAppearance (const std::string &appearanceName)
virtual void	setItemAppearance (const std::string &appearanceName)
virtual void	beginAppearanceEffect (const std::string &effect, const std::string &overrideLink, float overrideScale, const DtVector &overrideOffset, float overrideDuration)
virtual void	endAppearanceEffect (int instantly, const std::string &effect, const std::string &overrideLink)
virtual void	executeGesture (const std::string &gestureName, int reps, float overallDuration, float channelAWeight)
virtual void	endGesture (const std::string &gestureName, float rampDown)
virtual void	setFlamesPresent (bool val)
virtual void	setEnginePlume (bool val)
virtual void	setEngineSmoke (bool val)
virtual void	setTrailState (bool val)
virtual void	setLightState (unsigned int light, unsigned int lightState)
virtual void	fireWeapon ()
virtual void	setDesiredAction (const std::string &action, float speed)
	Set the action to attempt.
virtual void	forceAction (const std::string &action, float speed, int autoChooseTransitionBehavior)
	Force an action.
virtual void	forceTemporaryAction (const std::string &action, double duration)
	Force an action for a specific amount of time.
virtual void	unforceAction ()
	Restore the ability to use posture/weapon state, which is disabled when an explicit action is set.
virtual void	setSpeed (float speed)
	Set the speed of the character.
virtual void	setPosture (int posture)
	Set the posture of the model.
virtual bool	weaponDeployed () const
	Get whether the weapon is deployed.
virtual void	setWeaponDeployed (bool deployed)
	Set whether the weapon is deployed.
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 that the character is paused.
virtual std::string	className () const
	Get the class name of the model instance owner.
virtual void	setIsSupportModel (bool isSupport)
	Set whether the model is part of the support group (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.
virtual void	setEmbarked (bool b)
virtual void	setScale (const DtVector &scale)
virtual void	setWeight (float weightScale)
virtual void	setPartOrientation (int, const DtTaitBryan &, const DtVector &)
	Rotate the part.
virtual void	setPartTranslation (int partNumber, const DtVector &translation, const DtVector &velocity)
	translate the part.
virtual void	setPartVisibility (int partNumber, bool visible)
	control part visiblity not connected yet
virtual void	setEnableAnimationSmoothing (bool)
	Sets whether or not DI-Guy guides are suppressed. No-op at this level.
virtual void	setSelected (bool)
virtual void	setTextureVariations (std::vector< DtCharacterTextureVariationInfo > &varationInfoArray, int force)
virtual void	setDynamicSensorRegion (const std::string &, bool)
	Set the state of a dynamic sensor region.
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	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	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
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.

Static Public Attributes
static bool	instanceCreated
	Static variable set to true when first instance is created, used to prevent more than one error popup from being generated.

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
Protected Member Functions inherited from makVrv::DtModel
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop.
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

Dummy implementation of DtCharacterModel; generates an error message when created.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtDummyCharacterModel::~DtDummyCharacterModel ( )

virtual

Member Function Documentation

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

virtual

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

Implements makVrv::DtModel.

virtual void makVrv::DtDummyCharacterModel::removeFromScene ( )

virtual

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

Implements makVrv::DtModel.

virtual void makVrv::DtDummyCharacterModel::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::DtDummyCharacterModel::setDefaultAppearance ( const std::string &  appearanceName )

virtual

Implements makVrv::DtCharacterModel.

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

virtual

Implements makVrv::DtCharacterModel.

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

virtual

Implements makVrv::DtCharacterModel.

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

virtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

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

inlinevirtual

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::fireWeapon ( )

inlinevirtual

Implements makVrv::DtCharacterModel.

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

virtual

Set the action to attempt.

Implements makVrv::DtCharacterModel.

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

virtual

Force an action.

Implements makVrv::DtCharacterModel.

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

virtual

Force an action for a specific amount of time.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::unforceAction ( )

virtual

Restore the ability to use posture/weapon state, which is disabled when an explicit action is set.

Implements makVrv::DtCharacterModel.

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

virtual

Set the speed of the character.

Implements makVrv::DtCharacterModel.

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

virtual

Set the posture of the model.

Implements makVrv::DtCharacterModel.

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

virtual

Get whether the weapon is deployed.

Implements makVrv::DtCharacterModel.

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

virtual

Set whether the weapon is deployed.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::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::DtDummyCharacterModel::revive ( const std::string &  aliveAction )

virtual

Revive a previously dead character.

Implements makVrv::DtCharacterModel.

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

virtual

Set that the character is paused.

Implements makVrv::DtCharacterModel.

virtual std::string makVrv::DtDummyCharacterModel::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::DtDummyCharacterModel::setIsSupportModel ( bool  isSupport )

virtual

Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)

Implements makVrv::DtModel.

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

virtual

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

Implements makVrv::DtCharacterModel.

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

virtual

Implements makVrv::DtCharacterModel.

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

virtual

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setWeight ( float  weightScale )

virtual

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setPartOrientation ( int  , const DtTaitBryan &  , const DtVector &    )

inlinevirtual

Rotate the part.

Implements makVrv::DtCharacterModel.

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

inlinevirtual

translate the part.

Implements makVrv::DtCharacterModel.

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

inlinevirtual

control part visiblity not connected yet

Implements makVrv::DtCharacterModel.

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

virtual

Sets whether or not DI-Guy guides are suppressed. No-op at this level.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setSelected ( bool  )

inlinevirtual

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setTextureVariations ( std::vector< DtCharacterTextureVariationInfo > &  varationInfoArray, int  force  )

inlinevirtual

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setDynamicSensorRegion ( const std::string &  region, bool  state  )

inlinevirtual

Set the state of a dynamic sensor region.

Implements makVrv::DtCharacterModel.

Member Data Documentation

bool makVrv::DtDummyCharacterModel::instanceCreated

static

Static variable set to true when first instance is created, used to prevent more than one error popup from being generated.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvOsg/DtDummyCharacterModel.h