VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
environmentalStateManager.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2015 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 
11 #pragma once
12 
13 #include "vrfobjcore/vrfobjcoreDefines.h"
14 #include <vlutil/vlString.h>
15 #include <vrfExtObjects/vrfWeatherStateEnums.h>
16 #include "vrfobjcore/vrfObjectReference.h"
17 #include <matrix/vlVector.h>
18 #include <vrfutil/rwUUID.h>
19 #include <vrfobjcore/managedObjectList.h>
20 #include <vrfobjparam/illuminationObjectParameters.h>
21 
22 #include <set>
23 
24 class DtSimManager;
25 class DtVrfObject;
26 class DtObjectType;
27 class DtEnvironmentalStateSetter;
28 class DtChangeWeatherCommand;
29 class DtChangeTimeOfDayCommand;
30 class DtChord;
31 class DtSimMessage;
32 
39 class DT_DLL_vrfobjcore DtEnvironmentalStateManager
40 {
41 private:
43 
44  DtEnvironmentalStateManager(const DtEnvironmentalStateManager & orig);
45  const DtEnvironmentalStateManager & operator=(const DtEnvironmentalStateManager &
46  orig);
47  DtEnvironmentalStateManager();
49 
50 public:
51 
53  DtEnvironmentalStateManager(DtSimManager* simManager);
54 
56  virtual ~DtEnvironmentalStateManager();
57 
58  virtual bool init();
59 
60  virtual void tick();
61 
62  virtual DtSimManager* simManager();
63 
66  virtual bool globalEnvironmentSimulatedLocally() const;
67 
72  virtual bool startEnvironmentSimulationLocally();
73 
75  virtual DtSharedVrfObjectReference weatherObjectFor(const DtUUID& = DtUUID::nullUUID(),
76  bool* isGlobal = 0) const;
77 
80  virtual DtSharedVrfObjectReference weatherObjectFor(const DtVector& localPosition,
81  bool* isGlobal = 0) const;
82 
84  virtual DtSharedVrfObjectReference weatherObjectFor(const DtChord& localChord,
85  bool* isGlobal = 0) const;
86 
89  virtual std::vector<DtSharedVrfObjectReference> weatherObjectsFor(const DtChord& localChord) const;
90 
93 
94  virtual void setAirTurbidity(double factor, const DtUUID& weatherArea = DtUUID::nullUUID());
95  virtual double airTurbidity(const DtUUID& weatherArea) const;
96  virtual double airTurbidity(const DtVector&) const;
98 
100 
101  virtual void setAmbientAirTemperature(double temp, const DtUUID& weatherArea = DtUUID::nullUUID());
102  virtual double ambientAirTemperature(const DtUUID& weatherArea) const;
103  virtual double ambientAirTemperature(const DtVector&) const;
105 
107 
108  virtual void setCloudState(DtVrfWeatherCloudState current, const DtUUID& weatherArea = DtUUID::nullUUID());
109  virtual DtVrfWeatherCloudState cloudState(const DtUUID& weatherArea) const;
110  virtual DtVrfWeatherCloudState cloudState(const DtVector&) const;
112 
114 
115  virtual void setPrecipitationIntensity(double factor, const DtUUID& weatherArea = DtUUID::nullUUID());
116  virtual double precipitationIntensity(const DtUUID& weatherArea) const;
117  virtual double precipitationIntensity(const DtVector&) const;
119 
121 
122  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType current, const DtUUID& weatherArea = DtUUID::nullUUID());
123  virtual DtVrfWeatherPrecipitationType precipitationType(const DtUUID& weatherArea) const;
124  virtual DtVrfWeatherPrecipitationType precipitationType(const DtVector&) const;
126 
128 
129  virtual void setWindSpeed(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
130  virtual double windSpeed(const DtUUID& weatherArea) const;
131  virtual double windSpeed(const DtVector&) const;
133 
135 
136  virtual void setWindDirection(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
137  virtual double windDirection(const DtUUID& weatherArea) const;
138  virtual double windDirection(const DtVector&) const;
140 
142 
143  virtual void setVisibility(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
144  virtual double visibility(const DtUUID& weatherArea) const;
145  virtual double visibility(const DtVector&) const;
146 
149  virtual double visibility(const DtChord&) const;
151 
156 
157  virtual double illumination(const DtVector& localPosition) const;
159 
162  virtual void setWeatherState(const DtChangeWeatherCommand& command);
163 
166  virtual void setUseDayNightIlluminationModel(const DtChangeTimeOfDayCommand& command);
167  virtual void setDateAndTimeOfDay(double secondsPastMidnight);
168  virtual void setDateAndTimeOfDay(const DtChangeTimeOfDayCommand& command);
169  virtual double timeOfDay() const;
170  virtual double dateAndTimeOfDay() const;
171 
173  virtual void setTimeOfDayAdvancementSpeed(double speed);
174  virtual void setTimeOfDayAdvancementSpeed(const DtChangeTimeOfDayCommand& command);
175  virtual double timeOfDayAdvancementSpeed() const;
176 
178 
179  virtual void setPriority(int p, const DtUUID& weatherArea = DtUUID::nullUUID());
180  virtual int priority(const DtUUID& weatherArea) const;
181  virtual int priority(const DtVector&) const;
183 
185 
186  virtual void setUnderwaterVisibility(double underwaterVisibility, const DtUUID& weatherArea = DtUUID::nullUUID());
187  virtual double underwaterVisibility(const DtUUID& weatherArea) const;
188  virtual double underwaterVisibility(const DtVector&) const;
190 
192 
193  virtual void setSurfaceTransparency(double transparency, const DtUUID& weatherArea = DtUUID::nullUUID());
194  virtual double surfaceTransparency(const DtUUID& weatherArea) const;
195  virtual double surfaceTransparency(const DtVector&) const;
197 
199 
200  virtual void setWaterCurrentSpeed(double waterCurrentSpeed, const DtUUID& weatherArea = DtUUID::nullUUID());
201  virtual double waterCurrentSpeed(const DtUUID& weatherArea) const;
202  virtual double waterCurrentSpeed(const DtVector&) const;
204 
206 
207  virtual void setWaterCurrentDirection(double waterCurrentDirection, const DtUUID& weatherArea = DtUUID::nullUUID());
208  virtual double waterCurrentDirection(const DtUUID& weatherArea) const;
209  virtual double waterCurrentDirection(const DtVector&) const;
211 
213 
214  virtual void setAmbientWaterTemperature(double waterTemperature, const DtUUID& weatherArea = DtUUID::nullUUID());
215  virtual double ambientWaterTemperature(const DtUUID& weatherArea) const;
216  virtual double ambientWaterTemperature(const DtVector&) const;
218 
220 
221  virtual void setTidalOffset(double tidalOffset, const DtUUID& weatherArea = DtUUID::nullUUID());
222  virtual double tidalOffset(const DtUUID& weatherArea) const;
223  virtual double tidalOffset(const DtVector&) const;
225 
229  virtual void setUseDayNightIlluminationModel(bool);
230  virtual bool useDayNightIlluminationModel() const;
232 
235 
236  virtual void setTidalDirection(bool tidalDirection, const DtUUID& weatherArea = DtUUID::nullUUID());
237  virtual bool tidalDirection(const DtUUID& weatherArea) const;
238  virtual bool tidalDirection(const DtVector&) const;
240 
242 
243  virtual void setSwellState(unsigned int state, const DtUUID& weatherArea = DtUUID::nullUUID());
244  virtual unsigned int swellState(const DtUUID& weatherArea) const;
245  virtual unsigned int swellState(const DtVector&) const;
247 
249 
250  virtual void setSwellStateDirection(double direction, const DtUUID& weatherArea = DtUUID::nullUUID());
251  virtual double swellStateDirection(const DtUUID& weatherArea) const;
252  virtual double swellStateDirection(const DtVector&) const;
254 
256 
257  virtual void setSeaState(unsigned int state, const DtUUID& weatherArea = DtUUID::nullUUID());
258  virtual unsigned int seaState(const DtUUID& weatherArea) const;
259  virtual unsigned int seaState(const DtVector&) const;
261 
263 
264  virtual void setSeaStateDirection(double direction, const DtUUID& weatherArea = DtUUID::nullUUID());
265  virtual double seaStateDirection(const DtUUID& weatherArea) const;
266  virtual double seaStateDirection(const DtVector&) const;
268 
270 
271  virtual void setWindDrivenSeaStateEnabled(bool b, const DtUUID& weatherArea = DtUUID::nullUUID());
272  virtual bool windDrivenSeaStateEnabled(const DtUUID& weatherArea) const;
273  virtual bool windDrivenSeaStateEnabled(const DtVector&) const;
275 
277 
278  virtual void setChoppiness(double choppiness, const DtUUID& weatherArea = DtUUID::nullUUID());
279  virtual double choppiness(const DtUUID& weatherArea) const;
280  virtual double choppiness(const DtVector&) const;
282 
284 
285  virtual void setSurgeDepth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
286  virtual double surgeDepth(const DtUUID& weatherArea) const;
287  virtual double surgeDepth(const DtVector&) const;
289 
291 
292  virtual void setFogHeight(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
293  virtual double fogHeight(const DtUUID& weatherArea) const;
294  virtual double fogHeight(const DtVector&) const;
296 
298 
299  virtual void setFogColor(const DtVector& color, const DtUUID& weatherArea = DtUUID::nullUUID());
300  virtual DtVector fogColor(const DtUUID& weatherArea) const;
301  virtual DtVector fogColor(const DtVector&) const;
303 
306  virtual DtObjectType globalEnvironmentObjectType() const;
307 
310 
311  virtual void setThermoclineLayer1Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
312  virtual double thermoclineLayer1Depth(const DtUUID& weatherArea) const;
313  virtual double thermoclineLayer1Depth(const DtVector&) const;
314  virtual void setThermoclineLayer1Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
315  virtual double thermoclineLayer1Permeability(const DtUUID& weatherArea) const;
316  virtual double thermoclineLayer1Permeability(const DtVector&) const;
317  virtual void setThermoclineLayer2Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
318  virtual double thermoclineLayer2Depth(const DtUUID& weatherArea) const;
319  virtual double thermoclineLayer2Depth(const DtVector&) const;
320  virtual void setThermoclineLayer2Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
321  virtual double thermoclineLayer2Permeability(const DtUUID& weatherArea) const;
322  virtual double thermoclineLayer2Permeability(const DtVector&) const;
323  virtual void setThermoclineLayer3Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
324  virtual double thermoclineLayer3Depth(const DtUUID& weatherArea) const;
325  virtual double thermoclineLayer3Depth(const DtVector&) const;
326  virtual void setThermoclineLayer3Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
327  virtual double thermoclineLayer3Permeability(const DtUUID& weatherArea) const;
328  virtual double thermoclineLayer3Permeability(const DtVector&) const;
329  virtual void setThermoclineLayer4Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
330  virtual double thermoclineLayer4Depth(const DtUUID& weatherArea) const;
331  virtual double thermoclineLayer4Depth(const DtVector&) const;
332  virtual void setThermoclineLayer4Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
333  virtual double thermoclineLayer4Permeability(const DtUUID& weatherArea) const;
334  virtual double thermoclineLayer4Permeability(const DtVector&) const;
335  virtual void setThermoclineLayer5Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
336  virtual double thermoclineLayer5Depth(const DtUUID& weatherArea) const;
337  virtual double thermoclineLayer5Depth(const DtVector&) const;
338  virtual void setThermoclineLayer5Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
339  virtual double thermoclineLayer5Permeability(const DtUUID& weatherArea) const;
340  virtual double thermoclineLayer5Permeability(const DtVector&) const;
342 
346  virtual void createGlobalEnvironmentObject();
347 
348 protected:
349  static void objectAddedCallback(DtVrfObject* object, void* usr);
350  virtual void processObjectAdded(DtVrfObject* object);
351 
352  static void objectRemovedCallback(DtVrfObject* object, void* usr);
353  virtual void processObjectRemoved(DtVrfObject* object);
354 
356  virtual DtEnvironmentalStateSetter* createLocalEnvironmentalStateSetter();
358  virtual DtEnvironmentalStateSetter* createRemoteEnvironmentalStateSetter();
359 
360  static void changeWeatherPrioritiesCallback(DtSimMessage* msg, void* usr);
361  virtual void processChangeWeatherPriorities(DtSimMessage* msg);
362 
363  static void physicalWorldParametersChangedCallback(void* usr);
364  virtual void initializeIlluminationObjectsList();
365 
366  virtual const DtIlluminationObjectParameters& findBestMatch(const DtObjectType& objtype) const;
367 
368 protected:
369  DtSimManager* mySimManager;
370 
371  DtSharedVrfObjectReference myGlobalEnvironmentObject;
372  DtRwVrfObjectReferenceList myWeatherObjects;
373 
375  DtEnvironmentalStateSetter* myEnvironmentalStateSetter;
376 
377  bool myFirstTick;
378 
380  mutable DtVector myLastPointChecked;
381  mutable DtSharedVrfObjectReference myLastWeatherByPoint;
382 
383  DtManagedObjectListConstPtr myIlluminationObjects;
384 
385  std::map<DtObjectType, DtIlluminationObjectParameters> myIlluminationObjectTypes;
386 };
387 
388 
Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)