VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes
makVrf::DtLocalWeatherManager Class Reference
Inheritance diagram for makVrf::DtLocalWeatherManager:
Inheritance graph
[legend]

Classes

struct  GlobalScenarioCreationData
 

Public Types

typedef std::map
< makVrv::DtElementID,
DtSimObjectReference
WeatherObjects
 
typedef std::map
< makVrv::DtUniqueID,
GlobalScenarioCreationData
GlobalWeatherObjects
 

Public Member Functions

 DtLocalWeatherManager (makVrv::DtDe &)
 
virtual ~DtLocalWeatherManager () override
 
virtual const WeatherObjectsweatherObjects () const
 
virtual bool hasEnvironment (const std::string &) const
 
virtual void setupCommand (DtChangeWeatherCommand &weatherCommand, const std::string &environment) const
 
virtual void setupCommand (DtChangeWeatherCommand &weatherCommand, const makArchives::DtEnvironmentRecord &environment) const
 
virtual void setupRecord (makArchives::DtEnvironmentRecord &environment, const DtChangeWeatherCommand &weatherCommand) const
 
virtual void setupCommand (DtChangeWeatherCommand &weatherCommand, DtSimObjectReference environment) const
 
virtual void setupRecord (makArchives::DtEnvironmentRecord &rec, DtSimObjectReference environment) const
 
virtual int nextPriority () const
 
virtual void setShowWeather (bool)
 
virtual bool showWeather () const
 
virtual void setUseGlobalTimeZone (bool)
 
virtual bool useGlobalTimeZone () const
 
virtual void increasePriorityOf (makVrv::DtElementID)
 
virtual void decreasePriorityOf (makVrv::DtElementID)
 
virtual void bringWeatherToFront (makVrv::DtElementID)
 
virtual void sendWeatherToBack (makVrv::DtElementID)
 
virtual void changePriorityOf (makVrv::DtElementID, int)
 
const GlobalWeatherObjectsglobalWeatherObjects () const
 
bool hasGlobalWeather () const
 
virtual void setTimeBasedOnCreation (bool, int session=-1)
 
virtual int addWeatherLookModificationOperation (const DtWeatherLookModificationOperation &)
 
virtual void removeWeatherLookModificationOperation (int)
 
virtual void insertWeatherLookModificationOperation (int, const DtWeatherLookModificationOperation &)
 
virtual
DtLocalWeatherLookOperationManager::WeatherLookModificationOperations 
weatherLookModificationOperations () const
 
virtual void modifyColorForWeather (const makArchives::DtEnvironmentRecord &, float &r, float &g, float &b, float &a) const
 
virtual std::string weatherLookModelDefinitionFor (const makArchives::DtEnvironmentRecord &) const
 
virtual void setLocalWeatherLookManager (DtLocalWeatherLookOperationManager *)
 
DtLocalWeatherLookOperationManagerlocalWeatherLookManager () const
 
virtual bool isTimeFrozen () const
 
virtual bool isTimeSetToLocalOnFirstPlacement ()
 
virtual bool userModifiedTime () const
 
virtual bool isLocalWeatherArea (makVrv::DtUniqueID id) const
 
DtSimObjectReference globalWeather () const
 
virtual bool isWeatherObject (makVrv::DtUniqueID) const
 
virtual makVrv::DtUniqueID weatherAreaNear (makVrv::DtUniqueID) const
 
virtual makVrv::DtUniqueID weatherAreaNear (const DtVector &) const
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 
virtual ~DtVirtualBaseClass ()
 

Static Public Member Functions

static DtLocalWeatherManagerinstance (makVrv::DtDe &de)
 
static void registerInstance (makVrv::DtDe &, DtLocalWeatherManager *)
 

Public Attributes

boost::signals2::signal< void(makVrv::DtElementID)> signal_removed
 
boost::signals2::signal< void(DtSimObjectReference)> signal_weatherUpdated
 
boost::signals2::signal< void(makVrv::DtUniqueID,
bool)> 
signal_isTimeFrozenChanged
 
boost::signals2::signal< void(makVrv::DtUniqueID,
bool)> 
signal_isTimeSetToLocalOnFirstPlacementChanged
 
boost::signals2::signal< void()> signal_weatherLookRulesChanged
 
boost::signals2::signal< void(makVrv::DtUniqueID)> signal_globalWeatherDiscovered
 
boost::signals2::signal< void(makVrv::DtUniqueID)> signal_globalWeatherRemoved
 
boost::signals2::signal< void()> signal_globalWeatherObjectStateUpdated
 

Protected Types

typedef std::map
< makVrv::DtUniqueID,
makVrv::DtSignalConnectionManager * > 
WeatherConnections
 

Protected Member Functions

virtual void addIfWeatherObject (DtSimObjectReference)
 
virtual void slot_globalWeatherObjectStateUpdated (DtSimObjectReference)
 
virtual void weatherObjectAdded (DtSimObjectReference)
 
virtual void weatherObjectRemoved (DtSimObjectReference)
 
virtual void globalWeatherObjectAdded (DtSimObjectReference)
 
virtual void globalWeatherObjectRemoved (DtSimObjectReference)
 
virtual void initExistingWeatherObjects ()
 
virtual void slot_onWeatherUpdated (DtSimObjectReference s)
 
virtual void slot_onWeatherStateUpdated (DtSimObjectReference s)
 
virtual void offsetPriorityBy (makVrv::DtElementID id, int by)
 

Protected Attributes

makVrv::DtDemyDe
 
WeatherObjects myWeatherObjects
 
makVrv::DtSignalConnectionManager myConnectionManager
 
DtLocalWeatherLookOperationManagermyLocalWeatherOperationLookManager
 
GlobalWeatherObjects myGlobalWeatherObjects
 
WeatherConnections myGlobalWeatherObjectConnections
 
WeatherConnections myWeatherConnections
 
DtSimObjectReference myGlobalWeather
 
bool myIsTimeFrozen = true
 
bool myIsTimeSetToLocalOnFirstPlacement = true
 

Member Typedef Documentation

Constructor & Destructor Documentation

makVrf::DtLocalWeatherManager::DtLocalWeatherManager ( makVrv::DtDe )

CTOR.

virtual makVrf::DtLocalWeatherManager::~DtLocalWeatherManager ( )
overridevirtual

DTOR.

Member Function Documentation

static DtLocalWeatherManager& makVrf::DtLocalWeatherManager::instance ( makVrv::DtDe de)
static

Returns DtLocalWeatherManager of the manager.

static void makVrf::DtLocalWeatherManager::registerInstance ( makVrv::DtDe ,
DtLocalWeatherManager  
)
static

Register a new manager instance.

virtual const WeatherObjects& makVrf::DtLocalWeatherManager::weatherObjects ( ) const
inlinevirtual
virtual bool makVrf::DtLocalWeatherManager::hasEnvironment ( const std::string &  ) const
virtual

Returns true if the environment exists.

virtual void makVrf::DtLocalWeatherManager::setupCommand ( DtChangeWeatherCommand weatherCommand,
const std::string &  environment 
) const
virtual

Given an environment name retrieve the environment record and set the appropriate variables into the weather command.

virtual void makVrf::DtLocalWeatherManager::setupCommand ( DtChangeWeatherCommand weatherCommand,
const makArchives::DtEnvironmentRecord environment 
) const
virtual

Given the environment record set the appropriate variables into the weather command.

virtual void makVrf::DtLocalWeatherManager::setupRecord ( makArchives::DtEnvironmentRecord environment,
const DtChangeWeatherCommand weatherCommand 
) const
virtual
virtual void makVrf::DtLocalWeatherManager::setupCommand ( DtChangeWeatherCommand weatherCommand,
DtSimObjectReference  environment 
) const
virtual

Given the weather state record set the appropriate variables into the weather command.

virtual void makVrf::DtLocalWeatherManager::setupRecord ( makArchives::DtEnvironmentRecord rec,
DtSimObjectReference  environment 
) const
virtual
virtual int makVrf::DtLocalWeatherManager::nextPriority ( ) const
virtual

Returns the next lowest priority available.

virtual void makVrf::DtLocalWeatherManager::setShowWeather ( bool  )
virtual

Sets whether or not to show weather. This will simply show/hide the Weather overlay layer.

virtual bool makVrf::DtLocalWeatherManager::showWeather ( ) const
virtual
virtual void makVrf::DtLocalWeatherManager::setUseGlobalTimeZone ( bool  )
virtual

Returns whether or not to use the day/night illumination model (true to use, false to not)

virtual bool makVrf::DtLocalWeatherManager::useGlobalTimeZone ( ) const
virtual
virtual void makVrf::DtLocalWeatherManager::increasePriorityOf ( makVrv::DtElementID  )
virtual

Increases the priority of the given weather area referenced by the element id. If there is another weather area at the newly increased priority it will swap with this weather area. Note that the priority cannot be increased beyond 1.

virtual void makVrf::DtLocalWeatherManager::decreasePriorityOf ( makVrv::DtElementID  )
virtual

Decreases the priority of the given weather area referenced by the element id. If there is another weather area at the newly decreased priority it will swap with this weather area.

virtual void makVrf::DtLocalWeatherManager::bringWeatherToFront ( makVrv::DtElementID  )
virtual

Makes the specified weather object the highest priority, lowering the priority of all other weather items.

virtual void makVrf::DtLocalWeatherManager::sendWeatherToBack ( makVrv::DtElementID  )
virtual

Makes the specified weather object the lowest priority, filling the gap left with lower priority items than the one that was moved.

virtual void makVrf::DtLocalWeatherManager::changePriorityOf ( makVrv::DtElementID  ,
int   
)
virtual

Changes the priority of the given id to the specified priority, changing the priorities of all the other items to fill the gap left.

const GlobalWeatherObjects& makVrf::DtLocalWeatherManager::globalWeatherObjects ( ) const
inline
bool makVrf::DtLocalWeatherManager::hasGlobalWeather ( ) const
inline
virtual void makVrf::DtLocalWeatherManager::setTimeBasedOnCreation ( bool  ,
int  session = -1 
)
virtual

For the specified session (or all session) set the time to set to local based on the first simulation object creation. Only valid before the first entity is placed in the simulation. If the timeIsFrozen() is true this method will have no effect.

virtual int makVrf::DtLocalWeatherManager::addWeatherLookModificationOperation ( const DtWeatherLookModificationOperation )
virtual

Adds a new rule for modifying weather color. Returns the index it was added at. Use that index to remove the weather operation. Will clone operation and keep pointer.

virtual void makVrf::DtLocalWeatherManager::removeWeatherLookModificationOperation ( int  )
virtual

Removes operation.

virtual void makVrf::DtLocalWeatherManager::insertWeatherLookModificationOperation ( int  ,
const DtWeatherLookModificationOperation  
)
virtual

Inserts an operation.

virtual DtLocalWeatherLookOperationManager::WeatherLookModificationOperations makVrf::DtLocalWeatherManager::weatherLookModificationOperations ( ) const
virtual
virtual void makVrf::DtLocalWeatherManager::modifyColorForWeather ( const makArchives::DtEnvironmentRecord ,
float &  r,
float &  g,
float &  b,
float &  a 
) const
virtual

Given the environment record and some base colors, calls weather modification rules to change the color to a new one and returns in the same variables that were the base colors supplied.

virtual std::string makVrf::DtLocalWeatherManager::weatherLookModelDefinitionFor ( const makArchives::DtEnvironmentRecord ) const
virtual

Returns the model definition for the look of the weather icon.

virtual void makVrf::DtLocalWeatherManager::setLocalWeatherLookManager ( DtLocalWeatherLookOperationManager )
virtual

Sets the look manager for this local weather manager. This will delete the existing weather manager so do not hold onto the memory passed in.

DtLocalWeatherLookOperationManager* makVrf::DtLocalWeatherManager::localWeatherLookManager ( ) const
inline

Accessor for the manager.

virtual bool makVrf::DtLocalWeatherManager::isTimeFrozen ( ) const
virtual

Returns true if the setting of time for the first entity placement can be done. False means it can.

virtual bool makVrf::DtLocalWeatherManager::isTimeSetToLocalOnFirstPlacement ( )
virtual

Returns true if the first entity placement will set time to local time.

virtual bool makVrf::DtLocalWeatherManager::userModifiedTime ( ) const
virtual

Returns true if the user has modified the time.

virtual bool makVrf::DtLocalWeatherManager::isLocalWeatherArea ( makVrv::DtUniqueID  id) const
virtual
DtSimObjectReference makVrf::DtLocalWeatherManager::globalWeather ( ) const
inline
virtual bool makVrf::DtLocalWeatherManager::isWeatherObject ( makVrv::DtUniqueID  ) const
virtual
virtual makVrv::DtUniqueID makVrf::DtLocalWeatherManager::weatherAreaNear ( makVrv::DtUniqueID  ) const
virtual

Given the location of the particular object, return the area that contains the given location of the object given.

virtual makVrv::DtUniqueID makVrf::DtLocalWeatherManager::weatherAreaNear ( const DtVector &  ) const
virtual

Given the location of the particular object, return the area that contains the given location of the object given. The location is in geocentric.

virtual void makVrf::DtLocalWeatherManager::addIfWeatherObject ( DtSimObjectReference  )
protectedvirtual

Adds this item in if it is a local weather item (by matching object type)

virtual void makVrf::DtLocalWeatherManager::slot_globalWeatherObjectStateUpdated ( DtSimObjectReference  )
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::weatherObjectAdded ( DtSimObjectReference  )
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::weatherObjectRemoved ( DtSimObjectReference  )
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::globalWeatherObjectAdded ( DtSimObjectReference  )
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::globalWeatherObjectRemoved ( DtSimObjectReference  )
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::initExistingWeatherObjects ( )
protectedvirtual

Initializes environment by scanning for weather objects.

virtual void makVrf::DtLocalWeatherManager::slot_onWeatherUpdated ( DtSimObjectReference  s)
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::slot_onWeatherStateUpdated ( DtSimObjectReference  s)
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::offsetPriorityBy ( makVrv::DtElementID  id,
int  by 
)
protectedvirtual

Offsets the priority of the object by the given amount. If more than 1 will still swap weather areas that conflict with the new priority – it will not shift priorities.

Member Data Documentation

boost::signals2::signal<void (makVrv::DtElementID)> makVrf::DtLocalWeatherManager::signal_removed

Signal sent when the local weather area is removed.

boost::signals2::signal<void (DtSimObjectReference)> makVrf::DtLocalWeatherManager::signal_weatherUpdated

Signal sent when the local weather area is updated.

boost::signals2::signal<void (makVrv::DtUniqueID, bool)> makVrf::DtLocalWeatherManager::signal_isTimeFrozenChanged

Signals sent when information about a particular global weather has updated. If ID is 0 check to see if need to reset to defaults.

boost::signals2::signal<void (makVrv::DtUniqueID, bool)> makVrf::DtLocalWeatherManager::signal_isTimeSetToLocalOnFirstPlacementChanged
boost::signals2::signal<void ()> makVrf::DtLocalWeatherManager::signal_weatherLookRulesChanged

Signal sent when the weather look rules have changed.

boost::signals2::signal<void (makVrv::DtUniqueID)> makVrf::DtLocalWeatherManager::signal_globalWeatherDiscovered

Signal when global weather is discovered.

boost::signals2::signal<void (makVrv::DtUniqueID)> makVrf::DtLocalWeatherManager::signal_globalWeatherRemoved

Signal when all global weathers are removed.

boost::signals2::signal<void ()> makVrf::DtLocalWeatherManager::signal_globalWeatherObjectStateUpdated
makVrv::DtDe& makVrf::DtLocalWeatherManager::myDe
protected
WeatherObjects makVrf::DtLocalWeatherManager::myWeatherObjects
protected
makVrv::DtSignalConnectionManager makVrf::DtLocalWeatherManager::myConnectionManager
protected
DtLocalWeatherLookOperationManager* makVrf::DtLocalWeatherManager::myLocalWeatherOperationLookManager
protected
GlobalWeatherObjects makVrf::DtLocalWeatherManager::myGlobalWeatherObjects
protected
WeatherConnections makVrf::DtLocalWeatherManager::myGlobalWeatherObjectConnections
protected
WeatherConnections makVrf::DtLocalWeatherManager::myWeatherConnections
protected
DtSimObjectReference makVrf::DtLocalWeatherManager::myGlobalWeather
protected
bool makVrf::DtLocalWeatherManager::myIsTimeFrozen = true
protected
bool makVrf::DtLocalWeatherManager::myIsTimeSetToLocalOnFirstPlacement = true
protected

The documentation for this class was generated from the following file:

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)