DtVrfNavAreaManager Class Reference

The DtVrfNavAreaManager manages all of the nav areas currently created in the sim. More...

Public Member Functions
	DtVrfNavAreaManager (DtSimManager *manager)
virtual	~DtVrfNavAreaManager ()
	destructor More...
virtual bool	init ()
virtual void	tick ()
virtual void	setTerrainInterface (DtTerrainInterface *terrainInterface)
virtual void	processGenericRecordLoaded (makArchives::DtGenericTerrainRecord *record)
void	loadObjectNavData (DtVrfObject *simObject)
void	removeObjectNavData (DtVrfObject *simObject)
DtNavArea *	areaForObject (const DtVrfObject *simObject) const
virtual void	unloadAllNavData ()
	Clears all nav areas from the manager. Used when the terrain is being closed. More...
virtual DtNavArea *	findNavAreaForLocation (const DtVector &localPosition, const DtString &profile, DtSharedVrfObjectReference parentObject=DtSharedVrfObjectReference()) const
virtual std::vector< DtNavArea * >	findNavAreasForLocation (const DtVector &localPosition, const DtString &profile, DtSharedVrfObjectReference parentObject=DtSharedVrfObjectReference()) const
virtual DtNavArea *	findNavAreaForArea (const DtLocalVertexList *area, const DtString &profile, DtSharedVrfObjectReference parentObject=DtSharedVrfObjectReference()) const
virtual void	processRequestNavAreaStatus ()
virtual void	processRequestSimObjectDebugPortsCallback (DtUUID uuid)
virtual void	sendNavDataStatus ()
virtual void	addNavAreaAboutToBeRemovedCallback (DtNavAreaRemovalCallbackFcn fcn, void *usrData) const
virtual void	removeNavAreaAboutToBeRemovedCallback (DtNavAreaRemovalCallbackFcn fcn, void *usrData) const
	Remove a previously register callback for notification when a new area is about to be removed. More...

Static Public Member Functions
static void	tickCallback (void *args)
static void	genericRecordLoadedCallback (makArchives::DtGenericTerrainRecord *record, void *user)
static void	requestNavAreaStatusCallback (DtSimMessage *, void *usr)
static void	requestSimObjectDebugPortsCallback (DtSimMessage *msg, void *usr)
static void	setGamewareWorkingMemorySize (int sizeInMb)
static void	setRegenerateNavigationDataAtRuntime (bool regen)
static void	setMaxRegenerationThreads (int threads)
static void	setRegenerationDelay (double delay)
static void	setQueryTimeBudget (double ms)

Protected Types
typedef std::vector< DtNavArea * >	DtNavAreas
typedef std::map< const DtVrfObject *, DtNavArea * >	DtObjectNavAreaMap
typedef DtCallbackList < DtNavArea * >	NavAreaAboutToBeRemovedList

Protected Member Functions
virtual void	processObjectAboutToBeRemoved (const DtVrfObject *simObject)
virtual void	invokeAreaAboutToBeDeletedCallbacks (DtNavArea *)
	Invoke removal callbacks. More...
virtual void	processNavigationRegenUpdate ()

Static Protected Member Functions
static void	objectAboutToBeRemovedCallback (const DtVrfObject *simObject, void *userData)
static void	navigationRegenUpdateCallback (void *usr)

Protected Attributes
DtTerrainInterface *	myTerrainInterface
DtNavAreas	myNavAreas
DtObjectNavAreaMap	myObjectNavAreas
bool	myNavigationInitialized
DtSimManager *	mySimManager
Coordinate_System *	myObjectCoordSys
	Coord system used for nav datas on embarked objects. More...
DtNavGenerationThreadCounter *	myNavGenThreadCounter
NavAreaAboutToBeRemovedList	myNavAreaAboutToRemRemovedList

Static Protected Attributes
static int	theGamewareWorkingMemorySize
static bool	theRegenerateNavDataAtRuntime
static int	theMaxRegenerationThreads
static double	theRegenerationDelay
static double	theQueryTimeBudget

Detailed Description

The DtVrfNavAreaManager manages all of the nav areas currently created in the sim.

Member Typedef Documentation

typedef std::vector<DtNavArea*> DtVrfNavAreaManager::DtNavAreas

protected

typedef std::map<const DtVrfObject*, DtNavArea*> DtVrfNavAreaManager::DtObjectNavAreaMap

protected

typedef DtCallbackList<DtNavArea*> DtVrfNavAreaManager::NavAreaAboutToBeRemovedList

protected

Constructor & Destructor Documentation

DtVrfNavAreaManager::DtVrfNavAreaManager

(

DtSimManager *

manager

)

virtual DtVrfNavAreaManager::~DtVrfNavAreaManager ( )

virtual

destructor

Member Function Documentation

static void DtVrfNavAreaManager::tickCallback ( void *  args )

static

virtual bool DtVrfNavAreaManager::init ( )

virtual

virtual void DtVrfNavAreaManager::tick ( )

virtual

virtual void DtVrfNavAreaManager::setTerrainInterface ( DtTerrainInterface *  terrainInterface )

virtual

static void DtVrfNavAreaManager::genericRecordLoadedCallback ( makArchives::DtGenericTerrainRecord *  record, void *  user  )

static

virtual void DtVrfNavAreaManager::processGenericRecordLoaded ( makArchives::DtGenericTerrainRecord *  record )

virtual

void DtVrfNavAreaManager::loadObjectNavData

(

DtVrfObject *

simObject

)

void DtVrfNavAreaManager::removeObjectNavData

(

DtVrfObject *

simObject

)

DtNavArea* DtVrfNavAreaManager::areaForObject

(

const DtVrfObject *

simObject

)

const

virtual void DtVrfNavAreaManager::unloadAllNavData ( )

virtual

Clears all nav areas from the manager. Used when the terrain is being closed.

virtual DtNavArea* DtVrfNavAreaManager::findNavAreaForLocation ( const DtVector &  localPosition, const DtString &  profile, DtSharedVrfObjectReference  parentObject = DtSharedVrfObjectReference()  ) const

virtual

Returns

the nav area (if any) that contains a given location and matches the specified profile. If there is a parentObject, only nav areas that are attached to parentObject are considered. If parentObject is null, then nav areas on the terrain are considered. If the profile is a null string, nav areas for all profiles are considered to be matching.

virtual std::vector<DtNavArea*> DtVrfNavAreaManager::findNavAreasForLocation ( const DtVector &  localPosition, const DtString &  profile, DtSharedVrfObjectReference  parentObject = DtSharedVrfObjectReference()  ) const

virtual

virtual DtNavArea* DtVrfNavAreaManager::findNavAreaForArea ( const DtLocalVertexList *  area, const DtString &  profile, DtSharedVrfObjectReference  parentObject = DtSharedVrfObjectReference()  ) const

virtual

virtual void DtVrfNavAreaManager::addNavAreaAboutToBeRemovedCallback ( DtNavAreaRemovalCallbackFcn  fcn, void *  usrData  ) const

virtual

Add/remove callbacks for nav areas to be removed

virtual void DtVrfNavAreaManager::removeNavAreaAboutToBeRemovedCallback ( DtNavAreaRemovalCallbackFcn  fcn, void *  usrData  ) const

virtual

Remove a previously register callback for notification when a new area is about to be removed.

static void DtVrfNavAreaManager::requestNavAreaStatusCallback ( DtSimMessage *  , void *  usr  )

static

virtual void DtVrfNavAreaManager::processRequestNavAreaStatus ( )

virtual

static void DtVrfNavAreaManager::requestSimObjectDebugPortsCallback ( DtSimMessage *  msg, void *  usr  )

static

virtual void DtVrfNavAreaManager::processRequestSimObjectDebugPortsCallback ( DtUUID  uuid )

virtual

virtual void DtVrfNavAreaManager::sendNavDataStatus ( )

virtual

static void DtVrfNavAreaManager::setGamewareWorkingMemorySize ( int  sizeInMb )

static

static void DtVrfNavAreaManager::setRegenerateNavigationDataAtRuntime ( bool  regen )

static

static void DtVrfNavAreaManager::setMaxRegenerationThreads ( int  threads )

static

static void DtVrfNavAreaManager::setRegenerationDelay ( double  delay )

static

static void DtVrfNavAreaManager::setQueryTimeBudget ( double  ms )

static

static void DtVrfNavAreaManager::objectAboutToBeRemovedCallback ( const DtVrfObject *  simObject, void *  userData  )

staticprotected

virtual void DtVrfNavAreaManager::processObjectAboutToBeRemoved ( const DtVrfObject *  simObject )

protectedvirtual

virtual void DtVrfNavAreaManager::invokeAreaAboutToBeDeletedCallbacks ( DtNavArea *  )

protectedvirtual

Invoke removal callbacks.

static void DtVrfNavAreaManager::navigationRegenUpdateCallback ( void *  usr )

staticprotected

virtual void DtVrfNavAreaManager::processNavigationRegenUpdate ( )

protectedvirtual

Member Data Documentation

DtTerrainInterface* DtVrfNavAreaManager::myTerrainInterface

protected

DtNavAreas DtVrfNavAreaManager::myNavAreas

protected

DtObjectNavAreaMap DtVrfNavAreaManager::myObjectNavAreas

protected

bool DtVrfNavAreaManager::myNavigationInitialized

protected

DtSimManager* DtVrfNavAreaManager::mySimManager

protected

Coordinate_System* DtVrfNavAreaManager::myObjectCoordSys

protected

Coord system used for nav datas on embarked objects.

DtNavGenerationThreadCounter* DtVrfNavAreaManager::myNavGenThreadCounter

protected

int DtVrfNavAreaManager::theGamewareWorkingMemorySize

staticprotected

bool DtVrfNavAreaManager::theRegenerateNavDataAtRuntime

staticprotected

int DtVrfNavAreaManager::theMaxRegenerationThreads

staticprotected

double DtVrfNavAreaManager::theRegenerationDelay

staticprotected

double DtVrfNavAreaManager::theQueryTimeBudget

staticprotected

NavAreaAboutToBeRemovedList DtVrfNavAreaManager::myNavAreaAboutToRemRemovedList

mutableprotected

---

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

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