VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends
DtLocalObject Class Reference

A locally simulated VRF object. Holds all internal and external data for the object, and provides access to both the current frame and next frame state data for the object. All current frame data is read-only, and next-frame data can be written to. No thread safety guarantees are made on this object during the simulation frame and it should only be accessed by the thread that is simulating the object.

Inheritance diagram for DtLocalObject:
Inheritance graph
[legend]

Classes

class  SimObjectCallback
 

Public Types

enum  ChangeFlag {
  ObjectName = 1, ForceType, ObjectLabel, OverlayParent,
  ObjectType, SubordinateOfForceLevel
}
 
typedef std::list
< DtLuaScriptInterfaceExtension::CreatorUserPair > 		ScriptInterfaceExtensions
 

Public Member Functions

virtual ~DtLocalObject ()
 
const
makVrf::DtExternalNextFrameState * 		nextFrameState () const
 
makVrf::DtExternalNextFrameState * nextFrameState ()
 
template<typename T_Component >
T_Component * getNextFrameStateComponent ()
 
template<typename T_Component >
const T_Component * getNextFrameStateComponent () const
 
template<typename T_Component >
std::vector< T_Component * > getNextFrameStateComponentList ()
 
template<typename T_Component >
const std::vector< T_Component * > getNextFrameStateComponentList () const
 
virtual DtRwProperties & nextFrameStateProperties ()
 
virtual void setNextFrameActivity (const DtString &)
 
virtual void setGlobalIdentifierForPublication (const DtString &)
 
virtual void setNextFrameExtendedData (const DtString &key, const DtString &value)
 
virtual void setNextFrameExtendedDataMap (const std::map< DtString, DtString > &)
 
virtual void setNextFrameExtendedDataMap (const std::map< std::string, std::string > &)
 
virtual void clearNextFrameExtendedData ()
 
virtual void appendNextFrameExtendedData (const std::map< DtString, DtString > &s)
 
virtual void setNextFrameExtendedLabel (int, const DtString &value)
 
virtual void clearNextFrameExtendedLabels ()
 
virtual void setNextFrameExtendedLabels (const std::map< int, DtString > &)
 
virtual DtAppearance nextFrameAppearance () const
 
virtual void setNextFrameLocalPosition (const DtVector &)
 
virtual DtString nextFrameLabel () const
 
virtual const DtVector & nextFrameLocalPosition () const
 
virtual void setNextFrameWorldPosition (const DtVector &)
 
virtual const DtVector & nextFrameWorldPosition () const
 
virtual void setNextFrameParentPosition (const DtVector &)
 
virtual const DtVector & nextFrameParentPosition () const
 
virtual void setNextFrameLocalOrientationMatrix (const DtDcm &)
 
virtual const DtDcm & nextFrameLocalOrientationMatrix () const
 
virtual void setNextFrameLocalOrientationWrtDatabase (const DtTaitBryan &)
 
virtual const DtTaitBryan & nextFrameLocalOrientationWrtDatabase () const
 
virtual void setNextFrameLocalOrientation (const DtTaitBryan &)
 
virtual const DtTaitBryan & nextFrameLocalOrientation () const
 
virtual const DtTaitBryan & nextFrameTopographicOrientation () const
 
virtual void setNextFrameParentOrientation (const DtTaitBryan &)
 
virtual const DtTaitBryan & nextFrameParentOrientation () const
 
virtual void setNextFrameWorldOrientation (const DtTaitBryan &)
 
virtual void setNextFrameWorldOrientationMatrix (const DtDcm &)
 
virtual const DtTaitBryan & nextFrameWorldOrientation () const
 
virtual const DtDcm & nextFrameWorldOrientationMatrix () const
 
virtual void setNextFrameLocalVertices (const DtList &vertices, DtVector &newGeometricCenter)
 
virtual void setNextFrameLocalVertices (const DtLocalVertexList &vertices, DtVector &newGeometricCenter)
 
virtual void removeNextFrameVertex (int iIndex)
 
virtual void addNextFrameLocalVertex (const DtVector &vertex)
 
virtual void addNextFrameLocalVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 
virtual void setNextFrameWorldVertices (const std::vector< DtVector > &vertices, DtVector &newGeometricCenter)
 
virtual void setNextFrameWorldVertices (const DtVertexList &vertices, DtVector &newGeometricCenter)
 
virtual void setNextFrameWorldVertices (const DtList &vertices, DtVector &newGeometricCenter)
 
virtual void addNextFrameWorldVertex (const DtVector &vertex, DtVector &newGeometricCenter)
 
bool nextFrameIsDestroyed () const
 
int nextFrameDamageState () const
 
virtual void setNextFrameRelativeVertices (const DtLocalVertexList &vertices)
 
virtual const DtLocalVertexList & nextFrameLocalVertices () const
 
virtual const DtVertexList & nextFrameWorldVertices () const
 
virtual const DtLocalVertexList & nextFrameRelativeVertices () const
 
virtual double nextFrameHeading () const
 
virtual double nextFramePitch () const
 
virtual double nextFrameRoll () const
 
virtual void setNextFrameIsSubordinateOfForceLevel (bool)
 
virtual bool nextFrameIsSubordinateOfForceLevel () const
 
virtual bool nextFrameIsLocal () const
 
bool isLocal () const override
 
virtual void removedFromSimulation ()
 
virtual void makeInvalid () override
 
bool isValid () const
 
bool publishObject () const
 
int publishFlag () const
 
virtual void setNextFrameIsClutterEntity (bool b)
 
virtual bool nextFrameIsClutterEntity () const
 
virtual void setNextFrameIsVrfSimulated (bool)
 
virtual bool nextFrameIsVrfSimulated () const
 
virtual void setNextFrameCallsign (const DtString &cs)
 
virtual const DtString & nextFrameCallsign () const
 
virtual bool isRemoteAttachedObject () const
 
virtual void setNextFrameEngagementRules (const DtString &)
 
virtual DtString nextFrameEngagementRules () const
 
virtual void setNextFrameIsTasked (bool)
 
virtual bool nextFrameIsTasked () const
 
virtual void setNextFrameIndependentlyTasked (bool)
 
virtual bool nextFrameIndependentlyTasked () const
 
virtual void setNextFrameGlobalId (const DtString &)
 
virtual void setNextFrameEntityId (const DtEntityIdentifier &id)
 
virtual DtEntityIdentifier nextFrameEntityId () const
 
virtual bool setNextFrameObjectName (const DtString &)
 
virtual DtString nextFrameObjectName () const
 
virtual void setNextFrameObjectType (const DtObjectType &)
 
virtual DtObjectType nextFrameObjectType () const
 
void setNotifyLevel (int)
 
DtSimulationServices * simulationServices () const
 
bool converting () const
 
template<typename T_Component >
T_Component * addStateComponent (bool checkWritable=false, bool isRemote=false)
 
makVrf::DtFrameStateInterface * addStateComponent (makVrf::DtStateComponent::StateComponentType t)
 
virtual bool nextFrameIsEmbarked () const
 
virtual DtUUID nextFrameEmbarkedOn () const
 
virtual void setNextFrameEmbarkedOn (const DtUUID &u)
 
virtual bool nextFrameIsEmbarkedOn (const DtUUID &) const
 
virtual DtSimObjectReference nextFrameSimObjectEmbarkedOn () const
 
virtual void setNextFrameEchelonId (const DtEchelonId &)
 
virtual DtEchelonId nextFrameEchelonId () const
 
virtual void setNextFrameForceType (int)
 
virtual DtForceType nextFrameForceType () const
 
virtual void setNextFrameSessionId (int)
 
virtual int nextFrameSessionId () const
 
virtual void setNextFrameVrfMessageVersionSupported (int)
 
virtual int nextFrameVrfMessageVersionSupported () const
 
virtual void removeNextFrameExtendedData (const DtString &)
 
void removeStateComponent (const makVrf::DtFrameStateInterface *)
 
virtual void upgradeFromImport ()
 
makVrf::DtLaserDesignatorStateComponent * addLaserDesignator ()
 
void removeLaserDesignator (makVrf::DtLaserDesignatorStateComponent *)
 
makVrf::DtEmitterSystemStateComponent * addEmitterSystem ()
 
void removeEmitterSystem (makVrf::DtEmitterSystemStateComponent *)
 
makVrf::DtActiveSonarStateComponent * addActiveSonarSystem ()
 
void removeActiveSonarSystem (makVrf::DtActiveSonarStateComponent *)
 
makVrf::DtRadioTransmitterStateComponent * addRadioTransmitter ()
 
void removeRadioTransmitter (makVrf::DtRadioTransmitterStateComponent *)
 
makVrf::DtNavAidRadioTransmitterStateComponent * addNavAidRadioTransmitter ()
 
void removeNavAidRadioTransmitter (makVrf::DtNavAidRadioTransmitterStateComponent *)
 
makVrf::DtRadioReceiverStateComponent * addRadioReceiver ()
 
void removeRadioReceiver (makVrf::DtRadioReceiverStateComponent *)
 
makVrf::DtIffStateComponent * getOrCreateIffSystem ()
 
void removeIffSystem ()
 
makVrf::DtUnderwaterAcousticsStateComponent * getOrCreateUnderwaterAcousticsSystem (bool isRemote=false)
 
void removeUnderwaterAcousticsSystem ()
 
virtual void setNextFrameUnderFire (bool b)
 
virtual bool nextFrameUnderFire () const
 
virtual void setNextFrameInvulnerable (bool)
 
virtual bool nextFrameInvulnerable () const
 
virtual void setNextFrameUndetectable (bool)
 
virtual bool nextFrameUndetectable () const
 
virtual void setNextFrameHalfLengthWidthHeight (double length, double width, double height)
 
virtual void setNextFrameObjectGeometry (const makVrf::DtVrfObjectGeometry &)
 
virtual void setNextFrameBoundingGeometryType (DtSimBoundingGeometry::DtSimBoundingGeometryType type)
 
virtual void setNextFrameBoundingVolume (const Dt3dBoundingVolume &b)
 
virtual void setNextFrameHasPlan (bool)
 
virtual bool nextFrameHasPlan () const
 
virtual void setNextFrameExecutingPlan (bool)
 
virtual bool nextFrameExecutingPlan () const
 
virtual void setNextFrameOccupantsHidden (bool)
 
virtual bool nextFrameOccupantsHidden () const
 
virtual std::map< DtString,
DtString > 		nextFrameExtendedDataMap () const
 
virtual std::map< int, DtString > nextFrameExtendedLabels () const
 
virtual bool nextFrameIsOnTopOf (const DtSimObject *o, bool checkSupportPoints=false) const
 
virtual bool nextFrameIsOnTopOf (const DtSimObject *o, double d, bool checkSupportPoints=false) const
 
DtLocalObjectDecorator * getOrCreateDecorator (const std::string &Decorator)
 
void setLocationComplete ()
 
virtual void setNextFrameParameterProperties (const DtRwProperties &)
 
const DtRwProperties & nextFrameParameterProperties () const
 
virtual const DtRwProperties & nextFrameStateProperties () const
 
virtual const DtRwProperties & stateProperties () const
 
virtual void setNextFrameStateProperties (const DtRwProperties &)
 
virtual bool nextFrameFuelLevelsFrozen () const
 
virtual bool nextFrameMunitionLevelsFrozen () const
 
virtual void setSimulationCapable (bool)
 
bool simulationCapable () const
 
virtual void setNextFrameBlockParachute (bool)
 
virtual bool nextFrameBlockParachute () const
 
virtual void setNextFrameOnTerrainSurface (bool b)
 
virtual bool nextFrameOnTerrainSurface () const
 
virtual bool init ()
 
virtual bool create ()
 
bool isGlobalPlan () const
 
bool isSyncMatrix () const
 
virtual int publicationFlag () const
 
virtual bool isCapableOfTask (std::string taskName)
 
virtual bool convertToRemoteObject (DtString &error)
 
virtual bool convertToLocalObject (DtString &error, const std::string &archiveState)
 
virtual bool prepareForHandoff ()
 
virtual std::string archiveState () const
 
virtual
DtVrfObjectStateRepository * 		internalState ()
 
virtual const
DtVrfObjectStateRepository * 		internalState () const
 
virtual void prepareForReinitialization ()
 
DtVrfObjectSubComponentTypes * vrfSubComponentTypes () const
 
virtual void tick ()
 
virtual void startTick ()
 
virtual void tickComponents ()
 
virtual void endTick ()
 
virtual int scenarioRunId () const
 
virtual bool checkIfMoveOntoEmbarked (const DtVector &localPosition, const DtSimObject *&hit, const std::list< DtUUID > &additionalIgnore=std::list< DtUUID >())
 
virtual bool checkAndDisembarkIfEmbarked (const DtVector &localPosition)
 
virtual bool lowFidelityDisembarkHitCheck (const DtVector &localPosition) const
 
virtual bool highFidelityDisembarkHitCheck (const DtVector &localPosition) const
 
virtual int nextEmitterSystemId ()
 
bool initialized () const
 
DtVrfCallbackQueue::CallbackInterface::Ptr parallelContainer ()
 
virtual void setupFromMessageContent (const DtIfModifyVrfObject *ifModVrfObject)
 
virtual bool validNameLength (const DtString &name) const
 
virtual void sendVrfObjectCreated (unsigned long requestId=0, bool requestCreated=true)
 
virtual void setIsInMovementFlux (bool, const DtVector &proposedLocation=DtVector::zero())
 
virtual void setNextFrameLabel (const DtString &)
 
virtual const DtString & nextFrameExtendedData (const DtString &) const
 
virtual void setNextFrameInvisible (bool)
 
virtual bool nextFrameInvisible () const
 
virtual void setNextFrameOverlay (const DtString &)
 
virtual bool nextFrameSensorsKilled () const
 
virtual void setNextFrameSensorsKilled (bool sensorsKilled)
 
virtual void setNextFrameInvisibleSetByUser (bool b)
 
virtual bool nextFrameInvisibleSetByUser () const
 
virtual DtString nextFrameOverlay () const
 
Object Console Streams

Each VRF object has a console that is displayed as part of the information dialog box for that object. When you extend the simulation engine, you can send messages to the object console window for a particular object. These messages are also printed to the vrfSim console and to the vrfSim log file, with the name of the object added as a prefix.

To write messages to the object console, use one of the following objectConsole*() stream methods. Each object console has five notification levels, and each level has a stream method. You should choose a level appropriate to the nature of the message you are printing to the console. The console will only display messages with a notification level equal to or higher than the notification level chosen by the user. A description of each notification level is given for the methods below.

Object console messages can be translated as well. You can code object console messages so that they can be extracted by lupdate into an untranslated.ts file for translation. (For complete details about translation files, please see Section 2.5, Localizing the Graphical User Interface in VR-Forces Users Guide.) This is done using the trUtf8 macro defined in objectConsole.h. It uses the format:

trUtf8(format, module)

where module is the name of the class that the console message is in. For example:

void MyNewClass::tick()
{
objectConsoleWarn() << trUtf8("arg one %1, arg two %2", "MyNewClass").arg(one).arg(two);
}
virtual DtOutputStream & objectConsoleDebug (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleVerbose (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleInfo (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleWarn (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleError (const DtString &channel="") const
 
int notifyLevel () const
 
const DtObjectConsole * objectConsole () const
 
makVrf::DtTaskVisualizationStateComponent * lineTaskVisualization (const DtString &visualName, const DtString &component)
 
makVrf::DtTaskVisualizationStateComponent * pointTaskVisualization (const DtString &visualName, const DtString &component)
 
makVrf::DtTaskVisualizationStateComponent * areaTaskVisualization (const DtString &visualName, const DtString &component)
 
makVrf::DtTaskVisualizationStateComponent * textTaskVisualization (const DtString &visualName, const DtString &component)
 
void removeTaskVisualization (makVrf::DtTaskVisualizationStateComponent *)
 
virtual void setOperationInProgress (int, bool)
 
virtual bool operationInProgress (int) const
 
virtual void clearOperationsInProgress ()
 
virtual bool createInternalState (const DtVrfObjectParameters *parameterEntry)
 
virtual bool setupSubComponentTypes ()
 
const DtObjectResourceManager * objectResourceManager () const
 
DtObjectResourceManager * objectResourceManager ()
 
virtual
DtVrfObjectCommunicationInterface * 		communicationInterface ()
 
virtual const
DtVrfObjectCommunicationInterface * 		communicationInterface () const
 
virtual
DtVrfObjectTerrainPreloadManager * 		terrainPreloadManager ()
 
virtual DtSimRadio * radio () const
 
virtual DtSimTaskManager * taskManager () const
 
virtual DtScriptInterfaceHandler * scriptInterfaceHandler () const
 
virtual DtVrfObjectPlanManager * vrfObjectPlanManager () const
 
virtual DtSimComponentManager * componentManager ()
 
virtual const
DtSimComponentManager * 		componentManager () const
 
virtual DtSetDataManager * setDataManager ()
 
virtual const DtSetDataManager * setDataManager () const
 
virtual void cleanupItemsNeededForHandoff ()
 
virtual bool recreateItemsNeededFromHandoff ()
 
virtual void addScriptExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, void *usr)
 
virtual void removeScriptExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, void *usr)
 
virtual const
ScriptInterfaceExtensions & 		scriptExtensions () const
 
VRF4API_METHOD
DtVrfObjectStateRepository * 		vrfState ()
 
VRF4API_METHOD const
DtVrfObjectStateRepository * 		vrfState () const
 
VRF4API_METHOD void setObjectIdentifier (const DtEntityIdentifier &id)
 
VRF4API_METHOD void place (const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
 
VRF4API_METHOD void place (const DtVector &heading, bool *dataAvailable=0, bool requireAllData=false)
 
VRF4API_METHOD bool isVrfSimulated () const
 
VRF4API_METHOD void invokeSetLocationCompleteCallbacks ()
 
- Public Member Functions inherited from DtSimObject
 DtSimObject (const DtSimulationServices *simManager, const DtUUID &uuid)
 
 DtSimObject (const DtSimulationServices *simManager, const DtEntityIdentifier &id)
 
 DtSimObject (const DtSimulationServices *simManager, const makVrf::DtExternalCurrentFrameState *)
 
virtual ~DtSimObject ()
 
DtSimObject & operator= (const DtUUID &)
 
DtSimObject & operator= (const DtSimObject &rhs)
 
bool operator== (const DtUUID &rhs) const
 
bool operator== (const DtSimObject &rhs) const
 
bool operator!= (const DtUUID &rhs) const
 
bool operator!= (const DtSimObject &rhs) const
 
const DtUUID & uuid () const
 
const DtString & objectName () const
 
DtString label () const
 
DtEntityType entityType () const
 
DtObjectType objectType () const
 
bool isClutterEntity () const
 
makVrf::DtVrfObjectGeometry objectGeometry () const
 
Dt3dBoundingVolume boundingVolume () const
 
DtVector localBoundingVolumeCenterPosition () const
 
DtExtent extent () const
 
DtExtent roughExtent () const
 
void expandExtent (DtExtent &extent) const
 
const makVrf::DtIffStateComponent * iffStateComponent () const
 
std::vector< const
makVrf::DtLaserDesignatorStateComponent * > 		laserDesignatorStateComponents () const
 
template<typename T_Component >
const T_Component * getStateComponent () const
 
template<typename T_Component >
std::vector< const T_Component * > getStateComponentList () const
 
template<typename T_Component >
bool hasStateComponent () const
 
DtForceType forceType () const
 
const DtEntityIdentifier & entityId () const
 
const DtEntityIdentifier & objectIdentifier () const
 
bool isDestroyed () const
 
int damageState () const
 
const DtString & globalId () const
 
const DtPlatformSimObjectFacade & platformSimObjectFacade () const
 
const
DtVrfSimulatedSimObjectFacade & 		vrfSimulatedSimObjectFacade () const
 
bool isEntityOrUnit () const
 
bool isSimulatedObject () const
 
bool isEntity () const
 
bool isValid () const
 
int sessionId () const
 
bool isVrfSimulatedObject () const
 
bool isOnTopOf (const DtSimObject *o) const
 
bool isOnTopOf (const DtSimObject *o, double d) const
 
bool isOnTopOf (const DtSimObject *o, double d, const DtVector &position) const
 
bool isDeleted () const
 
virtual
DtVrfLocalObjectCreateInformation 		vrfLocalObjectCreateInformation () const
 
const DtSimulationServices * simulationServices () const
 
const DtVrfObjectParameters * parameters () const
 
DtVrfObjectParameters * duplicateParameters ()
 
double totalMass () const
 
const Coordinate_System * coordinateSystem () const
 
const DtLocalVertexList & localVertices () const
 
const DtVertexList & worldVertices () const
 
const DtLocalVertexList & relativeVertices () const
 
DtVector locationRelativeTo (const DtVector &, const DtSimObject *relativeTo) const
 
DtVector velocityRelativeTo (const DtVector &, const DtSimObject *relativeTo) const
 
DtVector accelerationRelativeTo (const DtVector &, const DtSimObject *relativeTo) const
 
DtTaitBryan orientationRelativeTo (const DtTaitBryan &, const DtSimObject *relativeTo) const
 
const DtRwProperties & parameterProperties () const
 
double distanceToLocalVector (const DtVector &) const
 
DtSimObjectReference simObjectReference () const
 
unsigned long long legionGlobalId () const
 
DtString awaiting () const
 
bool advancedFrame () const
 
DtSimObjectReference superior () const
 
DtUUID superiorUUID () const
 
const DtSimObjectReferenceList & attachments () const
 
bool isTopLevel () const
 
MAKVRinTerra::DtFeatureGeometry featureGeometry () const
 
const DtAttachedTerrain * terrainAttachedTo () const
 
const
makVrf::DtSimulatedObjectStateComponent * 		currentFrameSimulatedObjectStateComponent () const
 
const
makVrf::DtLocationStateComponent * 		currentFrameLocationStateComponent () const
 
const
makVrf::DtVrfGeometryStateComponent * 		currentFrameVrfGeometryStateComponent () const
 
const
makVrf::DtEntityStateComponent * 		currentFrameEntityStateComponent () const
 
const makVrf::DtVrfStateComponent * currentFrameVrfStateComponent () const
 
makVrf::DtRwVrfKinematicState kinematicState () const
 
const DtVector & worldPosition () const
 
const DtVector & localPosition () const
 
const DtVector & parentPosition () const
 
double distSquaredTo (const DtVector &) const
 
bool hasLocationChanged () const
 
bool objectVerticesChanged () const
 
bool worldVerticesChanged () const
 
bool haveVerticesChanged () const
 
virtual void frameAdvanced ()
 
virtual void firstFrameAdvance ()
 
const DtTaitBryan & topographicOrientation () const
 
const DtTaitBryan & worldOrientation () const
 
const DtTaitBryan & localOrientation () const
 
const DtTaitBryan & parentOrientation () const
 
const DtTaitBryan & localOrientationWrtDatabase () const
 
const DtDcm & localOrientationMatrix () const
 
const DtDcm & parentOrientationMatrix () const
 
const DtDcm & worldOrientationMatrix () const
 
double heading () const
 
double pitch () const
 
double roll () const
 
bool isUnit () const
 
bool isEmbarked () const
 
bool embarkedOnHighFidelityObject () const
 
DtUUID embarkedOn () const
 
DtSimObjectReference simObjectEmbarkedOn () const
 
bool isEmbarkedOn (const DtUUID &) const
 
DtSimObjectDecorator * getOrCreateDecorator (const std::string &Decorator) const
 
VRF4API_METHOD const DtSimObject * vrfState ()
 
VRF4API_METHOD const DtSimObject * vrfState () const
 
VRF4API_METHOD const DtSimObject * simState ()
 
VRF4API_METHOD const DtSimObject * simState () const
 
VRF4API_METHOD bool operator== (const DtSimObject *rhs) const
 
VRF4API_METHOD const
DtSimulationServices * 		simManager () const
 
VRF4API_METHOD
DtSimulationServices * 		simManager ()
 
VRF4API_METHOD
makVrf::DtVrfObjectGeometry 		vrfObjectGeometry () const
 
VRF4API_METHOD const
DtPhysicalWorld * 		physicalWorld () const
 
VRF4API_METHOD DtSimObjectReference sharedReference () const
 
VRF4API_METHOD const
DtVrfObjectParameters * 		parameterEntry () const
 
VRF4API_METHOD const
DtSimObjectManager * 		simObjectManager () const
 
VRF4API_METHOD DtSimObjectReference vrfObject () const
 
VRF4API_METHOD DtSimObjectReference parent () const
 
VRF4API_METHOD double currentHeading () const
 
VRF4API_METHOD double currentPitch () const
 
VRF4API_METHOD double currentRoll () const
 
VRF4API_METHOD const DtString & markingText () const
 
VRF4API_METHOD bool isSpatiallyFrozen () const
 
VRF4API_METHOD bool isFrozen () const
 
VRF4API_METHOD double speed () const
 
VRF4API_METHOD double forwardSpeed () const
 
VRF4API_METHOD DtVector worldVelocity () const
 
VRF4API_METHOD DtVector localVelocity () const
 
VRF4API_METHOD DtVector bodyVelocity () const
 
VRF4API_METHOD DtVector relativeVelocity () const
 
VRF4API_METHOD DtVector parentVelocity () const
 
VRF4API_METHOD DtVector rotationalVelocity () const
 
VRF4API_METHOD DtVector worldAcceleration () const
 
VRF4API_METHOD DtVector localAcceleration () const
 
VRF4API_METHOD DtVector relativeAcceleration () const
 

Static Public Member Functions

static bool shouldArchiveExtendedAttribute (const DtString &s)
 
static void doNotArchiveAttribute (const DtString &s, bool b)
 
static DtLocalObjectCreatorFcn setLocalObjectCreatorFunction (DtLocalObjectCreatorFcn)
 
static DtLocalObjectCreatorFcn localObjectCreatorFunction ()
 
static DtLocalObject * create (DtSimulationServices *, const DtVrfLocalObjectCreateInformation &)
 
static DtLocalObject * createAndInit (DtSimulationServices *, const DtVrfLocalObjectCreateInformation &)
 
static void enableSingleObjectMode ()
 
static bool singleObjectModeActive ()
 

Public Attributes

boost::signals2::signal< void()> signal_preUpgradeFromImport
 
boost::signals2::signal< void()> signal_postUpgradeFromImport
 
boost::signals2::signal< void()> signal_objectInitialized
 
boost::signals2::signal< void()> signal_objectRestored
 
boost::signals2::signal< void(DtLocalObject *)> signal_objectModifiedViaMessage
 
boost::signals2::signal< void(DtLocalObject *)> signal_newSensorContact
 
boost::signals2::signal< void(DtLocalObject *)> signal_navigationAreaChanged
 
boost::signals2::signal< void(DtLocalObject *)> signal_setLocationComplete
 
boost::signals2::signal< void()> signal_restored
 
boost::signals2::signal< void(const
DtLocalObject *, ChangeFlag)> 		signal_objectDataChanged
 
boost::signals2::signal< void(const
DtLocalObject *)> 		signal_localObjectAboutToBeDeleted
 
boost::signals2::signal< void(DtLocalObject
*, DtVrfObjectHandoffData::HandoffFlag)> 		signal_handoffStep
 
boost::signals2::signal< void(DtLocalObject
*, DtVrfObjectHandoffData &)> 		signal_prepareForHandoff
 
boost::signals2::signal< void(DtLocalObject *)> signal_postInitFromParams
 
- Public Attributes inherited from DtSimObject
boost::signals2::signal< void()> signal_objectVerticesChanged
 
boost::signals2::signal< void(const
DtSimObject *)> 		signal_extendedDataUpdated
 
boost::signals2::signal< void(const
DtSimObject *)> 		signal_simObjectDeleted
 
boost::signals2::signal< void(const
DtSimObject *, const DtString &)> 		signal_discoveredReference
 
boost::signals2::signal< void(const
DtUUID &oldUUID, const DtUUID
&newUUID)> 		signal_uuidChanged
 
boost::signals2::signal< void(const
DtSimObject *, const DtString
&oldName, const DtString
&newName)> 		signal_objectRenamed
 
boost::signals2::signal< void(const
DtSimObject *, const DtUUID
&oldSuperior, const DtUUID
&newSuperior)> 		signal_superiorChanged
 
boost::signals2::signal< void(const
DtSimObject *)> 		signal_isClutterChanged
 
boost::signals2::signal< void()> signal_advancedFrame
 
boost::signals2::signal< void()> signal_firstFrameAdvance
 

Protected Types

typedef std::map< int, int > OperationsInProgressCount
 
- Protected Types inherited from DtSimObject
typedef std::map< std::string,
DtSimObjectDecorator * > 		SimObjectDecorators
 

Protected Member Functions

 DtLocalObject (DtSimulationServices *, const DtVrfLocalObjectCreateInformation &)
 
 DtLocalObject (DtSimulationServices *)
 
virtual void createNavigationDecorator () override
 
virtual void setupStateRepository ()
 
virtual void internalStateInitializedFromParameters ()
 
virtual bool createCommunicationsInterface ()
 
virtual void initializeCommunicationInterfaceCallbacks ()
 
virtual void processSetOverlayLayerTask (const DtVrfObjectMessage *msg)
 
virtual bool createScriptInterfaceHandler ()
 
virtual bool createComponentManager ()
 
virtual bool initializeComponentManager ()
 
virtual bool createRadio ()
 
virtual bool createVrfObjectPlanManager ()
 
virtual bool createSetDataManager ()
 
virtual void tickDecorators ()
 
void createRemotelyControlledLocalObject ()
 
virtual void completeSetup () override
 
virtual bool createTaskManager ()
 
virtual void createCommunicationsInterface (const DtRadioDescriptorList &descList)
 
virtual void updateEntityHasTarget ()
 
void setUUID (const DtUUID &) override
 
virtual void convertedToRemote ()
 
virtual std::map< DtString,
DtString > 		unarchivedData ()
 
virtual void clearDecorators () override
 
virtual void usingParameterSource (const DtString &) override
 
virtual void setupVrfObjectParameters () override
 
void cacheNextFrameComponents ()
 
void clearNextFrameCachedComponents ()
 
virtual void hostChanged (const DtUUID &oldHost, const DtUUID &newHost) override
 
virtual void isClutterChanged () override
 
virtual void setupExtendedDataFromParameterData ()
 
virtual bool canBePlaced () const
 
 DtLocalObject (const DtLocalObject &orig)
 
DtLocalObject & operator= (const DtLocalObject &orig)
 
- Protected Member Functions inherited from DtSimObject
void tickDecorators ()
 
void cacheComponents ()
 
void clearCachedComponents ()
 
void stateDataAdded (makVrf::DtStateData *)
 
bool checkAndConnectForVrfStateComponent ()
 
void uuidChanged (const DtUUID &, const DtUUID &)
 
void objectNameChanged (const DtString &oldText, const DtString &newText)
 
void attachmentsChanged ()
 
void extendedDataUpdated ()
 
void superiorChanged ()
 
virtual void externalFrameStateToBeDestroyed ()
 

Static Protected Member Functions

static void setOverlayLayerTaskCallback (const DtVrfObjectMessage *msg, void *usr)
 

Protected Attributes

DtVrfObjectStateRepository * myInternalState
 
DtVrfObjectSubComponentTypes * mySubComponentTypes
 
makVrf::DtExternalNextFrameState * myExternalNextFrameState
 
DtVrfObjectCommunicationInterface * myCommunicationInterface
 
DtVrfObjectTerrainPreloadManager * myTerrainPreloadManager
 
DtSimRadio * myRadio
 
DtSimTaskManager * myTaskManager
 
DtScriptInterfaceHandler * myScriptInterfaceHandler
 
DtSimComponentManager * myComponentManager
 
DtVrfObjectPlanManager * myVrfObjectPlanManager
 
DtSetDataManager * mySetDataManager
 
bool myCreatedStateData
 
boost::signals2::scoped_connection myConvertedToRemoteConnection
 
DtVrfLocalObjectCreateInformation * myLocalObjectCreateInformation
 
bool myInitializing
 
bool myInitialized
 
int myNextEmitterSystemId
 
DtAppearanceLocalObjectFacade * myAppearanceLocalObjectFacade
 
ScriptInterfaceExtensions myScriptInterfaceExtensions
 
bool myConverting
 
bool mySimulationCapable
 
bool myHasTarget
 
bool myControllersTicked
 
bool mySkipNextComponentTick
 
bool mySignalLocationComplete
 
bool myIsEnvironmental = false
 
DtRwProperties * myDefaultStateProperties
 
makVrf::DtLocationStateComponent * myNextFrameLocationStateComponent
 
makVrf::DtSimulatedObjectStateComponent * myNextFrameSimulatedObjectStateComponent
 
makVrf::DtVrfGeometryStateComponent * myNextFrameVrfGeometryStateComponent
 
makVrf::DtVrfStateComponent * myNextFrameVrfStateComponent
 
makVrf::DtStatePropertiesStateComponent * myNextFrameStatePropertiesStateComponent
 
const
makVrf::DtStatePropertiesStateComponent * 		myCurrentFrameStatePropertiesStateComponent
 
DtSimObjectReference myNextFrameSimObjectEmbarkedOn
 
DtMovementLocalObjectFacade * myMovementLocalObjectFacade
 
OperationsInProgressCount myOperationsInProgressCount
 
int myFluxIndex = -1
 
DtVrfCallbackQueue::CallbackInterface::Ptr myParallelContainer
 
- Protected Attributes inherited from DtSimObject
const DtSimulationServices * mySimulationServices
 
const
makVrf::DtExternalCurrentFrameState * 		myExternalCurrentFrameState
 
boost::signals2::scoped_connection myDeletedConnection
 
boost::signals2::scoped_connection myAddedConnection
 
boost::signals2::scoped_connection myUUIDChangedConnection
 
boost::signals2::scoped_connection myObjectNameChangedConnection
 
boost::signals2::scoped_connection myExtendedDataUpdatedConnection
 
boost::signals2::scoped_connection myFirstFrameAdvancedConnection
 
boost::signals2::scoped_connection mySuperiorChangedConnection
 
boost::signals2::scoped_connection myAdvancedFrameConnection
 
boost::signals2::scoped_connection myIsClutterChangedConnection
 
ExtentInformation myExtentInformation
 
DtNavigationSimObjectDecorator * myNavigationSimDecorator = nullptr
 
DtString myAwaiting
 
DtUUID myUUID
 
unsigned long long myLegionGlobalId
 
const DtVrfObjectParameters * myParameters
 
DtVrfObjectParameters * myDuplicateParameters
 
bool myIsDeleted
 
DtString myObjectName
 
DtObjectType myEntityType
 
DtSimObjectReferenceList * myAttachments
 
boost::signals2::scoped_connection myAttachmentsChangedConnection
 
DtSimObjectReference mySuperior
 
bool myAdvancedFrame
 
DtSimObjectReference mySimObjectReference
 
tbb::spin_rw_mutex mySimObjectReferenceMutex
 
DtAttachedTerrain * myTerrainAttachedTo
 
boost::signals2::scoped_connection myHostChangedConnection
 
tbb::spin_rw_mutex myExternalCurrentFrameStateMutex
 
DtUUID myEmbarkedOn
 
const
makVrf::DtSimulatedObjectStateComponent * 		myCurrentFrameSimulatedObjectStateComponent
 
const makVrf::DtVrfStateComponent * myCurrentFrameVrfStateComponent
 
const
makVrf::DtEntityStateComponent * 		myCurrentFrameEntityStateComponent
 
const
makVrf::DtLocationStateComponent * 		myCurrentFrameLocationStateComponent
 
const
makVrf::DtVrfGeometryStateComponent * 		myCurrentFrameVrfGeometryStateComponent
 
bool myCachedComponents
 
DtAggregateSimObjectFacade * myAggregateSimObjectFacade
 
DtPlatformSimObjectFacade * myPlatformSimObjectFacade
 
DtVrfSimulatedSimObjectFacade * myVrfSimulatedSimObjectFacade
 
SimObjectDecorators mySimObjectDecorators
 
tbb::spin_rw_mutex mySimObjectDecoratorMutex
 

Static Protected Attributes

static DtLocalObjectCreatorFcn theLocalObjectCreatorFunction
 
static std::set< DtString > theDoNotArchiveAttributes
 

Friends

class DtVrfObjectStateRepository
 
virtual void processReadDRThresholdSettings (const DtSettingsObject *settings)
 
static void readDRThresholdSettingsCallback (const DtSettingsObject *settings, void *usr)
 
virtual void processLogToFile (const DtVrfObjectMessage *msg)
 
virtual void processStopLoggingToFile (const DtVrfObjectMessage *msg)
 
static void logToFileCallback (const DtVrfObjectMessage *msg, void *usr)
 
static void stopLoggingToFileCallback (const DtVrfObjectMessage *msg, void *usr)
 
typedef std::map< std::string,
DtLocalObjectDecorator * > 		LocalObjectDecorators
 
LocalObjectDecorators myLocalObjectDecorators
 

Member Typedef Documentation

typedef std::list<DtLuaScriptInterfaceExtension::CreatorUserPair> DtLocalObject::ScriptInterfaceExtensions
typedef std::map<std::string, DtLocalObjectDecorator*> DtLocalObject::LocalObjectDecorators
protected

Decorator members.

typedef std::map<int, int> DtLocalObject::OperationsInProgressCount
protected

Member Enumeration Documentation

enum DtLocalObject::ChangeFlag
Enumerator
ObjectName 
ForceType 
ObjectLabel 
OverlayParent 
ObjectType 
SubordinateOfForceLevel 

Constructor & Destructor Documentation

DtLocalObject::DtLocalObject ( DtSimulationServices *  ,
const DtVrfLocalObjectCreateInformation &   
)
protected

Use creator method Creates a new DtLocalObject from the parameters given.

DtLocalObject::DtLocalObject ( DtSimulationServices *  )
protected
virtual DtLocalObject::~DtLocalObject ( )
virtual

destructor

DtLocalObject::DtLocalObject ( const DtLocalObject &  orig)
protected

copy constructor

Member Function Documentation

const makVrf::DtExternalNextFrameState* DtLocalObject::nextFrameState ( ) const
makVrf::DtExternalNextFrameState* DtLocalObject::nextFrameState ( )
template<typename T_Component >
T_Component* DtLocalObject::getNextFrameStateComponent ( )
inline

General call to get any component that does not have a method.

template<typename T_Component >
const T_Component* DtLocalObject::getNextFrameStateComponent ( ) const
inline

General call to get any component that does not have a method.

template<typename T_Component >
std::vector<T_Component*> DtLocalObject::getNextFrameStateComponentList ( )
inline

General call to get any component that does not have a method.

template<typename T_Component >
const std::vector<T_Component*> DtLocalObject::getNextFrameStateComponentList ( ) const
inline

General call to get any component that does not have a method.

virtual DtRwProperties& DtLocalObject::nextFrameStateProperties ( )
virtual

Reimplemented in DtRemoteAttachedObject.

Referenced by DtSimComponent::cachedNextFrameStateProperty().

virtual void DtLocalObject::setNextFrameActivity ( const DtString &  )
virtual

Convenience methods.

virtual void DtLocalObject::setGlobalIdentifierForPublication ( const DtString &  )
virtual

Must be set before publication. This can be done in response to a local object manager simObjectAboutToBeAdded callback as:

void SetGlobalId(const DtLocalObject* lo, void* usr) { DtString globalId = "Global_Id_Is_"; globalId += lo->objectName();

const_cast<DtLocalObject*>(lo)->setGlobalIdentifierForPublication(globalId); } DT_VRF_DLL_PLUGIN void DtPostInitializeVrfPlugin(DtCgf* cgf) { cgf->localObjectManager()->addSimObjectAboutToBeAddedCallback(SetGlobalId, cgf); }

virtual void DtLocalObject::setNextFrameExtendedData ( const DtString &  key,
const DtString &  value 
)
virtual
virtual void DtLocalObject::setNextFrameExtendedDataMap ( const std::map< DtString, DtString > &  )
virtual
virtual void DtLocalObject::setNextFrameExtendedDataMap ( const std::map< std::string, std::string > &  )
virtual
virtual void DtLocalObject::clearNextFrameExtendedData ( )
virtual
virtual void DtLocalObject::appendNextFrameExtendedData ( const std::map< DtString, DtString > &  s)
virtual
virtual void DtLocalObject::setNextFrameExtendedLabel ( int  ,
const DtString &  value 
)
virtual
virtual void DtLocalObject::clearNextFrameExtendedLabels ( )
virtual
virtual void DtLocalObject::setNextFrameExtendedLabels ( const std::map< int, DtString > &  )
virtual
virtual DtAppearance DtLocalObject::nextFrameAppearance ( ) const
virtual
virtual void DtLocalObject::setNextFrameLocalPosition ( const DtVector &  )
virtual

@( TSPI mutators

Reimplemented in DtRemoteAttachedObject.

virtual DtString DtLocalObject::nextFrameLabel ( ) const
virtual
virtual const DtVector& DtLocalObject::nextFrameLocalPosition ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameWorldPosition ( const DtVector &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtVector& DtLocalObject::nextFrameWorldPosition ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameParentPosition ( const DtVector &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtVector& DtLocalObject::nextFrameParentPosition ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameLocalOrientationMatrix ( const DtDcm &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtDcm& DtLocalObject::nextFrameLocalOrientationMatrix ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameLocalOrientationWrtDatabase ( const DtTaitBryan &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtTaitBryan& DtLocalObject::nextFrameLocalOrientationWrtDatabase ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameLocalOrientation ( const DtTaitBryan &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtTaitBryan& DtLocalObject::nextFrameLocalOrientation ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtTaitBryan& DtLocalObject::nextFrameTopographicOrientation ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameParentOrientation ( const DtTaitBryan &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtTaitBryan& DtLocalObject::nextFrameParentOrientation ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameWorldOrientation ( const DtTaitBryan &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameWorldOrientationMatrix ( const DtDcm &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtTaitBryan& DtLocalObject::nextFrameWorldOrientation ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtDcm& DtLocalObject::nextFrameWorldOrientationMatrix ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameLocalVertices ( const DtList &  vertices,
DtVector &  newGeometricCenter 
)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameLocalVertices ( const DtLocalVertexList &  vertices,
DtVector &  newGeometricCenter 
)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::removeNextFrameVertex ( int  iIndex)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::addNextFrameLocalVertex ( const DtVector &  vertex)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::addNextFrameLocalVertex ( const DtVector &  vertex,
DtVector &  newGeometricCenter 
)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameWorldVertices ( const std::vector< DtVector > &  vertices,
DtVector &  newGeometricCenter 
)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameWorldVertices ( const DtVertexList &  vertices,
DtVector &  newGeometricCenter 
)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameWorldVertices ( const DtList &  vertices,
DtVector &  newGeometricCenter 
)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::addNextFrameWorldVertex ( const DtVector &  vertex,
DtVector &  newGeometricCenter 
)
virtual

Reimplemented in DtRemoteAttachedObject.

bool DtLocalObject::nextFrameIsDestroyed ( ) const

Convenience method to see if this object is destroyed. Is not applicable to all object types (e.g. tactical graphics)

int DtLocalObject::nextFrameDamageState ( ) const
virtual void DtLocalObject::setNextFrameRelativeVertices ( const DtLocalVertexList &  vertices)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtLocalVertexList& DtLocalObject::nextFrameLocalVertices ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtVertexList& DtLocalObject::nextFrameWorldVertices ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtLocalVertexList& DtLocalObject::nextFrameRelativeVertices ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual double DtLocalObject::nextFrameHeading ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual double DtLocalObject::nextFramePitch ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual double DtLocalObject::nextFrameRoll ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameLabel ( const DtString &  )
virtual

Label setting.

virtual const DtString& DtLocalObject::nextFrameExtendedData ( const DtString &  ) const
virtual

Index of 0 is equivalent to setNextFrameLabel.

virtual void DtLocalObject::setNextFrameIsSubordinateOfForceLevel ( bool  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameIsSubordinateOfForceLevel ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameIsLocal ( ) const
virtual

Whether or not this object is local in the next frame.

Reimplemented in DtRemoteAttachedObject.

bool DtLocalObject::isLocal ( ) const
overridevirtual

Returns true if this object is a locally simulated object.

Reimplemented from DtSimObject.

virtual void DtLocalObject::removedFromSimulation ( )
virtual

Call this before deleting the object (although it will also be called during object deletion) to clean up components such that they can still reference a valid local object when cleaninup up.

virtual void DtLocalObject::setNextFrameInvisible ( bool  )
virtual
virtual bool DtLocalObject::nextFrameInvisible ( ) const
virtual
virtual void DtLocalObject::setNextFrameOverlay ( const DtString &  )
virtual
virtual bool DtLocalObject::nextFrameSensorsKilled ( ) const
virtual
virtual void DtLocalObject::setNextFrameSensorsKilled ( bool  sensorsKilled)
virtual
virtual void DtLocalObject::setNextFrameInvisibleSetByUser ( bool  b)
virtual
virtual bool DtLocalObject::nextFrameInvisibleSetByUser ( ) const
virtual
virtual DtString DtLocalObject::nextFrameOverlay ( ) const
virtual
virtual DtOutputStream& DtLocalObject::objectConsoleDebug ( const DtString &  channel = "") const
virtual

Debug - Use for debugging level messages that only users attempting to debug operation of an object would be interested in.

virtual DtOutputStream& DtLocalObject::objectConsoleVerbose ( const DtString &  channel = "") const
virtual

Verbose - Use for general events or conditions for an object that are part of normal operation, but less important than Info level events.

virtual DtOutputStream& DtLocalObject::objectConsoleInfo ( const DtString &  channel = "") const
virtual

Info - Use for important events of an object that are part of normal operation.

virtual DtOutputStream& DtLocalObject::objectConsoleWarn ( const DtString &  channel = "") const
virtual

Warn - Displayed to the user by default. Use for situations that may lead to unexpected behavior.

virtual DtOutputStream& DtLocalObject::objectConsoleError ( const DtString &  channel = "") const
virtual

Error - Always displayed to the user. Use for important errors that indicate failure of some type.

int DtLocalObject::notifyLevel ( ) const

The current notify level this object is set to for sending messages.

const DtObjectConsole* DtLocalObject::objectConsole ( ) const

Debug - Use for debugging level messages that only users attempting to debug operation of an object would be interested in.

virtual void DtLocalObject::makeInvalid ( )
overridevirtual

Make this invalid by clearing the myExternalCurrentFrameState. This will also set the myIsDeleted flag to true.

Reimplemented from DtSimObject.

bool DtLocalObject::isValid ( ) const

Check if this DtLocalObject is valid to be used.

bool DtLocalObject::publishObject ( ) const
int DtLocalObject::publishFlag ( ) const
virtual void DtLocalObject::setNextFrameIsClutterEntity ( bool  b)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameIsClutterEntity ( ) const
virtual
virtual void DtLocalObject::setNextFrameIsVrfSimulated ( bool  )
virtual
virtual bool DtLocalObject::nextFrameIsVrfSimulated ( ) const
virtual
virtual void DtLocalObject::setNextFrameCallsign ( const DtString &  cs)
virtual
virtual const DtString& DtLocalObject::nextFrameCallsign ( ) const
virtual
virtual bool DtLocalObject::isRemoteAttachedObject ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameEngagementRules ( const DtString &  )
virtual
virtual DtString DtLocalObject::nextFrameEngagementRules ( ) const
virtual
virtual void DtLocalObject::setNextFrameIsTasked ( bool  )
virtual
virtual bool DtLocalObject::nextFrameIsTasked ( ) const
virtual
virtual void DtLocalObject::setNextFrameIndependentlyTasked ( bool  )
virtual
virtual bool DtLocalObject::nextFrameIndependentlyTasked ( ) const
virtual
virtual void DtLocalObject::setNextFrameGlobalId ( const DtString &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameEntityId ( const DtEntityIdentifier &  id)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual DtEntityIdentifier DtLocalObject::nextFrameEntityId ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::setNextFrameObjectName ( const DtString &  )
virtual

Returns true if marking text changed.

Reimplemented in DtRemoteAttachedObject.

virtual DtString DtLocalObject::nextFrameObjectName ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameObjectType ( const DtObjectType &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual DtObjectType DtLocalObject::nextFrameObjectType ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

void DtLocalObject::setNotifyLevel ( int  )
DtSimulationServices* DtLocalObject::simulationServices ( ) const
bool DtLocalObject::converting ( ) const
inline
template<typename T_Component >
T_Component* DtLocalObject::addStateComponent ( bool  checkWritable = false,
bool  isRemote = false 
)
inline

Adds the given state component by its intrinsic type.

References makVrf::DtStateData::getStateComponent(), DtSimObject::isValid(), DtSimObject::mySimulationServices, and makVrf::DtStateComponent::setIsRemoteComponent().

makVrf::DtFrameStateInterface* DtLocalObject::addStateComponent ( makVrf::DtStateComponent::StateComponentType  t)
virtual bool DtLocalObject::nextFrameIsEmbarked ( ) const
virtual

Embarkation Make this call if you embark an object for the next frame and want to see if the embarkation succeeded.

Reimplemented in DtRemoteAttachedObject.

virtual DtUUID DtLocalObject::nextFrameEmbarkedOn ( ) const
virtual

Call this to see who this entity will be embarked on the next frame.

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameEmbarkedOn ( const DtUUID &  u)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameIsEmbarkedOn ( const DtUUID &  ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual DtSimObjectReference DtLocalObject::nextFrameSimObjectEmbarkedOn ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameEchelonId ( const DtEchelonId &  )
virtual

Echelon id mutator.

virtual DtEchelonId DtLocalObject::nextFrameEchelonId ( ) const
virtual
virtual void DtLocalObject::setNextFrameForceType ( int  )
virtual

Force type mutator.

Reimplemented in DtRemoteAttachedObject.

virtual DtForceType DtLocalObject::nextFrameForceType ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameSessionId ( int  )
virtual
virtual int DtLocalObject::nextFrameSessionId ( ) const
virtual
virtual void DtLocalObject::setNextFrameVrfMessageVersionSupported ( int  )
virtual
virtual int DtLocalObject::nextFrameVrfMessageVersionSupported ( ) const
virtual
virtual void DtLocalObject::removeNextFrameExtendedData ( const DtString &  )
virtual

Removes the extended data key from the extended data map.

void DtLocalObject::removeStateComponent ( const makVrf::DtFrameStateInterface *  )

Removes the given state component.

virtual void DtLocalObject::upgradeFromImport ( )
virtual

Called when upgrading object from an import of a scenario.

makVrf::DtTaskVisualizationStateComponent* DtLocalObject::lineTaskVisualization ( const DtString &  visualName,
const DtString &  component 
)

Task Visualization.

makVrf::DtTaskVisualizationStateComponent* DtLocalObject::pointTaskVisualization ( const DtString &  visualName,
const DtString &  component 
)

Task Visualization.

makVrf::DtTaskVisualizationStateComponent* DtLocalObject::areaTaskVisualization ( const DtString &  visualName,
const DtString &  component 
)

Task Visualization.

makVrf::DtTaskVisualizationStateComponent* DtLocalObject::textTaskVisualization ( const DtString &  visualName,
const DtString &  component 
)

Task Visualization.

void DtLocalObject::removeTaskVisualization ( makVrf::DtTaskVisualizationStateComponent *  )

Task Visualization.

makVrf::DtLaserDesignatorStateComponent* DtLocalObject::addLaserDesignator ( )
void DtLocalObject::removeLaserDesignator ( makVrf::DtLaserDesignatorStateComponent *  )
makVrf::DtEmitterSystemStateComponent* DtLocalObject::addEmitterSystem ( )
void DtLocalObject::removeEmitterSystem ( makVrf::DtEmitterSystemStateComponent *  )
makVrf::DtActiveSonarStateComponent* DtLocalObject::addActiveSonarSystem ( )
void DtLocalObject::removeActiveSonarSystem ( makVrf::DtActiveSonarStateComponent *  )
makVrf::DtRadioTransmitterStateComponent* DtLocalObject::addRadioTransmitter ( )
void DtLocalObject::removeRadioTransmitter ( makVrf::DtRadioTransmitterStateComponent *  )
makVrf::DtNavAidRadioTransmitterStateComponent* DtLocalObject::addNavAidRadioTransmitter ( )
void DtLocalObject::removeNavAidRadioTransmitter ( makVrf::DtNavAidRadioTransmitterStateComponent *  )
makVrf::DtRadioReceiverStateComponent* DtLocalObject::addRadioReceiver ( )
void DtLocalObject::removeRadioReceiver ( makVrf::DtRadioReceiverStateComponent *  )
makVrf::DtIffStateComponent* DtLocalObject::getOrCreateIffSystem ( )

Only one IFF available, so create or return the existing.

void DtLocalObject::removeIffSystem ( )
makVrf::DtUnderwaterAcousticsStateComponent* DtLocalObject::getOrCreateUnderwaterAcousticsSystem ( bool  isRemote = false)

Only one Underwater Acoustics available, so, create or return the existing.

void DtLocalObject::removeUnderwaterAcousticsSystem ( )
virtual void DtLocalObject::setNextFrameUnderFire ( bool  b)
virtual
virtual bool DtLocalObject::nextFrameUnderFire ( ) const
virtual
virtual void DtLocalObject::setNextFrameInvulnerable ( bool  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameInvulnerable ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameUndetectable ( bool  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameUndetectable ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameHalfLengthWidthHeight ( double  length,
double  width,
double  height 
)
virtual

Geometry.

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameObjectGeometry ( const makVrf::DtVrfObjectGeometry &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameBoundingGeometryType ( DtSimBoundingGeometry::DtSimBoundingGeometryType  type)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameBoundingVolume ( const Dt3dBoundingVolume &  b)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameHasPlan ( bool  )
virtual
virtual bool DtLocalObject::nextFrameHasPlan ( ) const
virtual
virtual void DtLocalObject::setNextFrameExecutingPlan ( bool  )
virtual
virtual bool DtLocalObject::nextFrameExecutingPlan ( ) const
virtual
virtual void DtLocalObject::setNextFrameOccupantsHidden ( bool  )
virtual
virtual bool DtLocalObject::nextFrameOccupantsHidden ( ) const
virtual
virtual std::map<DtString, DtString> DtLocalObject::nextFrameExtendedDataMap ( ) const
virtual

The extended data map. Default null map.

virtual std::map<int, DtString> DtLocalObject::nextFrameExtendedLabels ( ) const
virtual

The extended labels map. Default null map.

virtual bool DtLocalObject::nextFrameIsOnTopOf ( const DtSimObject *  o,
bool  checkSupportPoints = false 
) const
virtual
virtual bool DtLocalObject::nextFrameIsOnTopOf ( const DtSimObject *  o,
double  d,
bool  checkSupportPoints = false 
) const
virtual
DtLocalObjectDecorator* DtLocalObject::getOrCreateDecorator ( const std::string &  Decorator)

This will get or create a decorator based on the decorator name. DO NOT delete this returned pointer. This class owns the decorator.

void DtLocalObject::setLocationComplete ( )

Call this method in response to a setLocation request being complete such that it will emit the signal_setLocaltionComplete signal.

virtual void DtLocalObject::setNextFrameParameterProperties ( const DtRwProperties &  )
virtual
const DtRwProperties& DtLocalObject::nextFrameParameterProperties ( ) const
virtual const DtRwProperties& DtLocalObject::nextFrameStateProperties ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual const DtRwProperties& DtLocalObject::stateProperties ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

Referenced by DtSimComponent::cachedCurrentFrameStateProperty().

virtual void DtLocalObject::setNextFrameStateProperties ( const DtRwProperties &  )
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameFuelLevelsFrozen ( ) const
virtual

Whether or not fuel levels are frozen. Default is false.

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameMunitionLevelsFrozen ( ) const
virtual

Whether or not munition levels are frozen. Default is false.

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setSimulationCapable ( bool  )
virtual

Sets whether or not this object is simulation capable. This is a single flag so there is only the frame that is currently being executed.

bool DtLocalObject::simulationCapable ( ) const
virtual void DtLocalObject::setNextFrameBlockParachute ( bool  )
virtual

Returns true if the parachute is blocked from opening.

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::nextFrameBlockParachute ( ) const
virtual

Reimplemented in DtRemoteAttachedObject.

virtual void DtLocalObject::setNextFrameOnTerrainSurface ( bool  b)
virtual

Whether or not the object should be considered on the terrain surface. This is set such that a terrain intersection does not need to be made. If you set something to be above the terrain surface but do not call this to be false, for some operations (like fidelity of intersection) this will be considered true.

virtual bool DtLocalObject::nextFrameOnTerrainSurface ( ) const
virtual
virtual void DtLocalObject::setOperationInProgress ( int  ,
bool   
)
virtual

Call this to set a sim operation status for this object. Make sure to turn off the status when you are done, else the status will be forever no the network (until this entity is deleted)

virtual bool DtLocalObject::operationInProgress ( int  ) const
virtual

Call this to set a sim operation status for this object. Make sure to turn off the status when you are done, else the status will be forever no the network (until this entity is deleted)

virtual void DtLocalObject::clearOperationsInProgress ( )
virtual

Call this to set a sim operation status for this object. Make sure to turn off the status when you are done, else the status will be forever no the network (until this entity is deleted)

virtual bool DtLocalObject::createInternalState ( const DtVrfObjectParameters *  parameterEntry)
virtual

Object initialization and creation routines.

Creates state that is internal to this object. This state is not thread safe so should not be accessed by any object other than this object in a single thread

virtual bool DtLocalObject::setupSubComponentTypes ( )
virtual

Set up the mySubComponentTypes member with the type of sub components to use (as gathered from the myParameters, which must be set up before this call is made)

virtual bool DtLocalObject::init ( )
virtual

Initialization - must be called after create() and before any other member functions are called.

virtual bool DtLocalObject::create ( )
virtual

Virtual construction - must be called before any other member functions are called. If createNetworkInterface is false then it will not create the network interface. Do this if you want to make sure all data is present in the object before it is on the network. When it is, call createNetworkInterface.

static DtLocalObjectCreatorFcn DtLocalObject::setLocalObjectCreatorFunction ( DtLocalObjectCreatorFcn  )
static

Install own creator to create a subclass of the DtLocalObject to add functionality. Note that the functionality should be considered thread safe for any addition. If you are adding non thread-safe code unpredictable results may occur.

Sets new creator and returns old. Set to null creator to create default object

static DtLocalObjectCreatorFcn DtLocalObject::localObjectCreatorFunction ( )
static

Install own creator to create a subclass of the DtLocalObject to add functionality. Note that the functionality should be considered thread safe for any addition. If you are adding non thread-safe code unpredictable results may occur.

Sets new creator and returns old. Set to null creator to create default object

static DtLocalObject* DtLocalObject::create ( DtSimulationServices *  ,
const DtVrfLocalObjectCreateInformation &   
)
static

Install own creator to create a subclass of the DtLocalObject to add functionality. Note that the functionality should be considered thread safe for any addition. If you are adding non thread-safe code unpredictable results may occur.

Sets new creator and returns old. Set to null creator to create default object

static DtLocalObject* DtLocalObject::createAndInit ( DtSimulationServices *  ,
const DtVrfLocalObjectCreateInformation &   
)
static

Shorthand for create, calling create method on newly created object and init on newly created object.

static void DtLocalObject::readDRThresholdSettingsCallback ( const DtSettingsObject *  settings,
void *  usr 
)
static

Callback function registered with the DtVrfSimSettings class. Called by DtVrfObject::init().

virtual void DtLocalObject::processReadDRThresholdSettings ( const DtSettingsObject *  settings)
virtual

Callback function registered with the DtVrfSimSettings class. Called by DtVrfObject::init().

bool DtLocalObject::isGlobalPlan ( ) const

Returns true if this object is a global plan object.

bool DtLocalObject::isSyncMatrix ( ) const

Returns true if this object is a synchronization matrix object.

virtual int DtLocalObject::publicationFlag ( ) const
virtual

How to publish (or not) this object on the network. See DtStateData for the flags.

virtual bool DtLocalObject::isCapableOfTask ( std::string  taskName)
virtual

Returns true if the given task name is registered with its task manager.

static void DtLocalObject::enableSingleObjectMode ( )
static

Code to only allow one platform or lifeform to be created locally.

Puts VRF in "single object mode" which limits it to simulating only a single local entity or lifeform object. Note: This mode cannot be turned off once it is enabled.

static bool DtLocalObject::singleObjectModeActive ( )
static
Returns
True if VRF is current in Single Object Mode.
virtual bool DtLocalObject::convertToRemoteObject ( DtString &  error)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::convertToLocalObject ( DtString &  error,
const std::string &  archiveState 
)
virtual
virtual bool DtLocalObject::prepareForHandoff ( )
virtual
virtual std::string DtLocalObject::archiveState ( ) const
virtual
const DtObjectResourceManager* DtLocalObject::objectResourceManager ( ) const
Returns
A pointer to the DtObjectResourceManager for this object. This resource manager interacts will all the resource managers in all the systems on this object, and allows the user to find any resource no matter where it is in the system hierarchy of the object.
Note
In VR-Forces 3.10 and earlier, components accessed the resourceManager in the state repository to find out what resources were on the entity. Now, DtComponentSystem instances are responsible for managing resources, and components should interact with the resource managers in their local system. They can access this using the call DtSimComponent::resourceManager().
DtObjectResourceManager* DtLocalObject::objectResourceManager ( )
Returns
A pointer to the DtObjectResourceManager for this object. This resource manager interacts will all the resource managers in all the systems on this object, and allows the user to find any resource no matter where it is in the system hierarchy of the object.
Note
In VR-Forces 3.10 and earlier, components accessed the resourceManager in the state repository to find out what resources were on the entity. Now, DtComponentSystem instances are responsible for managing resources, and components should interact with the resource managers in their local system. They can access this using the call DtSimComponent::resourceManager().
virtual DtVrfObjectStateRepository* DtLocalObject::internalState ( )
virtual
virtual const DtVrfObjectStateRepository* DtLocalObject::internalState ( ) const
virtual
virtual void DtLocalObject::prepareForReinitialization ( )
virtual

Prepares this object for reinitialization. This means: 1) Making sure the systems are set to read only so they are not saved as part of the order of battle 2) Restarting the plan (if one) and clearing out the current task (if one and there is a plan)

DtVrfObjectSubComponentTypes* DtLocalObject::vrfSubComponentTypes ( ) const

For use in virtual construction. Casts mySubComponentTypes to derived type.

virtual void DtLocalObject::tick ( )
virtual

Ticks object's organization manager, task manager, and component manager, and then calls down to base class tick. Calls invokeVrfObjectPredicateCallbacks. Calls startTick(), tickComponents(), endTick()

virtual void DtLocalObject::startTick ( )
virtual
virtual void DtLocalObject::tickComponents ( )
virtual
virtual void DtLocalObject::endTick ( )
virtual
virtual int DtLocalObject::scenarioRunId ( ) const
virtual

The id of the scenario being run (if set). Retrieved from the sim manager.

virtual bool DtLocalObject::checkIfMoveOntoEmbarked ( const DtVector &  localPosition,
const DtSimObject *&  hit,
const std::list< DtUUID > &  additionalIgnore = std::list< DtUUID >() 
)
virtual

Check to see if there are any entities at the location given that can be moved onto for embarkation. If ther are then check to see if they are intersected. Return true if is.

virtual bool DtLocalObject::checkAndDisembarkIfEmbarked ( const DtVector &  localPosition)
virtual

Check terrain hit, and, if entity is embarked, and there is no terrain hit on parent, disembark. Will only check if embarked.

virtual bool DtLocalObject::lowFidelityDisembarkHitCheck ( const DtVector &  localPosition) const
virtual
virtual bool DtLocalObject::highFidelityDisembarkHitCheck ( const DtVector &  localPosition) const
virtual
virtual int DtLocalObject::nextEmitterSystemId ( )
virtual
virtual DtVrfObjectCommunicationInterface* DtLocalObject::communicationInterface ( )
virtual

Accessors for sub components of this object.

virtual const DtVrfObjectCommunicationInterface* DtLocalObject::communicationInterface ( ) const
virtual

Accessors for sub components of this object.

virtual DtVrfObjectTerrainPreloadManager* DtLocalObject::terrainPreloadManager ( )
virtual

Accessors for sub components of this object.

virtual DtSimRadio* DtLocalObject::radio ( ) const
virtual

Accessors for sub components of this object.

virtual DtSimTaskManager* DtLocalObject::taskManager ( ) const
virtual

Accessors for sub components of this object.

virtual DtScriptInterfaceHandler* DtLocalObject::scriptInterfaceHandler ( ) const
virtual

Accessors for sub components of this object.

virtual DtVrfObjectPlanManager* DtLocalObject::vrfObjectPlanManager ( ) const
virtual

Accessors for sub components of this object.

virtual DtSimComponentManager* DtLocalObject::componentManager ( )
virtual

Accessors for sub components of this object.

virtual const DtSimComponentManager* DtLocalObject::componentManager ( ) const
virtual

Accessors for sub components of this object.

virtual DtSetDataManager* DtLocalObject::setDataManager ( )
virtual
Returns
The DtSetDataManager for this object. Any part of the object wishing notification of a set data request should register with this manager instead of registering directly with the radio. Any set data request can be invoked on the entity by passing it into this manager.
virtual const DtSetDataManager* DtLocalObject::setDataManager ( ) const
virtual

Accessors for sub components of this object.

bool DtLocalObject::initialized ( ) const
inline
DtVrfCallbackQueue::CallbackInterface::Ptr DtLocalObject::parallelContainer ( )
inline
virtual void DtLocalObject::cleanupItemsNeededForHandoff ( )
virtual

Ownership transfer.

virtual bool DtLocalObject::recreateItemsNeededFromHandoff ( )
virtual

Ownership transfer.

static void DtLocalObject::logToFileCallback ( const DtVrfObjectMessage *  msg,
void *  usr 
)
staticprotected

Message processing callbacks (admin and interface)

virtual void DtLocalObject::processLogToFile ( const DtVrfObjectMessage *  msg)
protectedvirtual

Message processing callbacks (admin and interface)

static void DtLocalObject::stopLoggingToFileCallback ( const DtVrfObjectMessage *  msg,
void *  usr 
)
staticprotected

Message processing callbacks (admin and interface)

virtual void DtLocalObject::processStopLoggingToFile ( const DtVrfObjectMessage *  msg)
protectedvirtual

Message processing callbacks (admin and interface)

virtual void DtLocalObject::createNavigationDecorator ( )
overrideprotectedvirtual

Reimplemented from DtSimObject.

virtual void DtLocalObject::addScriptExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension,
void *  usr 
)
virtual

Extensions to lua interface for this object only.

Add a lua script extension for this entity only. The creator function passed in will be called every time a lua environment is created for this entity.

virtual void DtLocalObject::removeScriptExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension,
void *  usr 
)
virtual

Remove a lua script extension that was previously added.

virtual const ScriptInterfaceExtensions& DtLocalObject::scriptExtensions ( ) const
virtual
Returns
The current set of script extensions.
virtual void DtLocalObject::setupFromMessageContent ( const DtIfModifyVrfObject *  ifModVrfObject)
virtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::validNameLength ( const DtString &  name) const
virtual
static bool DtLocalObject::shouldArchiveExtendedAttribute ( const DtString &  s)
static
static void DtLocalObject::doNotArchiveAttribute ( const DtString &  s,
bool  b 
)
static
virtual void DtLocalObject::sendVrfObjectCreated ( unsigned long  requestId = 0,
bool  requestCreated = true 
)
virtual

Create and send a DtVrfObjectCreated message about ourself. requestId is the requestId to be used in the message (request Ids are used to link a DtIfVrfCreated message to a DtCreateVrfObject message).

virtual void DtLocalObject::setIsInMovementFlux ( bool  ,
const DtVector &  proposedLocation = DtVector::zero() 
)
virtual

Set that the object is in flux for movement.

virtual void DtLocalObject::setupStateRepository ( )
protectedvirtual
virtual void DtLocalObject::internalStateInitializedFromParameters ( )
protectedvirtual
virtual bool DtLocalObject::createCommunicationsInterface ( )
protectedvirtual
Returns
The DtVrfObjectCommunicationInterface for this object. This is the central point for all processing of messages to/from this object, whether they are though a radio or though the internal communication mechanism of VR-Forces.
virtual void DtLocalObject::initializeCommunicationInterfaceCallbacks ( )
protectedvirtual
static void DtLocalObject::setOverlayLayerTaskCallback ( const DtVrfObjectMessage *  msg,
void *  usr 
)
staticprotected
virtual void DtLocalObject::processSetOverlayLayerTask ( const DtVrfObjectMessage *  msg)
protectedvirtual
virtual bool DtLocalObject::createScriptInterfaceHandler ( )
protectedvirtual
virtual bool DtLocalObject::createComponentManager ( )
protectedvirtual
virtual bool DtLocalObject::initializeComponentManager ( )
protectedvirtual

Initialize component manager that has been created. Only call once!

virtual bool DtLocalObject::createRadio ( )
protectedvirtual
virtual bool DtLocalObject::createVrfObjectPlanManager ( )
protectedvirtual
virtual bool DtLocalObject::createSetDataManager ( )
protectedvirtual
virtual void DtLocalObject::tickDecorators ( )
protectedvirtual
void DtLocalObject::createRemotelyControlledLocalObject ( )
protected

Non virtual as this is called from the constructor.

virtual void DtLocalObject::completeSetup ( )
overrideprotectedvirtual

Reimplemented from DtSimObject.

virtual bool DtLocalObject::createTaskManager ( )
protectedvirtual
virtual void DtLocalObject::createCommunicationsInterface ( const DtRadioDescriptorList &  descList)
protectedvirtual

Allows an external process to invoke creation of a communications interface, if myCommunicationInterface is NULL, and pass a radio descriptor list.

virtual void DtLocalObject::updateEntityHasTarget ( )
protectedvirtual

If this is a platform (non environmental or unit), will check to see if this entity has a target and update the DtEntityHasTarget keyword appropriately.

void DtLocalObject::setUUID ( const DtUUID &  )
overrideprotectedvirtual

Protected as this will not be used in the future – only used as part of DtVrfObject.

Reimplemented from DtSimObject.

virtual void DtLocalObject::convertedToRemote ( )
protectedvirtual
virtual std::map<DtString, DtString> DtLocalObject::unarchivedData ( )
protectedvirtual

Extended data that is not archived that is currently in the extended data list.

virtual void DtLocalObject::clearDecorators ( )
overrideprotectedvirtual

This code will keep track of DtSimObject decorator only. The DtLocalObject will be able to use this decorator, however, it will also keep a "next frame" decorator for the decorator that only works on DtLocalObject.

Reimplemented from DtSimObject.

virtual void DtLocalObject::usingParameterSource ( const DtString &  )
overrideprotectedvirtual

Called when the parameter is set up, this is the source it is using.

Reimplemented from DtSimObject.

virtual void DtLocalObject::setupVrfObjectParameters ( )
overrideprotectedvirtual

Will use next frame rather than current frame data.

Reimplemented from DtSimObject.

void DtLocalObject::cacheNextFrameComponents ( )
protected
void DtLocalObject::clearNextFrameCachedComponents ( )
protected
virtual void DtLocalObject::hostChanged ( const DtUUID &  oldHost,
const DtUUID &  newHost 
)
overrideprotectedvirtual

Reimplemented from DtSimObject.

virtual void DtLocalObject::isClutterChanged ( )
overrideprotectedvirtual

Reimplemented from DtSimObject.

virtual void DtLocalObject::setupExtendedDataFromParameterData ( )
protectedvirtual

Reimplemented in DtRemoteAttachedObject.

virtual bool DtLocalObject::canBePlaced ( ) const
protectedvirtual

Returns true if the object can be placed. Defaults to true unless overridden in a subclass.

Reimplemented in DtRemoteAttachedObject.

DtLocalObject& DtLocalObject::operator= ( const DtLocalObject &  orig)
protected

assignment operator

VRF4API_METHOD DtVrfObjectStateRepository* DtLocalObject::vrfState ( )
inline

These are backwards compatible methods that can be used if you define ALLOW_VRF4API in your header file.

VRF4API_METHOD const DtVrfObjectStateRepository* DtLocalObject::vrfState ( ) const
inline

These are backwards compatible methods that can be used if you define ALLOW_VRF4API in your header file.

VRF4API_METHOD void DtLocalObject::setObjectIdentifier ( const DtEntityIdentifier &  id)
inline

These are backwards compatible methods that can be used if you define ALLOW_VRF4API in your header file.

VRF4API_METHOD void DtLocalObject::place ( const DtReal  heading,
bool *  dataAvailable = 0,
bool  requireAllData = false 
)

These are backwards compatible methods that can be used if you define ALLOW_VRF4API in your header file.

VRF4API_METHOD void DtLocalObject::place ( const DtVector &  heading,
bool *  dataAvailable = 0,
bool  requireAllData = false 
)

These are backwards compatible methods that can be used if you define ALLOW_VRF4API in your header file.

VRF4API_METHOD bool DtLocalObject::isVrfSimulated ( ) const
inline

These are backwards compatible methods that can be used if you define ALLOW_VRF4API in your header file.

VRF4API_METHOD void DtLocalObject::invokeSetLocationCompleteCallbacks ( )
inline

These are backwards compatible methods that can be used if you define ALLOW_VRF4API in your header file.

Friends And Related Function Documentation

friend class DtVrfObjectStateRepository
friend

Member Data Documentation

boost::signals2::signal<void ()> DtLocalObject::signal_preUpgradeFromImport

Signal sent when upgrading from import. This will be called before any internal routines are called.

boost::signals2::signal<void ()> DtLocalObject::signal_postUpgradeFromImport

Signal sent when upgrading from import. This will be called after any internal routines are called.

boost::signals2::signal<void ()> DtLocalObject::signal_objectInitialized

Signal sent at the very end of the init() method.

boost::signals2::signal<void ()> DtLocalObject::signal_objectRestored

Signal sent after the object has been restored from the stream.

boost::signals2::signal<void (DtLocalObject*)> DtLocalObject::signal_objectModifiedViaMessage

Signal sent when this object is modified via a message.

boost::signals2::signal<void (DtLocalObject*)> DtLocalObject::signal_newSensorContact

Signal made available from this object to be used when a new sensor contact is made available for this object.

boost::signals2::signal<void (DtLocalObject*)> DtLocalObject::signal_navigationAreaChanged

Signal made available from this object to be used when the navigation area this object is in has changed.

boost::signals2::signal<void (DtLocalObject*)> DtLocalObject::signal_setLocationComplete

Signal sent when the location has been changed by an interface content message.

boost::signals2::signal<void ()> DtLocalObject::signal_restored

Signal emitted when the object has been restored.

boost::signals2::signal<void (const DtLocalObject*, ChangeFlag)> DtLocalObject::signal_objectDataChanged
mutable

Signal sent when certain data has changed in this class from being set by the API, not from the network.

boost::signals2::signal<void(const DtLocalObject*)> DtLocalObject::signal_localObjectAboutToBeDeleted

Signal sent when a local object is about to be deleted.

boost::signals2::signal<void (DtLocalObject*, DtVrfObjectHandoffData::HandoffFlag)> DtLocalObject::signal_handoffStep

Signal sent with object handoff flags for this object given the handoff state.

boost::signals2::signal<void (DtLocalObject*, DtVrfObjectHandoffData&)> DtLocalObject::signal_prepareForHandoff

Signal sent in preparing for handoff. Set the handoffFlag to Abort if this item should not be handed off.

boost::signals2::signal<void (DtLocalObject*)> DtLocalObject::signal_postInitFromParams

Signal sent right after the internal state is initialized from parameters.

DtVrfObjectStateRepository* DtLocalObject::myInternalState
protected
DtVrfObjectSubComponentTypes* DtLocalObject::mySubComponentTypes
protected
makVrf::DtExternalNextFrameState* DtLocalObject::myExternalNextFrameState
protected
DtVrfObjectCommunicationInterface* DtLocalObject::myCommunicationInterface
protected
DtVrfObjectTerrainPreloadManager* DtLocalObject::myTerrainPreloadManager
protected
DtSimRadio* DtLocalObject::myRadio
protected
DtSimTaskManager* DtLocalObject::myTaskManager
protected
DtScriptInterfaceHandler* DtLocalObject::myScriptInterfaceHandler
protected
DtSimComponentManager* DtLocalObject::myComponentManager
protected
DtVrfObjectPlanManager* DtLocalObject::myVrfObjectPlanManager
protected
DtSetDataManager* DtLocalObject::mySetDataManager
protected
bool DtLocalObject::myCreatedStateData
protected
LocalObjectDecorators DtLocalObject::myLocalObjectDecorators
protected

Decorator members.

boost::signals2::scoped_connection DtLocalObject::myConvertedToRemoteConnection
protected
DtLocalObjectCreatorFcn DtLocalObject::theLocalObjectCreatorFunction
staticprotected
DtVrfLocalObjectCreateInformation* DtLocalObject::myLocalObjectCreateInformation
protected

Information used to originally create this object.

bool DtLocalObject::myInitializing
protected
bool DtLocalObject::myInitialized
protected
int DtLocalObject::myNextEmitterSystemId
protected
std::set<DtString> DtLocalObject::theDoNotArchiveAttributes
staticprotected
DtAppearanceLocalObjectFacade* DtLocalObject::myAppearanceLocalObjectFacade
protected
ScriptInterfaceExtensions DtLocalObject::myScriptInterfaceExtensions
protected
bool DtLocalObject::myConverting
protected

Will be true if this object is in the process of converting from remote to local.

bool DtLocalObject::mySimulationCapable
protected

Whether or not this object is capable of simulating. Default is true.

bool DtLocalObject::myHasTarget
protected
bool DtLocalObject::myControllersTicked
protected
bool DtLocalObject::mySkipNextComponentTick
protected
bool DtLocalObject::mySignalLocationComplete
protected
bool DtLocalObject::myIsEnvironmental = false
protected
DtRwProperties* DtLocalObject::myDefaultStateProperties
mutableprotected
makVrf::DtLocationStateComponent* DtLocalObject::myNextFrameLocationStateComponent
protected

Only set if there is no state properties state component.

makVrf::DtSimulatedObjectStateComponent* DtLocalObject::myNextFrameSimulatedObjectStateComponent
protected
makVrf::DtVrfGeometryStateComponent* DtLocalObject::myNextFrameVrfGeometryStateComponent
protected
makVrf::DtVrfStateComponent* DtLocalObject::myNextFrameVrfStateComponent
protected
makVrf::DtStatePropertiesStateComponent* DtLocalObject::myNextFrameStatePropertiesStateComponent
protected
const makVrf::DtStatePropertiesStateComponent* DtLocalObject::myCurrentFrameStatePropertiesStateComponent
protected
DtSimObjectReference DtLocalObject::myNextFrameSimObjectEmbarkedOn
protected
DtMovementLocalObjectFacade* DtLocalObject::myMovementLocalObjectFacade
protected
OperationsInProgressCount DtLocalObject::myOperationsInProgressCount
protected
int DtLocalObject::myFluxIndex = -1
protected

If there is something pending for a database operation (like movement), this is the index in the update structure the object is holding such that when data becomes available it can be removed.

DtVrfCallbackQueue::CallbackInterface::Ptr DtLocalObject::myParallelContainer
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)