DtEnvironmentalStateManager Class Reference

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

Public Member Functions
	DtEnvironmentalStateManager (DtSimManager *simManager)
	constructor
virtual	~DtEnvironmentalStateManager ()
	destructor
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.
virtual DtSharedVrfObjectReference	weatherObjectFor (const DtUUID &=DtUUID::nullUUID(), bool *isGlobal=0) const
	Returns the weather object given the specified name (if blank uses global weather)
virtual DtSharedVrfObjectReference	weatherObjectFor (const DtVector &localPosition, bool *isGlobal=0) const
	Returns the weather object of the highest priority at the given location.
virtual std::vector < DtSharedVrfObjectReference >	weatherObjectsFor (const DtChord &localChord) const
	Returns all weather objects that are intersected by this chord.
virtual DtSharedVrfObjectReference	weatherObjectFor (const DtChord &localChord, bool *isGlobal=0) const
	Returns the weather object of the first area hit by this chord.
virtual DtSharedVrfObjectReference	cloudLayerFor (const DtUUID &) const
	Returns the cloud layer object given the specified name (if blank uses global weather)
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.
virtual DtSharedVrfObjectReference	cloudLayerFor (const DtChord &localChord) const
	Returns the cloud layer object of the first area hit by this chord.
virtual std::vector < DtSharedVrfObjectReference >	cloudLayersFor (const DtChord &localChord) const
	Returns all cloud layer objects that are intersected by this chord.
virtual std::vector < DtSharedVrfObjectReference >	cloudLayers () const
	Returns a vector of all the cloud layers.
virtual void	setCloudType (CloudLayerCloudType, const DtUUID &cloudLayer)
	Individual cloud layer mutators/accessors.
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.
virtual double	illumination (const DtVector &localPosition) const
	Illumination in percentage (0 to 1.0) at a particular location.
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.
virtual void	setWeatherState (const DtChangeWeatherCommand &command)
	Calls the appropriate setXXX() functions locally, depending on what is in the command.
virtual void	setUseDayNightIlluminationModel (const DtChangeTimeOfDayCommand &command)
	The current time of day, specified by the number of seconds passed midnight.
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.
virtual void	setTimeOfDayAdvancementSpeed (const DtChangeTimeOfDayCommand &command)
virtual double	timeOfDayAdvancementSpeed () const
virtual DtObjectType	globalEnvironmentObjectType () const
virtual void	createGlobalEnvironmentObject ()
	Creates a new locally simulated VRF object with the type returned from glovalEnvironmentObjectType().
virtual void	setAirTurbidity (double factor, const DtUUID &weatherArea=DtUUID::nullUUID())
	For weather.
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)
virtual double	ambientAirTemperature (const DtUUID &weatherArea) const
virtual double	ambientAirTemperature (const DtVector &) const
virtual void	setCloudState (DtVrfWeatherCloudState current, const DtUUID &weatherArea=DtUUID::nullUUID())
	Cloud state enumeration.
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.
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.
virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType current, const DtUUID &weatherArea=DtUUID::nullUUID())
	Weather state enumeration.
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.
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.
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.
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 – this will get the visibility through a particular weather area or simply use global if it crosses no area.
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.
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.
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)
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.
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)
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.
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.
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.
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.
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)
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)
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)
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)
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.
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)
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)
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)
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)
virtual DtVector	fogColor (const DtUUID &weatherArea) const
virtual DtVector	fogColor (const DtVector &) const
virtual void	setThermoclineLayer1Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
	Thermocline depth (in meters) and permeability (0..1).
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

Protected Member Functions
virtual void	processObjectAdded (DtVrfObject *object)
virtual void	processObjectRemoved (DtVrfObject *object)
virtual DtEnvironmentalStateSetter *	createLocalEnvironmentalStateSetter ()
virtual DtEnvironmentalStateSetter *	createRemoteEnvironmentalStateSetter ()
virtual void	processChangeWeatherPriorities (DtSimMessage *msg)
virtual void	initializeIlluminationObjectsList ()
virtual const DtIlluminationObjectParameters &	findBestMatch (const DtObjectType &objtype) const

Static Protected Member Functions
static void	objectAddedCallback (DtVrfObject *object, void *usr)
static void	objectRemovedCallback (DtVrfObject *object, void *usr)
static void	changeWeatherPrioritiesCallback (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.
bool	myFirstTick
DtVector	myLastPointChecked
	For faster access for consecutive lookups given a point.
DtSharedVrfObjectReference	myLastWeatherByPoint
DtManagedObjectListConstPtr	myIlluminationObjects
std::map< DtObjectType, DtIlluminationObjectParameters >	myIlluminationObjectTypes

Private Member Functions
	DtEnvironmentalStateManager (const DtEnvironmentalStateManager &orig)
	Not implemented.
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.

If none are intersected returns global weather as only 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 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 will get the visibility through a particular weather area or simply use global if it crosses no area.

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 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 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 ( DtVrfObject *  object, void *  usr  )

staticprotected

virtual void DtEnvironmentalStateManager::processObjectAdded ( DtVrfObject *  object )

protectedvirtual

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

staticprotected

virtual void DtEnvironmentalStateManager::processObjectRemoved ( 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::physicalWorldParametersChangedCallback ( void *  usr )

staticprotected

virtual void DtEnvironmentalStateManager::initializeIlluminationObjectsList ( )

protectedvirtual

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/environmentalStateManager.h