Handles the environmental state of the simulation. More...

Public Member Functions
	DtEnvironmentalStateManager (DtSimManager *simManager)
	constructor More...

virtual	~DtEnvironmentalStateManager ()
	destructor More...

virtual bool	init ()

virtual void	tick ()

virtual DtSimManager *	simManager ()

virtual bool	globalEnvironmentSimulatedLocally () const

virtual bool	startEnvironmentSimulationLocally ()
	Starts simulating the global environment locally on this simulation engine. More...

virtual DtSharedVrfObjectReference	weatherObjectFor (const DtUUID &=DtUUID::nullUUID(), bool *isGlobal=0) const
	Returns the weather object given the specified name (if blank uses global weather) More...

virtual DtSharedVrfObjectReference	weatherObjectFor (const DtVector &localPosition, bool *isGlobal=0) const
	Returns the weather object of the highest priority at the given location. More...

virtual std::vector < DtSharedVrfObjectReference >	weatherObjectsFor (const DtChord &localChord) const
	Returns all weather objects that are intersected by this chord. More...

virtual DtSharedVrfObjectReference	weatherObjectFor (const DtChord &localChord, bool *isGlobal=0) const
	Returns the weather object of the first area hit by this chord. More...

virtual DtSharedVrfObjectReference	cloudLayerFor (const DtUUID &) const
	Returns the cloud layer object given the specified name (if blank uses global weather) More...

virtual DtSharedVrfObjectReference	cloudLayerFor (const DtVector &localPosition) const
	Returns the cloud layer at the given location. if multiple at the same location returns the first hit. More...

virtual DtSharedVrfObjectReference	cloudLayerFor (const DtChord &localChord) const
	Returns the cloud layer object of the first area hit by this chord. More...

virtual std::vector < DtSharedVrfObjectReference >	cloudLayersFor (const DtChord &localChord) const
	Returns all cloud layer objects that are intersected by this chord. More...

virtual std::vector < DtSharedVrfObjectReference >	cloudLayers () const
	Returns a vector of all the cloud layers. More...

virtual void	setCloudType (CloudLayerCloudType, const DtUUID &cloudLayer)
	Individual cloud layer mutators/accessors. More...

virtual CloudLayerCloudType	cloudType (const DtUUID &cloudLayer) const

virtual CloudLayerCloudType	cloudType (const DtVector &cloudLayer) const

virtual void	setCloudAltitude (double, const DtUUID &cloudLayer)

virtual double	cloudAltitude (const DtUUID &cloudLayer) const

virtual double	cloudAltitude (const DtVector &cloudLayer) const

virtual void	setCloudThickness (double, const DtUUID &cloudLayer)

virtual double	cloudThickness (const DtUUID &cloudLayer) const

virtual double	cloudThickness (const DtVector &cloudLayer) const

virtual void	setCornerRadius (double, const DtUUID &cloudLayer)

virtual double	cornerRadius (const DtUUID &cloudLayer) const

virtual double	cornerRadius (const DtVector &cloudLayer) const

virtual void	setCloudDensity (double, const DtUUID &cloudLayer)

virtual double	cloudDensity (const DtUUID &cloudLayer) const

virtual double	cloudDensity (const DtVector &cloudLayer) const

virtual void	setCloudBox (const DtVector &center, double width, double length, const DtUUID &cloudLayer)

virtual void	cloudBox (const DtUUID &cloudLayer, DtVector &center, double &width, double &length) const

virtual void	cloudBox (const DtVector &cloudLayer, DtVector &center, double &width, double &length) const

virtual void	setCloudLayerState (const DtChangeCloudLayerCommand &command)
	Calls the appropriate setXXX() functions locally, depending on what is in the command. More...

virtual double	illumination (const DtVector &localPosition) const
	Illumination in percentage (0 to 1.0) at a particular location. More...

virtual double	expectedIllumination (const DtVector &localPosition, double dateAndTime) const
	The expected illumination in percentage (0 to 1.0) from the sun at a particular location and time. More...

virtual void	setWeatherState (const DtChangeWeatherCommand &command)
	Calls the appropriate setXXX() functions locally, depending on what is in the command. More...

virtual void	setUseDayNightIlluminationModel (const DtChangeTimeOfDayCommand &command)
	The current time of day, specified by the number of seconds passed midnight. More...

virtual void	setDateAndTimeOfDay (double secondsPastMidnight)

virtual void	setDateAndTimeOfDay (const DtChangeTimeOfDayCommand &command)

virtual double	timeOfDay () const

virtual double	dateAndTimeOfDay () const

virtual void	setTimeOfDayAdvancementSpeed (double speed)
	The current time of day advancement speed. More...

virtual void	setTimeOfDayAdvancementSpeed (const DtChangeTimeOfDayCommand &command)

virtual double	timeOfDayAdvancementSpeed () const

virtual DtObjectType	globalEnvironmentObjectType () const

virtual void	computeSoilWeatherMobilityModifiers (const DtVector &location, const DtString &soilType, double &snowEffectFraction, DtString &alternateSoil, double &alternateSoilFraction, double &tractionModifier) const
	This function computes a set of modifiers for a given soil based on weather conditions at the given location, for the purposes of changing ground vehicle mobility. More...

virtual void	createGlobalEnvironmentObject ()
	Creates a new locally simulated VRF object with the type returned from glovalEnvironmentObjectType(). More...


virtual void	setAirTurbidity (double factor, const DtUUID &weatherArea=DtUUID::nullUUID())
	For weather. More...

virtual double	airTurbidity (const DtUUID &weatherArea) const

virtual double	airTurbidity (const DtVector &) const


virtual void	setAmbientAirTemperature (double temp, const DtUUID &weatherArea=DtUUID::nullUUID())
	Ambient Air Temperature (in Celsius) More...

virtual double	ambientAirTemperature (const DtUUID &weatherArea) const

virtual double	ambientAirTemperature (const DtVector &) const

virtual double	ambientAirTemperature (const DtVector &, double defaultMslTemperature) const


virtual double	temperatureAtAltitude (double altitude, const double defaultMslTemperature=15.04) const
	Temperature at altitude (in Celcius) Looks up weather at lat-lon to get assumed MSL temperature; Uses default MSL temp (standard atmosphere) if no temperature is available from weather object. More...


virtual double	pressureAtAltitude (double altitude, const double temperatureAtAltitudeInCelcius, const double defaultMslPressure=0.7600) const
	Looks up weather at lat-lon to get assumed MSL pressure; uses default MSL pressure if no value is available from a weather object. More...


virtual void	setCloudState (DtVrfWeatherCloudState current, const DtUUID &weatherArea=DtUUID::nullUUID())
	Cloud state enumeration. More...

virtual DtVrfWeatherCloudState	cloudState (const DtUUID &weatherArea) const

virtual DtVrfWeatherCloudState	cloudState (const DtVector &) const


virtual void	setPrecipitationIntensity (double factor, const DtUUID &weatherArea=DtUUID::nullUUID())
	Precipitation Intensity. More...

virtual double	precipitationIntensity (const DtUUID &weatherArea) const

virtual double	precipitationIntensity (const DtVector &) const


virtual double	precipitationIntensity (const DtChord &) const
	Supply a chord in local coordinates – this will get the average precipitation intensity through a particular weather area or simply use global if it crosses no area. More...


virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType current, const DtUUID &weatherArea=DtUUID::nullUUID())
	Weather state enumeration. More...

virtual DtVrfWeatherPrecipitationType	precipitationType (const DtUUID &weatherArea) const

virtual DtVrfWeatherPrecipitationType	precipitationType (const DtVector &) const


virtual void	setWindSpeed (double value, const DtUUID &weatherArea=DtUUID::nullUUID())
	Wind speed in m/s. More...

virtual double	windSpeed (const DtUUID &weatherArea) const

virtual double	windSpeed (const DtVector &) const


virtual void	setWindDirection (double value, const DtUUID &weatherArea=DtUUID::nullUUID())
	Wind direction in radians. More...

virtual double	windDirection (const DtUUID &weatherArea) const

virtual double	windDirection (const DtVector &) const


virtual void	setVisibility (double value, const DtUUID &weatherArea=DtUUID::nullUUID())
	Visibility in meters. More...

virtual double	visibility (const DtUUID &weatherArea) const

virtual double	visibility (const DtVector &) const

virtual double	visibility (const DtChord &) const
	Supply a chord in local coordinates. More...


virtual void	setPriority (int p, const DtUUID &weatherArea=DtUUID::nullUUID())
	Sets the priority of the weather area. This value is not used for global weather. More...

virtual int	priority (const DtUUID &weatherArea) const

virtual int	priority (const DtVector &) const


virtual void	setUnderwaterVisibility (double underwaterVisibility, const DtUUID &weatherArea=DtUUID::nullUUID())
	Underwater visibility in meters. More...

virtual double	underwaterVisibility (const DtUUID &weatherArea) const

virtual double	underwaterVisibility (const DtVector &) const


virtual void	setSurfaceTransparency (double transparency, const DtUUID &weatherArea=DtUUID::nullUUID())
	Surface transparency (percentage) More...

virtual double	surfaceTransparency (const DtUUID &weatherArea) const

virtual double	surfaceTransparency (const DtVector &) const


virtual void	setWaterCurrentSpeed (double waterCurrentSpeed, const DtUUID &weatherArea=DtUUID::nullUUID())
	Water velocity in meters per second. More...

virtual double	waterCurrentSpeed (const DtUUID &weatherArea) const

virtual double	waterCurrentSpeed (const DtVector &) const


virtual void	setWaterCurrentDirection (double waterCurrentDirection, const DtUUID &weatherArea=DtUUID::nullUUID())
	Water direction in radians clockwise from 0 (north) More...

virtual double	waterCurrentDirection (const DtUUID &weatherArea) const

virtual double	waterCurrentDirection (const DtVector &) const


virtual void	setAmbientWaterTemperature (double waterTemperature, const DtUUID &weatherArea=DtUUID::nullUUID())
	Ambient water temperature in Celsius. More...

virtual double	ambientWaterTemperature (const DtUUID &weatherArea) const

virtual double	ambientWaterTemperature (const DtVector &) const


virtual void	setTidalOffset (double tidalOffset, const DtUUID &weatherArea=DtUUID::nullUUID())
	Tidal offset in meters from the water polygons in the database. More...

virtual double	tidalOffset (const DtUUID &weatherArea) const

virtual double	tidalOffset (const DtVector &) const


virtual void	setUseDayNightIlluminationModel (bool)
	If false uses GMT as the position of sunrise/sunset (default) rather than entity position. More...

virtual bool	useDayNightIlluminationModel () const


virtual void	setTidalDirection (bool tidalDirection, const DtUUID &weatherArea=DtUUID::nullUUID())
	Tidal direction where true represents the tide going in and false represents the tide going out. More...

virtual bool	tidalDirection (const DtUUID &weatherArea) const

virtual bool	tidalDirection (const DtVector &) const


virtual void	setSwellState (unsigned int state, const DtUUID &weatherArea=DtUUID::nullUUID())
	Swell state according to the Douglas Sea Scale (integer 0 - 9) More...

virtual unsigned int	swellState (const DtUUID &weatherArea) const

virtual unsigned int	swellState (const DtVector &) const


virtual void	setSwellStateDirection (double direction, const DtUUID &weatherArea=DtUUID::nullUUID())
	Swell direction in in radians clockwise from 0 (north) More...

virtual double	swellStateDirection (const DtUUID &weatherArea) const

virtual double	swellStateDirection (const DtVector &) const


virtual void	setSeaState (unsigned int state, const DtUUID &weatherArea=DtUUID::nullUUID())
	Sea state according to the Douglas Sea Scale (integer 0 - 9) More...

virtual unsigned int	seaState (const DtUUID &weatherArea) const

virtual unsigned int	seaState (const DtVector &) const


virtual void	setSeaStateDirection (double direction, const DtUUID &weatherArea=DtUUID::nullUUID())
	Sea state direction in in radians clockwise from 0 (north) More...

virtual double	seaStateDirection (const DtUUID &weatherArea) const

virtual double	seaStateDirection (const DtVector &) const


virtual void	setWindDrivenSeaStateEnabled (bool b, const DtUUID &weatherArea=DtUUID::nullUUID())
	Determines if the sea state is set based on the wind. More...

virtual bool	windDrivenSeaStateEnabled (const DtUUID &weatherArea) const

virtual bool	windDrivenSeaStateEnabled (const DtVector &) const


virtual void	setChoppiness (double choppiness, const DtUUID &weatherArea=DtUUID::nullUUID())
	Wave choppiness (0..1) More...

virtual double	choppiness (const DtUUID &weatherArea) const

virtual double	choppiness (const DtVector &) const


virtual void	setSurgeDepth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
	Surge depth (meters) More...

virtual double	surgeDepth (const DtUUID &weatherArea) const

virtual double	surgeDepth (const DtVector &) const


virtual void	setFogHeight (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
	Fog height (meters) More...

virtual double	fogHeight (const DtUUID &weatherArea) const

virtual double	fogHeight (const DtVector &) const


virtual void	setFogColor (const DtVector &color, const DtUUID &weatherArea=DtUUID::nullUUID())
	Fog color (x = red, y = green, z = blue) More...

virtual DtVector	fogColor (const DtUUID &weatherArea) const

virtual DtVector	fogColor (const DtVector &) const


virtual void	setSnowAccumulation (double snow, const DtUUID &weatherArea=DtUUID::nullUUID())
	Snow Accumulation (meters) More...

virtual double	snowAccumulation (const DtUUID &weatherArea) const

virtual double	snowAccumulation (const DtVector &) const


virtual void	setSnowMinimumAltitude (double snow, const DtUUID &weatherArea=DtUUID::nullUUID())
	Snow Minimum Altitude (meters) More...

virtual double	snowMinimumAltitude (const DtUUID &weatherArea) const

virtual double	snowMinimumAltitude (const DtVector &) const


virtual void	setSnowRoadAccumulation (double snow, const DtUUID &weatherArea=DtUUID::nullUUID())
	Snow Road Accumulation (meters) More...

virtual double	snowRoadAccumulation (const DtUUID &weatherArea) const

virtual double	snowRoadAccumulation (const DtVector &) const


virtual void	setRainAccumulation (double rain, const DtUUID &weatherArea=DtUUID::nullUUID())
	Rain Accumulation (meters) More...

virtual double	rainAccumulation (const DtUUID &weatherArea) const

virtual double	rainAccumulation (const DtVector &) const


virtual void	setThermoclineLayer1Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
	Thermocline depth (in meters) and permeability (0..1). More...

virtual double	thermoclineLayer1Depth (const DtUUID &weatherArea) const

virtual double	thermoclineLayer1Depth (const DtVector &) const

virtual void	setThermoclineLayer1Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer1Permeability (const DtUUID &weatherArea) const

virtual double	thermoclineLayer1Permeability (const DtVector &) const

virtual void	setThermoclineLayer2Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer2Depth (const DtUUID &weatherArea) const

virtual double	thermoclineLayer2Depth (const DtVector &) const

virtual void	setThermoclineLayer2Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer2Permeability (const DtUUID &weatherArea) const

virtual double	thermoclineLayer2Permeability (const DtVector &) const

virtual void	setThermoclineLayer3Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer3Depth (const DtUUID &weatherArea) const

virtual double	thermoclineLayer3Depth (const DtVector &) const

virtual void	setThermoclineLayer3Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer3Permeability (const DtUUID &weatherArea) const

virtual double	thermoclineLayer3Permeability (const DtVector &) const

virtual void	setThermoclineLayer4Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer4Depth (const DtUUID &weatherArea) const

virtual double	thermoclineLayer4Depth (const DtVector &) const

virtual void	setThermoclineLayer4Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer4Permeability (const DtUUID &weatherArea) const

virtual double	thermoclineLayer4Permeability (const DtVector &) const

virtual void	setThermoclineLayer5Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer5Depth (const DtUUID &weatherArea) const

virtual double	thermoclineLayer5Depth (const DtVector &) const

virtual void	setThermoclineLayer5Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())

virtual double	thermoclineLayer5Permeability (const DtUUID &weatherArea) const

virtual double	thermoclineLayer5Permeability (const DtVector &) const

Global Soil-Related Functions
virtual DtString	deepWaterSoilName () const

virtual void	setDeepWaterSoilName (const DtString &)


virtual DtString	shallowWaterSoilName () const

virtual void	setShallowWaterSoilName (const DtString &)


virtual DtString	waterySoilName () const

virtual void	setWaterySoilName (const DtString &)


virtual DtString	drySoilName () const

virtual void	setDrySoilName (const DtString &)


virtual DtString	roadSoilName () const

virtual void	setRoadSoilName (const DtString &)


virtual DtString	snowSoilName () const

virtual void	setSnowSoilName (const DtString &)


virtual DtString	iceSoilName () const

virtual void	setIceSoilName (const DtString &)


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)

Protected Member Functions
virtual void	processObjectAdded (const DtVrfObject *object)

virtual void	processObjectRemoved (const DtVrfObject *object)

virtual DtEnvironmentalStateSetter *	createLocalEnvironmentalStateSetter ()

virtual DtEnvironmentalStateSetter *	createRemoteEnvironmentalStateSetter ()

virtual void	processChangeWeatherPriorities (DtSimMessage *msg)

virtual void	processRequestWeatherAtLocation (DtSimMessage *msg)

virtual void	initializeIlluminationObjectsList ()

virtual void	initializeSoilCharacteristics ()
	Copy soil names and soil weather parameters from the physicalWorld parameters. More...

virtual const DtIlluminationObjectParameters &	findBestMatch (const DtObjectType &objtype) const

Static Protected Member Functions
static void	objectAddedCallback (const DtVrfObject object, void usr)

static void	objectRemovedCallback (const DtVrfObject object, void usr)

static void	changeWeatherPrioritiesCallback (DtSimMessage msg, void usr)

static void	requestWeatherAtLocationCallback (DtSimMessage msg, void usr)

static void	physicalWorldParametersChangedCallback (void *usr)

Protected Attributes
DtSimManager *	mySimManager

DtSharedVrfObjectReference	myGlobalEnvironmentObject

DtRwVrfObjectReferenceList	myWeatherObjects

DtRwVrfObjectReferenceList	myCloudLayerObjects

DtEnvironmentalStateSetter *	myEnvironmentalStateSetter
	This is only for setting global weather – local weather will use local vrf objects. More...

bool	myFirstTick

DtVector	myLastPointChecked
	For faster access for consecutive lookups given a point. More...

DtSharedVrfObjectReference	myLastWeatherByPoint

DtManagedObjectListConstPtr	myIlluminationObjects

std::map< DtObjectType, DtIlluminationObjectParameters >	myIlluminationObjectTypes

DtString	myDeepWaterSoilName
	Name of soil that is considered deep water. More...

DtString	myShallowWaterSoilName
	Name of soil that is considered shallow water. More...

DtString	myWaterySoilName
	Name of soil that is considered watery soil. More...

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

DtString	myRoadSoilName
	Name of soil that is paved road. More...

DtString	mySnowSoilName
	Name of "soil" that is snow. More...

DtString	myIceSoilName
	Name of "soil" that is ice. More...

double	myDeepSnowDepth
	Depth of snow required for full snow soil effect. Meters. More...

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

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

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

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

Private Member Functions

	DtEnvironmentalStateManager (const DtEnvironmentalStateManager &orig)
	Not implemented. More...

const DtEnvironmentalStateManager &	operator= (const DtEnvironmentalStateManager &orig)

	DtEnvironmentalStateManager ()

Detailed Description

Handles the environmental state of the simulation.

Currently there is only one environmental state for the whole simulation. This manager provides access to the environmental state and is responsible for updating the environmental state from the network.

As a general rule an empty weatherArea name will return weather for the global area. A vector location of zero() will also return global weather

Constructor & Destructor Documentation

DtEnvironmentalStateManager::DtEnvironmentalStateManager ( const DtEnvironmentalStateManager & orig )

private

Not implemented.

DtEnvironmentalStateManager::DtEnvironmentalStateManager ( )

private

DtEnvironmentalStateManager::DtEnvironmentalStateManager ( DtSimManager * simManager )

constructor

virtual DtEnvironmentalStateManager::~DtEnvironmentalStateManager ( )

virtual

destructor

Member Function Documentation

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

private

virtual bool DtEnvironmentalStateManager::init ( )

virtual

virtual void DtEnvironmentalStateManager::tick ( )

virtual

virtual DtSimManager* DtEnvironmentalStateManager::simManager ( )

virtual

virtual bool DtEnvironmentalStateManager::globalEnvironmentSimulatedLocally ( ) const

virtual

Returns: True if the global environment is currently being simulated by this simulation engine.

virtual bool DtEnvironmentalStateManager::startEnvironmentSimulationLocally ( )

virtual

Starts simulating the global environment locally on this simulation engine.

Only starts the local simulation if there is not one (remote or local) already running.

Returns: True if successful.

virtual DtSharedVrfObjectReference DtEnvironmentalStateManager::weatherObjectFor	(	const DtUUID &	= `DtUUID::nullUUID()`,
		bool *	isGlobal = `0`
	)		const

virtual

Returns the weather object given the specified name (if blank uses global weather)

virtual DtSharedVrfObjectReference DtEnvironmentalStateManager::weatherObjectFor	(	const DtVector &	localPosition,
		bool *	isGlobal = `0`
	)		const

virtual

Returns the weather object of the highest priority at the given location.

If no local weather returns global weather

virtual std::vector<DtSharedVrfObjectReference> DtEnvironmentalStateManager::weatherObjectsFor ( const DtChord & localChord ) const

virtual

Returns all weather objects that are intersected by this chord.

The global weather object is always returned on the list unless the chord intersects only one weather object, and both endpoints are within that object.

virtual DtSharedVrfObjectReference DtEnvironmentalStateManager::weatherObjectFor	(	const DtChord &	localChord,
		bool *	isGlobal = `0`
	)		const

virtual

Returns the weather object of the first area hit by this chord.

virtual DtSharedVrfObjectReference DtEnvironmentalStateManager::cloudLayerFor ( const DtUUID & ) const

virtual

Returns the cloud layer object given the specified name (if blank uses global weather)

virtual DtSharedVrfObjectReference DtEnvironmentalStateManager::cloudLayerFor ( const DtVector & localPosition ) const

virtual

Returns the cloud layer at the given location. if multiple at the same location returns the first hit.

virtual DtSharedVrfObjectReference DtEnvironmentalStateManager::cloudLayerFor ( const DtChord & localChord ) const

virtual

Returns the cloud layer object of the first area hit by this chord.

virtual std::vector<DtSharedVrfObjectReference> DtEnvironmentalStateManager::cloudLayersFor ( const DtChord & localChord ) const

virtual

Returns all cloud layer objects that are intersected by this chord.

virtual std::vector<DtSharedVrfObjectReference> DtEnvironmentalStateManager::cloudLayers ( ) const

virtual

Returns a vector of all the cloud layers.

virtual void DtEnvironmentalStateManager::setCloudType	(	CloudLayerCloudType	,
		const DtUUID &	cloudLayer
	)

virtual

Individual cloud layer mutators/accessors.

virtual CloudLayerCloudType DtEnvironmentalStateManager::cloudType ( const DtUUID & cloudLayer ) const

virtual

virtual CloudLayerCloudType DtEnvironmentalStateManager::cloudType ( const DtVector & cloudLayer ) const

virtual

virtual void DtEnvironmentalStateManager::setCloudAltitude	(	double	,
		const DtUUID &	cloudLayer
	)

virtual

virtual double DtEnvironmentalStateManager::cloudAltitude ( const DtUUID & cloudLayer ) const

virtual

virtual double DtEnvironmentalStateManager::cloudAltitude ( const DtVector & cloudLayer ) const

virtual

virtual void DtEnvironmentalStateManager::setCloudThickness	(	double	,
		const DtUUID &	cloudLayer
	)

virtual

virtual double DtEnvironmentalStateManager::cloudThickness ( const DtUUID & cloudLayer ) const

virtual

virtual double DtEnvironmentalStateManager::cloudThickness ( const DtVector & cloudLayer ) const

virtual

virtual void DtEnvironmentalStateManager::setCornerRadius	(	double	,
		const DtUUID &	cloudLayer
	)

virtual

virtual double DtEnvironmentalStateManager::cornerRadius ( const DtUUID & cloudLayer ) const

virtual

virtual double DtEnvironmentalStateManager::cornerRadius ( const DtVector & cloudLayer ) const

virtual

virtual void DtEnvironmentalStateManager::setCloudDensity	(	double	,
		const DtUUID &	cloudLayer
	)

virtual

virtual double DtEnvironmentalStateManager::cloudDensity ( const DtUUID & cloudLayer ) const

virtual

virtual double DtEnvironmentalStateManager::cloudDensity ( const DtVector & cloudLayer ) const

virtual

virtual void DtEnvironmentalStateManager::setCloudBox	(	const DtVector &	center,
		double	width,
		double	length,
		const DtUUID &	cloudLayer
	)

virtual

virtual void DtEnvironmentalStateManager::cloudBox	(	const DtUUID &	cloudLayer,
		DtVector &	center,
		double &	width,
		double &	length
	)		const

virtual

virtual void DtEnvironmentalStateManager::cloudBox	(	const DtVector &	cloudLayer,
		DtVector &	center,
		double &	width,
		double &	length
	)		const

virtual

virtual void DtEnvironmentalStateManager::setCloudLayerState ( const DtChangeCloudLayerCommand & command )

virtual

Calls the appropriate setXXX() functions locally, depending on what is in the command.

virtual void DtEnvironmentalStateManager::setAirTurbidity	(	double	factor,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

For weather.

Individual Environmental effects accessors Air Turbidity

virtual double DtEnvironmentalStateManager::airTurbidity ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::airTurbidity ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setAmbientAirTemperature	(	double	temp,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Ambient Air Temperature (in Celsius)

virtual double DtEnvironmentalStateManager::ambientAirTemperature ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::ambientAirTemperature ( const DtVector & ) const

virtual

virtual double DtEnvironmentalStateManager::ambientAirTemperature	(	const DtVector &	,
		double	defaultMslTemperature
	)		const

virtual

virtual double DtEnvironmentalStateManager::temperatureAtAltitude	(	double	altitude,
		const double	defaultMslTemperature = `15.04`
	)		const

virtual

Temperature at altitude (in Celcius) Looks up weather at lat-lon to get assumed MSL temperature; Uses default MSL temp (standard atmosphere) if no temperature is available from weather object.

Uses altitude to calculate final temp. altitude is in meters

virtual double DtEnvironmentalStateManager::pressureAtAltitude	(	double	altitude,
		const double	temperatureAtAltitudeInCelcius,
		const double	defaultMslPressure = `0.7600`
	)		const

virtual

Looks up weather at lat-lon to get assumed MSL pressure; uses default MSL pressure if no value is available from a weather object.

(4.8 IPB5– env object has no pressure values.) Uses altitude to calculate final pressure. altitude is in meters defaultMslPressure = meters of mercury; standard atmosphere calls temperatureAtAltitude() Returns pressure in meters of mercury

virtual void DtEnvironmentalStateManager::setCloudState	(	DtVrfWeatherCloudState	current,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Cloud state enumeration.

virtual DtVrfWeatherCloudState DtEnvironmentalStateManager::cloudState ( const DtUUID & weatherArea ) const

virtual

virtual DtVrfWeatherCloudState DtEnvironmentalStateManager::cloudState ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setPrecipitationIntensity	(	double	factor,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Precipitation Intensity.

virtual double DtEnvironmentalStateManager::precipitationIntensity ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::precipitationIntensity ( const DtVector & ) const

virtual

virtual double DtEnvironmentalStateManager::precipitationIntensity ( const DtChord & ) const

virtual

Supply a chord in local coordinates – this will get the average precipitation intensity through a particular weather area or simply use global if it crosses no area.

virtual void DtEnvironmentalStateManager::setPrecipitationType	(	DtVrfWeatherPrecipitationType	current,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Weather state enumeration.

virtual DtVrfWeatherPrecipitationType DtEnvironmentalStateManager::precipitationType ( const DtUUID & weatherArea ) const

virtual

virtual DtVrfWeatherPrecipitationType DtEnvironmentalStateManager::precipitationType ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setWindSpeed	(	double	value,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Wind speed in m/s.

virtual double DtEnvironmentalStateManager::windSpeed ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::windSpeed ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setWindDirection	(	double	value,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Wind direction in radians.

virtual double DtEnvironmentalStateManager::windDirection ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::windDirection ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setVisibility	(	double	value,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Visibility in meters.

virtual double DtEnvironmentalStateManager::visibility ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::visibility ( const DtVector & ) const

virtual

virtual double DtEnvironmentalStateManager::visibility ( const DtChord & ) const

virtual

Supply a chord in local coordinates.

This function gets all of the weather objects that the chord intersects and returns the minimum visibility of all objects. Returns the visibility in meters.

virtual double DtEnvironmentalStateManager::illumination ( const DtVector & localPosition ) const

virtual

Illumination in percentage (0 to 1.0) at a particular location.

Illumination cannot be set directly. It is a function of location and time of day.

virtual double DtEnvironmentalStateManager::expectedIllumination	(	const DtVector &	localPosition,
		double	dateAndTime
	)		const

virtual

The expected illumination in percentage (0 to 1.0) from the sun at a particular location and time.

Ignores other light sources. Illumination cannot be set directly. It is a function of location and time of day.

virtual void DtEnvironmentalStateManager::setWeatherState ( const DtChangeWeatherCommand & command )

virtual

Calls the appropriate setXXX() functions locally, depending on what is in the command.

virtual void DtEnvironmentalStateManager::setUseDayNightIlluminationModel ( const DtChangeTimeOfDayCommand & command )

virtual

The current time of day, specified by the number of seconds passed midnight.

virtual void DtEnvironmentalStateManager::setDateAndTimeOfDay ( double secondsPastMidnight )

virtual

virtual void DtEnvironmentalStateManager::setDateAndTimeOfDay ( const DtChangeTimeOfDayCommand & command )

virtual

virtual double DtEnvironmentalStateManager::timeOfDay ( ) const

virtual

virtual double DtEnvironmentalStateManager::dateAndTimeOfDay ( ) const

virtual

virtual void DtEnvironmentalStateManager::setTimeOfDayAdvancementSpeed ( double speed )

virtual

The current time of day advancement speed.

virtual void DtEnvironmentalStateManager::setTimeOfDayAdvancementSpeed ( const DtChangeTimeOfDayCommand & command )

virtual

virtual double DtEnvironmentalStateManager::timeOfDayAdvancementSpeed ( ) const

virtual

virtual void DtEnvironmentalStateManager::setPriority	(	int	p,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Sets the priority of the weather area. This value is not used for global weather.

virtual int DtEnvironmentalStateManager::priority ( const DtUUID & weatherArea ) const

virtual

virtual int DtEnvironmentalStateManager::priority ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setUnderwaterVisibility	(	double	underwaterVisibility,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Underwater visibility in meters.

virtual double DtEnvironmentalStateManager::underwaterVisibility ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::underwaterVisibility ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSurfaceTransparency	(	double	transparency,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Surface transparency (percentage)

virtual double DtEnvironmentalStateManager::surfaceTransparency ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::surfaceTransparency ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setWaterCurrentSpeed	(	double	waterCurrentSpeed,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Water velocity in meters per second.

virtual double DtEnvironmentalStateManager::waterCurrentSpeed ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::waterCurrentSpeed ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setWaterCurrentDirection	(	double	waterCurrentDirection,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Water direction in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::waterCurrentDirection ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::waterCurrentDirection ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setAmbientWaterTemperature	(	double	waterTemperature,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Ambient water temperature in Celsius.

virtual double DtEnvironmentalStateManager::ambientWaterTemperature ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::ambientWaterTemperature ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setTidalOffset	(	double	tidalOffset,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Tidal offset in meters from the water polygons in the database.

virtual double DtEnvironmentalStateManager::tidalOffset ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::tidalOffset ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setUseDayNightIlluminationModel ( bool )

virtual

If false uses GMT as the position of sunrise/sunset (default) rather than entity position.

virtual bool DtEnvironmentalStateManager::useDayNightIlluminationModel ( ) const

virtual

virtual void DtEnvironmentalStateManager::setTidalDirection	(	bool	tidalDirection,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Tidal direction where true represents the tide going in and false represents the tide going out.

virtual bool DtEnvironmentalStateManager::tidalDirection ( const DtUUID & weatherArea ) const

virtual

virtual bool DtEnvironmentalStateManager::tidalDirection ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSwellState	(	unsigned int	state,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtEnvironmentalStateManager::swellState ( const DtUUID & weatherArea ) const

virtual

virtual unsigned int DtEnvironmentalStateManager::swellState ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSwellStateDirection	(	double	direction,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::swellStateDirection ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::swellStateDirection ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSeaState	(	unsigned int	state,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Sea state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtEnvironmentalStateManager::seaState ( const DtUUID & weatherArea ) const

virtual

virtual unsigned int DtEnvironmentalStateManager::seaState ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSeaStateDirection	(	double	direction,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Sea state direction in in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::seaStateDirection ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::seaStateDirection ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setWindDrivenSeaStateEnabled	(	bool	b,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Determines if the sea state is set based on the wind.

virtual bool DtEnvironmentalStateManager::windDrivenSeaStateEnabled ( const DtUUID & weatherArea ) const

virtual

virtual bool DtEnvironmentalStateManager::windDrivenSeaStateEnabled ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setChoppiness	(	double	choppiness,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Wave choppiness (0..1)

virtual double DtEnvironmentalStateManager::choppiness ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::choppiness ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSurgeDepth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Surge depth (meters)

virtual double DtEnvironmentalStateManager::surgeDepth ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::surgeDepth ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setFogHeight	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Fog height (meters)

virtual double DtEnvironmentalStateManager::fogHeight ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::fogHeight ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setFogColor	(	const DtVector &	color,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Fog color (x = red, y = green, z = blue)

virtual DtVector DtEnvironmentalStateManager::fogColor ( const DtUUID & weatherArea ) const

virtual

virtual DtVector DtEnvironmentalStateManager::fogColor ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSnowAccumulation	(	double	snow,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Snow Accumulation (meters)

virtual double DtEnvironmentalStateManager::snowAccumulation ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::snowAccumulation ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSnowMinimumAltitude	(	double	snow,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Snow Minimum Altitude (meters)

virtual double DtEnvironmentalStateManager::snowMinimumAltitude ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::snowMinimumAltitude ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setSnowRoadAccumulation	(	double	snow,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Snow Road Accumulation (meters)

virtual double DtEnvironmentalStateManager::snowRoadAccumulation ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::snowRoadAccumulation ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setRainAccumulation	(	double	rain,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Rain Accumulation (meters)

virtual double DtEnvironmentalStateManager::rainAccumulation ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::rainAccumulation ( const DtVector & ) const

virtual

virtual DtObjectType DtEnvironmentalStateManager::globalEnvironmentObjectType ( ) const

virtual

Returns: The object type that will be used for the global environment object. Returns 1:21:0:0:1:0:0:0

virtual void DtEnvironmentalStateManager::setThermoclineLayer1Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer1Depth ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer1Depth ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer1Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer1Permeability ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer1Permeability ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer2Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer2Depth ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer2Depth ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer2Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer2Permeability ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer2Permeability ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer3Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer3Depth ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer3Depth ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer3Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer3Permeability ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer3Permeability ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer4Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer4Depth ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer4Depth ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer4Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer4Permeability ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer4Permeability ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer5Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer5Depth ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer5Depth ( const DtVector & ) const

virtual

virtual void DtEnvironmentalStateManager::setThermoclineLayer5Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer5Permeability ( const DtUUID & weatherArea ) const

virtual

virtual double DtEnvironmentalStateManager::thermoclineLayer5Permeability ( const DtVector & ) const

virtual

virtual DtString DtEnvironmentalStateManager::deepWaterSoilName ( ) const

virtual

See Also: myDeepWaterSoilName

virtual void DtEnvironmentalStateManager::setDeepWaterSoilName ( const DtString & )

virtual

virtual DtString DtEnvironmentalStateManager::shallowWaterSoilName ( ) const

virtual

See Also: myShallowWaterSoilName

virtual void DtEnvironmentalStateManager::setShallowWaterSoilName ( const DtString & )

virtual

virtual DtString DtEnvironmentalStateManager::waterySoilName ( ) const

virtual

See Also: myWaterySoilName

virtual void DtEnvironmentalStateManager::setWaterySoilName ( const DtString & )

virtual

virtual DtString DtEnvironmentalStateManager::drySoilName ( ) const

virtual

See Also: myDrySoilName

virtual void DtEnvironmentalStateManager::setDrySoilName ( const DtString & )

virtual

virtual DtString DtEnvironmentalStateManager::roadSoilName ( ) const

virtual

See Also: myRoadSoilName

virtual void DtEnvironmentalStateManager::setRoadSoilName ( const DtString & )

virtual

virtual DtString DtEnvironmentalStateManager::snowSoilName ( ) const

virtual

See Also: mySnowSoilName

virtual void DtEnvironmentalStateManager::setSnowSoilName ( const DtString & )

virtual

virtual DtString DtEnvironmentalStateManager::iceSoilName ( ) const

virtual

See Also: #myIceSoilType

virtual void DtEnvironmentalStateManager::setIceSoilName ( const DtString & )

virtual

virtual double DtEnvironmentalStateManager::deepSnowDepth ( ) const

virtual

See Also: myDeepSnowDepth

virtual void DtEnvironmentalStateManager::setDeepSnowDepth ( const double )

virtual

virtual double DtEnvironmentalStateManager::saturationWaterDepth ( ) const

virtual

See Also: mySaturationWaterDepth

virtual void DtEnvironmentalStateManager::setSaturationWaterDepth ( const double )

virtual

virtual double DtEnvironmentalStateManager::waterSlideDepth ( ) const

virtual

See Also: myWaterSlideDepth

virtual void DtEnvironmentalStateManager::setWaterSlideDepth ( const double )

virtual

virtual double DtEnvironmentalStateManager::waterSlideFactor ( ) const

virtual

See Also: myWaterSlideFactor

virtual void DtEnvironmentalStateManager::setWaterSlideFactor ( const double )

virtual

virtual double DtEnvironmentalStateManager::hardFreezeTemperature ( ) const

virtual

See Also: myHardFreezeTemperature

virtual void DtEnvironmentalStateManager::setHardFreezeTemperature ( const double )

virtual

virtual void DtEnvironmentalStateManager::computeSoilWeatherMobilityModifiers	(	const DtVector &	location,
		const DtString &	soilType,
		double &	snowEffectFraction,
		DtString &	alternateSoil,
		double &	alternateSoilFraction,
		double &	tractionModifier
	)		const

virtual

This function computes a set of modifiers for a given soil based on weather conditions at the given location, for the purposes of changing ground vehicle mobility.

Parameters

location	Local coordinates. Note that altitude is important for determining temperature and possible snow coverage.
soilTame	The "roughness soil type" of the ground surface. A string.
snowEffectFraction	An output [0-1] indicating what fraction of the soil factors for snow should be applied.
alternateSoilType	An output indicating a different type of soil that weather conditions have turned the ground to.
alternateSoilFraction	An output [0-1] indicating what fraction of the alternate soil factors should be combined with input soil type factors.
tractionModifier	An output [0-1] to be multiplied by the stoppingFactor after the above modifiers are applied to produce a net stoppingFactor.

virtual void DtEnvironmentalStateManager::createGlobalEnvironmentObject ( )

virtual

Creates a new locally simulated VRF object with the type returned from glovalEnvironmentObjectType().

Sets this new object to myGlovalEnvironmentObject, and sets up myEnvironmentalStateSetter.

static void DtEnvironmentalStateManager::objectAddedCallback	(	const DtVrfObject *	object,
		void *	usr
	)

staticprotected

virtual void DtEnvironmentalStateManager::processObjectAdded ( const DtVrfObject * object )

protectedvirtual

static void DtEnvironmentalStateManager::objectRemovedCallback	(	const DtVrfObject *	object,
		void *	usr
	)

staticprotected

virtual void DtEnvironmentalStateManager::processObjectRemoved ( const DtVrfObject * object )

protectedvirtual

virtual DtEnvironmentalStateSetter* DtEnvironmentalStateManager::createLocalEnvironmentalStateSetter ( )

protectedvirtual

Returns: A new instance of DtLocalEnvironmentalStateSetter().

virtual DtEnvironmentalStateSetter* DtEnvironmentalStateManager::createRemoteEnvironmentalStateSetter ( )

protectedvirtual

Returns: A new instance of DtRemoteEnvironmentalStateSetter().

static void DtEnvironmentalStateManager::changeWeatherPrioritiesCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

virtual void DtEnvironmentalStateManager::processChangeWeatherPriorities ( DtSimMessage * msg )

protectedvirtual

static void DtEnvironmentalStateManager::requestWeatherAtLocationCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

virtual void DtEnvironmentalStateManager::processRequestWeatherAtLocation ( DtSimMessage * msg )

protectedvirtual

static void DtEnvironmentalStateManager::physicalWorldParametersChangedCallback ( void * usr )

staticprotected

virtual void DtEnvironmentalStateManager::initializeIlluminationObjectsList ( )

protectedvirtual

virtual void DtEnvironmentalStateManager::initializeSoilCharacteristics ( )

protectedvirtual

Copy soil names and soil weather parameters from the physicalWorld parameters.

virtual const DtIlluminationObjectParameters& DtEnvironmentalStateManager::findBestMatch ( const DtObjectType & objtype ) const

protectedvirtual

Member Data Documentation

DtSimManager* DtEnvironmentalStateManager::mySimManager

protected

DtSharedVrfObjectReference DtEnvironmentalStateManager::myGlobalEnvironmentObject

protected

DtRwVrfObjectReferenceList DtEnvironmentalStateManager::myWeatherObjects

protected

DtRwVrfObjectReferenceList DtEnvironmentalStateManager::myCloudLayerObjects

protected

DtEnvironmentalStateSetter* DtEnvironmentalStateManager::myEnvironmentalStateSetter

protected

This is only for setting global weather – local weather will use local vrf objects.

bool DtEnvironmentalStateManager::myFirstTick

protected

DtVector DtEnvironmentalStateManager::myLastPointChecked

mutableprotected

For faster access for consecutive lookups given a point.

DtSharedVrfObjectReference DtEnvironmentalStateManager::myLastWeatherByPoint

mutableprotected

DtManagedObjectListConstPtr DtEnvironmentalStateManager::myIlluminationObjects

protected

std::map<DtObjectType, DtIlluminationObjectParameters> DtEnvironmentalStateManager::myIlluminationObjectTypes

protected

DtString DtEnvironmentalStateManager::myDeepWaterSoilName

protected

Name of soil that is considered deep water.

DtString DtEnvironmentalStateManager::myShallowWaterSoilName

protected

Name of soil that is considered shallow water.

DtString DtEnvironmentalStateManager::myWaterySoilName

protected

Name of soil that is considered watery soil.

DtString DtEnvironmentalStateManager::myDrySoilName

protected

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

DtString DtEnvironmentalStateManager::myRoadSoilName

protected

Name of soil that is paved road.

DtString DtEnvironmentalStateManager::mySnowSoilName

protected

Name of "soil" that is snow.

DtString DtEnvironmentalStateManager::myIceSoilName

protected

Name of "soil" that is ice.

double DtEnvironmentalStateManager::myDeepSnowDepth

protected

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

double DtEnvironmentalStateManager::mySaturationWaterDepth

protected

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

Meters.

DtReal DtEnvironmentalStateManager::myWaterSlideDepth

protected

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

DtReal DtEnvironmentalStateManager::myWaterSlideFactor

protected

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

double DtEnvironmentalStateManager::myHardFreezeTemperature

protected

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

Degrees C.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/environmentalStateManager.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation