VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | 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 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
DtPhysicalWorldParamsoperator= (const DtPhysicalWorldParams &orig)
 assignment
virtual ~DtPhysicalWorldParams ()
virtual void mergeDynamicFeaturesObjectTypes (const DtPhysicalWorldParams *)
 Merges dynamic features object types into this list.
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 DtRwNLengthStringVectorlineOfSightTests ()
 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 DtRwObjectTypeListspatialOrganizationObjectTypes ()
 The list of object types that will be spatially organized by the object spatial subdivision.
virtual const DtRwObjectTypeListspatialOrganizationObjectTypes () 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 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 DtRwObjectTypeListdynamicFeaturesObjectTypes ()
 List of object types which will be turned into dynamic features.
virtual const DtRwObjectTypeListdynamicFeaturesObjectTypes () const
 List of object types which will be turned into dynamic features.
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.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
virtual void writeSelf (FILE *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.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
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.
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
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.
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.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

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.
DtRwReal myFeatureLOSPredictionTime
 Number of seconds ahead to project entities when !doing predictive LOS feature paging.
DtRwReal myFeatureLOSCheckDistance
 Distance entity must travel in prediction time in order to start predictive loading.
DtRwReal myMinimalIlluminationValue
 The minimal value of illumination given no sun or moon present. Value is 0 - 1.
DtRwReal myNighttimeIlluminationValue
 The maximum nighttime illumination value given a full moon. Value is 0 - 1.
DtRwObjectTypeList myDynamicFeaturesObjectTypes
 The list of object type patterns for creating dynamic features from entities.
- 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.
bool myInvalid
 Set to true if there is a problem reading this item.

Private Member Functions

 DtPhysicalWorldParams ()
 default constructor; not implemented

Additional Inherited Members

- 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 )()
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const chartheXmlType ()
 The type that is used when archiving to an XML stream.
static const DtFilename & appPath ()
 Gets the current working directory.
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static void cleanupFactory ()
static DtReaderWriterFactoryfactory ()
static DtReaderWritercreateFromXmlFile (const DtFilename &)
 Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromXml (const DtString &)
 Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP)
 Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- 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

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
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 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
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 DtRwObjectTypeList& DtPhysicalWorldParams::dynamicFeaturesObjectTypes ( )
virtual

List of object types which will be turned into dynamic features.

virtual const DtRwObjectTypeList& DtPhysicalWorldParams::dynamicFeaturesObjectTypes ( ) const
virtual

List of object types which will be turned into dynamic features.

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.

virtual void DtPhysicalWorldParams::mergeDynamicFeaturesObjectTypes ( const DtPhysicalWorldParams )
virtual

Merges dynamic features object types into this list.

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.

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.

DtRwObjectTypeList DtPhysicalWorldParams::myDynamicFeaturesObjectTypes
protected

The list of object type patterns for creating dynamic features from entities.


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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)