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. Nav edges can connect disparate points in the nav data that are not otherwise connected by any nav data.

Inheritance diagram for DtCoverPointNavInterface:

Public Member Functions
virtual	~DtCoverPointNavInterface ()
virtual void	postObjectInit ()
virtual void	tick ()
virtual DtNavArea *	navArea ()
Public Member Functions inherited from DtVrfObjectNavInterface
virtual bool	ableToNavigate () const
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 ()
virtual void	setWaitingForLoad (bool isLoading)
virtual bool	isWaitingForLoad () const

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

Protected Member Functions
	DtCoverPointNavInterface (DtLocalObject *vrfObject)
virtual bool	init ()
virtual void	changingNavArea (DtNavArea *newNavArea)
virtual void	processVerticesChanged ()
bool	createCoverPoint ()
bool	coverPointCreationComplete ()
void	removeCoverPoint ()
bool	adjustToNearestVertexLinkPoint (const DtString &, const double, const double, const DtVector &, DtVector &) const
Protected Member Functions inherited from DtVrfObjectNavInterface
	DtVrfObjectNavInterface (DtLocalObject *vrfObject)
virtual bool	isCollidableWhenDestroyed () const

Protected Attributes
DtNavArea *	myNavArea
DtNavArea *	myNewNavArea
bool	myUpdatePointsRequired
bool	myChangingNavArea
bool	myCreationInProgress
unsigned	myCoverPointIndex
boost::signals2::scoped_connection	mySetLocationConnection
Protected Attributes inherited from DtVrfObjectNavInterface
DtLocalObject *	myVrfObject
DtNavArea *	myCurrentNavArea
bool	myFirstTick
bool	myIsWaitingForNavLoad
DtNoArgumentCallbackList	myChangedNavAreaCallbackList

Private Member Functions
	DtCoverPointNavInterface ()
	DtCoverPointNavInterface (const DtCoverPointNavInterface &orig)
DtCoverPointNavInterface &	operator= (const DtCoverPointNavInterface &orig)

Constructor & Destructor Documentation

DtCoverPointNavInterface::DtCoverPointNavInterface ( )

private

Not Implemented.

DtCoverPointNavInterface::DtCoverPointNavInterface ( const DtCoverPointNavInterface &  orig )

private

Not Implemented.

DtCoverPointNavInterface::DtCoverPointNavInterface ( DtLocalObject *  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 ( DtLocalObject *  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.

virtual void DtCoverPointNavInterface::processVerticesChanged ( )

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

boost::signals2::scoped_connection DtCoverPointNavInterface::mySetLocationConnection

protected

---

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

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