DtDiGuyAnimationTask Class Reference

Inheritance diagram for DtDiGuyAnimationTask:

Public Member Functions
	DtDiGuyAnimationTask ()
	DtDiGuyAnimationTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtDiGuyAnimationTask (const DtString &writeName, const DtDiGuyAnimationTask &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtDiGuyAnimationTask ()
virtual const DtSimTaskMessageType &	type () const
virtual void	setAnimation (const DtString &retreatKind)
virtual const DtString &	animation () const
virtual void	setAnimationDuration (const double time)
virtual const double	animationDuration () const
virtual void	setAnimationNumberOfTimes (int numberOfTimes)
virtual int	animationNumberOfTimes () const
virtual void	setUsingAnimationOffset (const bool useOffset)
virtual const bool	usingAnimationOffset () const
virtual void	setAnimationOffset (const DtVector &offset)
virtual const DtVector &	animationOffset () const
virtual void	setTransitionSpeed (const float speedScale)
virtual const float	transitionSpeed () const
virtual DtString	stringRep () const
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
virtual bool	init ()
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
virtual bool	subtask () const
virtual void	setAllowTaskVisualizations (bool flag)
virtual bool	allowTaskVisualizations () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
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)
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 DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
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 DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimTask &	operator= (const DtSimTask &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwString	myAnimation
DtRwReal	myAnimationDuration
DtRwInt	myAnimationNumberOfTimes
DtRwBoolean	myUsingAnimationOffset
DtRwVector	myAnimationOffset
DtRwReal	myTransitionSpeed
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
DtRwBoolean	myAllowTaskVisualizations
char *	myNetRep
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
DtDiGuyAnimationTask &	operator= (const DtDiGuyAnimationTask &orig)

Additional Inherited Members
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 )()
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	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

DtDiGuyAnimationTask::DtDiGuyAnimationTask

(

)

Default CTOR.

DtDiGuyAnimationTask::DtDiGuyAnimationTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

CTOR.

DtDiGuyAnimationTask::DtDiGuyAnimationTask	(	const DtString &	writeName,
		const DtDiGuyAnimationTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Copy CTOR.

virtual DtDiGuyAnimationTask::~DtDiGuyAnimationTask ( )

virtual

destructor

Member Function Documentation

static DtSimTask* DtDiGuyAnimationTask::creator ( )

static

virtual const DtSimTaskMessageType& DtDiGuyAnimationTask::type ( ) const

virtual

What kind of task am I? Returns a string indicating the kind of task (for example, “move-to”, “follow-entity”). Derived classes must implement this member function to return a unique string representing the type of task. The set of standard task types supplied with VR-Forces is in taskTypes.h.

Implements DtSimTask.

virtual void DtDiGuyAnimationTask::setAnimation ( const DtString &  retreatKind )

virtual

virtual const DtString& DtDiGuyAnimationTask::animation ( ) const

virtual

virtual void DtDiGuyAnimationTask::setAnimationDuration ( const double  time )

virtual

virtual const double DtDiGuyAnimationTask::animationDuration ( ) const

virtual

virtual void DtDiGuyAnimationTask::setAnimationNumberOfTimes ( int  numberOfTimes )

virtual

virtual int DtDiGuyAnimationTask::animationNumberOfTimes ( ) const

virtual

virtual void DtDiGuyAnimationTask::setUsingAnimationOffset ( const bool  useOffset )

virtual

virtual const bool DtDiGuyAnimationTask::usingAnimationOffset ( ) const

virtual

virtual void DtDiGuyAnimationTask::setAnimationOffset ( const DtVector &  offset )

virtual

virtual const DtVector& DtDiGuyAnimationTask::animationOffset ( ) const

virtual

virtual void DtDiGuyAnimationTask::setTransitionSpeed ( const float  speedScale )

virtual

virtual const float DtDiGuyAnimationTask::transitionSpeed ( ) const

virtual

virtual DtString DtDiGuyAnimationTask::stringRep ( ) const

virtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual DtSimTask* DtDiGuyAnimationTask::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

protectedvirtual

Creates a copy of the task.

Implements DtSimTask.

virtual int DtDiGuyAnimationTask::netRepSize ( ) const

protectedvirtual

Returns the size in bytes of the network representation of the class. This is the size in bytes of the DtNetSimTask structure. Derived classes should take into account the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimTask.

virtual bool DtDiGuyAnimationTask::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

protectedvirtual

Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask). Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

virtual bool DtDiGuyAnimationTask::setToNet ( )

protectedvirtual

Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*, and then sets the mySubtask member in the DtNetSimTask from mySubtask. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

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

private

Assignment operator - not implemented.

Member Data Documentation

DtRwString DtDiGuyAnimationTask::myAnimation

protected

The name of the animation to be performed.

DtRwReal DtDiGuyAnimationTask::myAnimationDuration

protected

The duration the animation should be performed for.

• -1.0 represents an indefinite animation
• 0.0 represents an animation that should only happen a set number of times
• any value > 0 is the duration the animation should run for in seconds

DtRwInt DtDiGuyAnimationTask::myAnimationNumberOfTimes

protected

If myAnimationDuration is 0.0, the number of times the animation should be performed.

DtRwBoolean DtDiGuyAnimationTask::myUsingAnimationOffset

protected

Whether the offset for the animation is being used.

DtRwVector DtDiGuyAnimationTask::myAnimationOffset

protected

The NED offset for the animation. Animation will be stretched to end at the specified offset from where it normally ends.

DtRwReal DtDiGuyAnimationTask::myTransitionSpeed

protected

The speed scale factor to use for transitions between animations. A value of 1.0 indicates transitions should be played at normal speed, while 2.0 indicates they should be played twice as fast. Likewise, a value of 0.5 indicates half speed.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/diGuyAnimationTask.h