DtPhysicalWorldParams Class Reference

Readable-writable class holding all parameters for to configure the DtPhysicalWorld. More...

Inheritance diagram for DtPhysicalWorldParams:

List of all members.

Public Member Functions
	DtPhysicalWorldParams (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor.
	DtPhysicalWorldParams (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtPhysicalWorldParams (const DtPhysicalWorldParams &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtPhysicalWorldParams &	operator= (const DtPhysicalWorldParams &orig)
	assignment
virtual	~DtPhysicalWorldParams ()
virtual DtSignaturePropagatorDescriptorList &	signaturePropagatorParams ()
	Parameters for configuring signature propagators instantiated by the DtPhysicalWorld's DtSensorSignatureManager.
virtual const DtSignaturePropagatorDescriptorList &	signaturePropagatorParams () const
	Parameters for configuring signature propagators instantiated by the DtPhysicalWorld's DtSensorSignatureManager.
virtual DtRwNLengthStringVector &	lineOfSightTests ()
	Parameters for configuring types and order of Line of Sight tests performed by the physical world when general LOS queries are asked.
virtual const DtRwNLengthStringVector &	lineOfSightTests () const
	Parameters for configuring types and order of Line of Sight tests performed by the physical world when general LOS queries are asked.
virtual bool	extrudeVectorObstructions () const
	If true (the default), the vector obstruction manager will extend all vector obstructions in the Z direction.
virtual void	setExtrudeVectorObstructions (bool extrude)
	If true (the default), the vector obstruction manager will extend all vector obstructions in the Z direction.
virtual bool	allowEnvironmentalEffects () const
	If true (the default), environmental effects will affect sensors-Visibility, time of day...
virtual void	setAllowEnvironmentalEffects (bool allow)
	If true (the default), environmental effects will affect sensors-Visibility, time of day...
virtual DtRwObjectTypeList &	spatialOrganizationObjectTypes ()
	The list of object types that will be spatially organized by the object spatial subdivision.
virtual const DtRwObjectTypeList &	spatialOrganizationObjectTypes () const
	The list of object types that will be spatially organized by the object spatial subdivision.
virtual double	terrainPreloadLookaheadTime () const
virtual void	setTerrainPreloadLookaheadTime (double v)
virtual double	terrainPreloadPeriod () const
virtual void	setTerrainPreloadPeriod (double seconds)
virtual double	terrainPreloadExpireTime () const
virtual void	setTerrainPreloadExpireTime (double seconds)
virtual double	terrainIntersectExpireTime () const
virtual void	setTerrainIntersectExpireTime (double seconds)
virtual void	merge (const DtPhysicalWorldParams *)
	Merges the contents of the supplied parameters into this.
virtual void	mergeLineOfSightTests (const DtPhysicalWorldParams *)
	Merges in any line of sight tests that do not exist into the myLineOfSighTests list.
virtual void	addTest (const DtString &test)
	Merges in any line of sight tests that do not exist into the myLineOfSighTests list.
virtual void	mergeSignaturePropagatorParams (const DtPhysicalWorldParams *)
	Merges entries from incoming physical world params signature propagator params into this one.
virtual void	mergeSpatialOrganizationObjectTypes (const DtPhysicalWorldParams *)
	Merges spatial objects types into this object.
Protected Attributes
DtSignaturePropagatorDescriptorList	mySignaturePropagatorParams
DtRwNLengthStringVector	myLineOfSightTests
DtRwBoolean	myExtrudeVectorObstructions
DtRwBoolean	myAllowEnvironmentalEffects
DtRwObjectTypeList	mySpatialOrganizationObjectTypes
DtRwReal	myTerrainPreloadLookaheadTime
	The number of seconds that the terrain pre-loader will look ahead of entity positions when preloading the terrain areas they may move on to.
DtRwReal	myTerrainPreloadPeriod
	Evaluation period for terrain preload. Specified in seconds.
DtRwReal	myTerrainPreloadExpireTime
	Expire time offset (from actual time) for preload data load requests.
DtRwReal	myTerrainIntersectExpireTime
	Expire time offset (from actual time) for intersect data load requests.
Private Member Functions
	DtPhysicalWorldParams ()
	default constructor; not implemented

---

Detailed Description

Readable-writable class holding all parameters for to configure the DtPhysicalWorld.

---

Constructor & Destructor Documentation

DtPhysicalWorldParams::DtPhysicalWorldParams	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor.

DtPhysicalWorldParams::DtPhysicalWorldParams	(	const DtSymbolString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtPhysicalWorldParams::DtPhysicalWorldParams	(	const DtPhysicalWorldParams &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

Parameters:

orig	DtPhysicalWorldParams to copy.
parentRegistry	The registry of the DtReaderWriter object to which this object belongs.

virtual DtPhysicalWorldParams::~DtPhysicalWorldParams

(

)

[virtual]

DtPhysicalWorldParams::DtPhysicalWorldParams

(

)

[private]

default constructor; not implemented

---

Member Function Documentation

DtPhysicalWorldParams& DtPhysicalWorldParams::operator=

(

const DtPhysicalWorldParams &

orig

)

assignment

virtual DtSignaturePropagatorDescriptorList& DtPhysicalWorldParams::signaturePropagatorParams

(

)

[virtual]

Parameters for configuring signature propagators instantiated by the DtPhysicalWorld's DtSensorSignatureManager.

virtual const DtSignaturePropagatorDescriptorList& DtPhysicalWorldParams::signaturePropagatorParams

(

)

const [virtual]

Parameters for configuring signature propagators instantiated by the DtPhysicalWorld's DtSensorSignatureManager.

virtual DtRwNLengthStringVector& DtPhysicalWorldParams::lineOfSightTests

(

)

[virtual]

Parameters for configuring types and order of Line of Sight tests performed by the physical world when general LOS queries are asked.

virtual const DtRwNLengthStringVector& DtPhysicalWorldParams::lineOfSightTests

(

)

const [virtual]

Parameters for configuring types and order of Line of Sight tests performed by the physical world when general LOS queries are asked.

virtual bool DtPhysicalWorldParams::extrudeVectorObstructions

(

)

const [virtual]

If true (the default), the vector obstruction manager will extend all vector obstructions in the Z direction.

If false, they will be clamped the the highest polygon at their position (same behavior in VRF3.8 and earlier)

virtual void DtPhysicalWorldParams::setExtrudeVectorObstructions

(

bool

extrude

)

[virtual]

If true (the default), the vector obstruction manager will extend all vector obstructions in the Z direction.

If false, they will be clamped the the highest polygon at their position (same behavior in VRF3.8 and earlier)

virtual bool DtPhysicalWorldParams::allowEnvironmentalEffects

(

)

const [virtual]

If true (the default), environmental effects will affect sensors-Visibility, time of day...

virtual void DtPhysicalWorldParams::setAllowEnvironmentalEffects

(

bool

allow

)

[virtual]

If true (the default), environmental effects will affect sensors-Visibility, time of day...

virtual DtRwObjectTypeList& DtPhysicalWorldParams::spatialOrganizationObjectTypes

(

)

[virtual]

The list of object types that will be spatially organized by the object spatial subdivision.

Any physical object type in the simulation that may be sensed, block intervisibility, etc, should be on this list.

virtual const DtRwObjectTypeList& DtPhysicalWorldParams::spatialOrganizationObjectTypes

(

)

const [virtual]

The list of object types that will be spatially organized by the object spatial subdivision.

Any physical object type in the simulation that may be sensed, block intervisibility, etc, should be on this list.

virtual double DtPhysicalWorldParams::terrainPreloadLookaheadTime

(

)

const [virtual]

See also:

myTerrainPreloadLookaheadTime

virtual void DtPhysicalWorldParams::setTerrainPreloadLookaheadTime

(

double

v

)

[virtual]

See also:

myTerrainPreloadLookaheadTime

virtual double DtPhysicalWorldParams::terrainPreloadPeriod

(

)

const [virtual]

See also:

myTerrainPreloadPeriod

virtual void DtPhysicalWorldParams::setTerrainPreloadPeriod

(

double

seconds

)

[virtual]

See also:

myTerrainPreloadPeriod

virtual double DtPhysicalWorldParams::terrainPreloadExpireTime

(

)

const [virtual]

See also:

myTerrainPreloadExpireTime

virtual void DtPhysicalWorldParams::setTerrainPreloadExpireTime

(

double

seconds

)

[virtual]

See also:

myTerrainPreloadExpireTime

virtual double DtPhysicalWorldParams::terrainIntersectExpireTime

(

)

const [virtual]

See also:

myTerrainIntersectExpireTime

virtual void DtPhysicalWorldParams::setTerrainIntersectExpireTime

(

double

seconds

)

[virtual]

See also:

myTerrainIntersectExpireTime

virtual void DtPhysicalWorldParams::merge

(

const DtPhysicalWorldParams *

)

[virtual]

Merges the contents of the supplied parameters into this.

Includes merging any new tests and all lists

virtual void DtPhysicalWorldParams::mergeLineOfSightTests

(

const DtPhysicalWorldParams *

)

[virtual]

Merges in any line of sight tests that do not exist into the myLineOfSighTests list.

virtual void DtPhysicalWorldParams::addTest

(

const DtString &

test

)

[virtual]

Merges in any line of sight tests that do not exist into the myLineOfSighTests list.

virtual void DtPhysicalWorldParams::mergeSignaturePropagatorParams

(

const DtPhysicalWorldParams *

)

[virtual]

Merges entries from incoming physical world params signature propagator params into this one.

virtual void DtPhysicalWorldParams::mergeSpatialOrganizationObjectTypes

(

const DtPhysicalWorldParams *

)

[virtual]

Merges spatial objects types into this object.

---

Member Data Documentation

DtSignaturePropagatorDescriptorList DtPhysicalWorldParams::mySignaturePropagatorParams [protected]

DtRwNLengthStringVector DtPhysicalWorldParams::myLineOfSightTests [protected]

DtRwBoolean DtPhysicalWorldParams::myExtrudeVectorObstructions [protected]

DtRwBoolean DtPhysicalWorldParams::myAllowEnvironmentalEffects [protected]

DtRwObjectTypeList DtPhysicalWorldParams::mySpatialOrganizationObjectTypes [protected]

DtRwReal DtPhysicalWorldParams::myTerrainPreloadLookaheadTime [protected]

The number of seconds that the terrain pre-loader will look ahead of entity positions when preloading the terrain areas they may move on to.

DtRwReal DtPhysicalWorldParams::myTerrainPreloadPeriod [protected]

Evaluation period for terrain preload. Specified in seconds.

DtRwReal DtPhysicalWorldParams::myTerrainPreloadExpireTime [protected]

Expire time offset (from actual time) for preload data load requests.

DtRwReal DtPhysicalWorldParams::myTerrainIntersectExpireTime [protected]

Expire time offset (from actual time) for intersect data load requests.

---

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

• include/vrfobjparam/physicalWorldParams.h