The DtWeatherAreaObjectManager manages, sets values, and provides signals related to weather area objects (see DtWeatherAreaObject). More...

Inheritance diagram for makVrv::DtWeatherAreaObjectManager:

[legend]

Public Member Functions
virtual	~DtWeatherAreaObjectManager ()
	DTOR. More...

	DtWeatherAreaObjectManager ()=delete
	Default Constructor not implemented � default constructor not allowed. More...

	DtWeatherAreaObjectManager (const DtWeatherAreaObjectManager &)=delete
	Copy Constructor not implemented � Copy not allowed. More...

DtWeatherAreaObjectManager &	operator= (const DtWeatherAreaObjectManager &)=delete
	Assignment Operator not implemented � Copy not allowed. More...

virtual DtWeatherAreaObjectAgent *	findWeatherAreaObjectAgent (DtUniqueID id)
	Find a weather area object agent, returns null if none exists. More...

virtual DtUniqueID	addWeatherArea ()
	Add a weather area and return its unique id. More...

virtual void	removeWeatherArea (DtUniqueID id)
	Remove a weather area. More...

virtual void	setWeatherAreaTransform (DtUniqueID id, const DtVector &position, const float orientation)
	Set a weather area's transform. More...

virtual void	setWeatherAreaBounds (DtUniqueID id, const DtVector &bounds, const float cornerRadius)
	Set a weather area's bounds. More...

virtual void	setWeatherAreaPrecipitationIntensity (DtUniqueID id, const float intensity)
	Set a weather area's precipitation intensity. More...

virtual void	setWeatherAreaPrecipitationType (DtUniqueID id, const unsigned int type)
	Set a weather area's precipitation type. More...

virtual void	setWeatherAreaGroundRainAccumulation (DtUniqueID id, const float depth)
	Set a weather area's ground rain accumulation depth. More...

virtual void	setWeatherAreaFogColor (DtUniqueID id, const DtVector &color)
	Set a weather area's fog color. More...

virtual void	setWeatherAreaVisibilityDistance (DtUniqueID id, const float distance)
	Set a weather area's visibility distance. More...

virtual void	setWeatherAreaOvercast (DtUniqueID id, const float overcast)
	Set a weather area's overcast lighting value. More...

virtual void	setWeatherAreaLightningEnabled (DtUniqueID id, const bool enabled)
	Set a weather area's lightning enabled value. 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 DtWeatherAreaObjectManager &	instance (DtDe &de)
	Get/create instance of weather area object manager. More...

static const std::string &	theClassName ()
	Get the name this class is registered by. More...

Public Attributes
boost::signalslib::signal < void(DtUniqueID id, DtWeatherAreaObject *area)>	signal_weatherAreaObjectAdded
	Signal raised when a weather area is added. More...

boost::signalslib::signal < void(DtUniqueID id, DtWeatherAreaObject *area)>	signal_weatherAreaObjectToBeRemoved
	Signal raised when a weather area is about to be removed. More...

boost::signalslib::signal < void(DtUniqueID id, const DtVector &position, const float orientation) >	signal_weatherAreaObjectTransformChanged
	Signal raised when a weather area transform changes. More...

boost::signalslib::signal < void(DtUniqueID id, const DtVector &bounds, const float cornerRadius) >	signal_weatherAreaObjectBoundsChanged
	Signal raised when a weather area bounds changes. More...

boost::signalslib::signal < void(DtUniqueID id, const float intensity) >	signal_weatherAreaObjectPrecipitationIntensityChanged
	Signal raised when a weather area precipitation intensity changes. More...

boost::signalslib::signal < void(DtUniqueID id, const unsigned int type) >	signal_weatherAreaObjectPrecipitationTypeChanged
	Signal raised when a weather area precipitation type changes. More...

boost::signalslib::signal < void(DtUniqueID id, const float depth) >	signal_weatherAreaObjectGroundRainAccumulationChanged
	Signal raised when a weather area ground rain accumulation changes. More...

boost::signalslib::signal < void(DtUniqueID id, const DtVector &color) >	signal_weatherAreaObjectFogColorChanged
	Signal raised when a weather area fog color changes. More...

boost::signalslib::signal < void(DtUniqueID id, const float distance) >	signal_weatherAreaObjectVisibilityDistanceChanged
	Signal raised when a weather area visibility distance changes. More...

boost::signalslib::signal < void(DtUniqueID id, const float overcast) >	signal_weatherAreaObjectOvercastChanged
	Signal raised when a weather area overcast changes. More...

boost::signalslib::signal < void(DtUniqueID id, const bool enabled) >	signal_weatherAreaObjectLightningEnabledChanged
	Signal raised when a weather area lightning enabled changes. More...

Protected Types
typedef std::map< DtUniqueID, DtWeatherAreaObjectAgent * >	WeatherAreaMap

Protected Member Functions
	DtWeatherAreaObjectManager (DtDe &de)
	CTOR (protected) More...

Protected Attributes
DtDe &	myDe

WeatherAreaMap	myIDToWeatherAreaObjectAgent

Detailed Description

The DtWeatherAreaObjectManager manages, sets values, and provides signals related to weather area objects (see DtWeatherAreaObject).

The DtWeatherAreaObjectManager is accessed by a singleton. Use addWeatherArea to get a unique id that can be used modify the weather area during the lifetime of the weather area object. Use removeWeatherArea to remove the weather area object when no longer needed.

Signals are provided by this manager for all changes to weather area objects. Each weather area object will trigger the proper signals when modified. A weather area object is a distrubuted object and will trigger the signals on a master and slave.

Member Typedef Documentation

typedef std::map<DtUniqueID, DtWeatherAreaObjectAgent* > makVrv::DtWeatherAreaObjectManager::WeatherAreaMap

protected

Constructor & Destructor Documentation

virtual makVrv::DtWeatherAreaObjectManager::~DtWeatherAreaObjectManager ( )

virtual

DTOR.

makVrv::DtWeatherAreaObjectManager::DtWeatherAreaObjectManager ( )

delete

Default Constructor not implemented � default constructor not allowed.

makVrv::DtWeatherAreaObjectManager::DtWeatherAreaObjectManager ( const DtWeatherAreaObjectManager & )

delete

Copy Constructor not implemented � Copy not allowed.

makVrv::DtWeatherAreaObjectManager::DtWeatherAreaObjectManager ( DtDe & de )

protected

CTOR (protected)

Member Function Documentation

DtWeatherAreaObjectManager& makVrv::DtWeatherAreaObjectManager::operator= ( const DtWeatherAreaObjectManager & )

delete

Assignment Operator not implemented � Copy not allowed.

static DtWeatherAreaObjectManager& makVrv::DtWeatherAreaObjectManager::instance ( DtDe & de )

static

Get/create instance of weather area object manager.

static const std::string& makVrv::DtWeatherAreaObjectManager::theClassName ( )

static

Get the name this class is registered by.

virtual DtWeatherAreaObjectAgent* makVrv::DtWeatherAreaObjectManager::findWeatherAreaObjectAgent ( DtUniqueID id )

virtual

Find a weather area object agent, returns null if none exists.

Parameters

id	The unique ID of the agent to find.

virtual DtUniqueID makVrv::DtWeatherAreaObjectManager::addWeatherArea ( )

virtual

Add a weather area and return its unique id.

virtual void makVrv::DtWeatherAreaObjectManager::removeWeatherArea ( DtUniqueID id )

virtual

Remove a weather area.

Parameters

id	The unique ID of the weather area.

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaTransform	(	DtUniqueID	id,
		const DtVector &	position,
		const float	orientation
	)

virtual

Set a weather area's transform.

Parameters

id	The unique ID of the weather area.
position	The position of the transform.
orientation	The orientation of the transform.

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaBounds	(	DtUniqueID	id,
		const DtVector &	bounds,
		const float	cornerRadius
	)

virtual

Set a weather area's bounds.

Parameters

id	The unique ID of the weather area.
bounds	The (width, length, height) of the bounding box.
cornerRadius	The corner radius of the bounding box (for a rounded rect).

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaPrecipitationIntensity	(	DtUniqueID	id,
		const float	intensity
	)

virtual

Set a weather area's precipitation intensity.

Parameters

id	The unique ID of the weather area.
intensity	The precipitation intensity.

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaPrecipitationType	(	DtUniqueID	id,
		const unsigned int	type
	)

virtual

Set a weather area's precipitation type.

Parameters

id	The unique ID of the weather area.
type	The precipitation type (see DtEnvironmentInterface::PrecipitationType).

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaGroundRainAccumulation	(	DtUniqueID	id,
		const float	depth
	)

virtual

Set a weather area's ground rain accumulation depth.

Parameters

id	The unique ID of the weather area.
depth	The ground rain accumulation depth.

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaFogColor	(	DtUniqueID	id,
		const DtVector &	color
	)

virtual

Set a weather area's fog color.

Parameters

id	The unique ID of the weather area.
color	The fog color (r,g,b) (0.0 - 1.0).

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaVisibilityDistance	(	DtUniqueID	id,
		const float	distance
	)

virtual

Set a weather area's visibility distance.

Parameters

id	The unique ID of the weather area.
distance	The visibility distance in meters.

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaOvercast	(	DtUniqueID	id,
		const float	overcast
	)

virtual

Set a weather area's overcast lighting value.

Parameters

id	The unique ID of the weather area.
overcast	The amount of overcast (0.0 [clear] - 1.0 [full overcast]).

virtual void makVrv::DtWeatherAreaObjectManager::setWeatherAreaLightningEnabled	(	DtUniqueID	id,
		const bool	enabled
	)

virtual

Set a weather area's lightning enabled value.

Parameters

id	The unique ID of the weather area.
enabled	Set to true if lightning is enabled.

Member Data Documentation

boost::signalslib::signal<void(DtUniqueID id, DtWeatherAreaObject* area)> makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectAdded

Signal raised when a weather area is added.

Parameters

id	The unique ID of the weather area.
area	The the weather area object.

boost::signalslib::signal<void(DtUniqueID id, DtWeatherAreaObject* area)> makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectToBeRemoved

Signal raised when a weather area is about to be removed.

Parameters

id	The unique ID of the weather area.
area	The the weather area object.

boost::signalslib::signal<void(DtUniqueID id, const DtVector& position, const float orientation) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectTransformChanged

Signal raised when a weather area transform changes.

Parameters

id	The unique ID of the weather area.
position	The position of the transform.
orientation	The orientation of the transform.

boost::signalslib::signal<void(DtUniqueID id, const DtVector& bounds, const float cornerRadius) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectBoundsChanged

Signal raised when a weather area bounds changes.

Parameters

id	The unique ID of the weather area.
bounds	The (width, length, height) of the bounding box.
cornerRadius	The corner radius of the bounding box (for a rounded rect).

boost::signalslib::signal<void(DtUniqueID id, const float intensity) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectPrecipitationIntensityChanged

Signal raised when a weather area precipitation intensity changes.

Parameters

id	The unique ID of the weather area.
intensity	The precipitation intensity.

boost::signalslib::signal<void(DtUniqueID id, const unsigned int type) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectPrecipitationTypeChanged

Signal raised when a weather area precipitation type changes.

Parameters

id	The unique ID of the weather area.
type	The precipitation type (see DtEnvironmentInterface::PrecipitationType).

boost::signalslib::signal<void(DtUniqueID id, const float depth) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectGroundRainAccumulationChanged

Signal raised when a weather area ground rain accumulation changes.

Parameters

id	The unique ID of the weather area.
depth	The ground rain accumulation depth.

boost::signalslib::signal<void(DtUniqueID id, const DtVector& color) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectFogColorChanged

Signal raised when a weather area fog color changes.

Parameters

id	The unique ID of the weather area.
color	The fog color (r,g,b) (0.0 - 1.0).

boost::signalslib::signal<void(DtUniqueID id, const float distance) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectVisibilityDistanceChanged

Signal raised when a weather area visibility distance changes.

Parameters

id	The unique ID of the weather area.
distance	The visibility distance in meters.

boost::signalslib::signal<void(DtUniqueID id, const float overcast) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectOvercastChanged

Signal raised when a weather area overcast changes.

Parameters

overcast The amount of overcast (0.0 [clear] - 1.0 [full overcast]).

boost::signalslib::signal<void(DtUniqueID id, const bool enabled) > makVrv::DtWeatherAreaObjectManager::signal_weatherAreaObjectLightningEnabledChanged

Signal raised when a weather area lightning enabled changes.

Parameters

enabled Set to true when lightning is enabled.

DtDe& makVrv::DtWeatherAreaObjectManager::myDe

protected

WeatherAreaMap makVrv::DtWeatherAreaObjectManager::myIDToWeatherAreaObjectAgent

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtWeatherAreaObjectManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation