![]() |
VR-Forces 4.8 Class Documentation
|

Public Member Functions | |
| DtDisabledEnvironment (makVrv::DtDe &de) | |
| virtual void | clear () |
| virtual void | getRecord (makArchives::DtEnvironmentRecord &record) |
| Clear all clouds, precipitation. More... | |
| virtual void | setFromRecord (const makArchives::DtEnvironmentRecord &record) |
| Set the startup (last current) environment from record. More... | |
| virtual void | saveEnvironment (const std::string &envName) |
| Save the current environment with the current name. More... | |
| virtual void | removeEnvironment (const std::string &envName) |
| Remove an environment entry. More... | |
| virtual void | renameEnvironment (const std::string &oldName, const std::string &newName) |
| Rename an environment entry. More... | |
| virtual void | getEnvironmentNames (std::vector< std::string > &names) |
| Get the names of all the environment conditions. More... | |
| virtual void | setEnvironment (const std::string &envName) |
| The current environment takes on the settings of the named env. More... | |
| virtual void | setDefaultEnvironmentName (const std::string &name) |
| Set the name of the default environment conditions. More... | |
| virtual std::string | defaultEnvironmentName () const |
| Get the name of the default environment conditions. More... | |
| virtual void | setCloudCover (makArchives::DtCloudCoverType cloudCover) |
| Set/Get which cloud cover to use. More... | |
| virtual makArchives::DtCloudCoverType | cloudCover () const |
| virtual int | cloudLayerCount () const |
| virtual const makVrv::DtCloudLayer & | cloudLayer (unsigned int layerId) const |
| virtual void | setCloudLayer (unsigned int layerId, const makVrv::DtCloudLayer &layer) |
| virtual void | addCloudLayer (const makVrv::DtCloudLayer &layer) |
| virtual void | removeCloudLayer (unsigned int layerId) |
| virtual void | removeCloudLayers () |
| virtual void | setCloudLayerEnabled (unsigned int layerId, bool enabled) |
| virtual bool | useCustomCloudCover () const |
| virtual void | setUseCustomCloudCover (bool enabled) |
| virtual void | setAirTurbidity (float turbidity) |
| Set/Get the air turbidity (haziness) More... | |
| virtual float | airTurbidity () const |
| virtual void | setVisibleDistance (float distance) |
| Set/Get the visible distance in meters. More... | |
| virtual float | visibleDistance () const |
| virtual void | setPrecipitationIntensity (float intensity) |
| Set/Get the precipitation intensity. More... | |
| virtual float | precipitationIntensity () const |
| virtual void | setWindSpeed (float speed) |
| Set/Get the wind speed in meters per second. More... | |
| virtual float | windSpeed () const |
| virtual void | setWindDirection (float direction) |
| Set/Get the wind direction in radians from north (clockwise). More... | |
| virtual float | windDirection () const |
| virtual void | setAmbientAirTemperature (float temperature) |
| Set/Get the ambient air temperature in Celsius. More... | |
| virtual float | ambientAirTemperature () const |
| virtual void | setFogHeight (float height) |
| Set/Get the fog ceiling height in meters. More... | |
| virtual float | fogHeight () const |
| virtual void | setFogColor (const DtVector &color) |
| Set/Get the fog color in normalized color components. More... | |
| virtual DtVector | fogColor () const |
| virtual void | setGroundSnowAccumulation (float snow) |
| Set/Get the ground snow accumulation depth. More... | |
| virtual float | groundSnowAccumulation () const |
| virtual void | setSnowMinimumElevation (float snow) |
| Set/Get the snow minimum elevation. More... | |
| virtual float | snowMinimumElevation () const |
| virtual void | setRoadSnowAccumulation (float snow) |
| Set/Get the road snow accumulation depth. More... | |
| virtual float | roadSnowAccumulation () const |
| virtual void | setSeaState (int state) |
| Set/Get the sea state according to the Beaufort Scale. More... | |
| virtual int | seaState () const |
| virtual void | setSeaStateDirection (float dir) |
| Set/Get the sea state direction in radians from north. More... | |
| virtual float | seaStateDirection () const |
| virtual void | setWindDrivenSeaState (bool enabled) |
| Set/Get if sea state is wind driven or manually driven. More... | |
| virtual bool | windDrivenSeaState () const |
| virtual void | setSwellState (int state) |
| Set/Get the sea-swell state according to the Douglas Scale. More... | |
| virtual int | swellState () const |
| virtual void | setSwellStateDirection (float dir) |
| Set/Get the sea-swell state direction in radians from north. More... | |
| virtual float | swellStateDirection () const |
| virtual void | setWindFetch (float distance) |
| Set/Get the ocean fetch. More... | |
| virtual float | windFetch () const |
| virtual void | setSeaChoppiness (float chop) |
| Set/Get the amount of chop on the sea. More... | |
| virtual float | seaChoppiness () const |
| virtual void | setUnderwaterVisibilityEnabled (bool enabled) |
| virtual bool | underwaterVisibilityEnabled () const |
| virtual void | setUnderwaterVisibility (float distance) |
| Set/Get the maximum visibility under water in meters. More... | |
| virtual float | underwaterVisibility () const |
| virtual void | setWaterSurfaceTransparency (float normalizedValue) |
| Set/Get the transparency value of water surface. More... | |
| virtual float | waterSurfaceTransparency () const |
| virtual void | setSurgeDepth (float meters) |
| Set / Get the surge depth in distance. More... | |
| virtual float | surgeDepth () const |
| virtual void | setDepthOffset (float meters) |
| Set / Get the depth offset in distance. More... | |
| virtual float | depthOffset () const |
| virtual void | setAmbientWaterTemperature (float temperature) |
| Set/Get the ambient water temperature in Celsius. More... | |
| virtual float | ambientWaterTemperature () const |
| virtual void | setWaterCurrentSpeed (float speed) |
| Set/Get the speed of water currents in meters per second. More... | |
| virtual float | waterCurrentSpeed () const |
| virtual void | setWaterCurrentDirection (float direction) |
| Set/Get the direction of water currents in radians from north (clockwise). More... | |
| virtual float | waterCurrentDirection () const |
| virtual void | setTidalOffset (float meters) |
| Set/Get the current tidal offset from mean-sea-level in meters. More... | |
| virtual float | tidalOffset () const |
| virtual void | setTidalDirection (bool inOut) |
| Set/Get the current direction of tidal flow (0=out, 1=in). More... | |
| virtual bool | tidalDirection () const |
| virtual void | setThermoclineDepth (unsigned int layer, float depth) |
| Set/Get the thermocline depths. More... | |
| virtual float | thermoclineDepth (unsigned int layer) const |
| virtual void | setThermoclinePermeability (unsigned int layer, float permeability) |
| Set/Get the thermocline permeability. More... | |
| virtual float | thermoclinePermeability (unsigned int layer) const |
| virtual void | setSnowElevationTransition (float elevation) |
| virtual float | snowElevationTransition () const |
| virtual void | setGroundRainAccumulation (float depth) |
| Set/Get the ground rain accumulation depth. More... | |
| virtual float | groundRainAccumulation () const |
| virtual void | loadDefaults (bool loadOnlyFactorySettings=false) |
| virtual void | restore () |
| virtual void | saveAsDefaults () |
| virtual void | exportSettings (const std::string &filename) |
| Import / export the list of named conditions. More... | |
| virtual void | importSettings (const std::string &filename) |
| virtual void | setPrecipitationType (PrecipitationType type) |
| These are implemented because they're required by DtEnvironmentConditionsLogic::onChangePrecipitationType. More... | |
| virtual PrecipitationType | precipitationType () const |
Public Member Functions inherited from makVrv::DtEnvironmentInterface | |
| DtEnvironmentInterface () | |
| CTOR. More... | |
| virtual | ~DtEnvironmentInterface () |
| Virtual DTOR. More... | |
Protected Member Functions | |
| virtual void | slot_coordinateSystemChanged () |
| \name Slots for handling changes in the simulation. More... | |
| virtual void | slot_oceanLayerAdded (const makVrv::DtOceanLayer &layer) |
| Handle an ocean layer being added. More... | |
| virtual void | slot_oceanLayerToBeDeleted (const makVrv::DtOceanLayer &layer) |
| Handle an ocean layer being removed. More... | |
| virtual void | slot_oceanLayerSeaLevelChanged (const makVrv::DtOceanLayer &layer, double seaLevel) |
| Handle a change to an ocean layer's sea level. More... | |
| virtual void | slot_oceanLayerLodRangeChanged (const makVrv::DtOceanLayer &layer, int range) |
| Handle a change to an ocean layer's lod range. More... | |
| virtual void | slot_surgeDepthChanged (double depth) |
| Handle a change to surge depth. More... | |
| virtual void | slot_depthOffsetChanged (double offset) |
| Handle a change to depth offset. More... | |
Protected Attributes | |
| makVrv::DtCloudLayer | myCloudLayer |
| makVrv::DtEnvironmentInterface::PrecipitationType | myPrecipitationType |
| makVrv::DtDe & | myDe |
| makArchives::DtEnvironmentRecord | myCurrentSettings |
| This is an env record that reflects our current settings. More... | |
| bool | myWindDrivenSeaStateEnabled |
| bool | myUseCustomCloudCover |
| bool | myUnderwaterVisibilityEnabled |
| bool | myTidalDirection |
| makVrv::DtEnvironmentList | myEnvironmentList |
Additional Inherited Members | |
Public Types inherited from makVrv::DtEnvironmentInterface | |
| enum | PrecipitationType { None = DtSkyObject::None, Rain = DtSkyObject::Rain, Snow = DtSkyObject::SnowWet, Hail = DtSkyObject::Hail } |
|
inline |
|
inlinevirtual |
|
inlinevirtual |
Clear all clouds, precipitation.
Get the specified environment by record; used to serialize a scene This method throws the exception DtException if the named environment is not found.
Implements makVrv::DtEnvironmentInterface.
References myCurrentSettings.
|
inlinevirtual |
Set the startup (last current) environment from record.
Implements makVrv::DtEnvironmentInterface.
References myCurrentSettings.
Referenced by setEnvironment().
|
inlinevirtual |
Save the current environment with the current name.
If an environment with that name does not exist, add a new environment entry.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Remove an environment entry.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Rename an environment entry.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Get the names of all the environment conditions.
Implements makVrv::DtEnvironmentInterface.
References makVrv::DtScene::environment(), makVrv::DtEnvironment::getEnvironmentNames(), myDe, and makVrv::DtDe::scene().
|
inlinevirtual |
The current environment takes on the settings of the named env.
Implements makVrv::DtEnvironmentInterface.
References makVrv::DtEnvironmentList::getEnvironment(), myEnvironmentList, and setFromRecord().
|
inlinevirtual |
Set the name of the default environment conditions.
| [in] | name | is the name of the default environment. |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Get the name of the default environment conditions.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get which cloud cover to use.
This chooses one of the NOAA-defined cloud conditions. cloudCover is one of: DtCloudCoverTypeClear DtCloudCoverTypeMostlyClear DtCloudCoverTypeCloudy DtCloudCoverTypePartlyCloudy DtCloudCoverTypeMostlyCloudy DtCloudCoverTypeOvercast DtCloudCoverTypeThunderstorm
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
References makArchives::DtCloudCoverTypeClear.
|
inlinevirtual |
|
inlinevirtual |
References myCloudLayer.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
References myUseCustomCloudCover.
|
inlinevirtual |
References myUseCustomCloudCover.
|
inlinevirtual |
Set/Get the air turbidity (haziness)
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the visible distance in meters.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
These are implemented because they're required by DtEnvironmentConditionsLogic::onChangePrecipitationType.
Implements makVrv::DtEnvironmentInterface.
References myPrecipitationType.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
References myPrecipitationType.
|
inlinevirtual |
Set/Get the precipitation intensity.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the wind speed in meters per second.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the wind direction in radians from north (clockwise).
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the ambient air temperature in Celsius.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the fog ceiling height in meters.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the fog color in normalized color components.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the ground snow accumulation depth.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the snow minimum elevation.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the road snow accumulation depth.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the sea state according to the Beaufort Scale.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the sea state direction in radians from north.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get if sea state is wind driven or manually driven.
Implements makVrv::DtEnvironmentInterface.
References myWindDrivenSeaStateEnabled.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
References myWindDrivenSeaStateEnabled.
|
inlinevirtual |
Set/Get the sea-swell state according to the Douglas Scale.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the sea-swell state direction in radians from north.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the ocean fetch.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the amount of chop on the sea.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set / Get underwater visibility enabled.
Implements makVrv::DtEnvironmentInterface.
References myUnderwaterVisibilityEnabled.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
References myUnderwaterVisibilityEnabled.
|
inlinevirtual |
Set/Get the maximum visibility under water in meters.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the transparency value of water surface.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set / Get the surge depth in distance.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set / Get the depth offset in distance.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the ambient water temperature in Celsius.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the speed of water currents in meters per second.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the direction of water currents in radians from north (clockwise).
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the current tidal offset from mean-sea-level in meters.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the current direction of tidal flow (0=out, 1=in).
Implements makVrv::DtEnvironmentInterface.
References myTidalDirection.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
References myTidalDirection.
|
inlinevirtual |
Set/Get the thermocline depths.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the thermocline permeability.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
get/set the snow elevation transition which specifies how long it takes to go from no snow to the full snow depth.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Set/Get the ground rain accumulation depth.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Import / export the list of named conditions.
Implements makVrv::DtEnvironmentInterface.
|
inlinevirtual |
Implements makVrv::DtEnvironmentInterface.
|
inlineprotectedvirtual |
\name Slots for handling changes in the simulation.
Handle current coordinate system changes
Implements makVrv::DtEnvironmentInterface.
|
inlineprotectedvirtual |
Handle an ocean layer being added.
Implements makVrv::DtEnvironmentInterface.
|
inlineprotectedvirtual |
Handle an ocean layer being removed.
Implements makVrv::DtEnvironmentInterface.
|
inlineprotectedvirtual |
Handle a change to an ocean layer's sea level.
Implements makVrv::DtEnvironmentInterface.
|
inlineprotectedvirtual |
Handle a change to an ocean layer's lod range.
Implements makVrv::DtEnvironmentInterface.
|
inlineprotectedvirtual |
Handle a change to surge depth.
Implements makVrv::DtEnvironmentInterface.
|
inlineprotectedvirtual |
Handle a change to depth offset.
Implements makVrv::DtEnvironmentInterface.
|
protected |
Referenced by cloudLayer().
|
protected |
Referenced by precipitationType(), and setPrecipitationType().
|
protected |
Referenced by getEnvironmentNames().
|
protected |
This is an env record that reflects our current settings.
Referenced by getRecord(), and setFromRecord().
|
protected |
Referenced by setWindDrivenSeaState(), and windDrivenSeaState().
|
protected |
Referenced by setUseCustomCloudCover(), and useCustomCloudCover().
|
protected |
Referenced by setUnderwaterVisibilityEnabled(), and underwaterVisibilityEnabled().
|
protected |
Referenced by setTidalDirection(), and tidalDirection().
|
protected |
Referenced by setEnvironment().