DtScriptedMovementController Class Reference

This controller will process the scripted movement message to move the object along the scripted path.

Inheritance diagram for DtScriptedMovementController:

Public Member Functions
	DtScriptedMovementController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtScriptedMovementController () override
virtual bool	init () override
virtual bool	createPSR ()
virtual const char *	type () const override
virtual void	tick () override
virtual void	setDesiredLocation (const DtVector &)
virtual void	setDesiredSpeed (const DtVector &velocity, const DtVector &acceleration)
virtual void	setDesiredRotationalVelocity (const DtVector &)
virtual void	setDesiredOrientation (const DtTaitBryan &)
virtual void	clearTask () override
virtual DtScriptedMovementControllerPSR *	getPSR ()
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtSingleTaskControllerComponent () override
virtual void	postTick () override
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState) override
virtual void	taskNotify (const DtSimTask &task) override
virtual void	taskComplete (bool success=true)
virtual void	suspendTask ()
virtual int	sendSubtask (DtSimTask &task)
virtual void	clearSubtask (int subtaskId)
virtual void	addPendingSubtaskId (int subtaskId)
virtual bool	findPendingSubtaskId (int subtaskId)
virtual bool	isSubtasked () const
virtual void	removePendingSubtaskId (int subtaskId)
virtual void	removeAllPendingSubtaskIds ()
virtual std::vector< int >	currentPendingSubstaskIds () const
virtual DtSubtaskStatusEntry *	subtaskStatus (int subtaskId)
virtual void	clearCurrentTaskMessage ()
virtual DtTaskMessage *	currentTaskMessage () const
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
virtual void	giveUpTask ()
virtual bool	taskActive (int taskId) const override
virtual bool	clearTopLevelTasks () override
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType) override
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType) override
virtual void	clearTaskById (int taskId) override
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId) override
virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId) override
virtual std::list < DtTaskMessage * >	currentTaskMessages () const override
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override
virtual void	disable () override
virtual void	updateImgui () override
virtual void	initializeTaskInformationStateProperty (const DtSimTaskMessageType &taskType)
virtual void	updateCurrentTaskInformationStatusProperty (const DtString &status)
virtual DtString	taskInformationStatusPropertyValue (const DtSimTaskMessageType &taskType) const
virtual DtString	currentTaskInformationStatusPropertyValue () const
virtual DtRwPropertiesStructure *	taskInformationProperty (const DtSimTaskMessageType &taskType)
virtual DtRwPropertiesStructure *	currentTaskInformationProperty ()
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtTaskControllerComponent () override
virtual AcceptLevel	acceptTask (const DtTaskMessage &task)
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio) override
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
virtual void	enable () override
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
virtual bool	taskVisualizationsActive () const override
virtual void	setTasked (bool tasked)
virtual bool	tasked () const
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtControllerComponent () override
virtual bool	postAddComponentsInit () override
virtual DtSimRadio *	radio ()
virtual void	enableTaskTypes ()
virtual void	enableScriptedTask (const DtString &scriptId)
virtual void	disableTaskTypes ()
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent () override
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual void	registerAttributeFunctions ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)
virtual void	setupFirstTickTime ()
virtual void	setEntity (DtLocalObject *entity)
virtual DtSimComponent *	nextComponent ()
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual void	addInputPort (DtInputPort *port)
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
virtual DtList	inputPortList () const
virtual void	addOutputPort (DtOutputPort *port)
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
virtual DtList	outputPortList () const
virtual void	addInputPortGroup (DtInputPortGroup *group)
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
virtual DtList	inputPortGroupList () const
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
virtual DtList	outputPortGroupList () const
virtual int	priority () const
virtual void	setPriority (int priority)
double	dT () const
virtual void	setDT (double deltaT)
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual const DtSymbolString &	componentFullName () const
DtPhysicalWorld *	physicalWorld ()
const DtPhysicalWorld *	physicalWorld () const
const DtAttachedTerrain *	terrainAttachedTo () const
DtLocalObject *	entity ()
const DtLocalObject *	entity () const
DtSimulationServices *	simulationServices ()
const DtSimulationServices *	simulationServices () const
const Coordinate_System *	coordinateSystem () const
virtual void	isClutterChanged ()
virtual bool	taskVisualizationsEnabled () const
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual bool	debugActive () const
virtual bool	isEnabled ()
virtual void	setIsEnabled (bool yesNo)
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
virtual int	notifyLevel () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
VRF4API_METHOD const DtSimulationServices *	simManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static DtReaderWriter *	provideAnimationFrame (void *controller)
Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskState)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	registerTaskMsgCallbacks () override
virtual void	processScriptedMovementTask (DtSimMessage *msg)
virtual void	preFirstTickInit () override
virtual bool	setup ()
virtual makVrfEvents::DtFireEvent *	createFireInteraction ()
virtual void	finishUp ()
virtual void	sendDetonation ()
virtual int	detonationResultFromDistance (double d, const DtVector &detonationPosition, const DtEntityType &targetType) const
virtual bool	createPortGroups () override
virtual bool	createPorts () override
virtual bool	createNegateSpeedPort ()
virtual bool	tickWhileDestroyed () const override
virtual void	setupInitialState ()
virtual void	updateTaskVisualizations () override
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
virtual void	cleanupInactiveSubtaskStatus ()
Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	DtControllerComponent (const DtControllerComponent &orig)
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
virtual void	onRestore () override
virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
virtual void	sendCapableSetsAndTasks ()
Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)
virtual double	computeCurrentTime ()
bool	testInvariant () const
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
virtual void	destroyTaskVisualizations ()
virtual void	destroyTaskVisualization (const DtString &name)
virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
double	calculateNextTaskVisTickTime () const
DtVrfObjectStateRepository *	localStateRepository ()
const DtVrfObjectStateRepository *	localStateRepository () const
DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)
template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)
const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const
template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const
void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
void	invokeSimObjectPredicateCallbacks ()
virtual void	clearPredicateCallbacks ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Member Functions
static void	scriptedMovementTaskCallback (DtSimMessage *msg, void *usr)

Protected Attributes
DtScriptedMovementControllerPSR *	myProcessState
DtSimObjectReference	myTargetPoint
bool	myInitialized
DtUpdateRepositoryOutputPortGroup *	myUpdateRepositoryOutputPortGroup
DtBooleanOutputPort *	myNegateSpeedPort
bool	myCompleteNextTick
DtMovementLocalObjectFacade	myMovementLocalObjectFacade
Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap
std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
bool	myTaskIsRunning
Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
bool	myTaskTypesEnabled
bool	myInitialized
Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity
DtComponentSystem *	mySystem
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myLastTickSimTime
std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager *	myPredicateCallbackManager
boost::signals2::scoped_connection	myIsClutterChangedConnection
bool	myLocalDebug
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Private Member Functions
	DtScriptedMovementController ()
	DtScriptedMovementController (const DtScriptedMovementController &orig)
DtScriptedMovementController &	operator= (const DtScriptedMovementController &orig)
virtual void	processAnimatedMovementTask (DtSimMessage *msg)
static void	animatedMovementTaskCallback (DtSimMessage *msg, void *usr)

Additional Inherited Members
Public Types inherited from DtTaskControllerComponent
enum	AcceptLevel { AcceptLevel_Accept = 0, AcceptLevel_Partial = 1, AcceptLevel_Error = 2, AcceptLevel_NoAccept = 99 }
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Public Attributes inherited from DtSingleTaskControllerComponent
const DtString	TaskStatusRunning = "TaskRunning"
const DtString	TaskStatusNotActive = "TaskNotActive"
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtScriptedMovementController::DtScriptedMovementController ( )

private

DtScriptedMovementController::DtScriptedMovementController ( const DtScriptedMovementController &  orig )

private

DtScriptedMovementController::DtScriptedMovementController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = NULL,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtScriptedMovementController::~DtScriptedMovementController ( )

overridevirtual

Member Function Documentation

DtScriptedMovementController& DtScriptedMovementController::operator= ( const DtScriptedMovementController &  orig )

private

virtual bool DtScriptedMovementController::init ( )

overridevirtual

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual bool DtScriptedMovementController::createPSR ( )

virtual

virtual const char* DtScriptedMovementController::type ( ) const

overridevirtual

Returns a string identifies the class type of component. Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Implements DtTaskControllerComponent.

virtual void DtScriptedMovementController::tick ( )

overridevirtual

This gives the thread of control to the component. The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

virtual void DtScriptedMovementController::setDesiredLocation ( const DtVector &  )

virtual

Sets the desired location for the entity. By default sets in kinematic state. Vector is in geocentric.

virtual void DtScriptedMovementController::setDesiredSpeed ( const DtVector &  velocity, const DtVector &  acceleration  )

virtual

Both values are local.

virtual void DtScriptedMovementController::setDesiredRotationalVelocity ( const DtVector &  )

virtual

virtual void DtScriptedMovementController::setDesiredOrientation ( const DtTaitBryan &  )

virtual

Orientation in local.

virtual void DtScriptedMovementController::clearTask ( )

overridevirtual

If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.

Reimplemented from DtSingleTaskControllerComponent.

virtual DtScriptedMovementControllerPSR* DtScriptedMovementController::getPSR ( )

inlinevirtual

Gets the process state repository for purposes of providing attributes.

static DtReaderWriter* DtScriptedMovementController::provideAnimationFrame ( void *  controller )

static

Attribute access functions. These functions are registered with the parent system in init().Provides the current animation frame of the animation.

virtual void DtScriptedMovementController::registerTaskMsgCallbacks ( )

overrideprotectedvirtual

Reimplemented from DtTaskControllerComponent.

static void DtScriptedMovementController::scriptedMovementTaskCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

virtual void DtScriptedMovementController::processScriptedMovementTask ( DtSimMessage *  msg )

protectedvirtual

virtual void DtScriptedMovementController::preFirstTickInit ( )

overrideprotectedvirtual

This function can be overridden to initialize a component before it is ticked for the first time. The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented from DtSimComponent.

virtual bool DtScriptedMovementController::setup ( )

protectedvirtual

virtual makVrfEvents::DtFireEvent* DtScriptedMovementController::createFireInteraction ( )

protectedvirtual

Creates and returns a fire interaction at the launch point.

virtual void DtScriptedMovementController::finishUp ( )

protectedvirtual

virtual void DtScriptedMovementController::sendDetonation ( )

protectedvirtual

static void DtScriptedMovementController::animatedMovementTaskCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Process scripted task version of this task. Variables allowed for definition reference_point - Geocentric point or object name. This point will either be the start point of the animation that all the animation points are based from or the end point of the animation, with the points in the animation file leading to this end point. reference_orientation - Starting geocentric orientation supplied as topographic orientation. Will be converted to geocentric orientation. If not supplied the initial orientation will be used. reference_heading - Starting heading. reference_theta - "Tilt" of the reference frame with respect to the earth tangent line. time_scale - If defined the scale used to advance the frames. Default is 1.0 force_automatic_orientation - If defined and true, orientation as defined by the animation model selected will be ignored, and an automatic orientation will be used based on current heading and inclination. (Notably, roll is not approximated.) animation_model - Can be either a string representing an existing animation model defined in the entity editor or an animation model class which will contain all the information necessary to animate the entity clamp_type - If defined overrides the clamp type specified in the animation model. This can have the value of: 1 - Clamp high fidelity (includes orientation clamp) 2 - Clamp low fidelity 3 - Z value in data file is height above terrain 4 - No change, w/height interpreted as geodetic offset 5 - Conditional ground clamping (clamp when altitude is unchanged, otherwise use altitude as an offset) 6 - Use phased radar face-cartesian coordinate system (topographic height w/no altitude clamping) 7 - No change, w/height interpreted as a topographic (e.g. cartesian) offset completion_rule - What to do with the entity when the animation is complete. If defined overrides what is in animation model. Values can be 0 - Detonate 1 - Detonate and remove 2 - Remove 3 - Stay around.

virtual void DtScriptedMovementController::processAnimatedMovementTask ( DtSimMessage *  msg )

protectedvirtual

Process scripted task version of this task. Variables allowed for definition reference_point - Geocentric point or object name. This point will either be the start point of the animation that all the animation points are based from or the end point of the animation, with the points in the animation file leading to this end point. reference_orientation - Starting geocentric orientation supplied as topographic orientation. Will be converted to geocentric orientation. If not supplied the initial orientation will be used. reference_heading - Starting heading. reference_theta - "Tilt" of the reference frame with respect to the earth tangent line. time_scale - If defined the scale used to advance the frames. Default is 1.0 force_automatic_orientation - If defined and true, orientation as defined by the animation model selected will be ignored, and an automatic orientation will be used based on current heading and inclination. (Notably, roll is not approximated.) animation_model - Can be either a string representing an existing animation model defined in the entity editor or an animation model class which will contain all the information necessary to animate the entity clamp_type - If defined overrides the clamp type specified in the animation model. This can have the value of: 1 - Clamp high fidelity (includes orientation clamp) 2 - Clamp low fidelity 3 - Z value in data file is height above terrain 4 - No change, w/height interpreted as geodetic offset 5 - Conditional ground clamping (clamp when altitude is unchanged, otherwise use altitude as an offset) 6 - Use phased radar face-cartesian coordinate system (topographic height w/no altitude clamping) 7 - No change, w/height interpreted as a topographic (e.g. cartesian) offset completion_rule - What to do with the entity when the animation is complete. If defined overrides what is in animation model. Values can be 0 - Detonate 1 - Detonate and remove 2 - Remove 3 - Stay around.

virtual int DtScriptedMovementController::detonationResultFromDistance ( double  d, const DtVector &  detonationPosition, const DtEntityType &  targetType  ) const

protectedvirtual

Given the distance to the target, the detonation position, and the target entity type, return the detonation result.

virtual bool DtScriptedMovementController::createPortGroups ( )

overrideprotectedvirtual

Called by init. Derived classes should override this method to create all their input/output port groups.

Reimplemented from DtSimComponent.

virtual bool DtScriptedMovementController::createPorts ( )

overrideprotectedvirtual

Called by init. Derived classes should override this method to create all their input/output ports and port groups.

Reimplemented from DtSimComponent.

virtual bool DtScriptedMovementController::createNegateSpeedPort ( )

protectedvirtual

virtual bool DtScriptedMovementController::tickWhileDestroyed ( ) const

overrideprotectedvirtual

If the component returns true here, it will be ticked regardless of the destroyed state of the host entity. Otherwise, tick will only be called when the entity is alive.

Returns

false.

Reimplemented from DtSimComponent.

virtual void DtScriptedMovementController::setupInitialState ( )

protectedvirtual

Sets up initial anchor values if not set. Will only be set if there is no target point.

virtual void DtScriptedMovementController::updateTaskVisualizations ( )

overrideprotectedvirtual

Called to update task visualizations after every tick. Implemented by subclasses.

Reimplemented from DtSimComponent.

static DtSimComponent* DtScriptedMovementController::creator ( const DtString &  name, DtLocalObject *  owner, DtSimulationServices *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Member Data Documentation

DtScriptedMovementControllerPSR* DtScriptedMovementController::myProcessState

protected

DtSimObjectReference DtScriptedMovementController::myTargetPoint

protected

bool DtScriptedMovementController::myInitialized

protected

DtUpdateRepositoryOutputPortGroup* DtScriptedMovementController::myUpdateRepositoryOutputPortGroup

protected

Used to update repository with any movement data. As long as this controller has control of this port group no other controllers/actuators will be allowed to write to it.

DtBooleanOutputPort* DtScriptedMovementController::myNegateSpeedPort

protected

Output Port Name: is-action-speed-negated
Output Port Description: Indicates that the speed used for action choosing should be negated. The speed is usually directionless, but for choosing 'reverse' actions, the choosing logic needs to know whether to pick a forward or reverse action. Other controllers can use this port to specify that.
Output Port Range: true or false
Output Port Default Value: false.

bool DtScriptedMovementController::myCompleteNextTick

protected

DtMovementLocalObjectFacade DtScriptedMovementController::myMovementLocalObjectFacade

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/scriptedMovementController.h