VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Attributes | Private Member Functions
DtPhysicalWorldParams Class Reference

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

Inheritance diagram for DtPhysicalWorldParams:
Inheritance graph
[legend]

Public Types

enum  MergeFlags {
  LineOfSiteTests = 0x00000001, SignaturePropagatorParams = 0x00000002, IlluminationObjects = 0x00000004, SpatialOrganizationObjectTypes = 0x00000008,
  DefaultMerge = SignaturePropagatorParams | IlluminationObjects |SpatialOrganizationObjectTypes
}
 
- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
 
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
 
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
 
typedef std::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 

Public Member Functions

 DtPhysicalWorldParams (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
 Constructor. More...
 
 DtPhysicalWorldParams (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtPhysicalWorldParams (const DtPhysicalWorldParams &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
DtPhysicalWorldParamsoperator= (const DtPhysicalWorldParams &orig)
 assignment More...
 
virtual ~DtPhysicalWorldParams ()
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void mergeIlluminationObjects (const DtPhysicalWorldParams *l)
 Merges illumination object types into this object. More...
 
virtual
DtSignaturePropagatorDescriptorList
signaturePropagatorParams ()
 Parameters for configuring signature propagators instantiated by the DtPhysicalWorld's DtSensorSignatureManager. More...
 
virtual const
DtSignaturePropagatorDescriptorList
signaturePropagatorParams () const
 
virtual DtRwNLengthStringVectorlineOfSightTests ()
 Parameters for configuring types and order of Line of Sight tests performed by the physical world when general LOS queries are asked. More...
 
virtual const
DtRwNLengthStringVector
lineOfSightTests () const
 
virtual bool extrudeVectorObstructions () const
 If true (the default), the vector obstruction manager will extend all vector obstructions in the Z direction. More...
 
virtual void setExtrudeVectorObstructions (bool extrude)
 
virtual DtRwObjectTypeListspatialOrganizationObjectTypes ()
 The list of object types that will be spatially organized by the object spatial subdivision. More...
 
virtual const DtRwObjectTypeListspatialOrganizationObjectTypes () const
 
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 double featureLOSPredictionTime () const
 
virtual void setFeatureLOSPredictionTime (double seconds)
 
virtual double featureLOSCheckDistance () const
 
virtual void setFeatureLOSCheckDistance (double meters)
 
virtual double minimalIlluminationValue () const
 
virtual void setMinimalIlluminationValue (double)
 
virtual double nighttimeIlluminationValue () const
 
virtual void setNighttimeIlluminationValue (double)
 
virtual
DtIlluminationObjectParametersList
illuminationObjects ()
 
virtual const
DtIlluminationObjectParametersList
illuminationObjects () const
 
virtual DtRwString weatherStateProviderName () const
 
virtual void setWeatherStateProviderName (const DtRwString &)
 
Global Soil-Related Functions
virtual DtRwString deepWaterSoilName () const
 
virtual void setDeepWaterSoilName (const DtRwString &)
 
virtual DtRwString shallowWaterSoilName () const
 
virtual void setShallowWaterSoilName (const DtRwString &)
 
virtual DtRwString waterySoilName () const
 
virtual void setWaterySoilName (const DtRwString &)
 
virtual DtRwString drySoilName () const
 
virtual void setDrySoilName (const DtRwString &)
 
virtual DtRwString roadSoilName () const
 
virtual void setRoadSoilName (const DtRwString &)
 
virtual DtRwString snowSoilName () const
 
virtual void setSnowSoilName (const DtRwString &)
 
virtual DtRwString iceSoilName () const
 
virtual void setIceSoilName (const DtRwString &)
 
virtual double deepSnowDepth () const
 
virtual void setDeepSnowDepth (const double)
 
virtual double saturationWaterDepth () const
 
virtual void setSaturationWaterDepth (const double)
 
virtual double waterSlideDepth () const
 
virtual void setWaterSlideDepth (const double)
 
virtual double waterSlideFactor () const
 
virtual void setWaterSlideFactor (const double)
 
virtual double hardFreezeTemperature () const
 
virtual void setHardFreezeTemperature (const double)
 
virtual double normalizedPrecipitationRate () const
 
virtual void setNormalizedPrecipitationRate (const double)
 
virtual bool reduceVisibilityForPrecipitation () const
 
virtual void setReduceVisibilityForPrecipitation (const bool)
 
virtual void merge (const DtPhysicalWorldParams *, MergeFlags merge=DefaultMerge)
 Merges the contents of the supplied parameters into this. More...
 
virtual void mergeLineOfSightTests (const DtPhysicalWorldParams *)
 Merges in any line of sight tests that do not exist into the myLineOfSighTests list. More...
 
virtual void addTest (const DtString &test)
 
virtual void mergeSignaturePropagatorParams (const DtPhysicalWorldParams *)
 Merges entries from incoming physical world params signature propagator params into this one. More...
 
virtual void mergeSpatialOrganizationObjectTypes (const DtPhysicalWorldParams *)
 Merges spatial objects types into this object. More...
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor More...
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor More...
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator More...
 
bool operator== (const DtReaderWriter &) const
 Equivalence operator. More...
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 destructor More...
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file. More...
 
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op. More...
 
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream. More...
 
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op. More...
 
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op. More...
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...
 
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object. More...
 
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object. More...
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 Set read-only flag. More...
 
bool isReadonly () const
 
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...
 
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment. More...
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false. More...
 
virtual void setName (const DtString &)
 Set the name of the object. More...
 
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable. More...
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children. More...
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain. More...
 
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference. More...
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...
 
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated. More...
 
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time. More...
 
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called. More...
 
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
 
virtual void putData (std::string &fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data. More...
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values. More...
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively. More...
 
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference. More...
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here. More...
 
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
 
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename. More...
 
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid. More...
 
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file. More...
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data. More...
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference. More...
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 Gets data from the environment value. More...
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference. More...
 

Protected Attributes

DtSignaturePropagatorDescriptorList mySignaturePropagatorParams
 
DtRwNLengthStringVector myLineOfSightTests
 
DtRwBoolean myExtrudeVectorObstructions
 
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. More...
 
DtRwReal myTerrainPreloadPeriod
 Evaluation period for terrain preload. Specified in seconds. More...
 
DtRwReal myTerrainPreloadExpireTime
 Expire time offset (from actual time) for preload data load requests. More...
 
DtRwReal myTerrainIntersectExpireTime
 Expire time offset (from actual time) for intersect data load requests. More...
 
DtRwReal myFeatureLOSPredictionTime
 Number of seconds ahead to project entities when !doing predictive LOS feature paging. More...
 
DtRwReal myFeatureLOSCheckDistance
 Distance entity must travel in prediction time in order to start predictive loading. More...
 
DtRwReal myMinimalIlluminationValue
 The minimal value of illumination given no sun or moon present. Value is 0 - 1. More...
 
DtRwReal myNighttimeIlluminationValue
 The maximum nighttime illumination value given a full moon. Value is 0 - 1. More...
 
DtIlluminationObjectParametersList myIlluminationObjects
 List of object types that produce illumination. More...
 
DtRwString myWeatherStateProviderName
 Name of weather state provider class. More...
 
DtRwString myDeepWaterSoilName
 Name of soil that is considered deep water. More...
 
DtRwString myShallowWaterSoilName
 Name of soil that is considered shallow water. More...
 
DtRwString myWaterySoilName
 Name of soil that is considered watery soil. More...
 
DtRwString myDrySoilName
 Name of soil that is dry soil–not sand or gravel. More...
 
DtRwString myRoadSoilName
 Name of soil that is paved road. More...
 
DtRwString mySnowSoilName
 Name of "soil" that is snow. More...
 
DtRwString myIceSoilName
 Name of "soil" that is ice. More...
 
DtRwReal myDeepSnowDepth
 Depth of snow required for full snow soil effect. Meters. More...
 
DtRwReal mySaturationWaterDepth
 Depth of water accumulation before dry soil is changed completely to watery soil. More...
 
DtRwReal myWaterSlideDepth
 Depth of water on a hard surface that causes loss of normal traction. More...
 
DtRwReal myWaterSlideFactor
 Fraction [0-1] of traction retained on hard surface with water on it. More...
 
DtRwReal myHardFreezeTemperature
 Temperature at which shallow water is frozen enough to drive a vehicle on. More...
 
DtRwReal myNormalizedPrecipitationRate
 The (rain) precipitation rate corresponding to a value of 1.0 in a local weather object, or as the value from the environmental state manager function. More...
 
DtRwBoolean myReduceVisibilityForPrecipitation
 This flag determines whether to degrade visibility due to precipitation, on top of the effect of the visibility parameter in the weather state. More...
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object. More...
 
bool myInvalid
 Set to true if there is a problem reading this item. More...
 
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...
 

Private Member Functions

 DtPhysicalWorldParams ()
 default constructor; not implemented More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 The type that is used when archiving to an XML stream. More...
 
static const DtFilename & appPath ()
 Gets the current working directory. More...
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory. More...
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within. More...
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP. More...
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Detailed Description

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

Member Enumeration Documentation

Enumerator
LineOfSiteTests 
SignaturePropagatorParams 
IlluminationObjects 
SpatialOrganizationObjectTypes 
DefaultMerge 

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
origDtPhysicalWorldParams to copy.
parentRegistryThe 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 DtlObjPtr DtPhysicalWorldParams::getData ( DtlObjPtr  args,
const SearchPaths searchPaths,
const DtVariableBindingsList variableBindings 
)
virtual

Reimplemented from DtReaderWriter.

virtual DtSignaturePropagatorDescriptorList& DtPhysicalWorldParams::signaturePropagatorParams ( )
virtual

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

virtual const DtSignaturePropagatorDescriptorList& DtPhysicalWorldParams::signaturePropagatorParams ( ) const
virtual
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
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
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
virtual double DtPhysicalWorldParams::terrainPreloadLookaheadTime ( ) const
virtual
virtual void DtPhysicalWorldParams::setTerrainPreloadLookaheadTime ( double  v)
virtual
virtual double DtPhysicalWorldParams::terrainPreloadPeriod ( ) const
virtual
virtual void DtPhysicalWorldParams::setTerrainPreloadPeriod ( double  seconds)
virtual
virtual double DtPhysicalWorldParams::terrainPreloadExpireTime ( ) const
virtual
virtual void DtPhysicalWorldParams::setTerrainPreloadExpireTime ( double  seconds)
virtual
virtual double DtPhysicalWorldParams::terrainIntersectExpireTime ( ) const
virtual
virtual void DtPhysicalWorldParams::setTerrainIntersectExpireTime ( double  seconds)
virtual
virtual double DtPhysicalWorldParams::featureLOSPredictionTime ( ) const
virtual
virtual void DtPhysicalWorldParams::setFeatureLOSPredictionTime ( double  seconds)
virtual
virtual double DtPhysicalWorldParams::featureLOSCheckDistance ( ) const
virtual
virtual void DtPhysicalWorldParams::setFeatureLOSCheckDistance ( double  meters)
virtual
virtual double DtPhysicalWorldParams::minimalIlluminationValue ( ) const
virtual
virtual void DtPhysicalWorldParams::setMinimalIlluminationValue ( double  )
virtual
virtual double DtPhysicalWorldParams::nighttimeIlluminationValue ( ) const
virtual
virtual void DtPhysicalWorldParams::setNighttimeIlluminationValue ( double  )
virtual
virtual DtIlluminationObjectParametersList& DtPhysicalWorldParams::illuminationObjects ( )
virtual
virtual const DtIlluminationObjectParametersList& DtPhysicalWorldParams::illuminationObjects ( ) const
virtual
virtual DtRwString DtPhysicalWorldParams::weatherStateProviderName ( ) const
virtual
virtual void DtPhysicalWorldParams::setWeatherStateProviderName ( const DtRwString )
virtual
virtual DtRwString DtPhysicalWorldParams::deepWaterSoilName ( ) const
virtual
virtual void DtPhysicalWorldParams::setDeepWaterSoilName ( const DtRwString )
virtual
virtual DtRwString DtPhysicalWorldParams::shallowWaterSoilName ( ) const
virtual
virtual void DtPhysicalWorldParams::setShallowWaterSoilName ( const DtRwString )
virtual
virtual DtRwString DtPhysicalWorldParams::waterySoilName ( ) const
virtual
virtual void DtPhysicalWorldParams::setWaterySoilName ( const DtRwString )
virtual
virtual DtRwString DtPhysicalWorldParams::drySoilName ( ) const
virtual
See Also
myDrySoilName
virtual void DtPhysicalWorldParams::setDrySoilName ( const DtRwString )
virtual
virtual DtRwString DtPhysicalWorldParams::roadSoilName ( ) const
virtual
See Also
myRoadSoilName
virtual void DtPhysicalWorldParams::setRoadSoilName ( const DtRwString )
virtual
virtual DtRwString DtPhysicalWorldParams::snowSoilName ( ) const
virtual
See Also
mySnowSoilName
virtual void DtPhysicalWorldParams::setSnowSoilName ( const DtRwString )
virtual
virtual DtRwString DtPhysicalWorldParams::iceSoilName ( ) const
virtual
See Also
#myIceSoilType
virtual void DtPhysicalWorldParams::setIceSoilName ( const DtRwString )
virtual
virtual double DtPhysicalWorldParams::deepSnowDepth ( ) const
virtual
See Also
myDeepSnowDepth
virtual void DtPhysicalWorldParams::setDeepSnowDepth ( const double  )
virtual
virtual double DtPhysicalWorldParams::saturationWaterDepth ( ) const
virtual
virtual void DtPhysicalWorldParams::setSaturationWaterDepth ( const double  )
virtual
virtual double DtPhysicalWorldParams::waterSlideDepth ( ) const
virtual
virtual void DtPhysicalWorldParams::setWaterSlideDepth ( const double  )
virtual
virtual double DtPhysicalWorldParams::waterSlideFactor ( ) const
virtual
virtual void DtPhysicalWorldParams::setWaterSlideFactor ( const double  )
virtual
virtual double DtPhysicalWorldParams::hardFreezeTemperature ( ) const
virtual
virtual void DtPhysicalWorldParams::setHardFreezeTemperature ( const double  )
virtual
virtual double DtPhysicalWorldParams::normalizedPrecipitationRate ( ) const
virtual
virtual void DtPhysicalWorldParams::setNormalizedPrecipitationRate ( const double  )
virtual
virtual bool DtPhysicalWorldParams::reduceVisibilityForPrecipitation ( ) const
virtual
virtual void DtPhysicalWorldParams::setReduceVisibilityForPrecipitation ( const bool  )
virtual
virtual void DtPhysicalWorldParams::merge ( const DtPhysicalWorldParams ,
MergeFlags  merge = DefaultMerge 
)
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
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.

virtual void DtPhysicalWorldParams::mergeIlluminationObjects ( const DtPhysicalWorldParams l)
virtual

Merges illumination object types into this object.

Member Data Documentation

DtSignaturePropagatorDescriptorList DtPhysicalWorldParams::mySignaturePropagatorParams
protected
DtRwNLengthStringVector DtPhysicalWorldParams::myLineOfSightTests
protected
DtRwBoolean DtPhysicalWorldParams::myExtrudeVectorObstructions
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.

DtRwReal DtPhysicalWorldParams::myFeatureLOSPredictionTime
protected

Number of seconds ahead to project entities when !doing predictive LOS feature paging.

DtRwReal DtPhysicalWorldParams::myFeatureLOSCheckDistance
protected

Distance entity must travel in prediction time in order to start predictive loading.

DtRwReal DtPhysicalWorldParams::myMinimalIlluminationValue
protected

The minimal value of illumination given no sun or moon present. Value is 0 - 1.

DtRwReal DtPhysicalWorldParams::myNighttimeIlluminationValue
protected

The maximum nighttime illumination value given a full moon. Value is 0 - 1.

DtIlluminationObjectParametersList DtPhysicalWorldParams::myIlluminationObjects
protected

List of object types that produce illumination.

DtRwString DtPhysicalWorldParams::myWeatherStateProviderName
protected

Name of weather state provider class.

DtRwString DtPhysicalWorldParams::myDeepWaterSoilName
protected

Name of soil that is considered deep water.

DtRwString DtPhysicalWorldParams::myShallowWaterSoilName
protected

Name of soil that is considered shallow water.

DtRwString DtPhysicalWorldParams::myWaterySoilName
protected

Name of soil that is considered watery soil.

DtRwString DtPhysicalWorldParams::myDrySoilName
protected

Name of soil that is dry soil–not sand or gravel.

DtRwString DtPhysicalWorldParams::myRoadSoilName
protected

Name of soil that is paved road.

DtRwString DtPhysicalWorldParams::mySnowSoilName
protected

Name of "soil" that is snow.

DtRwString DtPhysicalWorldParams::myIceSoilName
protected

Name of "soil" that is ice.

DtRwReal DtPhysicalWorldParams::myDeepSnowDepth
protected

Depth of snow required for full snow soil effect. Meters.

DtRwReal DtPhysicalWorldParams::mySaturationWaterDepth
protected

Depth of water accumulation before dry soil is changed completely to watery soil.

Meters.

DtRwReal DtPhysicalWorldParams::myWaterSlideDepth
protected

Depth of water on a hard surface that causes loss of normal traction.

DtRwReal DtPhysicalWorldParams::myWaterSlideFactor
protected

Fraction [0-1] of traction retained on hard surface with water on it.

DtRwReal DtPhysicalWorldParams::myHardFreezeTemperature
protected

Temperature at which shallow water is frozen enough to drive a vehicle on.

Degrees C.

DtRwReal DtPhysicalWorldParams::myNormalizedPrecipitationRate
protected

The (rain) precipitation rate corresponding to a value of 1.0 in a local weather object, or as the value from the environmental state manager function.

This is used to normalize the precipitationValue returned from the weather state provider.

DtRwBoolean DtPhysicalWorldParams::myReduceVisibilityForPrecipitation
protected

This flag determines whether to degrade visibility due to precipitation, on top of the effect of the visibility parameter in the weather state.

Of course precipitation should degrade visibility, but the stealth viewer may use the visibility parameter as the net visibility including precipitation, in which case visibility should not be reduced further.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)