DtNavEdgeNavInterface Class Reference

This is the DtVrfObjectNavInterface subclass for objects which insert themselves as nav edges into the nav areas to affect the path finding behavior of active entities. More...

Inheritance diagram for DtNavEdgeNavInterface:

Public Member Functions
virtual	~DtNavEdgeNavInterface ()
virtual void	postObjectInit ()
	Perform additional initialization after the object has been initialized.
virtual void	tick ()
virtual DtNavArea *	navArea ()
Public Member Functions inherited from DtVrfObjectNavInterface
virtual bool	ableToNavigate () const
	Generic call. Basic nav interfaces are not able to navigate.
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 ()

Static Public Member Functions
static DtVrfObjectNavInterface *	create (DtVrfObject *vrfObject)

Protected Member Functions
	DtNavEdgeNavInterface (DtVrfObject *vrfObject)
	Use the create() method instead of calling the constructor.
virtual bool	init ()
	Virtual init, called from the create() method.
virtual void	changingNavArea (DtNavArea *newNavArea)
	Called when the objects position is in a navArea that it was not on the previous check.
virtual void	processVerticesChanged (DtVrfObject *obj)
void	createNavEdge ()
	Creates a nav edge that matches the current geometry of this object.
void	removeNavEdge ()
	Removes the current nav edge.
Protected Member Functions inherited from DtVrfObjectNavInterface
	DtVrfObjectNavInterface (DtVrfObject *vrfObject)
	Use the create() method instead of calling the constructor.
virtual bool	isCollidableWhenDestroyed () const

Static Protected Member Functions
static void	verticesChangedCallback (DtVrfObject *obj, void *usr)
	Callback to handle the changing of nav edge vertices.

Protected Attributes
DtNavArea *	myNavArea
DtNavArea *	myNewNavArea
bool	myUpdatePointsRequired
bool	myChangingNavArea
unsigned	myNavEdgeIndex
Protected Attributes inherited from DtVrfObjectNavInterface
DtVrfObject *	myVrfObject
bool	myFirstTick
DtNavArea *	myCurrentNavArea
DtNoArgumentCallbackList	myChangedNavAreaCallbackList

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

Detailed Description

This is the DtVrfObjectNavInterface subclass for objects which insert themselves as nav edges into the nav areas to affect the path finding behavior of active entities.

Nav edges can connect disparate points in the nav data that are not otherwise connected by any nav data.

Constructor & Destructor Documentation

DtNavEdgeNavInterface::DtNavEdgeNavInterface ( )

private

Not Implemented.

DtNavEdgeNavInterface::DtNavEdgeNavInterface ( const DtNavEdgeNavInterface &  orig )

private

Not Implemented.

DtNavEdgeNavInterface::DtNavEdgeNavInterface ( DtVrfObject *  vrfObject )

protected

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

virtual DtNavEdgeNavInterface::~DtNavEdgeNavInterface ( )

virtual

Member Function Documentation

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

private

Not Implemented.

static DtVrfObjectNavInterface* DtNavEdgeNavInterface::create ( DtVrfObject *  vrfObject )

static

virtual bool DtNavEdgeNavInterface::init ( )

protectedvirtual

Virtual init, called from the create() method.

Reimplemented from DtVrfObjectNavInterface.

virtual void DtNavEdgeNavInterface::postObjectInit ( )

virtual

Perform additional initialization after the object has been initialized.

Ensures the nav edge is created prior to ticking sim components.

Reimplemented from DtVrfObjectNavInterface.

virtual void DtNavEdgeNavInterface::tick ( )

virtual

Reimplemented from DtVrfObjectNavInterface.

virtual DtNavArea* DtNavEdgeNavInterface::navArea ( )

virtual

virtual void DtNavEdgeNavInterface::changingNavArea ( DtNavArea *  newNavArea )

protectedvirtual

Called when the objects position is in a navArea that it was not on the previous check.

Reimplemented from DtVrfObjectNavInterface.

static void DtNavEdgeNavInterface::verticesChangedCallback ( DtVrfObject *  obj, void *  usr  )

staticprotected

Callback to handle the changing of nav edge vertices.

virtual void DtNavEdgeNavInterface::processVerticesChanged ( DtVrfObject *  obj )

protectedvirtual

void DtNavEdgeNavInterface::createNavEdge ( )

protected

Creates a nav edge that matches the current geometry of this object.

void DtNavEdgeNavInterface::removeNavEdge ( )

protected

Removes the current nav edge.

Member Data Documentation

DtNavArea* DtNavEdgeNavInterface::myNavArea

protected

DtNavArea* DtNavEdgeNavInterface::myNewNavArea

protected

bool DtNavEdgeNavInterface::myUpdatePointsRequired

protected

bool DtNavEdgeNavInterface::myChangingNavArea

protected

unsigned DtNavEdgeNavInterface::myNavEdgeIndex

protected

---

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

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