VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtDiGuyAnimationTask Class Reference
Inheritance diagram for DtDiGuyAnimationTask:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtDiGuyAnimationTask ()
 default constructor
 DtDiGuyAnimationTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor
virtual ~DtDiGuyAnimationTask ()
 destructor
 DtDiGuyAnimationTask (const DtString &writeName, const DtDiGuyAnimationTask &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor - not implemented
virtual int type () const
 What kind of task am I? Returns a string indicating the kind of task (for example, “move-to”, “follow-entity”).
virtual const DtStringanimation () const
virtual void setAnimation (const DtString &retreatKind)
virtual const double animationDuration () const
virtual void setAnimationDuration (const double time)
virtual DtString stringRep () const
 Get a readable string representation of this task.

Static Public Member Functions

static DtSimTaskcreator ()

Protected Member Functions

virtual DtSimTaskclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of the task.
virtual int netRepSize () const
 Returns the size in bytes of the network representation of the class.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
virtual bool setToNet ()
 Calls netRep() to create the network buffer.

Protected Attributes

DtRwString myAnimation
DtRwReal myAnimationDuration
 -1.0 represents an indefinite animation, 0.0 represents an animation that should only happen once, and any value > 0 is the duration the animation should run for.

Private Member Functions

DtDiGuyAnimationTaskoperator= (const DtDiGuyAnimationTask &orig)
 assignment operator - not implemented

Constructor & Destructor Documentation

default constructor

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

constructor

destructor

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

copy constructor - not implemented


Member Function Documentation

virtual int 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 const DtString& DtDiGuyAnimationTask::animation ( ) const [virtual]
virtual void DtDiGuyAnimationTask::setAnimation ( const DtString retreatKind) [virtual]
virtual const double DtDiGuyAnimationTask::animationDuration ( ) const [virtual]
virtual void DtDiGuyAnimationTask::setAnimationDuration ( const double  time) [virtual]
virtual DtString DtDiGuyAnimationTask::stringRep ( ) const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

DtDiGuyAnimationTask& DtDiGuyAnimationTask::operator= ( const DtDiGuyAnimationTask orig) [private]

assignment operator - not implemented

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

Creates a copy of the task.

Implements DtSimTask.

virtual int DtDiGuyAnimationTask::netRepSize ( ) const [protected, virtual]

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 acount 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 
) [protected, virtual]

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 ( ) [protected, virtual]

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.


Member Data Documentation

-1.0 represents an indefinite animation, 0.0 represents an animation that should only happen once, and any value > 0 is the duration the animation should run for.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)