 |
VR-Forces 4.10 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.10 Class Documentation
|
This class contains the functions that the VRF simulation uses to query the current state of the weather. More...
Public Member Functions | |
| DtWeatherStateProvider (const DtSimManager *simManager) | |
| constructor More... | |
| virtual | ~DtWeatherStateProvider () |
| destructor More... | |
| virtual bool | init () |
| This is called by the environmental state manager immediately after it creates a weather state provider. More... | |
| virtual void | tick () |
| Called by DtEnvironmentalStateManager::tick(). More... | |
| virtual const DtSimManager * | simManager () const |
Atmosphere | |
| virtual std::vector < CloudStateSegment > | cloudLayers (const DtVector &localPosition) const |
| Provides descriptions of each cloud layer. More... | |
| virtual double | airVisibility (const DtVector &localPosition) const |
| Visibility of just the air (without clouds or precipitation). More... | |
| virtual double | visibility (const DtVector &localPosition) const |
| Visibility in meters. More... | |
| virtual int | visibilityObscurant (const DtVector &localPosition) const |
| Visibility obscurant at the given position. More... | |
| virtual double | averageVisibilityOnChord (const DtChord &path) const |
| Average visibility value along the given chord. More... | |
| virtual double | airTemperatureAtAltitude (const double mslTemperature, const double altitude) const |
| Air temperature at an altitude, given the MSL temperature. More... | |
| virtual double | airTemperature (const DtVector &localPosition) const |
| Air temperature in degrees C at the given 3D location. More... | |
| virtual double | mslTemperatureFromAirTemperatureAtAltitude (const double airTemperature, const double altitude) const |
| Return MSL temperature, given an air temperature at a specific altitude. More... | |
| virtual double | airPressureAtAltitude (const double mslPressure, const double altitude, const double mslTemperature) const |
| Air pressure at an altitude, given the MSL pressure and MSL temperature. More... | |
| virtual double | airPressure (const DtVector &localPosition) const |
| Air pressure at the given 3D location. More... | |
| virtual double | mslPressureFromAirPressureAtAltitude (const double airPressure, const double altitude, const double mslTemperature) const |
| Return MSL temperature, given an air temperature at a specific altitude and the msl temperature. More... | |
| virtual double | airTemperatureAltitude (const DtVector &localPosition) const |
| Air temperature altitude in meters. More... | |
| virtual double | airPressureAltitude (const DtVector &localPosition) const |
| Air pressure altitude in meters. More... | |
| virtual bool | airTemperatureAltitudeIsSeaLevel (const DtVector &localPosition) const |
| Air temperature altitude is sea level flag. More... | |
| virtual bool | airPressureAltitudeIsSeaLevel (const DtVector &localPosition) const |
| Air pressure altitude is sea level flag. More... | |
| virtual double | humidity (const DtVector &localPosition) const |
| Humidity in ppmv. More... | |
| virtual double | relativeHumidity (const DtVector &localPosition) const |
| Percentage humidity. More... | |
| virtual double | windSpeed (const DtVector &localPosition) const |
| Wind speed in mps. More... | |
| virtual double | windDirection (const DtVector &localPosition) const |
| Wind heading in radians. More... | |
| virtual bool | windSpeedAndDirectionAtAltitude (const DtVector &localPosition, double altMSL, double &windSpeed, double &windDiection) const |
| Gets both wind speed and direction. More... | |
| virtual bool | visibilityAndObscurantAtAltitude (const DtVector &localPosition, double altMSL, double &visibility, int &obscurant) const |
| Gets both visibility and obscurant. More... | |
| virtual DtVrfTurbulenceLevel | airTurbulence (const DtVector &localPosition) const |
| Turbulence level. More... | |
| virtual void | lineQueryAtmosphericState (const DtVector &startPosition, const DtVector &endPosition, double minSegmentLength, size_t maxSegmentCount, std::vector< AtmosphericStateSegment > &atmosphericStateSegments) const |
| Query the atmospheric state along a line. More... | |
| virtual void | lineQueryCloudState (const DtVector &startPosition, const DtVector &endPosition, std::vector< CloudStateSegment > &cloudStateSegments, double tolerance=5.0) const |
| Query the cloud layers state along a line. More... | |
| virtual bool | lightningPresent (const DtVector &localPosition) const |
| Returns whether lightning is present. More... | |
Precipitation | |
The functions may make use of the altitude of the point; however, in the default implementation, altitude is not considered. | |
| virtual double | precipitationIntensity (const DtVector &localPosition) const |
| Returns mm/hr precipitation. More... | |
| virtual double | averagePrecipitationIntensity (const DtChord &) const |
| virtual DtVrfWeatherPrecipitationType | precipitationType (const DtVector &localPosition) const |
| virtual double | snowAccumulationDepth (const DtVector &localPosition) const |
| virtual double | snowDepthOnRoads (const DtVector &localPosition) const |
| virtual double | rainAccumulationDepth (const DtVector &localPosition) const |
| virtual void | lineQueryPrecipitationState (const DtVector &startPosition, const DtVector &endPosition, std::vector< PrecipitationStateSegment > &precipitationStateSegments, double tolerance=5.0) const |
| Query the precipitation state along a line. More... | |
Illumination | |
| virtual double | illuminationFromSky (const DtVector &localPosition) const |
| Illumination only from sun, moon, and stars. More... | |
| virtual double | illuminationAtTime (const DtVector &localPosition, const double dateTime) const |
| This version of the illumination function calculates the light from sun/moon/stars at an arbitrary date-time. More... | |
Water | |
| virtual double | underwaterVisibility (const DtVector &localPosition) const |
| Visibility distance in meters. More... | |
| virtual double | averageWaterVisibilityOnChord (const DtChord &path) const |
| Provides a visibility value that can be used for sensing along the chord (e.g., computing loss of contrast). More... | |
| virtual double | waterCurrentSpeed (const DtVector &localPosition) const |
| virtual double | waterCurrentDirection (const DtVector &localPosition) const |
| virtual double | waterTemperature (const DtVector &localPosition) const |
| Heading in radians. More... | |
| virtual double | tidalOffset (const DtVector &localPosition) const |
| Tidal offset in meters above the water surface in the database. More... | |
| virtual bool | tidalDirection (const DtVector &localPosition) const |
| If T, tide is giong in; F = tide is going out. More... | |
| virtual unsigned int | swellState (const DtVector &localPosition) const |
| Swell state according to the Douglas Sea Scale (integer 0 - 9) More... | |
| virtual double | swellDirection (const DtVector &localPosition) const |
| virtual unsigned int | seaState (const DtVector &localPosition) const |
| Heading in radians. More... | |
| virtual double | seaDirection (const DtVector &localPosition) const |
| virtual double | choppiness (const DtVector &localPosition) const |
| Heading in radians. More... | |
| virtual double | surgeDepth (const DtVector &localPosition) const |
| Meters. More... | |
| virtual double | thermoclineLayer1Depth (const DtVector &localPosition) const |
| Depths are the depth of the top of the thermocline. More... | |
| virtual double | thermoclineLayer1Permeability (const DtVector &localPosition) const |
| virtual double | thermoclineLayer2Depth (const DtVector &localPosition) const |
| virtual double | thermoclineLayer2Permeability (const DtVector &localPosition) const |
| virtual double | thermoclineLayer3Depth (const DtVector &localPosition) const |
| virtual double | thermoclineLayer3Permeability (const DtVector &localPosition) const |
| virtual double | thermoclineLayer4Depth (const DtVector &localPosition) const |
| virtual double | thermoclineLayer4Permeability (const DtVector &localPosition) const |
| virtual double | thermoclineLayer5Depth (const DtVector &localPosition) const |
| virtual double | thermoclineLayer5Permeability (const DtVector &localPosition) const |
Static Public Member Functions | |
| static DtWeatherStateProvider * | creator (const DtSimManager *simMgr) |
| The weatherStateProvider will be created by the environmentalStateManager using a factory, so that other weatherStateProviders can be used instead by registering a different creator function in the factory. More... | |
Protected Member Functions | |
| std::vector< DtPoint > | chordIntersectsPointsPrecipitationAreas (const DtVector &startPosition, const DtVector &endPosition, const std::vector< DtSharedVrfObjectReference > &weatherObjects) const |
| Check if a chord intersects a list of weather objects Return an ordered vector of intersection points along the chord The points are ordered based on the distance to the chord starting point. More... | |
| void | setChordPrecipitationStateWeatherObjects (const std::vector< DtPoint > &chordIntersectingPoints, const std::vector< DtSharedVrfObjectReference > &weatherObjects, std::vector< PrecipitationStateSegment > &precipitationStateSegments, std::vector< DtChord > &globalWeatherChordSegments, double tolerance=5.0) const |
| Set the precipitation data for chords segments intersecting with the weather objects. More... | |
| void | setChordPrecipitationStateGlobalWeather (const DtPoint &startPosition, const std::vector< DtChord > &globalWeatherChordSegments, const std::vector< DtSharedVrfObjectReference > &weatherObjects, std::vector< PrecipitationStateSegment > &precipitationStateSegments) const |
| Set the precipitation data for chords segments falling into the global weather area. More... | |
| std::vector< DtPoint > | chordIntersectsPointsCloudLayers (const DtVector &startPosition, const DtVector &endPosition, const std::vector< DtSharedVrfObjectReference > &weatherObjects) const |
| Check if a chord intersects the cloud layers within a list of weather objects Return an ordered vector of intersection points along the chord The points are ordered based on the distance to the chord starting point. More... | |
| void | setChordCloudStateWeatherObjects (const std::vector< DtPoint > &chordIntersectingPoints, const std::vector< DtSharedVrfObjectReference > &weatherObjects, std::vector< CloudStateSegment > &cloudStateSegments, std::vector< DtChord > &globalWeatherChordSegments, double tolerance=5.0) const |
| Set the cloud data for chords segments intersecting with the cloud layers within a list of weather objects. More... | |
| void | setChordCloudStateGlobalWeather (const DtPoint &startPosition, const std::vector< DtChord > &globalWeatherChordSegments, const std::vector< DtSharedVrfObjectReference > &weatherObjects, std::vector< CloudStateSegment > &cloudStateSegments) const |
| Set the cloud data for chords segments falling into the global weather area. More... | |
| bool | chordIntersectsExtent (const DtChord &chord, const DtExtent &extent, DtVector &intersectionPosition, double &intersectionLengt) const |
| Check if a chord intersects or is contained entirely or partially within extent Return the starting intersection point between the chord and the extent, and the length of the cord segment intersecting with the extent. More... | |
| bool | chordIntersectsExtent (const DtChord &chord, const DtExtent &extent, DtPoint &intersectionEntryPoint, DtPoint &intersectionExitPoint) const |
| Check if a chord intersects or is contained entirely or partially within extent Return the intersection two end points. More... | |
| virtual double | defaultCloudVisibility () const |
| The visibility in clouds. More... | |
Protected Attributes | |
| const DtSimManager * | mySimManager |
| double | myKoschmiederConstant |
Constants for physical calculations that are computed from other constants, and cached to avoid recomputation. More... | |
Private Member Functions | |
| DtWeatherStateProvider (const DtWeatherStateProvider &orig) | |
| Not implemented. More... | |
| const DtWeatherStateProvider & | operator= (const DtWeatherStateProvider &orig) |
| DtWeatherStateProvider () | |
This class contains the functions that the VRF simulation uses to query the current state of the weather.
All locations are terrain database ("local") coordinates.
|
private |
Not implemented.
|
private |
| DtWeatherStateProvider::DtWeatherStateProvider | ( | const DtSimManager * | simManager | ) |
constructor
|
virtual |
destructor
|
private |
|
virtual |
This is called by the environmental state manager immediately after it creates a weather state provider.
Any other code that creates a weather state provider should call this before calling other functions.
|
virtual |
Called by DtEnvironmentalStateManager::tick().
The default weather state provider does nothing here. It could be used to accumulate snow, or something.
|
virtual |
|
static |
The weatherStateProvider will be created by the environmentalStateManager using a factory, so that other weatherStateProviders can be used instead by registering a different creator function in the factory.
|
virtual |
Provides descriptions of each cloud layer.
Not normally needed, but here in case a VRF component needs this detailed data, e.g. to find a cloud ceiling or something. Normally, visibility is the attribute of interest, and the visibility functions below use cloud layers in their calculations, so this cloud layer detail is not necessary.
Layers at a 2D location (i.e., above a point on the surface).
|
virtual |
Visibility of just the air (without clouds or precipitation).
With weather areas, this is the value of visibility(). In meters.
Visibility in meters.
Accounts for base air visibility and precipitation (uses intensity in a formula).
|
virtual |
Visibility obscurant at the given position.
|
virtual |
Average visibility value along the given chord.
This is visibility through the air (i.e., not water). The default computation finds all weather objects that the chord passes through. An attenuation value is calculated for air visibility and precipitation; these are averaged equally over the number of objects–there is no calculation of distance within each object. Clouds are not yet (VRF 4.8 IPB7) considered. These attenuations are added and then a net visibility is calculated.
|
virtual |
Air temperature at an altitude, given the MSL temperature.
Temperature is in degrees C; altitude is in meters.
|
virtual |
Air temperature in degrees C at the given 3D location.
In the default implementation, the ambient temperature in a weather object is taken to be the MSL temperature. airTemperatureAtAltitude is used to compute the net temperature.
Reimplemented in MyWeatherStateProvider.
|
virtual |
Return MSL temperature, given an air temperature at a specific altitude.
Temperature is in degrees C; altitude is in meters. Max valid altitude value is 10000m.
|
virtual |
Air pressure at an altitude, given the MSL pressure and MSL temperature.
Pressure is in kPa; altitude is in meters. temperature is in degrees C.
Air pressure at the given 3D location.
In kiloPascals. Uses airTemperature(). In the default implementation, there is no pressure attribute in weather objects, so this function assumes a default MSL pressure of 101.321 kPa.
|
virtual |
Return MSL temperature, given an air temperature at a specific altitude and the msl temperature.
Pressure is in kPa; altitude is in meters. temperature in degrees C. Max valid altitude value is 10000m.
|
virtual |
Air temperature altitude in meters.
|
virtual |
Air pressure altitude in meters.
|
virtual |
Air temperature altitude is sea level flag.
|
virtual |
Air pressure altitude is sea level flag.
Humidity in ppmv.
|
virtual |
Percentage humidity.
Returns a value 0 - 100. No information about this in the default implementation, so by default returns 10.0.
Wind speed in mps.
|
virtual |
Wind heading in radians.
|
virtual |
Gets both wind speed and direction.
|
virtual |
Gets both visibility and obscurant.
|
virtual |
Turbulence level.
|
virtual |
Query the atmospheric state along a line.
The line is split into equal length segments and the atmospheric data is retrieved at sample positions.
| Input | |
| startPosition | the coordinates of the query line's starting point. |
| endPosition | the coordinates of the query line's end point. |
| minSegmentLength | the minimal length of the segments, the query line will be split into. This is the minimal distance between the data sampling points along the line. |
| maxSegmentCount | the maximal number of segments, the query line will be split into. minSegmentLength and maxSegmentCount are used to determine the number and the positions of of the sampling points along the query line. |
| Output | |
| atmosphericStateSegments | a collection of AtmosphericStateSegment structures. Each AtmosphericStateSegment structure contains the atmospheric data - e.g. air pressure, air temperature, etc. taken at a sampling position along the query line. Each line segment is determined by the position of the sampling point. See the AtmosphericStateSegment declaration in the current file. |
|
virtual |
Query the cloud layers state along a line.
Returned are the segments along the line where there is cloud coverage, with the associated cloud layer data.
| Input | |
| startPosition | the coordinates of the query line's starting point. |
| endPosition | the coordinates of the query line's end point. |
| Output | |
| cloudStateSegments | a collection of CloudStateSegment structures. Each CloudStateSegment structure contains the cloud layer data - e.g. cloud type, visibility, etc. for a section along the query line where there is a cloud coverage. The cloud parameters have the same value along the entire line segment. The line segments without cloud coverage are not included in the collection. Each line segment is determined by its starting position and length. See the CloudStateSegment declaration in the current file. |
|
virtual |
Returns whether lightning is present.
|
virtual |
Returns mm/hr precipitation.
Note that for snow, this value should be about 10x what it would be for rain for the same amount of water.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Query the precipitation state along a line.
Returned are the segments along the line where there is precipitation, with the associated precipitation data.
| Input | |
| startPosition | the coordinates of the query line's starting point. |
| endPosition | the coordinates of the query line's end point. |
| Output | |
| precipitationStateSegments | a collection of PrecipitationStateSegment structures. Each PrecipitationStateSegment structure contains the precipitation data - e.g. precipitation intensity, etc. for a section along the query line where there is a precipitation. The precipitation parameters have the same value along the entire line segment. The line segments without precipitation are not included in the collection. Each line segment is determined by its starting position and length. See the PrecipitationStateSegment declaration in the current file. |
|
virtual |
Illumination only from sun, moon, and stars.
Returns a value [0-1] representing a fraction of full sunlight.
|
virtual |
This version of the illumination function calculates the light from sun/moon/stars at an arbitrary date-time.
|
virtual |
Visibility distance in meters.
|
virtual |
Provides a visibility value that can be used for sensing along the chord (e.g., computing loss of contrast).
|
virtual |
|
virtual |
|
virtual |
Heading in radians.
Tidal offset in meters above the water surface in the database.
If T, tide is giong in; F = tide is going out.
|
virtual |
Swell state according to the Douglas Sea Scale (integer 0 - 9)
|
virtual |
|
virtual |
Heading in radians.
Sea state according to the Douglas Sea Scale (integer 0 - 9)
Heading in radians.
Wave choppiness (0..1).
Meters.
|
virtual |
Depths are the depth of the top of the thermocline.
If the depth is 0, the layer is not present.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
protected |
Check if a chord intersects a list of weather objects Return an ordered vector of intersection points along the chord The points are ordered based on the distance to the chord starting point.
|
protected |
Set the precipitation data for chords segments intersecting with the weather objects.
Returns the chord segments outside the weather objects - i.e. falling into the global weather area.
|
protected |
Set the precipitation data for chords segments falling into the global weather area.
|
protected |
Check if a chord intersects the cloud layers within a list of weather objects Return an ordered vector of intersection points along the chord The points are ordered based on the distance to the chord starting point.
|
protected |
Set the cloud data for chords segments intersecting with the cloud layers within a list of weather objects.
Returns the chord segments outside the weather objects - i.e. falling into the global weather area.
|
protected |
Set the cloud data for chords segments falling into the global weather area.
|
protected |
Check if a chord intersects or is contained entirely or partially within extent Return the starting intersection point between the chord and the extent, and the length of the cord segment intersecting with the extent.
|
protected |
Check if a chord intersects or is contained entirely or partially within extent Return the intersection two end points.
|
protectedvirtual |
The visibility in clouds.
Default value is 45m, taken from Table 8 in Collins, "Military Geography for Professionals and the Public", p. 74; for dense fog.
|
protected |
|
protected |
Constants for physical calculations that are computed from other constants, and cached to avoid recomputation.
Constant used to calculate visibility range from attenuation coefficient, and vice versa. Calculated from visual detection minimum contrast ratio.(see https://en.wikipedia.org/wiki/Visibility)