VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
localEnvironment.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2021 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
12 
13 #pragma once
14 
15 #include <vrfGuiCore/vrfGuiCore.h>
16 #include <vrvCore/DtCloudLayer.h>
17 #include <vrvCore/DtEnvironmentInterface.h>
18 #include <vrvCore/DtEnvironmentList.h>
19 
20 namespace makVrv
21 {
22  class DtDe;
23 }
24 
25 namespace makVrf
26 {
27  class DT_DLL_VRFGUICORE DtLocalEnvironment : public makVrv::DtEnvironmentInterface
28  {
29  public:
30  DtLocalEnvironment(makVrv::DtDe& de);
31  virtual ~DtLocalEnvironment() override;
32 
33 
35  virtual void setLightningPresent(bool lightningPresent) override;
37  virtual bool lightningPresent() const override;
39 
41  virtual void setAirTurbidity(float turbidity) override;
43  virtual float airTurbidity() const override;
45 
47  virtual void setVisibleDistance(float distance) override;
52  virtual float visibleDistance() const override;
54 
56  virtual void setWindSpeed(float windSpeed) override;
61  virtual float windSpeed() const override;
63 
65  virtual void setWindDirection(float direction) override;
70  virtual float windDirection() const override;
72 
74  virtual void setPrecipitationType(PrecipitationType type) override;
76  virtual PrecipitationType precipitationType() const override;
78 
80  virtual void setPrecipitationIntensity(float intensity) override;
82  virtual float precipitationIntensity() const override;
84 
95  virtual void updateOrAddElevationalConfiguration(const DtElevationalConfigurationRecord& record) override;
96 
104  virtual bool getElevationalConfiguration(float baseMSLAltitude,
105  makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord& wRec) const override;
106 
114  virtual void removeElevationalConfiguration(float baseMSLAltitude) override;
115 
126  virtual void moveElevationalConfiguration(float oldBaseMSLAltitude, float newBaseMSLAltitude) override;
127 
132  virtual void setWindSpeedAtMSLAltitude(float mslAltitude, float windSpeed) override;
133 
139  virtual float windSpeedAtMSLAltitude(float mslAltitude) const override;
140 
146  virtual void setWindDirectionAtMSLAltitude(float mslAltitude, float windDirection) override;
147 
153  virtual float windDirectionAtMSLAltitude(float mslAltitude) const override;
154 
160  virtual void setVisibilityDistanceAtMSLAltitude(float mslAltitude, float visibilityDistance) override;
161 
167  virtual float visibilityDistanceAtMSLAltitude(float mslAltitude) const override;
168 
174  virtual void setObscurantAtMSLAltitude(float mslAltitude, VisibilityObscurant obscurant) override;
175 
181  virtual VisibilityObscurant obscurantAtMSLAltitude(float mslAltitude) const override;
182 
188  virtual void setCloudTypeAtMSLAltitude(float mslAltitude, CloudType cloudType) override;
189 
195  virtual CloudType cloudTypeAtMSLAltitude(float mslAltitude) const override;
196 
201  virtual void setSkyCoverageAtMSLAltitude(float mslAltitude, float skyCoverage) override;
202 
207  virtual float skyCoverageAtMSLAltitude(float mslAltitude) const override;
208 
210  virtual void setAmbientAirTemperature(float temperature) override;
212  virtual float ambientAirTemperature() const override;
214 
216  virtual void setAmbientAirPressure(float pressure) override;
218  virtual float ambientAirPressure() const override;
220 
223  virtual void setAirPressureAltitude(float altitude) override;
224  virtual float airPressureAltitude() const override;
226 
229  virtual void setAirTemperatureAltitude(float altitude) override;
230  virtual float airTemperatureAltitude() const override;
232 
235  virtual void setAirPressureAltitudeIsSeaLevel(bool seaLevel) override;
236  virtual bool airPressureAltitudeIsSeaLevel() const override;
238 
241  virtual void setAirTemperatureAltitudeIsSeaLevel(bool seaLevel) override;
242  virtual bool airTemperatureAltitudeIsSeaLevel() const override;
244 
247  virtual void setSeaLevelWaterConcentration(float water) override;
248  virtual float seaLevelWaterConcentration() const override;
250 
252  virtual void setFogHeight(float height) override;
254  virtual float fogHeight() const override;
256 
258  virtual void setFogColor(const DtVector& color) override;
260  virtual DtVector fogColor() const override;
262 
264  virtual void setGroundFogColor(const DtVector& color) override;
266  virtual DtVector groundFogColor() const override;
268 
270  virtual void setBlowingParticulateMatter(int);
272  virtual int blowingParticulateMatter() const;
274 
276  virtual void setSeaState(makVrv::DtDouglasSeaState::Scale state) override;
278  virtual makVrv::DtDouglasSeaState::Scale seaState() const override;
280 
282  virtual void setSeaStateDirection(float dir) override;
284  virtual float seaStateDirection() const override;
286 
288  virtual void setWindDrivenSeaState(bool enabled) override;
290  virtual bool windDrivenSeaState() const override;
292 
294  virtual void setSwellState(makVrv::DtDouglasSwellState::Scale state) override;
296  virtual makVrv::DtDouglasSwellState::Scale swellState() const override;
298 
300  virtual void setSwellStateDirection(float dir) override;
302  virtual float swellStateDirection() const override;
304 
306  virtual void setWindFetch(float distance) override;
308  virtual float windFetch() const override;
310 
312  virtual void setSeaChoppiness(float chop) override;
314  virtual float seaChoppiness() const override;
316 
319  virtual void setUnderwaterVisibilityEnabled(bool enabled) override;
320  virtual bool underwaterVisibilityEnabled() const override;
322 
324  virtual void setUnderwaterVisibility(float distance) override;
326  virtual float underwaterVisibility() const override;
328 
330  virtual void setWaterSurfaceTransparency(float normalizedValue) override;
332  virtual float waterSurfaceTransparency() const override;
334 
336  virtual void setSurgeDepth(float meters) override;
338  virtual float surgeDepth() const override;
340 
342  virtual void setDepthOffset(float meters) override;
344  virtual float depthOffset() const override;
346 
348  virtual void setAmbientWaterTemperature(float temperature) override;
350  virtual float ambientWaterTemperature() const override;
352 
354  virtual void setWaterCurrentSpeed(float speed) override;
356  virtual float waterCurrentSpeed() const override;
358 
360  virtual void setWaterCurrentDirection(float direction) override;
363  virtual float waterCurrentDirection() const override;
365 
367  virtual void setTidalOffset(float meters) override;
369  virtual float tidalOffset() const override;
371 
372  virtual void setTidalDirection(bool inOut) override;
373  virtual bool tidalDirection() const override;
374 
376  virtual void setThermoclineDepth(unsigned int layer, float depth) override;
378  virtual float thermoclineDepth(unsigned int layer) const override;
380 
382  virtual void setThermoclinePermeability(unsigned int layer, float permeability) override;
384  virtual float thermoclinePermeability(unsigned int layer) const override;
386 
388  virtual void setGroundSnowAccumulation(float depth) override;
390  virtual float groundSnowAccumulation() const override;
392 
394  virtual void setRoadSnowAccumulation(float depth) override;
396  virtual float roadSnowAccumulation() const override;
398 
400  virtual void setSnowMinimumElevation(float elevation) override;
402  virtual float snowMinimumElevation() const override;
404 
407  virtual void setSnowElevationTransition(float elevation) override;
408  virtual float snowElevationTransition() const override;
410 
412  virtual void setGroundRainAccumulation(float depth) override;
414  virtual float groundRainAccumulation() const override;
416 
417  virtual void loadDefaults(bool loadOnlyFactorySettings = false) override;
418 
421  virtual void getRecord(makArchives::DtEnvironmentRecord& record) const override;
422 
425  virtual void setFromRecord(const makArchives::DtEnvironmentRecord& record) override;
426 
428  virtual makArchives::DtEnvironmentRecord environmentConditionRecord(const std::string&);
429 
437  virtual void saveEnvironment(const std::string& name) override;
438 
441  virtual void setEnvironment(const std::string& name) override;
442 
445  virtual void removeEnvironment(const std::string& name) override;
446 
448  virtual void renameEnvironment(const std::string& oldName, const std::string& newName) override;
449 
454  virtual void getEnvironmentNames(
455  std::vector<std::string>& names, bool includeLocalOnlyEnvironment = true) override;
456 
459  virtual void setDefaultEnvironmentName(const std::string& name) override;
460 
463  virtual std::string defaultEnvironmentName() const override;
464 
466  virtual void restore() override {};
467 
469  virtual void saveAsDefaults() override;
471 
473  virtual void exportSettings(const std::string& filename) override {};
475  virtual void importSettings(const std::string& filename) override {};
477 
479  virtual void slot_coordinateSystemChanged() override {};
480  virtual void slot_oceanLayerAdded(const makVrv::DtOceanLayer& layer) override {};
481  virtual void slot_oceanLayerToBeDeleted(const makVrv::DtOceanLayer& layer) override {};
482  virtual void slot_oceanLayerSeaLevelChanged(const makVrv::DtOceanLayer& layer, double seaLevel) override {};
483  virtual void slot_oceanLayerLodRangeChanged(const makVrv::DtOceanLayer& layer, int range) override {};
484  virtual void slot_surgeDepthChanged(double depth) override {};
485  virtual void slot_depthOffsetChanged(double offset) override {};
486  virtual void autoSave();
487 
488  protected:
489  makVrv::DtDe& myDe;
490 
492  makArchives::DtEnvironmentRecord myCurrentSettings;
493 
495  makVrv::DtEnvironmentList myEnvironmentList;
496 
498  DtVector myGroundFogColor;
499  };
500 }
DtEnvironmentInterface.h
The declaration of the makVrv::DtEnvironmentInterface class.
makVrf::DtLocalEnvironment::slot_oceanLayerSeaLevelChanged
virtual void slot_oceanLayerSeaLevelChanged(const makVrv::DtOceanLayer &layer, double seaLevel) override
Handle a change to an ocean layer&#39;s sea level.
Definition: localEnvironment.h:482
makVrf::DtLocalEnvironment
Definition: localEnvironment.h:27
makVrf::DtLocalEnvironment::myEnvironmentList
makVrv::DtEnvironmentList myEnvironmentList
This is an env list that reflects saved settings.
Definition: localEnvironment.h:495
DtEnvironmentList.h
The declaration of the makVrv::DtEnvironmentList class.
DT_DLL_VRFGUICORE
#define DT_DLL_VRFGUICORE
Contains DLL export macros.
Definition: vrfGuiCore.h:25
makArchives::VisibilityObscurant
VisibilityObscurant
Definition: DtEnvironmentRecord.h:30
makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord
Record for an elevational configuration A record of this type consists of 1) a base MSL altitude...
Definition: DtEnvironmentRecord.h:251
makVrf::DtLocalEnvironment::importSettings
virtual void importSettings(const std::string &filename) override
Import / export the list of named conditions (.enlx file)
Definition: localEnvironment.h:475
makVrv::DtDouglasSeaState::Scale
Scale
Definition: DtDouglasSeaScale.h:33
makVrv::vrvTacticalGraphicUtilities::distance
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points. Coordinates are in local database coordinates The coordinat...
makVrv::DtEnvironmentInterface
The DtEnvironmentInterface is an interface class providing abstraction for different managers of envi...
Definition: DtEnvironmentInterface.h:40
makVrf::DtLocalEnvironment::slot_coordinateSystemChanged
virtual void slot_coordinateSystemChanged() override
\name Slots for handling changes in the simulation.
Definition: localEnvironment.h:479
makVrf::DtLocalEnvironment::myCurrentSettings
makArchives::DtEnvironmentRecord myCurrentSettings
This is an env record that reflects our current settings.
Definition: localEnvironment.h:492
makVrf::DtLocalEnvironment::restore
virtual void restore() override
Restores to backup settings from startup default.
Definition: localEnvironment.h:466
makVrv::DtDouglasSwellState::Scale
Scale
Definition: DtDouglasSeaScale.h:114
makVrf::DtLocalEnvironment::slot_surgeDepthChanged
virtual void slot_surgeDepthChanged(double depth) override
Handle a change to surge depth.
Definition: localEnvironment.h:484
makArchives::DtEnvironmentRecord
Record of environment/weather settings Includes precipitation, air, and clouds.
Definition: DtEnvironmentRecord.h:45
makVrf::DtLocalEnvironment::myGroundFogColor
DtVector myGroundFogColor
Until this is in an environment record.
Definition: localEnvironment.h:498
DtCloudLayer.h
Contains vrvCore::DtCloudLayerRecord declaration.
makVrv::DtEnvironmentInterface::PrecipitationType
PrecipitationType
Definition: DtEnvironmentInterface.h:44
makVrv::DtOceanLayer
The ocean layer is a type of terrain layer which contains information about an area that should be re...
Definition: DtOceanLayer.h:25
makVrf::DtLocalEnvironment::slot_depthOffsetChanged
virtual void slot_depthOffsetChanged(double offset) override
Handle a change to depth offset.
Definition: localEnvironment.h:485
makVrf::DtLocalEnvironment::myDe
makVrv::DtDe & myDe
Definition: localEnvironment.h:489
makVrf::DtLocalEnvironment::slot_oceanLayerAdded
virtual void slot_oceanLayerAdded(const makVrv::DtOceanLayer &layer) override
Handle an ocean layer being added.
Definition: localEnvironment.h:480
makVrf::DtLocalEnvironment::slot_oceanLayerLodRangeChanged
virtual void slot_oceanLayerLodRangeChanged(const makVrv::DtOceanLayer &layer, int range) override
Handle a change to an ocean layer&#39;s lod range.
Definition: localEnvironment.h:483
makVrv::DtDe
The DtDe is the core component of any VR-Vantage application. It owns a DtRenderer, DtDeCommunicator, as well as a DtDisplay and other things.
Definition: DtDe.h:76
offset
voidpf uLong offset
Definition: ioapi.h:42
makVrv::DtCloudTypeMapper::CloudType
CloudType
Cloud layer types.
Definition: DtCloudTypeMapper.h:35
makVrf::DtLocalEnvironment::slot_oceanLayerToBeDeleted
virtual void slot_oceanLayerToBeDeleted(const makVrv::DtOceanLayer &layer) override
Handle an ocean layer being removed.
Definition: localEnvironment.h:481
makVrv::DtEnvironmentList
The DtEnvironmentList maintains a list of DtEnvironment records that can be looked up by the environm...
Definition: DtEnvironmentList.h:32
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)