![]() |
VR-Forces 4.10 Class Documentation
|
Dummy implementation of DtCharacterModel; generates an error message when created. More...

Public Member Functions | |
| DtDummyCharacterModel (DtDe &de, DtUniqueID id) | |
| CTOR. More... | |
| virtual | ~DtDummyCharacterModel () |
| virtual void | setFlamesPresent (bool val) |
| turn on/off flames More... | |
| virtual void | setEnginePlume (bool val) |
| turn on/off engine smoke plume More... | |
| virtual void | setEngineSmoke (bool val) |
| turn on/off engine smoke More... | |
| virtual void | setTrailState (bool val) |
| turn on/off missle trail More... | |
| virtual void | setLightState (unsigned int light, unsigned int lightState) |
| turn on/off various lights More... | |
| virtual void | fireWeapon () |
| play fire weapon gesture and trigger effects. More... | |
| virtual void | beginAppearanceEffect (const std::string &effect, const std::string &overrideLink, float overrideScale, const DtVector &overrideOffset, float overrideDuration) |
| starts a diguy particles effect More... | |
| virtual void | endAppearanceEffect (int instantly, const std::string &effect, const std::string &overrideLink) |
| ends a diguy particle effect More... | |
| virtual void | executeGesture (const std::string &gestureName, int reps, float overallDuration, float channelAWeight) |
| starts a diguy gesture, a animation that plays a limited amount More... | |
| virtual void | endGesture (const std::string &gestureName, float rampDown) |
| interrups the gesture incase it's still playing More... | |
| 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, float transitionSpeed) |
| 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) |
| Set/Get embarked state. More... | |
| 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 visibility 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... | |
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 &characterType) |
| Override the character model in the model definition. More... | |
DI-Guy Appearance Setters | |
set the base body appearance | |
| virtual void | setDefaultAppearance (const std::string &appearanceName) |
| virtual void | setAppearance (const std::string &appearanceName) |
| set the base body appearance More... | |
| virtual void | setHeadAppearance (const std::string &appearanceName) |
| sets the current character head More... | |
| virtual void | setItemAppearance (const std::string &appearanceName) |
| sets the character current hand item More... | |
| virtual void | setCharacterEquipment (const std::string &appearanceName) |
| sets additional equipment the character has | separated list, empty string to reset More... | |
| virtual void | setCharacterName (const std::string &name) |
| sets the text on a character's uniform More... | |
| virtual void | setUnit (unsigned int unit, unsigned int personalUnit) |
| sets the arm unit patches More... | |
| virtual void | setRank (unsigned int rank) |
| sets the rank patches 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... | |
| DtModelInstance * | createModelInstance (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 DtVector & | position (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 DtVector & | positionOffset () 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 DtVector & | boundingBoxExtents () 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 DtVector & | boundingBoxCenter () 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... | |
| DtDe & | de () |
| 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 DtModelInstance * | modelInstance () |
| Get the model instance. More... | |
| 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. 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 DtLoaderHandle * | getLoadQueueHandle () |
| 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... | |
Private Member Functions | |
| DtDummyCharacterModel (const DtDummyCharacterModel &)=delete | |
| not allowed More... | |
| DtDummyCharacterModel & | operator= (const DtDummyCharacterModel &)=delete |
| not allowed More... | |
Additional Inherited Members | |
Public Types inherited from makVrv::DtCharacterModel | |
| enum | Posture { Upright, Crouched, Prone, Sitting } |
Public Attributes inherited from makVrv::DtModel | |
| boost::signalslib::signal < void(DtModel *)> | signal_modelToBeDestroyed |
| Signal emitted when the model is to be destroyed. More... | |
| boost::signalslib::signal < void(DtModel *)> | signal_modelChanged |
| boost::signalslib::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::signalslib::signal < void(DtModelInstance *, DtModel *)> | signal_modelInstanceCreated |
| Signal emitted when the model instance is created. More... | |
| boost::signalslib::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 | |
| DtLoaderHandle * | myInLoadQueueHandle |
| DtDe & | myDe |
| 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... | |
| DtModelInstance * | myBackgroundModelInstance |
| 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... | |
| DtModelInstance * | myModelInstance |
| 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 |
Dummy implementation of DtCharacterModel; generates an error message when created.
| makVrv::DtDummyCharacterModel::DtDummyCharacterModel | ( | DtDe & | de, |
| DtUniqueID | id | ||
| ) |
CTOR.
|
virtual |
|
privatedelete |
not allowed
|
virtual |
Virtual Functions to be implemented, add this model to the scene.
Implements makVrv::DtModel.
|
virtual |
Virtual Functions to be implemented, remove this model from the scene.
Implements makVrv::DtModel.
|
virtual |
Override the character model in the model definition.
This is necessary when explicitly setting the character via custom network messages.
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
set the base body appearance
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
sets the current character head
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
sets the character current hand item
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
sets additional equipment the character has | separated list, empty string to reset
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
sets the text on a character's uniform
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
sets the arm unit patches
Implements makVrv::DtCharacterModel.
sets the rank patches
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
turn on/off flames
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
turn on/off engine smoke plume
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
turn on/off engine smoke
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
turn on/off missle trail
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
turn on/off various lights
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
play fire weapon gesture and trigger effects.
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
starts a diguy particles effect
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
ends a diguy particle effect
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
starts a diguy gesture, a animation that plays a limited amount
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
interrups the gesture incase it's still playing
Implements makVrv::DtCharacterModel.
|
virtual |
Set the action to attempt.
Implements makVrv::DtCharacterModel.
|
virtual |
Force an action.
Implements makVrv::DtCharacterModel.
|
virtual |
Force an action for a specific amount of time.
Implements makVrv::DtCharacterModel.
|
virtual |
Restore the ability to use posture/weapon state, which is disabled when an explicit action is set.
Implements makVrv::DtCharacterModel.
|
virtual |
Set the speed of the character.
Implements makVrv::DtCharacterModel.
|
virtual |
Set the posture of the model.
Implements makVrv::DtCharacterModel.
|
virtual |
Get whether the weapon is deployed.
Implements makVrv::DtCharacterModel.
|
virtual |
Set whether the weapon is deployed.
Implements makVrv::DtCharacterModel.
|
virtual |
Tell the character to 'die.
Dead characters perform their death action then disable most dynamic behavior (saving CPU cycles).
Implements makVrv::DtCharacterModel.
|
virtual |
Revive a previously dead character.
Implements makVrv::DtCharacterModel.
|
virtual |
Set that the character is paused.
Implements makVrv::DtCharacterModel.
|
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 |
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 |
Indicate whether or not this model may be model-scaled Default is false.
Implements makVrv::DtCharacterModel.
|
virtual |
Set/Get embarked state.
Implements makVrv::DtCharacterModel.
|
virtual |
Implements makVrv::DtCharacterModel.
|
virtual |
Implements makVrv::DtCharacterModel.
|
virtual |
Set a position offset to a character (ex. driver)
Reimplemented from makVrv::DtModel.
|
virtual |
Set an orientation offset to a character (ex.
swivel person about their local origin before any position offsets)
Reimplemented from makVrv::DtModel.
|
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 |
Set whether this DI-Guy is an driver / pilot / ocupant of a vehicle.
Implements makVrv::DtCharacterModel.
|
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 |
Hide the DI-Guy.
Reimplemented from makVrv::DtModel.
|
virtual |
Disable processing/updating of the DI-Guy.
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
Rotate the part.
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
translate the part.
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
control part visibility not connected yet
Implements makVrv::DtCharacterModel.
|
virtual |
Sets whether or not DI-Guy guides are suppressed. No-op at this level.
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
Implements makVrv::DtCharacterModel.
|
inlinevirtual |
Set the state of a dynamic sensor region.
Implements makVrv::DtCharacterModel.
|
privatedelete |
not allowed
|
static |
Static variable set to true when first instance is created, used to prevent more than one error popup from being generated.