Inheritance diagram for makVrf::DtLocalWeatherManager:

Classes
struct	GlobalScenarioCreationData

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

typedef std::map < makVrv::DtUniqueID, GlobalScenarioCreationData >	GlobalWeatherObjects

Public Member Functions
	DtLocalWeatherManager (makVrv::DtDe &)
	CTOR. More...

virtual	~DtLocalWeatherManager ()
	DTOR. More...

virtual const WeatherObjects &	weatherObjects () const

virtual bool	hasEnvironment (const std::string &) const
	Returns true if the environment exists. More...

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. More...

virtual void	setupCommand (DtChangeWeatherCommand &weatherCommand, const makArchives::DtEnvironmentRecord &environment) const
	Given the environment record set the appropriate variables into the weather command. More...

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. More...

virtual void	setupRecord (makArchives::DtEnvironmentRecord &rec, const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *environment) const

virtual int	nextPriority () const
	Returns the next lowest priority available. More...

virtual void	setShowWeather (bool)
	Sets whether or not to show weather. This will simply show/hide the Weather overlay layer. More...

virtual bool	showWeather () const

virtual void	setWeatherAreaFilled (bool)
	Sets whether or not weather areas are unfilled. More...

virtual bool	weatherAreaFilled () const

virtual void	setUseDayNightIlluminationModel (bool)
	Returns whether or not to use the day/night illumination model. More...

virtual bool	useDayNightIlluminationModel () const

virtual void	increasePriorityOf (makVrv::DtElementID)
	Increases the priority of the given weather area referenced by the element id. More...

virtual void	decreasePriorityOf (makVrv::DtElementID)
	Decreases the priority of the given weather area referenced by the element id. More...

virtual void	bringWeatherToFront (makVrv::DtElementID)
	Makes the specified weather object the highest priority, lowering the priority of all other weather items. More...

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. More...

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. More...

const GlobalWeatherObjects &	globalWeatherObjects () const

bool	hasGlobalWeather () const

virtual void	setTimeBasedOnCreation (bool, int session=-1)
	For the specified session (or all session) set the time to set to local based on the first simulation object creation. More...

virtual int	addWeatherLookModificationOperation (const DtWeatherLookModificationOperation &)
	Adds a new rule for modifying weather color. More...

virtual void	removeWeatherLookModificationOperation (int)
	Removes operation. More...

virtual void	insertWeatherLookModificationOperation (int, const DtWeatherLookModificationOperation &)
	Inserts an operation. More...

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. More...

virtual std::string	weatherLookModelDefinitionFor (const makArchives::DtEnvironmentRecord &) const
	Returns the model definition for the look of the weather icon. More...

virtual void	setLocalWeatherLookManager (DtLocalWeatherLookOperationManager *)
	Sets the look manager for this local weather manager. More...

DtLocalWeatherLookOperationManager *	localWeatherLookManager () const
	Accessor for the manager. More...

virtual bool	isTimeFrozen () const
	Returns true if the setting of time for the first entity placement can be done. False means it can. More...

virtual bool	isTimeSetToLocalOnFirstPlacement ()
	Returns true if the first entity placement will set time to local time. More...

virtual bool	isLocalWeatherArea (makVrv::DtUniqueID id) const

const makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	globalWeather () const

virtual bool	isWeatherObject (makVrv::DtUniqueID) const

virtual makVrv::DtUniqueID	weatherAreaNear (makVrv::DtUniqueID) const
	Given the location of the particular object, return the area that contains the given location of the object given. More...

virtual makVrv::DtUniqueID	weatherAreaNear (const DtVector &) const
	Given the location of the particular object, return the area that contains the given location of the object given. More...

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...

virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtLocalWeatherManager &	instance (makVrv::DtDe &de)
	Returns DtLocalWeatherManager of the manager. More...

static void	registerInstance (makVrv::DtDe &, DtLocalWeatherManager *)
	Register a new manager instance. More...

Public Attributes
boost::signals2::signal< void(makVrv::DtElementID)>	signal_removed
	Signal sent when the local weather area is removed. More...

boost::signals2::signal< void(const makVrv::DtStateView < DtVrlinkSimulatedEnvironmentProcess > *)>	signal_updated
	Signal sent when the local weather area is updated. More...

boost::signals2::signal< void(const makVrv::DtStateView < DtVrlinkSimulatedWeatherState > *)>	signal_weatherUpdated

boost::signals2::signal< void(makVrv::DtUniqueID, bool)>	signal_isTimeFrozenChanged
	Signals sent when information about a particular global weather has updated. More...

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

boost::signals2::signal< void()>	signal_weatherLookRulesChanged
	Signal sent when the weather look rules have changed. More...

boost::signals2::signal< void(makVrv::DtUniqueID)>	signal_globalWeatherDiscovered
	Signal when global weather is discovered. More...

boost::signals2::signal< void(makVrv::DtUniqueID)>	signal_globalWeatherRemoved
	Signal when all global weathers are removed. More...

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

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) More...

virtual void	slot_globalWeatherObjectStateUpdated (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)

virtual void	weatherObjectAdded (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)

virtual void	weatherObjectRemoved (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)

virtual void	globalWeatherObjectAdded (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)

virtual void	globalWeatherObjectRemoved (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)

virtual void	initExistingWeatherObjects ()
	Initializes environment by scanning for weather objects. More...

virtual void	slot_onWeatherUpdated (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *s)

virtual void	slot_onWeatherStateUpdated (const makVrv::DtStateView< DtVrlinkSimulatedWeatherState > *s)

virtual void	offsetPriorityBy (makVrv::DtElementID id, int by)
	Offsets the priority of the object by the given amount. More...

Protected Attributes
makVrv::DtDe &	myDe

WeatherObjects	myWeatherObjects

makVrv::DtSignalConnectionManager	myConnectionManager

DtLocalWeatherLookOperationManager *	myLocalWeatherOperationLookManager

GlobalWeatherObjects	myGlobalWeatherObjects

WeatherConnections	myGlobalWeatherObjectConnections

WeatherConnections	myWeatherConnections

const makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	myGlobalWeather

Member Typedef Documentation

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

typedef std::map<makVrv::DtUniqueID, GlobalScenarioCreationData> makVrf::DtLocalWeatherManager::GlobalWeatherObjects

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

protected

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 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,
		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::setWeatherAreaFilled ( bool )

virtual

Sets whether or not weather areas are unfilled.

If they are unfilled then the label of the weather area will also b shown under the weather icon

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

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::isLocalWeatherArea ( makVrv::DtUniqueID id ) const

virtual

const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* 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 ( 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::slot_globalWeatherObjectStateUpdated ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > * )

protectedvirtual

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::globalWeatherObjectAdded ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > * )

protectedvirtual

virtual void makVrf::DtLocalWeatherManager::globalWeatherObjectRemoved ( 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::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 (const makVrv::DtStateView<DtVrlinkSimulatedEnvironmentProcess>*)> makVrf::DtLocalWeatherManager::signal_updated

Signal sent when the local weather area is updated.

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

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.

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

const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtLocalWeatherManager::myGlobalWeather

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfGuiCore/localWeatherManager.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation