VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
environmentalStateSetter.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2013 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
11 
12 #pragma once
13 
14 #include "vrfobjcore/vrfobjcoreDefines.h"
15 #include <matrix/vlVector.h>
16 #include <vrfExtObjects/vrfWeatherStateEnums.h>
17 #include <vrfExtObjects/vrfCloudLayerStateEnums.h>
18 #include <vrfutil/rwWindLevels.h>
19 
20 class DtEnvironmentalStateManager;
21 class DtLocalObject;
22 class DtChangeGlobalWeatherCommand;
23 
29 class DT_DLL_vrfobjcore DtEnvironmentalStateSetter
30 {
31 private:
33 
34  DtEnvironmentalStateSetter();
35  DtEnvironmentalStateSetter(const DtEnvironmentalStateSetter& orig);
36  DtEnvironmentalStateSetter& operator==(const DtEnvironmentalStateSetter& orig);
38 
39 public:
40  DtEnvironmentalStateSetter(DtEnvironmentalStateManager* manager);
41  virtual ~DtEnvironmentalStateSetter();
42 
43  virtual bool init();
44 
45  virtual void setGlobalEnvironmentObject(DtLocalObject* vrfObject);
46 
48  virtual void setAmbientAirTemperature(double value) = 0;
49  virtual void setAmbientAirPressure(double value) = 0;
50  virtual void setAirTemperatureAltitude(double value) = 0;
51  virtual void setAirPressureAltitude(double value) = 0;
52  virtual void setSeaLevelWaterConcentration(double value) = 0;
53  virtual void setPrecipitationIntensity(double value) = 0;
54  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType current) = 0;
55  virtual void setWindSpeed(double value) = 0;
56  virtual void setWindDirection(double value) = 0;
57  virtual void setVisibility(double value) = 0;
58  virtual void setDateAndTimeOfDay(double secondsPastUTC) = 0;
59  virtual void setTimeOfDayAdvancementSpeed(double speed) = 0;
60  virtual void setUnderwaterVisibility(double underwaterVisibility) = 0;
61  virtual void setSurfaceTransparency(double transparency) = 0;
62  virtual void setWaterCurrentSpeed(double waterCurrentSpeed) = 0;
63  virtual void setWaterCurrentDirection(double waterCurrentDirection) = 0;
64  virtual void setAmbientWaterTemperature(double waterTemperature) = 0;
65  virtual void setTidalOffset(double tidalOffset) = 0;
66  virtual void setSwellState(unsigned int state) = 0;
67  virtual void setSwellStateDirection(double direction) = 0;
68  virtual void setSeaState(unsigned int state) = 0;
69  virtual void setSeaStateDirection(double direction) = 0;
70  virtual void setWindDrivenSeaStateEnabled(bool b) = 0;
71  virtual void setChoppiness(double choppiness) = 0;
72  virtual void setSurgeDepth(double depth) = 0;
73  virtual void setDepthOffset(double depth) = 0;
74  virtual void setWindFetch(double depth) = 0;
75  virtual void setFogHeight(double depth) = 0;
76  virtual void setFogColor(const DtVector& color) = 0;
77  virtual void setBlowingParticulateMatter(int value) = 0;
78  virtual void setSnowAccumulation(double snow) = 0;
79  virtual void setSnowMinimumAltitude(double snow) = 0;
80  virtual void setSnowRoadAccumulation(double snow) = 0;
81  virtual void setRainAccumulation(double rain) = 0;
82  virtual void setThermoclineLayer1Depth(double depth) = 0;
83  virtual void setThermoclineLayer1Permeability(double depth) = 0;
84  virtual void setThermoclineLayer2Depth(double depth) = 0;
85  virtual void setThermoclineLayer2Permeability(double depth) = 0;
86  virtual void setThermoclineLayer3Depth(double depth) = 0;
87  virtual void setThermoclineLayer3Permeability(double depth) = 0;
88  virtual void setThermoclineLayer4Depth(double depth) = 0;
89  virtual void setThermoclineLayer4Permeability(double depth) = 0;
90  virtual void setThermoclineLayer5Depth(double depth) = 0;
91  virtual void setThermoclineLayer5Permeability(double depth) = 0;
92  virtual void setUseDayNightIlluminationModel(bool) = 0;
93  virtual void clearWindLevels() = 0;
94  virtual void setWindLevels(const DtRwWindLevels&) = 0;
95  virtual void setLightningPresent(bool isPresent) = 0;
96 
97 protected:
98  DtEnvironmentalStateManager* myEnvironmentalStateManager;
99  DtLocalObject* myGlobalEnvironmentObject;
100 };
101 
104 class DT_DLL_vrfobjcore DtLocalEnvironmentalStateSetter : public DtEnvironmentalStateSetter
105 {
106 public:
107  DtLocalEnvironmentalStateSetter(DtEnvironmentalStateManager* manager);
108  virtual ~DtLocalEnvironmentalStateSetter() override;
109 
111  virtual void setAmbientAirTemperature(double value) override;
112  virtual void setAmbientAirPressure(double value) override;
113  virtual void setAirTemperatureAltitude(double value) override;
114  virtual void setAirPressureAltitude(double value) override;
115  virtual void setSeaLevelWaterConcentration(double value) override;
116  virtual void setPrecipitationIntensity(double value) override;
117  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType current) override;
118  virtual void setWindSpeed(double value) override;
119  virtual void setWindDirection(double value) override;
120  virtual void setVisibility(double value) override;
121  virtual void setDateAndTimeOfDay(double secondsPastMidnight) override;
122  virtual void setTimeOfDayAdvancementSpeed(double speed) override;
123  virtual void setUnderwaterVisibility(double underwaterVisibility) override;
124  virtual void setSurfaceTransparency(double transparency) override;
125  virtual void setWaterCurrentSpeed(double waterCurrentSpeed) override;
126  virtual void setWaterCurrentDirection(double waterCurrentDirection) override;
127  virtual void setAmbientWaterTemperature(double waterTemperature) override;
128  virtual void setTidalOffset(double tidalOffset) override;
129  virtual void setSwellState(unsigned int state) override;
130  virtual void setSwellStateDirection(double direction) override;
131  virtual void setSeaState(unsigned int state) override;
132  virtual void setSeaStateDirection(double direction) override;
133  virtual void setWindDrivenSeaStateEnabled(bool b) override;
134  virtual void setChoppiness(double choppiness) override;
135  virtual void setSurgeDepth(double depth) override;
136  virtual void setDepthOffset(double depth) override;
137  virtual void setWindFetch(double depth) override;
138  virtual void setFogHeight(double depth) override;
139  virtual void setFogColor(const DtVector& color) override;
140  virtual void setBlowingParticulateMatter(int value) override;
141  virtual void setSnowAccumulation(double snow) override;
142  virtual void setSnowMinimumAltitude(double snow) override;
143  virtual void setSnowRoadAccumulation(double snow) override;
144  virtual void setRainAccumulation(double rain) override;
145  virtual void setThermoclineLayer1Depth(double depth) override;
146  virtual void setThermoclineLayer1Permeability(double depth) override;
147  virtual void setThermoclineLayer2Depth(double depth) override;
148  virtual void setThermoclineLayer2Permeability(double depth) override;
149  virtual void setThermoclineLayer3Depth(double depth) override;
150  virtual void setThermoclineLayer3Permeability(double depth) override;
151  virtual void setThermoclineLayer4Depth(double depth) override;
152  virtual void setThermoclineLayer4Permeability(double depth) override;
153  virtual void setThermoclineLayer5Depth(double depth) override;
154  virtual void setThermoclineLayer5Permeability(double depth) override;
155  virtual void setUseDayNightIlluminationModel(bool) override;
156  virtual void setWindLevels(const DtRwWindLevels&) override;
157  virtual void clearWindLevels() override;
158  virtual void setLightningPresent(bool isPresent) override;
159 };
160 
163 class DT_DLL_vrfobjcore DtRemoteEnvironmentalStateSetter : public DtEnvironmentalStateSetter
164 {
165 public:
166  DtRemoteEnvironmentalStateSetter(DtEnvironmentalStateManager* manager);
167  virtual ~DtRemoteEnvironmentalStateSetter() override;
168 
169  virtual bool init() override;
170 
172  virtual void setAmbientAirTemperature(double value) override;
174  virtual void setAmbientAirPressure(double value) override;
175  virtual void setAirTemperatureAltitude(double value) override;
176  virtual void setAirPressureAltitude(double value) override;
177  virtual void setSeaLevelWaterConcentration(double value) override;
178  virtual void setPrecipitationIntensity(double value) override;
179  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType current) override;
180  virtual void setWindSpeed(double value) override;
181  virtual void setWindDirection(double value) override;
182  virtual void setVisibility(double value) override;
183  virtual void setDateAndTimeOfDay(double secondsPastUTC) override;
184  virtual void setTimeOfDayAdvancementSpeed(double speed) override;
185  virtual void setUnderwaterVisibility(double underwaterVisibility) override;
186  virtual void setSurfaceTransparency(double transparency) override;
187  virtual void setWaterCurrentSpeed(double waterCurrentSpeed) override;
188  virtual void setWaterCurrentDirection(double waterCurrentDirection) override;
189  virtual void setAmbientWaterTemperature(double waterTemperature) override;
190  virtual void setTidalOffset(double tidalOffset) override;
191  virtual void setSwellState(unsigned int state) override;
192  virtual void setSwellStateDirection(double direction) override;
193  virtual void setSeaState(unsigned int state) override;
194  virtual void setSeaStateDirection(double direction) override;
195  virtual void setWindDrivenSeaStateEnabled(bool b) override;
196  virtual void setChoppiness(double choppiness) override;
197  virtual void setSurgeDepth(double depth) override;
198  virtual void setDepthOffset(double depth) override;
199  virtual void setWindFetch(double depth) override;
200  virtual void setFogHeight(double depth) override;
201  virtual void setFogColor(const DtVector& color) override;
202  virtual void setBlowingParticulateMatter(int value) override;
203  virtual void setSnowAccumulation(double snow) override;
204  virtual void setSnowMinimumAltitude(double snow) override;
205  virtual void setSnowRoadAccumulation(double snow) override;
206  virtual void setRainAccumulation(double rain) override;
207  virtual void setThermoclineLayer1Depth(double depth) override;
208  virtual void setThermoclineLayer1Permeability(double depth) override;
209  virtual void setThermoclineLayer2Depth(double depth) override;
210  virtual void setThermoclineLayer2Permeability(double depth) override;
211  virtual void setThermoclineLayer3Depth(double depth) override;
212  virtual void setThermoclineLayer3Permeability(double depth) override;
213  virtual void setThermoclineLayer4Depth(double depth) override;
214  virtual void setThermoclineLayer4Permeability(double depth) override;
215  virtual void setThermoclineLayer5Depth(double depth) override;
216  virtual void setThermoclineLayer5Permeability(double depth) override;
217  virtual void setUseDayNightIlluminationModel(bool) override;
218  virtual void setWindLevels(const DtRwWindLevels&) override;
219  virtual void clearWindLevels() override;
220  virtual void setLightningPresent(bool isPresent) override;
221 
222 protected:
223  static void tickCallback(void* usr);
224  virtual void tick();
225 
226  DtChangeGlobalWeatherCommand* myChangeCommand;
227  bool myChangeCommandNeedsSending;
228 };
229 
DtVrfWeatherPrecipitationType
DtVrfWeatherPrecipitationType
Definition: vrfWeatherStateEnums.h:13
DtChangeGlobalWeatherCommand
A DtSimCommand subclass which specifies a change to the global weather settings in the simulation eng...
Definition: changeGlobalWeatherCommand.h:22
DtEnvironmentalStateSetter::setUnderwaterVisibility
virtual void setUnderwaterVisibility(double underwaterVisibility)=0
DtEnvironmentalStateSetter::clearWindLevels
virtual void clearWindLevels()=0
DtEnvironmentalStateSetter::setThermoclineLayer4Depth
virtual void setThermoclineLayer4Depth(double depth)=0
DtEnvironmentalStateSetter::setWindDirection
virtual void setWindDirection(double value)=0
DtEnvironmentalStateSetter::setPrecipitationType
virtual void setPrecipitationType(DtVrfWeatherPrecipitationType current)=0
DtEnvironmentalStateSetter::setSurfaceTransparency
virtual void setSurfaceTransparency(double transparency)=0
DtEnvironmentalStateSetter::setAmbientAirTemperature
virtual void setAmbientAirTemperature(double value)=0
For weather.
DtEnvironmentalStateSetter::setThermoclineLayer5Depth
virtual void setThermoclineLayer5Depth(double depth)=0
DtEnvironmentalStateSetter::setSeaLevelWaterConcentration
virtual void setSeaLevelWaterConcentration(double value)=0
DtEnvironmentalStateSetter::setAirPressureAltitude
virtual void setAirPressureAltitude(double value)=0
DtEnvironmentalStateSetter::setBlowingParticulateMatter
virtual void setBlowingParticulateMatter(int value)=0
DtEnvironmentalStateSetter::setThermoclineLayer1Depth
virtual void setThermoclineLayer1Depth(double depth)=0
DtEnvironmentalStateSetter::setSwellState
virtual void setSwellState(unsigned int state)=0
DtEnvironmentalStateSetter::myGlobalEnvironmentObject
DtLocalObject * myGlobalEnvironmentObject
Definition: environmentalStateSetter.h:99
DtEnvironmentalStateSetter::setThermoclineLayer5Permeability
virtual void setThermoclineLayer5Permeability(double depth)=0
DtEnvironmentalStateSetter::setWindFetch
virtual void setWindFetch(double depth)=0
operator==
DT_DLL_terrainCS bool operator==(const DtDegMinSec &lhs, const DtDegMinSec &rhs)
DtEnvironmentalStateSetter::setDateAndTimeOfDay
virtual void setDateAndTimeOfDay(double secondsPastUTC)=0
DtEnvironmentalStateSetter::setThermoclineLayer2Depth
virtual void setThermoclineLayer2Depth(double depth)=0
DtEnvironmentalStateSetter::setChoppiness
virtual void setChoppiness(double choppiness)=0
DtEnvironmentalStateSetter::setAmbientAirPressure
virtual void setAmbientAirPressure(double value)=0
DtEnvironmentalStateSetter::setVisibility
virtual void setVisibility(double value)=0
DtEnvironmentalStateSetter::setThermoclineLayer4Permeability
virtual void setThermoclineLayer4Permeability(double depth)=0
DtRemoteEnvironmentalStateSetter::myChangeCommand
DtChangeGlobalWeatherCommand * myChangeCommand
Definition: environmentalStateSetter.h:226
DtEnvironmentalStateSetter::setThermoclineLayer3Permeability
virtual void setThermoclineLayer3Permeability(double depth)=0
DT_DLL_vrfobjcore
#define DT_DLL_vrfobjcore
This file is used to determine how to build.
Definition: vrfobjcoreDefines.h:24
DtEnvironmentalStateSetter::setPrecipitationIntensity
virtual void setPrecipitationIntensity(double value)=0
vrfCloudLayerStateEnums.h
Contains the enums for cloud layers.
DtEnvironmentalStateSetter::setWindDrivenSeaStateEnabled
virtual void setWindDrivenSeaStateEnabled(bool b)=0
DtEnvironmentalStateSetter::setSnowAccumulation
virtual void setSnowAccumulation(double snow)=0
DtRemoteEnvironmentalStateSetter::myChangeCommandNeedsSending
bool myChangeCommandNeedsSending
Definition: environmentalStateSetter.h:227
DtEnvironmentalStateSetter::setThermoclineLayer2Permeability
virtual void setThermoclineLayer2Permeability(double depth)=0
DtEnvironmentalStateSetter::setTimeOfDayAdvancementSpeed
virtual void setTimeOfDayAdvancementSpeed(double speed)=0
DtEnvironmentalStateSetter::setSeaStateDirection
virtual void setSeaStateDirection(double direction)=0
DtEnvironmentalStateSetter::setSnowMinimumAltitude
virtual void setSnowMinimumAltitude(double snow)=0
DtEnvironmentalStateSetter::setRainAccumulation
virtual void setRainAccumulation(double rain)=0
DtEnvironmentalStateSetter::setSeaState
virtual void setSeaState(unsigned int state)=0
init
DT_DLL_DEBUGDRAWRENDERER void init(makVrv::DtDe &de)
Work function for the plugin initialization.
DtEnvironmentalStateSetter::setWaterCurrentSpeed
virtual void setWaterCurrentSpeed(double waterCurrentSpeed)=0
DtRemoteEnvironmentalStateSetter
Sends environment setting messages to the simulator that is currently simulating the global environme...
Definition: environmentalStateSetter.h:163
DtEnvironmentalStateSetter::setSnowRoadAccumulation
virtual void setSnowRoadAccumulation(double snow)=0
DtEnvironmentalStateSetter::setSurgeDepth
virtual void setSurgeDepth(double depth)=0
DtLocalEnvironmentalStateSetter
Sets the environmental state in a locally simulated environmental state object.
Definition: environmentalStateSetter.h:104
DtEnvironmentalStateSetter::setAirTemperatureAltitude
virtual void setAirTemperatureAltitude(double value)=0
DtEnvironmentalStateSetter::myEnvironmentalStateManager
DtEnvironmentalStateManager * myEnvironmentalStateManager
Definition: environmentalStateSetter.h:98
DtEnvironmentalStateSetter::setUseDayNightIlluminationModel
virtual void setUseDayNightIlluminationModel(bool)=0
DtEnvironmentalStateSetter::setThermoclineLayer1Permeability
virtual void setThermoclineLayer1Permeability(double depth)=0
DtEnvironmentalStateManager
Maintains the environmental state of the simulation, such as time of day, illumination, and various aspects of the weather. All access to this data from any behavior or dynamics model should be made to this class.
Definition: environmentalStateManager.h:67
DtEnvironmentalStateSetter::setLightningPresent
virtual void setLightningPresent(bool isPresent)=0
DtEnvironmentalStateSetter::setAmbientWaterTemperature
virtual void setAmbientWaterTemperature(double waterTemperature)=0
DtEnvironmentalStateSetter::setTidalOffset
virtual void setTidalOffset(double tidalOffset)=0
DtEnvironmentalStateSetter::setFogHeight
virtual void setFogHeight(double depth)=0
DtEnvironmentalStateSetter::setWindSpeed
virtual void setWindSpeed(double value)=0
DtEnvironmentalStateSetter::setDepthOffset
virtual void setDepthOffset(double depth)=0
DtRwWindLevels
Definition: rwWindLevels.h:17
DtEnvironmentalStateSetter::setSwellStateDirection
virtual void setSwellStateDirection(double direction)=0
DtEnvironmentalStateSetter::setWindLevels
virtual void setWindLevels(const DtRwWindLevels &)=0
DtEnvironmentalStateSetter
Abstract base class for classes that set new environmental state to the environmental state simulator...
Definition: environmentalStateSetter.h:29
DtEnvironmentalStateSetter::setWaterCurrentDirection
virtual void setWaterCurrentDirection(double waterCurrentDirection)=0
DtEnvironmentalStateSetter::setThermoclineLayer3Depth
virtual void setThermoclineLayer3Depth(double depth)=0
DtLocalObject
A locally simulated VRF object.
Definition: localObject.h:98
DtEnvironmentalStateSetter::setFogColor
virtual void setFogColor(const DtVector &color)=0
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)