Represents a single simulation object in the exercise. Object may be VRF simulation, or non-VRF simulated, and may be simulated by the local sim engine, or by a remote sim engine. Only public (external) state of the object is available. All data is read-only. All access to data of the object is thread safe within the simulation frame.

Related Examples

Scenario Metrics

Inheritance diagram for DtSimObject:

[legend]

Classes
struct	ExtentInformation

Public Member Functions
	DtSimObject (const DtSimulationServices simManager, makVrf::DtStateData sd)

	DtSimObject (const DtSimulationServices *simManager, const DtUUID &uuid)

	DtSimObject (const DtSimulationServices *simManager, const DtEntityIdentifier &id)

	DtSimObject (const DtSimulationServices simManager, const makVrf::DtExternalCurrentFrameState )

virtual	~DtSimObject () override

virtual Dt3dBoundingVolume	boundingVolume () const override

DtVector	localBoundingVolumeCenterPosition () const

DtExtent	extent () const

DtExtent	roughExtent () const

void	expandExtent (DtExtent &extent) 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

virtual DtVrfLocalObjectCreateInformation	vrfLocalObjectCreateInformation () const

virtual void	makeInvalid () override

const DtSimulationServices *	simulationServices () const

const DtVrfObjectParameters *	parameters () const

DtVrfObjectParameters *	duplicateParameters ()

double	totalMass () const

const Coordinate_System *	coordinateSystem () 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

DtSimObjectReference	superior () const

virtual void	superiorChanged () override

const DtSimObjectReferenceList &	attachments () const

bool	isTopLevel () const

MAKVRinTerra::DtFeatureGeometry	featureGeometry () const

const DtAttachedTerrain *	terrainAttachedTo () const


double	distSquaredTo (const DtVector &) const

virtual void	frameAdvanced () override

virtual bool	isLocal () const

const DtPlatformSimObjectFacade &	platformSimObjectFacade () const

const DtVrfSimulatedSimObjectFacade &	vrfSimulatedSimObjectFacade () const

bool	embarkedOnHighFidelityObject () const

DtSimObjectReference	simObjectEmbarkedOn () const


virtual void	clearDecorators ()

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

Public Member Functions inherited from makVrf::DtStateDataWrapper
	DtStateDataWrapper ()

	DtStateDataWrapper (const DtStateDataManager *simManager, const DtUUID &uuid)

	DtStateDataWrapper (const DtStateDataManager *simManager, const DtEntityIdentifier &id)

	DtStateDataWrapper (const DtStateDataManager simManager, const DtExternalCurrentFrameState )

	DtStateDataWrapper (const DtStateData *sd)

virtual	~DtStateDataWrapper ()

DtStateDataWrapper &	operator= (const DtUUID &)

DtStateDataWrapper &	operator= (const DtStateDataWrapper &rhs)

bool	operator== (const DtUUID &rhs) const

bool	operator== (const DtStateDataWrapper &rhs) const

bool	operator!= (const DtUUID &rhs) const

bool	operator!= (const DtStateDataWrapper &rhs) const

const DtUUID &	uuid () const

const DtString &	objectName () const

DtString	label () const

DtEntityType	entityType () const

DtEntityType	objectType () const

unsigned long long	userData () const

const DtString &	extendedData (const DtString &key) const

std::map< DtString, DtString >	extendedDataMap () const

std::map< std::string, std::string >	extendedDataStdStringMap () const

bool	hasExtendedData (const DtString &key) const

DtString	overlay () const

DtAppearance	appearance () const

int	capabilities () const

DtEntityType	guise () const

const DtRwProperties &	stateProperties () const

bool	isClutterEntity () const

DtVrfObjectGeometry	objectGeometry () const

const DtIffStateComponent *	iffStateComponent () const

std::vector< const DtLaserDesignatorStateComponent * >	laserDesignatorStateComponents () const

DtString	awaiting () const

bool	isSpotReport () const

bool	isTDLReport () const

bool	awaitingTransfer () const

bool	isModified () 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

DtSimulationAddress	simEngineAddress () const

bool	isDestroyed () const

int	damageState () const

const DtString &	globalId () const

bool	isEntityOrUnit () const

bool	isSimulatedObject () const

bool	isEntity () const

bool	isValid () const

int	sessionId () const

bool	isVrfSimulatedObject () const

bool	isCurrentlyTasked () const

bool	isExecutingPlan () const

bool	hasPlan () const

bool	independentlyTasked () const

bool	underFire () const

DtString	rulesOfEngagement () const

DtEchelonId	echelonId () const

bool	isDeleted () const

const DtLocalVertexList &	localVertices () const

std::vector< DtVector >	localVertexList () const

const DtVertexList &	worldVertices () const

std::vector< DtVector >	worldVertexList () const

const DtLocalVertexList &	relativeVertices () const

std::vector< DtVector >	relativeVertexList () const

unsigned long long	legionGlobalId () const

bool	advancedFrame () const

DtUUID	superiorUUID () const

bool	isTopLevel () const

const DtExternalFrameStateInterface *	externalCurrentFrameState () const

const DtSimulatedObjectStateComponent *	currentFrameSimulatedObjectStateComponent () const

const DtLocationStateComponent *	currentFrameLocationStateComponent () const

const DtStatePropertiesStateComponent *	currentFrameStatePropertiesStateComponent () const

const DtVrfGeometryStateComponent *	currentFrameVrfGeometryStateComponent () const

const DtEntityStateComponent *	currentFrameEntityStateComponent () const

const DtVrfStateComponent *	currentFrameVrfStateComponent () const

std::set< int >	currentFrameModifiedStateComponentTypes () const

std::set< int >	nextFrameModifiedStateComponentTypes () const

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	firstFrameAdvance ()

const DtStateData *	stateData () const

DtUUID	hostGlobalId () const

DtString	parentGlobalId () const

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

DtUUID	embarkedOn () const

bool	isEmbarkedOn (const DtUUID &) const

Protected Member Functions
void	tickDecorators ()

virtual void	createNavigationDecorator ()

virtual void	setupVrfObjectParameters ()

virtual void	setUUID (const DtUUID &) override

bool	checkAndConnectForVrfStateComponent ()

void	attachmentsChanged ()

virtual void	completeSetup () override

virtual void	hostChanged (const DtUUID &oldHost, const DtUUID &newHost)

virtual void	usingParameterSource (const DtString &)

virtual void	stateDataAdded (makVrf::DtStateData *sd) override

Protected Member Functions inherited from makVrf::DtStateDataWrapper
virtual const DtStateData *	stateDataFor (const DtUUID &uuid) const

virtual void	cacheComponents ()

virtual void	clearCachedComponents ()

bool	checkAndConnectForVrfStateComponent ()

void	uuidChanged (const DtUUID &, const DtUUID &)

virtual void	objectNameChanged (const DtString &oldText, const DtString &newText)

virtual void	extendedDataUpdated ()

virtual void	isClutterChanged ()

virtual void	externalFrameStateToBeDestroyed ()

virtual void	slot_stateComponentAdded (DtStateComponent *)

virtual void	slot_stateComponentRemoved (DtStateComponent *)

virtual void	simEngineAddressChanged (const DtSimulationAddress &oldAddress, const DtSimulationAddress &newAddress)

Protected Attributes
const DtSimulationServices *	mySimulationServices

ExtentInformation	myExtentInformation

DtNavigationSimObjectDecorator *	myNavigationSimDecorator = nullptr

const DtVrfObjectParameters *	myParameters

DtVrfObjectParameters *	myDuplicateParameters

DtSimObjectReferenceList *	myAttachments

boost::signals2::scoped_connection	myAttachmentsChangedConnection

boost::signals2::scoped_connection	myHostChangedConnection

DtSimObjectReference	mySuperior

DtSimObjectReference	mySimObjectReference

tbb::spin_rw_mutex	mySimObjectReferenceMutex

DtAttachedTerrain *	myTerrainAttachedTo

DtAggregateSimObjectFacade *	myAggregateSimObjectFacade

DtPlatformSimObjectFacade *	myPlatformSimObjectFacade

DtVrfSimulatedSimObjectFacade *	myVrfSimulatedSimObjectFacade

Protected Attributes inherited from makVrf::DtStateDataWrapper
const DtExternalFrameStateInterface *	myExternalCurrentFrameState

boost::signals2::scoped_connection	myStateComponentAddedConnection

boost::signals2::scoped_connection	myStateComponentRemovedConnection

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

boost::signals2::scoped_connection	mySimEngineAddressChangedConnection

DtString	myAwaiting

DtUUID	myUUID

unsigned long long	myLegionGlobalId

bool	myIsDeleted

DtString	myObjectName

DtEntityType	myEntityType

DtUUID	mySuperiorUUID

bool	myAdvancedFrame

tbb::spin_rw_mutex	myExternalCurrentFrameStateMutex

DtUUID	myEmbarkedOn

const DtSimulatedObjectStateComponent *	myCurrentFrameSimulatedObjectStateComponent

const DtVrfStateComponent *	myCurrentFrameVrfStateComponent

const DtEntityStateComponent *	myCurrentFrameEntityStateComponent

const DtLocationStateComponent *	myCurrentFrameLocationStateComponent

const DtVrfGeometryStateComponent *	myCurrentFrameVrfGeometryStateComponent

const DtStatePropertiesStateComponent *	myCurrentFrameStatePropertiesStateComponent

bool	myCachedComponents

const DtStateData *	myStateData = nullptr

const DtStateDataManager *	myStateDataManager

Private Member Functions
	DtSimObject ()

	DtSimObject (const DtSimObject &)

void	resetUUID (const DtUUID &)

Friends
class	DtSimObjectManager

typedef std::map< std::string, DtSimObjectDecorator * >	SimObjectDecorators

SimObjectDecorators	mySimObjectDecorators

tbb::spin_rw_mutex	mySimObjectDecoratorMutex

Additional Inherited Members
Public Attributes inherited from makVrf::DtStateDataWrapper
boost::signals2::signal< void()>	signal_objectVerticesChanged

boost::signals2::signal< void()>	signal_extendedDataUpdated

boost::signals2::signal< void()>	signal_simObjectDeleted

boost::signals2::signal< void(const DtString &)>	signal_discoveredReference

boost::signals2::signal< void(const DtUUID &oldUUID, const DtUUID &newUUID)>	signal_uuidChanged

boost::signals2::signal< void(const DtSimulationAddress &oldAddr, const DtSimulationAddress &newAddr)>	signal_simEngineAddressChanged

boost::signals2::signal< void(const DtString &oldName, const DtString &newName)>	signal_objectRenamed

boost::signals2::signal< void(const DtUUID &oldSuperior, const DtUUID &newSuperior)>	signal_superiorChanged

boost::signals2::signal< void()>	signal_isClutterChanged

boost::signals2::signal< void(DtStateComponent *)>	signal_stateComponentAdded

boost::signals2::signal< void(DtStateComponent *)>	signal_stateComponentRemoved

boost::signals2::signal< void()>	signal_advancedFrame

boost::signals2::signal< void()>	signal_firstFrameAdvance

Member Typedef Documentation

typedef std::map<std::string, DtSimObjectDecorator*> DtSimObject::SimObjectDecorators

protected

Decorator members.

Constructor & Destructor Documentation

DtSimObject::DtSimObject ( )

private

Creates an empty (invalid) object.

DtSimObject::DtSimObject ( const DtSimObject & )

private

DtSimObject::DtSimObject	(	const DtSimulationServices *	simManager,
		makVrf::DtStateData *	sd
	)

explicit

CTOR – Even though this takes a state data it will not keep a reference to that state data. It is only used to keep the pointer to the current frame state.

DtSimObject::DtSimObject	(	const DtSimulationServices *	simManager,
		const DtUUID &	uuid
	)

explicit

DtSimObject::DtSimObject	(	const DtSimulationServices *	simManager,
		const DtEntityIdentifier &	id
	)

explicit

DtSimObject::DtSimObject	(	const DtSimulationServices *	simManager,
		const makVrf::DtExternalCurrentFrameState *
	)

explicit

virtual DtSimObject::~DtSimObject ( )

overridevirtual

DTOR.

Member Function Documentation

virtual Dt3dBoundingVolume DtSimObject::boundingVolume ( ) const

overridevirtual

Geometry.

Reimplemented from makVrf::DtStateDataWrapper.

DtVector DtSimObject::localBoundingVolumeCenterPosition ( ) const

DtExtent DtSimObject::extent ( ) const

DtExtent DtSimObject::roughExtent ( ) const

Little bit bigger bounding box than extent() might give.

void DtSimObject::expandExtent ( DtExtent & extent ) const

double DtSimObject::distSquaredTo ( const DtVector & ) const

TSP information Position.

virtual void DtSimObject::frameAdvanced ( )

overridevirtual

TSP information Position.

Reimplemented from makVrf::DtStateDataWrapper.

virtual bool DtSimObject::isLocal ( ) const

virtual

Returns true if this object is a locally simulated object.

Reimplemented in DtLocalObject.

const DtPlatformSimObjectFacade& DtSimObject::platformSimObjectFacade ( ) const

Convenience return. Check for nullptr as this is only valid after the first advance frame of this object.

const DtVrfSimulatedSimObjectFacade& DtSimObject::vrfSimulatedSimObjectFacade ( ) const

Convenience return. Check for nullptr as this is only valid after the first advance frame of this object.

bool DtSimObject::embarkedOnHighFidelityObject ( ) const

TSP information Position.

DtSimObjectReference DtSimObject::simObjectEmbarkedOn ( ) const

If embarked, the parent this object is embarked on.

bool DtSimObject::isOnTopOf ( const DtSimObject * o ) const

bool DtSimObject::isOnTopOf	(	const DtSimObject *	o,
		double	d
	)		const

Calls isOnTopOf with localPosition()

bool DtSimObject::isOnTopOf	(	const DtSimObject *	o,
		double	d,
		const DtVector &	position
	)		const

virtual DtVrfLocalObjectCreateInformation DtSimObject::vrfLocalObjectCreateInformation ( ) const

virtual

Enough information to create an object list this as a local object.

virtual void DtSimObject::makeInvalid ( )

overridevirtual

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

Reimplemented from makVrf::DtStateDataWrapper.

Reimplemented in DtLocalObject.

const DtSimulationServices* DtSimObject::simulationServices ( ) const

inline

const DtVrfObjectParameters* DtSimObject::parameters ( ) const

inline

VR-Forces parameters.

DtVrfObjectParameters* DtSimObject::duplicateParameters ( )

This call is not thread safe. Only call outside of component ticks when you want do duplicate the parameters to be able to modify them for this object only. This is used by the remote attachment system. Once created this will replace the myParameters.

double DtSimObject::totalMass ( ) const

Will look up unit specific data for mass.

const Coordinate_System* DtSimObject::coordinateSystem ( ) const

DtVector DtSimObject::locationRelativeTo	(	const DtVector &	,
		const DtSimObject *	relativeTo
	)		const

Given the local position vector, return a location that is relative to this entity given that position (in parent coordinates)

DtVector DtSimObject::velocityRelativeTo	(	const DtVector &	,
		const DtSimObject *	relativeTo
	)		const

Given the local velocity vector, return a velocity that is relative to this entity given that velocity (in parent coordinates)

DtVector DtSimObject::accelerationRelativeTo	(	const DtVector &	,
		const DtSimObject *	relativeTo
	)		const

Given the local acceleration vector, return an acceleration that is relative to this entity given that acceleration (in parent coordinates)

DtTaitBryan DtSimObject::orientationRelativeTo	(	const DtTaitBryan &	,
		const DtSimObject *	relativeTo
	)		const

Given the local orientation vector, return an orientation that is relative to this entity given that orientation (in parent coordinates)

const DtRwProperties& DtSimObject::parameterProperties ( ) const

Since this is a function of the object parameters, this will always return a value whether or not this is vrf simulated.

double DtSimObject::distanceToLocalVector ( const DtVector & ) const

Returns the distance from this objects local distance to the given local vector.

DtSimObjectReference DtSimObject::simObjectReference ( ) const

Returns the original instance to this state data by looking up the legion global id in the state data manager.

DtSimObjectReference DtSimObject::superior ( ) const

virtual void DtSimObject::superiorChanged ( )

overridevirtual

Reimplemented from makVrf::DtStateDataWrapper.

const DtSimObjectReferenceList& DtSimObject::attachments ( ) const

bool DtSimObject::isTopLevel ( ) const

Convenience method to see if this is a top level object. It is if it is local and the entity type is DtTopLevelEntityType.

MAKVRinTerra::DtFeatureGeometry DtSimObject::featureGeometry ( ) const

Compute DtFeatureGeometry representation of object geometry.

const DtAttachedTerrain* DtSimObject::terrainAttachedTo ( ) const

virtual void DtSimObject::clearDecorators ( )

virtual

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 in DtLocalObject.

DtSimObjectDecorator* DtSimObject::getOrCreateDecorator ( const std::string & Decorator ) const

This will get or create a decorator based on the decorator name. This is not virtual such that the DtLocalObject can implement its own version. DO NOT delete this returned pointer. This class owns the decorator.

void DtSimObject::tickDecorators ( )

protected

virtual void DtSimObject::createNavigationDecorator ( )

protectedvirtual

Reimplemented in DtLocalObject.

virtual void DtSimObject::setupVrfObjectParameters ( )

protectedvirtual

Reimplemented in DtLocalObject.

virtual void DtSimObject::setUUID ( const DtUUID & )

overrideprotectedvirtual

Reimplemented from makVrf::DtStateDataWrapper.

Reimplemented in DtLocalObject.

bool DtSimObject::checkAndConnectForVrfStateComponent ( )

protected

void DtSimObject::attachmentsChanged ( )

protected

virtual void DtSimObject::completeSetup ( )

overrideprotectedvirtual

Reimplemented from makVrf::DtStateDataWrapper.

Reimplemented in DtLocalObject.

virtual void DtSimObject::hostChanged	(	const DtUUID &	oldHost,
		const DtUUID &	newHost
	)

protectedvirtual

Reimplemented in DtLocalObject.

virtual void DtSimObject::usingParameterSource ( const DtString & )

protectedvirtual

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

Reimplemented in DtLocalObject.

virtual void DtSimObject::stateDataAdded ( makVrf::DtStateData * sd )

overrideprotectedvirtual

Reimplemented from makVrf::DtStateDataWrapper.

void DtSimObject::resetUUID ( const DtUUID & )

private

Called only when the original UUID has changed. If this already has a pointer to the external state will only set the new UUID, else it will try and look up the new data. This is not thread safe, so, make sure to only call in a way that you know will not cause threading issues.

VRF4API_METHOD const DtSimObject* DtSimObject::vrfState ( )