DtCoverPointNavInterface 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 DtCoverPointNavInterface:

Public Member Functions
virtual	~DtCoverPointNavInterface ()
virtual void	postObjectInit ()
	Perform additional initialization after the object has been initialized. More...
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. More...
virtual void	firstTick ()
virtual	~DtVrfObjectNavInterface ()=0
virtual void	addNavAreaChangedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType callback, void *usr) const
virtual void	removeNavAreaChangedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType callback, void *usr) const
virtual void	invokeNavAreaChangedCallbacks ()

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

Protected Member Functions
	DtCoverPointNavInterface (DtSharedVrfObjectReference vrfObject)
	Use the create() method instead of calling the constructor. More...
virtual bool	init ()
	Virtual init, called from the create() method. More...
virtual void	changingNavArea (DtNavArea *newNavArea)
	Called when the objects position is in a navArea that it was not on the previous check. More...
virtual void	processVerticesChanged (const DtVrfObject *obj)
bool	createCoverPoint ()
	Creates a cover point that matches the current location of this object. More...
bool	coverPointCreationComplete ()
	Returns true if the cover point has finished being created. More...
void	removeCoverPoint ()
	Removes the current cover point. More...
bool	adjustToNearestVertexLinkPoint (const DtString &, const double, const double, const DtVector &, DtVector &) const
	Attempt to modify the given DtVector to a point that is "navigable" within the given point profile radius. More...
Protected Member Functions inherited from DtVrfObjectNavInterface
	DtVrfObjectNavInterface (DtSharedVrfObjectReference vrfObject)
	Use the create() method instead of calling the constructor. More...
virtual bool	isCollidableWhenDestroyed () const

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

Protected Attributes
DtNavArea *	myNavArea
DtNavArea *	myNewNavArea
bool	myUpdatePointsRequired
bool	myChangingNavArea
bool	myCreationInProgress
unsigned	myCoverPointIndex
Protected Attributes inherited from DtVrfObjectNavInterface
DtSharedVrfObjectReference	myVrfObject
bool	myFirstTick
DtNavArea *	myCurrentNavArea
DtNoArgumentCallbackList	myChangedNavAreaCallbackList

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

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

DtCoverPointNavInterface::DtCoverPointNavInterface ( )

private

Not Implemented.

DtCoverPointNavInterface::DtCoverPointNavInterface ( const DtCoverPointNavInterface &  orig )

private

Not Implemented.

DtCoverPointNavInterface::DtCoverPointNavInterface ( DtSharedVrfObjectReference  vrfObject )

protected

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

virtual DtCoverPointNavInterface::~DtCoverPointNavInterface ( )

virtual

Member Function Documentation

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

private

Not Implemented.

static DtVrfObjectNavInterface* DtCoverPointNavInterface::create ( DtSharedVrfObjectReference  vrfObject )

static

virtual bool DtCoverPointNavInterface::init ( )

protectedvirtual

Virtual init, called from the create() method.

Reimplemented from DtVrfObjectNavInterface.

virtual void DtCoverPointNavInterface::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 DtCoverPointNavInterface::tick ( )

virtual

Reimplemented from DtVrfObjectNavInterface.

virtual DtNavArea* DtCoverPointNavInterface::navArea ( )

virtual

virtual void DtCoverPointNavInterface::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 DtCoverPointNavInterface::verticesChangedCallback ( const DtVrfObject *  obj, void *  usr  )

staticprotected

Callback to handle the changing of nav edge vertices.

virtual void DtCoverPointNavInterface::processVerticesChanged ( const DtVrfObject *  obj )

protectedvirtual

bool DtCoverPointNavInterface::createCoverPoint ( )

protected

Creates a cover point that matches the current location of this object.

Returns whether it has finished creating the cover point. (true means nothing more needs to be created, false means it will attempt to finish creating on next tick)

bool DtCoverPointNavInterface::coverPointCreationComplete ( )

protected

Returns true if the cover point has finished being created.

void DtCoverPointNavInterface::removeCoverPoint ( )

protected

Removes the current cover point.

bool DtCoverPointNavInterface::adjustToNearestVertexLinkPoint ( const DtString &  , const double  , const double  , const DtVector &  , DtVector &    ) const

protected

Attempt to modify the given DtVector to a point that is "navigable" within the given point profile radius.

Returns true if it actually modified the vector

Member Data Documentation

DtNavArea* DtCoverPointNavInterface::myNavArea

protected

DtNavArea* DtCoverPointNavInterface::myNewNavArea

protected

bool DtCoverPointNavInterface::myUpdatePointsRequired

protected

bool DtCoverPointNavInterface::myChangingNavArea

protected

bool DtCoverPointNavInterface::myCreationInProgress

protected

unsigned DtCoverPointNavInterface::myCoverPointIndex

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/coverPointNavInterface.h