DtDIGuyControllerPSR Class Reference

class DtDIGuyControllerPSR: More...

Inheritance diagram for DtDIGuyControllerPSR:

Public Member Functions
	DtDIGuyControllerPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtDIGuyControllerPSR (const DtDIGuyControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtDIGuyControllerPSR ()
	destructor
DtDIGuyControllerPSR &	operator= (const DtDIGuyControllerPSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of this process state repository.
virtual void	setElapsedTime (double time)
	Get / Set the elapsed time state variable.
virtual double	elapsedTime () const
virtual void	setAnimationDuration (double time)
	How long it this animation suppose to be?
virtual double	animationDuration () const
virtual void	setDirectionOfMovement (double angle)
	What direction is the animation going in relation to our heading? Ie if we're side stepping to the right we are moveing 90 degrees from our heading.
virtual double	directionOfMovement () const
virtual void	setAmRotating (bool rot)
	Is there any rotation involved?
virtual bool	amRotating () const
virtual void	setDefaultAnimationName (const DtString &name)
	This is the default animation an entity should show when it has nothing better to do.
virtual const DtString &	defaultAnimationName () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

Protected Attributes
DtRwReal	myElapsedTime
DtRwReal	myDuration
DtRwBoolean	myAmRotating
DtRwReal	myDirectionOfMovement
DtRwString	myDefaultAnimationName
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

class DtDIGuyControllerPSR:

This Process State Repository keeps track of the current paramters of the animation this entity was doing when it was saved out and how far along it was. This data will be written to and read from the OOB file when a scenario checkpoint is saved and loaded.

Constructor & Destructor Documentation

DtDIGuyControllerPSR::DtDIGuyControllerPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtDIGuyControllerPSR::DtDIGuyControllerPSR	(	const DtDIGuyControllerPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtDIGuyControllerPSR::~DtDIGuyControllerPSR ( )

virtual

destructor

Member Function Documentation

DtDIGuyControllerPSR& DtDIGuyControllerPSR::operator=

(

const DtDIGuyControllerPSR &

orig

)

assignment operator

virtual DtVrfProcessStateRepository* DtDIGuyControllerPSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtDIGuyControllerPSR::type ( ) const

virtual

Returns the string type of this process state repository.

Implements DtVrfProcessStateRepository.

virtual void DtDIGuyControllerPSR::setElapsedTime ( double  time )

virtual

Get / Set the elapsed time state variable.

virtual double DtDIGuyControllerPSR::elapsedTime ( ) const

virtual

virtual void DtDIGuyControllerPSR::setAnimationDuration ( double  time )

virtual

How long it this animation suppose to be?

virtual double DtDIGuyControllerPSR::animationDuration ( ) const

virtual

virtual void DtDIGuyControllerPSR::setDirectionOfMovement ( double  angle )

virtual

What direction is the animation going in relation to our heading? Ie if we're side stepping to the right we are moveing 90 degrees from our heading.

virtual double DtDIGuyControllerPSR::directionOfMovement ( ) const

virtual

virtual void DtDIGuyControllerPSR::setAmRotating ( bool  rot )

virtual

Is there any rotation involved?

virtual bool DtDIGuyControllerPSR::amRotating ( ) const

virtual

virtual void DtDIGuyControllerPSR::setDefaultAnimationName ( const DtString &  name )

virtual

This is the default animation an entity should show when it has nothing better to do.

virtual const DtString& DtDIGuyControllerPSR::defaultAnimationName ( ) const

virtual

static DtVrfProcessStateRepository* DtDIGuyControllerPSR::creator ( const DtString &  rwName, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwReal DtDIGuyControllerPSR::myElapsedTime

protected

DtRwReal DtDIGuyControllerPSR::myDuration

protected

DtRwBoolean DtDIGuyControllerPSR::myAmRotating

protected

DtRwReal DtDIGuyControllerPSR::myDirectionOfMovement

protected

DtRwString DtDIGuyControllerPSR::myDefaultAnimationName

protected

---

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

• include/vrfobjcore/diGuyControllerPSR.h