DtVrfObjectNavInterface Class Reference

Inheritance diagram for DtVrfObjectNavInterface:

Public Member Functions
virtual bool	ableToNavigate () const
	Generic call. Basic nav interfaces are not able to navigate.
virtual void	postObjectInit ()
	Perform additional initialization after the object has been initialized.
virtual void	tick ()
virtual void	firstTick ()
virtual	~DtVrfObjectNavInterface ()=0
virtual void	addNavAreaChangedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType callback, void *usr)
virtual void	removeNavAreaChangedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType callback, void *usr)
virtual void	invokeNavAreaChangedCallbacks ()
virtual void	changingNavArea (DtNavArea *newNavArea)
	Called when about to change to a new navArea.

Protected Member Functions
	DtVrfObjectNavInterface (DtVrfObject *vrfObject)
	Use the create() method instead of calling the constructor.
virtual bool	init ()
	Virtual init, called from the create() method.
virtual bool	isCollidableWhenDestroyed () const

Protected Attributes
DtVrfObject *	myVrfObject
bool	myFirstTick
DtNavArea *	myCurrentNavArea
DtNoArgumentCallbackList	myChangedNavAreaCallbackList

Private Member Functions
	DtVrfObjectNavInterface ()
	Not Implemented.
	DtVrfObjectNavInterface (const DtVrfObjectNavInterface &orig)
	Not Implemented.
DtVrfObjectNavInterface &	operator= (const DtVrfObjectNavInterface &orig)
	Not Implemented.

Constructor & Destructor Documentation

DtVrfObjectNavInterface::DtVrfObjectNavInterface ( )

private

Not Implemented.

DtVrfObjectNavInterface::DtVrfObjectNavInterface ( const DtVrfObjectNavInterface &  orig )

private

Not Implemented.

DtVrfObjectNavInterface::DtVrfObjectNavInterface ( DtVrfObject *  vrfObject )

protected

Use the create() method instead of calling the constructor.

virtual DtVrfObjectNavInterface::~DtVrfObjectNavInterface ( )

pure virtual

Member Function Documentation

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

private

Not Implemented.

virtual bool DtVrfObjectNavInterface::ableToNavigate ( ) const

virtual

Generic call. Basic nav interfaces are not able to navigate.

Reimplemented in DtActiveBotNavInterface.

virtual bool DtVrfObjectNavInterface::init ( )

protectedvirtual

Virtual init, called from the create() method.

Reimplemented in DtActiveBotNavInterface, DtNavEdgeNavInterface, DtTagVolumeNavInterface, DtDynamicObstacleNavInterface, and DtStaticObstacleNavInterface.

virtual void DtVrfObjectNavInterface::postObjectInit ( )

inlinevirtual

Perform additional initialization after the object has been initialized.

Default behavior is to do nothing, must be implemented in subclass.

Reimplemented in DtNavEdgeNavInterface, and DtTagVolumeNavInterface.

virtual void DtVrfObjectNavInterface::tick ( )

virtual

Reimplemented in DtDynamicObstacleNavInterface, DtNavEdgeNavInterface, DtTagVolumeNavInterface, DtActiveBotNavInterface, and DtStaticObstacleNavInterface.

virtual void DtVrfObjectNavInterface::firstTick ( )

virtual

Reimplemented in DtTagVolumeNavInterface, and DtActiveBotNavInterface.

virtual void DtVrfObjectNavInterface::addNavAreaChangedCallback ( DtNoArgumentCallbackList::DtCallbackFunctionType  callback, void *  usr  )

virtual

virtual void DtVrfObjectNavInterface::removeNavAreaChangedCallback ( DtNoArgumentCallbackList::DtCallbackFunctionType  callback, void *  usr  )

virtual

virtual void DtVrfObjectNavInterface::invokeNavAreaChangedCallbacks ( )

virtual

virtual void DtVrfObjectNavInterface::changingNavArea ( DtNavArea *  newNavArea )

virtual

Called when about to change to a new navArea.

Reimplemented in DtActiveBotNavInterface, DtTagVolumeNavInterface, DtNavEdgeNavInterface, and DtDynamicObstacleNavInterface.

virtual bool DtVrfObjectNavInterface::isCollidableWhenDestroyed ( ) const

protectedvirtual

Returns

The value of the "collidable-when-destroyed" property from the navigation parameters in the object's parameter entry. This value defaults to true if not specified.

Member Data Documentation

DtVrfObject* DtVrfObjectNavInterface::myVrfObject

protected

bool DtVrfObjectNavInterface::myFirstTick

protected

DtNavArea* DtVrfObjectNavInterface::myCurrentNavArea

protected

DtNoArgumentCallbackList DtVrfObjectNavInterface::myChangedNavAreaCallbackList

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/vrfObjectNavInterface.h