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

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

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

Public Member Functions

 DtDummyCharacterModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
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. More...
 
virtual void removeFromScene ()
 Virtual Functions to be implemented, remove this model from the scene. More...
 
virtual void setCharacterModel (const std::string &appearanceName)
 Override the character model in the model definition. More...
 
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. More...
 
virtual void forceAction (const std::string &action, float speed, bool usePositioning, const DtVector &offset, int autoChooseTransitionBehavior)
 Force an action. More...
 
virtual void forceTemporaryAction (const std::string &action, double duration)
 Force an action for a specific amount of time. More...
 
virtual void unforceAction ()
 Restore the ability to use posture/weapon state, which is disabled when an explicit action is set. More...
 
virtual void setSpeed (float speed)
 Set the speed of the character. More...
 
virtual void setPosture (int posture)
 Set the posture of the model. More...
 
virtual bool weaponDeployed () const
 Get whether the weapon is deployed. More...
 
virtual void setWeaponDeployed (bool deployed)
 Set whether the weapon is deployed. More...
 
virtual void die (const std::string &deathAction)
 Tell the character to 'die. More...
 
virtual void revive (const std::string &aliveAction)
 Revive a previously dead character. More...
 
virtual void setPaused (bool paused)
 Set that the character is paused. More...
 
virtual const std::string & className () const
 Get the class name of the model instance owner. More...
 
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) More...
 
virtual void setModelScalingEnabled (bool b)
 Indicate whether or not this model may be model-scaled Default is false. More...
 
virtual void setEmbarked (bool b)
 
virtual void setScale (const DtVector &scale)
 
virtual void setWeight (float weightScale)
 
virtual void setPositionOffset (const DtVector &posOffset)
 Set a position offset to a character (ex. driver) More...
 
virtual void setOrientationOffset (const DtTaitBryan &oriOffset)
 Set an orientation offset to a character (ex. More...
 
virtual void setUseTransitions (bool use)
 Set whether animations have transitions and ramp downs (ex. More...
 
virtual void setIsOccupant (bool occupant)
 Set whether this DI-Guy is an driver / pilot / ocupant of a vehicle. More...
 
virtual void setMotionModelByName (const std::string &modelName)
 Set the motion model for a character so that different update functions are called per frame This is used by occupants to change from their default motion model. More...
 
virtual void setVisible (bool visible)
 Hide the DI-Guy. More...
 
virtual void setEnabled (bool enabled)
 Disable processing/updating of the DI-Guy. More...
 
virtual void setPartOrientation (int, const DtTaitBryan &, const DtVector &)
 Rotate the part. More...
 
virtual void setPartTranslation (int partNumber, const DtVector &translation, const DtVector &velocity)
 translate the part. More...
 
virtual void setPartVisibility (int partNumber, bool visible)
 control part visiblity not connected yet More...
 
virtual void setEnableAnimationSmoothing (bool)
 Sets whether or not DI-Guy guides are suppressed. No-op at this level. More...
 
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. More...
 
- Public Member Functions inherited from makVrv::DtCharacterModel
 DtCharacterModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtCharacterModel ()
 
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtModel ()
 DTOR. More...
 
DtModelInstancecreateModelInstance (const std::string &modelDefName, bool realize=true)
 Set the model definition and creates an instance of the model. More...
 
virtual void setModelDefinition (const std::string &str)
 Set the model definition. More...
 
virtual const std::string & modelDefinitionName ()
 returns the model definition name. More...
 
virtual void saveModelToFile (const std::string &filename)
 
unsigned int transformSize () const
 Get the number of position/orientations this model has. More...
 
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model. More...
 
virtual const DtVectorposition (int vtx=0) const
 Get the Position of a given point. More...
 
virtual void removePosition (int vtx)
 Remove a transform at the given position. More...
 
virtual const DtVectorpositionOffset () const
 Get the Position Offset of the model. More...
 
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model. More...
 
virtual void setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
 Set the position and orientation of a vertex in the model at the same time. More...
 
virtual const DtTaitBryan & orientation (int vtx=0) const
 Get the Orientation of a given point. More...
 
virtual const DtTaitBryan & orientationOffset () const
 Get the Orientation Offset of the model. More...
 
virtual void enableColorBlending (bool b)
 Enable / disable color blending for this model. More...
 
virtual void setBlendColor (float r, float g, float b, float a)
 Set color to use if color blending is enabled. More...
 
virtual void getBlendColor (float &r, float &g, float &b, float &a)
 Returns the blend color. More...
 
virtual bool colorBlendingEnabled () const
 Returns whether or not blending is enabled. More...
 
virtual void setColor (float r, float g, float b, float a)
 set the model's color More...
 
virtual void enableLighting (bool l)
 set whether the model is lit; this may not be an option on all models More...
 
virtual int modelSet () const
 Get the model set this model is part of. More...
 
const DtVectorboundingBoxExtents () const
 Get the bounding box extents of the model instance. More...
 
void getBoundingBoxExtents (double &x, double &y, double &z) const
 Get the bounding box extents of the model instance. More...
 
const DtVectorboundingBoxCenter () const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 Get the minimum and maximum X,Y,Z components of the bounding box. More...
 
void setContributesToBound (bool trueOrFalse)
 Set whether this model instance contributes to an object's overall bounding volume. More...
 
bool contributesToBound () const
 Get whether this model instance contributes to an object's overall bounding volume. More...
 
DtDede ()
 Get the DtDe object. More...
 
virtual void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer. More...
 
virtual void promoteBackgroundModelInstance (DtModelDefinition &defintion)
 Internally set the model instance pointer to the background one, also realizes and sends signal. More...
 
virtual bool visible () const
 Get the visible state of the model. More...
 
DtUniqueID parentSceneObjectID () const
 Parent of the model. More...
 
virtual void addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
 Called when a scene object added the model as a prop. More...
 
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. More...
 
virtual void setElementId (DtUniqueID id)
 Called when the element ID of the model's parent object is set. More...
 
virtual void removedFromSceneObject ()
 Called when the model was removed from a scene object. More...
 
virtual void setSolid (bool isSolid)
 Set whether or not other this model is drawn filled in. More...
 
virtual bool isProp ()
 Return whether or not this model was added as a prop. More...
 
virtual void updateMinLastFrameDistance (float distance)
 updates the closest distance to an observer over the last frame More...
 
virtual void resetLastFrameDistance ()
 resets the closest distance to an observer More...
 
virtual float minLastFrameDistance () const
 gets the closest distance to an observer last frame More...
 
virtual DtModelInstancemodelInstance ()
 Get the model instance. More...
 
virtual const DtModelInstancemodelInstance () 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. More...
 
virtual bool supportsMultithreadedLoad ()
 can be quickly overridden to disable background loading More...
 
virtual void backgroundLoad ()
 the chunk of loading that can safely happen in the background More...
 
virtual void foregroundLoad ()
 the chunk of loading that must happen happen in the foreground, adding to scene graph etc. More...
 
virtual bool isActivelyBackgroundLoading ()
 is this being actively loaded (it has a myInLoadQueueHandle object and it's loading) More...
 
virtual DtLoaderHandlegetLoadQueueHandle ()
 returns the load queue object More...
 

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. More...
 

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. More...
 
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. More...
 
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceCreated
 Signal emitted when the model instance is created. More...
 
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceToBeDestroyed
 Signal emitted when the model instance is to be destroyed. More...
 
- 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. More...
 
virtual void initializeModelInstance ()
 Push any state maintained by the model to the model instance. More...
 
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed. More...
 
virtual void waitAndClearLoadHandle ()
 avoids race condition, on destruction subclasses need to wait for the model to cleanly finish loading this can happen if an object times in and out very quickly More...
 
virtual void removedFromLoadQueue ()
 deletes the myInLoadQueueHandle handle More...
 
virtual void setDoneBackgroundLoading ()
 called by async task, updates myCurrentlyLoading atomic More...
 
virtual void setActivelyBackgroundLoading ()
 called right before tbb task creation More...
 
- Protected Attributes inherited from makVrv::DtModel
DtLoaderHandlemyInLoadQueueHandle
 
DtDemyDe
 
const DtUniqueID myUniqueId
 The unique id is constant after initialization. More...
 
bool myColorBlendingEnabled
 The color blending enabled is needed to be set by the derived class so it doesn't get down to the model instances when instancing is enabled. More...
 
DtModelInstancemyBackgroundModelInstance
 holds the model created in the background for a bit More...
 
float myMinLastFrameDistance
 last frames mimimal distance to the camera, calculated by the instancing system More...
 
TransformList myTransforms
 We keep our own copy in case we get updates before we get a model instance. More...
 
DtModelInstancemyModelInstance
 
int myModelSet
 
int myVisualizerType
 
bool myContributesToBound
 
DtUniqueID myParentSceneObjectID
 
bool myIsPropFlag
 
float myBlendColor [4]
 
bool myVisibleFlag
 
DtVector myPositionOffset
 
DtTaitBryan myOrientationOffset
 
std::string myModelDefinitionName
 
- Static Protected Attributes inherited from makVrv::DtModel
static bool theInittedState
 

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
virtual void makVrv::DtDummyCharacterModel::setAppearance ( const std::string &  appearanceName)
virtual
virtual void makVrv::DtDummyCharacterModel::setHeadAppearance ( const std::string &  appearanceName)
virtual
virtual void makVrv::DtDummyCharacterModel::setItemAppearance ( const std::string &  appearanceName)
virtual
virtual void makVrv::DtDummyCharacterModel::beginAppearanceEffect ( const std::string &  effect,
const std::string &  overrideLink,
float  overrideScale,
const DtVector overrideOffset,
float  overrideDuration 
)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::endAppearanceEffect ( int  instantly,
const std::string &  effect,
const std::string &  overrideLink 
)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::executeGesture ( const std::string &  gestureName,
int  reps,
float  overallDuration,
float  channelAWeight 
)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::endGesture ( const std::string &  gestureName,
float  rampDown 
)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::setFlamesPresent ( bool  val)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::setEnginePlume ( bool  val)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::setEngineSmoke ( bool  val)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::setTrailState ( bool  val)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::setLightState ( unsigned int  light,
unsigned int  lightState 
)
inlinevirtual
virtual void makVrv::DtDummyCharacterModel::fireWeapon ( )
inlinevirtual
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,
bool  usePositioning,
const DtVector offset,
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 const 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
virtual void makVrv::DtDummyCharacterModel::setScale ( const DtVector scale)
virtual
virtual void makVrv::DtDummyCharacterModel::setWeight ( float  weightScale)
virtual
virtual void makVrv::DtDummyCharacterModel::setPositionOffset ( const DtVector posOffset)
virtual

Set a position offset to a character (ex. driver)

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtDummyCharacterModel::setOrientationOffset ( const DtTaitBryan &  oriOffset)
virtual

Set an orientation offset to a character (ex.

swivel person about their local origin before any position offsets)

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtDummyCharacterModel::setUseTransitions ( bool  use)
virtual

Set whether animations have transitions and ramp downs (ex.

don't want occupants transitioning from standing to sitting initially, just want to jump to sitting animation to start)

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setIsOccupant ( bool  occupant)
virtual

Set whether this DI-Guy is an driver / pilot / ocupant of a vehicle.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setMotionModelByName ( const std::string &  modelName)
virtual

Set the motion model for a character so that different update functions are called per frame This is used by occupants to change from their default motion model.

Implements makVrv::DtCharacterModel.

virtual void makVrv::DtDummyCharacterModel::setVisible ( bool  visible)
virtual

Hide the DI-Guy.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtDummyCharacterModel::setEnabled ( bool  enabled)
virtual

Disable processing/updating of the DI-Guy.

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
virtual void makVrv::DtDummyCharacterModel::setTextureVariations ( std::vector< DtCharacterTextureVariationInfo > &  varationInfoArray,
int  force 
)
inlinevirtual
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:

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)