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

Public Types

typedef std::map
< makVrv::DtElementID,
makVrv::DtStateView
< DtVrlinkSimulatedEnvironmentProcess > * > 
WeatherObjects

Public Member Functions

 DtLocalWeatherManager (makVrv::DtDe &)
 CTOR.
virtual ~DtLocalWeatherManager ()
 DTOR.
virtual const WeatherObjectsweatherObjects () const
virtual void setupCommand (DtChangeWeatherCommand &weatherCommand, const std::string &environment) const
 Given an environment name retrieve the environment record and set the appropriate variables into the weather command.
virtual void setupCommand (DtChangeWeatherCommand &weatherCommand, const makArchives::DtEnvironmentRecord &environment) const
 Given the environment record set the appropriate variables into the weather command.
virtual void setupRecord (makArchives::DtEnvironmentRecord &environment, const DtChangeWeatherCommand &weatherCommand) const
virtual void setupCommand (DtChangeWeatherCommand &weatherCommand, const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *environment) const
 Given the weather state record set the appropriate variables into the weather command.
virtual void setupRecord (makArchives::DtEnvironmentRecord &rec, const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *environment) const
virtual int nextPriority () const
 Returns the next lowest priority available.
virtual void setShowWeather (bool)
 Sets whether or not to show weather. This will simply show/hide the Weather overlay layer.
virtual bool showWeather () const
virtual void setUseDayNightIlluminationModel (bool)
 Returns whether or not to use the day/night illumination model.
virtual bool useDayNightIlluminationModel () const
virtual void increasePriorityOf (makVrv::DtElementID)
 Increases the priority of the given weather area referenced by the element id.
virtual void decreasePriorityOf (makVrv::DtElementID)
 Decreases the priority of the given weather area referenced by the element id.
virtual void bringWeatherToFront (makVrv::DtElementID)
 Makes the specified weather object the highest priority, lowering the priority of all other weather items.
virtual void sendWeatherToBack (makVrv::DtElementID)
 Makes the specified weather object the lowest priority, filling the gap left with lower priority items than the one that was moved.
virtual void changePriorityOf (makVrv::DtElementID, int)
 Changes the priority of the given id to the specified priority, changing the priorities of all the other items to fill the gap left.
virtual int addWeatherLookModificationOperation (const DtWeatherLookModificationOperation &)
 Adds a new rule for modifying weather color.
virtual void removeWeatherLookModificationOperation (int)
 Removes operation.
virtual void insertWeatherLookModificationOperation (int, const DtWeatherLookModificationOperation &)
 Inserts an operation.
virtual
DtLocalWeatherLookOperationManager::WeatherLookModificationOperations 
weatherLookModificationOperations () const
virtual void modifyColorForWeather (const makArchives::DtEnvironmentRecord &, float &r, float &g, float &b, float &a) const
 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 weatherLookModelDefinitionFor (const makArchives::DtEnvironmentRecord &) const
 Returns the model definition for the look of the weather icon.
virtual void setLocalWeatherLookManager (DtLocalWeatherLookOperationManager *)
 Sets the look manager for this local weather manager.
DtLocalWeatherLookOperationManagerlocalWeatherLookManager () const
 Accessor for the manager.
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static DtLocalWeatherManagerinstance (makVrv::DtDe &de)
 Returns DtLocalWeatherManager of the manager.
static void registerInstance (makVrv::DtDe &, DtLocalWeatherManager *)
 Register a new manager instance.

Public Attributes

boost::signal< void(makVrv::DtElementID)> signal_removed
 Signal sent when the local weather area is removed.
boost::signal< void(const
makVrv::DtStateView
< DtVrlinkSimulatedEnvironmentProcess > *)> 
signal_updated
 Signal sent when the local weather area is updated.
boost::signal< void(const
makVrv::DtStateView
< DtVrlinkSimulatedWeatherState > *)> 
signal_weatherUpdated
boost::signal< void()> signal_weatherLookRulesChanged
 Signal sent when the weather look rules have changed.

Protected Member Functions

virtual void addIfWeatherObject (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
 Adds this item in if it is a local weather item (by matching object type)
virtual void weatherObjectAdded (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
virtual void weatherObjectRemoved (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
virtual void initExistingWeatherObjects ()
 Initializes environment by scanning for weather objects.
virtual void slot_onWeatherUpdated (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *s)
virtual void slot_onWeatherStateUpdated (const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *s)
virtual void extendedApplicationOptionsChanged ()
 Sees whether or not the weather layer should be shown/hidden.
virtual void offsetPriorityBy (makVrv::DtElementID id, int by)
 Offsets the priority of the object by the given amount.
virtual void overlayAdded (const std::string &)
 When an overlay is added if this is the weather layer set to be visible/not visible.
virtual void overlayVisibilityChanged (const std::string &, bool)
 When an overlay visibility is changed keep the settings constant if this is the weather layer.

Protected Attributes

makVrv::DtDemyDe
WeatherObjects myWeatherObjects
makVrv::DtSignalConnectionManager myConnectionManager
DtLocalWeatherLookOperationManagermyLocalWeatherOperationLookManager

Member Typedef Documentation

Constructor & Destructor Documentation

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

CTOR.

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

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 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,
const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *  environment 
) const
virtual

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

virtual void makVrf::DtLocalWeatherManager::setupRecord ( makArchives::DtEnvironmentRecord rec,
const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *  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::setUseDayNightIlluminationModel ( bool  )
virtual

Returns whether or not to use the day/night illumination model.

virtual bool makVrf::DtLocalWeatherManager::useDayNightIlluminationModel ( ) 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.

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 void makVrf::DtLocalWeatherManager::addIfWeatherObject ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )
protectedvirtual

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

virtual void makVrf::DtLocalWeatherManager::weatherObjectAdded ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::weatherObjectRemoved ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::initExistingWeatherObjects ( )
protectedvirtual

Initializes environment by scanning for weather objects.

virtual void makVrf::DtLocalWeatherManager::slot_onWeatherUpdated ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  s)
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::slot_onWeatherStateUpdated ( const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *  s)
protectedvirtual
virtual void makVrf::DtLocalWeatherManager::extendedApplicationOptionsChanged ( )
protectedvirtual

Sees whether or not the weather layer should be shown/hidden.

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

virtual void makVrf::DtLocalWeatherManager::overlayAdded ( const std::string &  )
protectedvirtual

When an overlay is added if this is the weather layer set to be visible/not visible.

virtual void makVrf::DtLocalWeatherManager::overlayVisibilityChanged ( const std::string &  ,
bool   
)
protectedvirtual

When an overlay visibility is changed keep the settings constant if this is the weather layer.

Member Data Documentation

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

Signal sent when the local weather area is removed.

boost::signal<void (const makVrv::DtStateView<DtVrlinkSimulatedEnvironmentProcess>*)> makVrf::DtLocalWeatherManager::signal_updated

Signal sent when the local weather area is updated.

boost::signal<void (const makVrv::DtStateView<DtVrlinkSimulatedWeatherState>*)> makVrf::DtLocalWeatherManager::signal_weatherUpdated
boost::signal<void ()> makVrf::DtLocalWeatherManager::signal_weatherLookRulesChanged

Signal sent when the weather look rules have changed.

makVrv::DtDe& makVrf::DtLocalWeatherManager::myDe
protected
WeatherObjects makVrf::DtLocalWeatherManager::myWeatherObjects
protected
makVrv::DtSignalConnectionManager makVrf::DtLocalWeatherManager::myConnectionManager
protected
DtLocalWeatherLookOperationManager* makVrf::DtLocalWeatherManager::myLocalWeatherOperationLookManager
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)