DtDynamicObstacleNavInterface Class Reference

This is the DtVrfObjectNavInterface subclass for objects which are treated as frequently moving obstacles by the navigation system, but are not using the navigation system to plan paths. For example, this is used for remote entities.

Inheritance diagram for DtDynamicObstacleNavInterface:

Public Member Functions
virtual void	tick () override
virtual	~DtDynamicObstacleNavInterface () override
virtual void	clearNavObstacles ()
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 *	createSimObjectInterface (DtSimObjectReference vrfObject)
static DtVrfObjectNavInterface *	createLocalObjectInterface (DtLocalObject *vrfObject)

Protected Member Functions
	DtDynamicObstacleNavInterface (DtLocalObject *vrfObject)
	DtDynamicObstacleNavInterface (DtSimObjectReference vrfObject)
virtual bool	init () override
virtual void	postObjectInit () override
virtual void	changingNavArea (DtNavArea *newNavArea) override
virtual bool	obstacleEnabled ()
virtual void	createNavObstacle ()
virtual bool	shouldBecomeStationary (double &elapsedTime) const
Protected Member Functions inherited from DtVrfObjectNavInterface
	DtVrfObjectNavInterface (DtLocalObject *vrfObject)
	DtVrfObjectNavInterface (DtSimObjectReference vrfObject)
virtual bool	isCollidableWhenDestroyed () const

Protected Attributes
std::map< DtNavArea *, DtNavObstacle * >	myNavObstacles
DtVector	myPreviousLocalPos
DtNavArea *	myNavArea
double	myStationaryTime
double	myTimeToBecomeStationary
bool	myShouldBecomeStationary
DtPlatformSimObjectFacade	myPlatformSimObjectFacade
bool	myOnlyCreateInCurrentArea
Protected Attributes inherited from DtVrfObjectNavInterface
DtLocalObject *	myVrfObject
DtSimObjectReference	mySimObjectReference
DtSimulationServices *	mySimulationServices
DtNavArea *	myCurrentNavArea
bool	myFirstTick
bool	myIsWaitingForNavLoad
DtNoArgumentCallbackList	myChangedNavAreaCallbackList

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

Constructor & Destructor Documentation

DtDynamicObstacleNavInterface::DtDynamicObstacleNavInterface ( )

private

Not Implemented.

DtDynamicObstacleNavInterface::DtDynamicObstacleNavInterface ( const DtDynamicObstacleNavInterface &  orig )

private

Not Implemented.

DtDynamicObstacleNavInterface::DtDynamicObstacleNavInterface ( DtLocalObject *  vrfObject )

protected

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

DtDynamicObstacleNavInterface::DtDynamicObstacleNavInterface ( DtSimObjectReference  vrfObject )

protected

virtual DtDynamicObstacleNavInterface::~DtDynamicObstacleNavInterface ( )

overridevirtual

Member Function Documentation

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

private

Not Implemented.

static DtVrfObjectNavInterface* DtDynamicObstacleNavInterface::createSimObjectInterface ( DtSimObjectReference  vrfObject )

static

static DtVrfObjectNavInterface* DtDynamicObstacleNavInterface::createLocalObjectInterface ( DtLocalObject *  vrfObject )

static

virtual bool DtDynamicObstacleNavInterface::init ( )

overrideprotectedvirtual

Virtual init, called from the create() method.

Reimplemented from DtVrfObjectNavInterface.

virtual void DtDynamicObstacleNavInterface::postObjectInit ( )

overrideprotectedvirtual

Perform additional initialization after the object has been initialized. Default behavior is to do nothing, must be implemented in subclass.

Reimplemented from DtVrfObjectNavInterface.

virtual void DtDynamicObstacleNavInterface::changingNavArea ( DtNavArea *  newNavArea )

overrideprotectedvirtual

Called when about to change to a new navArea.

Reimplemented from DtVrfObjectNavInterface.

virtual bool DtDynamicObstacleNavInterface::obstacleEnabled ( )

protectedvirtual

Returns

True if the obstacle should be enabled as a collidable object.

virtual void DtDynamicObstacleNavInterface::createNavObstacle ( )

protectedvirtual

Creates the NavObstacle in the current navArea.

virtual bool DtDynamicObstacleNavInterface::shouldBecomeStationary ( double &  elapsedTime ) const

protectedvirtual

Returns

If the "dynamic-obstacle-to-stationary-time" property from the navigation parameters is set, then this function returns true and sets elapsedTime to its value. Otherwise, it returns false and leaves elapsedTime unchanged.

virtual void DtDynamicObstacleNavInterface::tick ( )

overridevirtual

Reimplemented from DtVrfObjectNavInterface.

virtual void DtDynamicObstacleNavInterface::clearNavObstacles ( )

virtual

Member Data Documentation

std::map<DtNavArea*, DtNavObstacle*> DtDynamicObstacleNavInterface::myNavObstacles

protected

DtVector DtDynamicObstacleNavInterface::myPreviousLocalPos

protected

DtNavArea* DtDynamicObstacleNavInterface::myNavArea

protected

double DtDynamicObstacleNavInterface::myStationaryTime

protected

How long the obstacle has been stationary.

double DtDynamicObstacleNavInterface::myTimeToBecomeStationary

protected

Cache for the nav property.

bool DtDynamicObstacleNavInterface::myShouldBecomeStationary

protected

DtPlatformSimObjectFacade DtDynamicObstacleNavInterface::myPlatformSimObjectFacade

protected

bool DtDynamicObstacleNavInterface::myOnlyCreateInCurrentArea

protected

---

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

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