![]() |
VR-Forces 4.8 Class Documentation
|
The DtEnvironmentInterface is an interface class providing abstraction for different managers of environmental effects for a scene. More...

Public Types | |
| enum | PrecipitationType { None = DtSkyObject::None, Rain = DtSkyObject::Rain, Snow = DtSkyObject::SnowWet, Hail = DtSkyObject::Hail } |
Public Member Functions | |
| DtEnvironmentInterface () | |
| CTOR. More... | |
| virtual | ~DtEnvironmentInterface () |
| Virtual DTOR. More... | |
| virtual void | getRecord (makArchives::DtEnvironmentRecord &record)=0 |
| Clear all clouds, precipitation. More... | |
| virtual void | setFromRecord (const makArchives::DtEnvironmentRecord &record)=0 |
| Set the startup (last current) environment from record. More... | |
| virtual void | loadDefaults (bool loadOnlyFactorySettings=false)=0 |
| virtual void | restore ()=0 |
| virtual void | saveAsDefaults ()=0 |
| virtual void | saveEnvironment (const std::string &envName)=0 |
| Save the current environment with the current name. More... | |
| virtual void | removeEnvironment (const std::string &envName)=0 |
| Remove an environment entry. More... | |
| virtual void | renameEnvironment (const std::string &oldName, const std::string &newName)=0 |
| Rename an environment entry. More... | |
| virtual void | getEnvironmentNames (std::vector< std::string > &names)=0 |
| Get the names of all the environment conditions. More... | |
| virtual void | setEnvironment (const std::string &envName)=0 |
| The current environment takes on the settings of the named env. More... | |
| virtual void | setDefaultEnvironmentName (const std::string &name)=0 |
| Set the name of the default environment conditions. More... | |
| virtual std::string | defaultEnvironmentName () const =0 |
| Get the name of the default environment conditions. More... | |
| virtual void | setCloudCover (makArchives::DtCloudCoverType cloudCover)=0 |
| Set/Get which cloud cover to use. More... | |
| virtual makArchives::DtCloudCoverType | cloudCover () const =0 |
| virtual void | setAirTurbidity (float turbidity)=0 |
| Set/Get the air turbidity (haziness) More... | |
| virtual float | airTurbidity () const =0 |
| virtual void | setVisibleDistance (float distance)=0 |
| Set/Get the visible distance in meters. More... | |
| virtual float | visibleDistance () const =0 |
| virtual void | setPrecipitationType (PrecipitationType type)=0 |
| Set/Get the precipitation type. More... | |
| virtual PrecipitationType | precipitationType () const =0 |
| virtual void | setPrecipitationIntensity (float intensity)=0 |
| Set/Get the precipitation intensity. More... | |
| virtual float | precipitationIntensity () const =0 |
| virtual void | setWindSpeed (float speed)=0 |
| Set/Get the wind speed in meters per second. More... | |
| virtual float | windSpeed () const =0 |
| virtual void | setWindDirection (float direction)=0 |
| Set/Get the wind direction in radians from north (clockwise). More... | |
| virtual float | windDirection () const =0 |
| virtual void | setAmbientAirTemperature (float temperature)=0 |
| Set/Get the ambient air temperature in Celsius. More... | |
| virtual float | ambientAirTemperature () const =0 |
| virtual void | setFogHeight (float height)=0 |
| Set/Get the fog ceiling height in meters. More... | |
| virtual float | fogHeight () const =0 |
| virtual void | setFogColor (const DtVector &color)=0 |
| Set/Get the fog color in normalized color components. More... | |
| virtual DtVector | fogColor () const =0 |
| virtual void | setSeaState (int state)=0 |
| Set/Get the sea state according to the Beaufort Scale. More... | |
| virtual int | seaState () const =0 |
| virtual void | setSeaStateDirection (float dir)=0 |
| Set/Get the sea state direction in radians from north. More... | |
| virtual float | seaStateDirection () const =0 |
| virtual void | setWindDrivenSeaState (bool enabled)=0 |
| Set/Get if sea state is wind driven or manually driven. More... | |
| virtual bool | windDrivenSeaState () const =0 |
| virtual void | setSwellState (int state)=0 |
| Set/Get the sea-swell state according to the Douglas Scale. More... | |
| virtual int | swellState () const =0 |
| virtual void | setSwellStateDirection (float dir)=0 |
| Set/Get the sea-swell state direction in radians from north. More... | |
| virtual float | swellStateDirection () const =0 |
| virtual void | setWindFetch (float distance)=0 |
| Set/Get the ocean fetch. More... | |
| virtual float | windFetch () const =0 |
| virtual void | setSeaChoppiness (float chop)=0 |
| Set/Get the amount of chop on the sea. More... | |
| virtual float | seaChoppiness () const =0 |
| virtual void | setUnderwaterVisibilityEnabled (bool enabled)=0 |
| virtual bool | underwaterVisibilityEnabled () const =0 |
| virtual void | setUnderwaterVisibility (float distance)=0 |
| Set/Get the maximum visibility under water in meters. More... | |
| virtual float | underwaterVisibility () const =0 |
| virtual void | setWaterSurfaceTransparency (float normalizedValue)=0 |
| Set/Get the transparency value of water surface. More... | |
| virtual float | waterSurfaceTransparency () const =0 |
| virtual void | setSurgeDepth (float meters)=0 |
| Set / Get the surge depth in distance. More... | |
| virtual float | surgeDepth () const =0 |
| virtual void | setDepthOffset (float meters)=0 |
| Set / Get the depth offset in distance. More... | |
| virtual float | depthOffset () const =0 |
| virtual void | setAmbientWaterTemperature (float temperature)=0 |
| Set/Get the ambient water temperature in Celsius. More... | |
| virtual float | ambientWaterTemperature () const =0 |
| virtual void | setWaterCurrentSpeed (float speed)=0 |
| Set/Get the speed of water currents in meters per second. More... | |
| virtual float | waterCurrentSpeed () const =0 |
| virtual void | setWaterCurrentDirection (float direction)=0 |
| Set/Get the direction of water currents in radians from north (clockwise). More... | |
| virtual float | waterCurrentDirection () const =0 |
| virtual void | setTidalOffset (float meters)=0 |
| Set/Get the current tidal offset from mean-sea-level in meters. More... | |
| virtual float | tidalOffset () const =0 |
| virtual void | setTidalDirection (bool inOut)=0 |
| Set/Get the current direction of tidal flow (0=out, 1=in). More... | |
| virtual bool | tidalDirection () const =0 |
| virtual void | setThermoclineDepth (unsigned int layer, float depth)=0 |
| Set/Get the thermocline depths. More... | |
| virtual float | thermoclineDepth (unsigned int layer) const =0 |
| virtual void | setThermoclinePermeability (unsigned int layer, float permeability)=0 |
| Set/Get the thermocline permeability. More... | |
| virtual float | thermoclinePermeability (unsigned int layer) const =0 |
| virtual void | setGroundSnowAccumulation (float depth)=0 |
| Set/Get the ground snow accumulation depth. More... | |
| virtual float | groundSnowAccumulation () const =0 |
| virtual void | setRoadSnowAccumulation (float depth)=0 |
| Set/Get the road snow accumulation depth. More... | |
| virtual float | roadSnowAccumulation () const =0 |
| virtual void | setSnowMinimumElevation (float elevation)=0 |
| Set/Get the snow minimum elevation. More... | |
| virtual float | snowMinimumElevation () const =0 |
| virtual void | setSnowElevationTransition (float elevation)=0 |
| virtual float | snowElevationTransition () const =0 |
| virtual void | setGroundRainAccumulation (float depth)=0 |
| Set/Get the ground rain accumulation depth. More... | |
| virtual float | groundRainAccumulation () const =0 |
| virtual void | exportSettings (const std::string &filename)=0 |
| Import / export the list of named conditions. More... | |
| virtual void | importSettings (const std::string &filename)=0 |
Protected Member Functions | |
| virtual void | slot_coordinateSystemChanged ()=0 |
| \name Slots for handling changes in the simulation. More... | |
| virtual void | slot_oceanLayerAdded (const DtOceanLayer &layer)=0 |
| Handle an ocean layer being added. More... | |
| virtual void | slot_oceanLayerToBeDeleted (const DtOceanLayer &layer)=0 |
| Handle an ocean layer being removed. More... | |
| virtual void | slot_oceanLayerSeaLevelChanged (const DtOceanLayer &layer, double seaLevel)=0 |
| Handle a change to an ocean layer's sea level. More... | |
| virtual void | slot_oceanLayerLodRangeChanged (const DtOceanLayer &layer, int range)=0 |
| Handle a change to an ocean layer's lod range. More... | |
| virtual void | slot_surgeDepthChanged (double depth)=0 |
| Handle a change to surge depth. More... | |
| virtual void | slot_depthOffsetChanged (double offset)=0 |
| Handle a change to depth offset. More... | |
The DtEnvironmentInterface is an interface class providing abstraction for different managers of environmental effects for a scene.
| makVrv::DtEnvironmentInterface::DtEnvironmentInterface | ( | ) |
CTOR.
|
virtual |
Virtual DTOR.
|
pure virtual |
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.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set the startup (last current) environment from record.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Save the current environment with the current name.
If an environment with that name does not exist, add a new environment entry.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Remove an environment entry.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Rename an environment entry.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Get the names of all the environment conditions.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
The current environment takes on the settings of the named env.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set the name of the default environment conditions.
| [in] | name | is the name of the default environment. |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Get the name of the default environment conditions.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
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
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the air turbidity (haziness)
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the visible distance in meters.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the precipitation type.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the precipitation intensity.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the wind speed in meters per second.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the wind direction in radians from north (clockwise).
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the ambient air temperature in Celsius.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the fog ceiling height in meters.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the fog color in normalized color components.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the sea state according to the Beaufort Scale.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the sea state direction in radians from north.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get if sea state is wind driven or manually driven.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the sea-swell state according to the Douglas Scale.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the sea-swell state direction in radians from north.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the ocean fetch.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the amount of chop on the sea.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set / Get underwater visibility enabled.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the maximum visibility under water in meters.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the transparency value of water surface.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set / Get the surge depth in distance.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set / Get the depth offset in distance.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the ambient water temperature in Celsius.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the speed of water currents in meters per second.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the direction of water currents in radians from north (clockwise).
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the current tidal offset from mean-sea-level in meters.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the current direction of tidal flow (0=out, 1=in).
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the thermocline depths.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the thermocline permeability.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the ground snow accumulation depth.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the road snow accumulation depth.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the snow minimum elevation.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
get/set the snow elevation transition which specifies how long it takes to go from no snow to the full snow depth.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Set/Get the ground rain accumulation depth.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Import / export the list of named conditions.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
pure virtual |
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
protectedpure virtual |
\name Slots for handling changes in the simulation.
Handle current coordinate system changes
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
protectedpure virtual |
Handle an ocean layer being added.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
protectedpure virtual |
Handle an ocean layer being removed.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
protectedpure virtual |
Handle a change to an ocean layer's sea level.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
protectedpure virtual |
Handle a change to an ocean layer's lod range.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
protectedpure virtual |
Handle a change to surge depth.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.
|
protectedpure virtual |
Handle a change to depth offset.
Implemented in makVrv::DtEnvironment, and makVrf::DtDisabledEnvironment.