The weather area object represents a set localized environmental conditions such as local rain and fog. More...

Public Member Functions
	DtWeatherAreaObject (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtWeatherAreaObject ()
	DTOR. More...

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

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

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

virtual void	setBounds (const DtVector &bounds, const float cornerRadius)
	Sets the bounds of the area. More...

virtual void	setTransform (const DtVector &position, const float orientation)
	Sets the area transform. More...

virtual const DtVector &	position () const
	Returns the area origin position in world space. More...

virtual const float	orientation () const
	Returns yaw orientation in degrees (0 = north). More...

virtual const DtVector &	bounds () const
	Returns the bounds (x,y,z) of the area. More...

virtual const float	boundsCornerRadius () const
	Returns the bounds corner radius. More...

virtual void	setPrecipitationIntensity (const float intensity)
	Sets the precipitation intensity. More...

virtual const float	precipitationIntensity () const
	Returns the precipitation intensity. More...

virtual void	setPrecipitationType (const unsigned int type)
	Sets the precipitation type. More...

virtual const unsigned int	precipitationType () const
	Returns the precipitation type. More...

virtual void	setGroundRainAccumulation (const float depth)
	Set the ground rain accumulation depth. More...

virtual const float	groundRainAccumulation () const
	Returns the ground rain accumulation depth. More...

virtual void	setFogColor (const DtVector &color)
	Sets a fog color for the area. More...

virtual const DtVector &	fogColor () const
	Returns the fog color for the area. More...

virtual void	setVisibilityDistance (const float distance)
	Sets a visibility distance for the area. More...

virtual const float	visibilityDistance () const
	Returns the visibility distance for the area. More...

virtual void	setOvercast (const float overcast)
	Sets an overcast lighting value for the area. More...

virtual const float	overcast () const
	Returns the overcast for the area. More...

virtual void	setLightningEnabled (const bool enabled)
	Sets the lightning enabled flag for the area. More...

virtual const bool	lightningEnabled () const
	Returns the lightning enabled flag for the area. More...

Protected Attributes
DtDe &	myDe

DtUniqueID	myUniqueId

DtVector	myPosition

float	myOrientation

DtVector	myBounds

float	myBoundsCornerRadius

float	myPrecipitationIntensity

unsigned int	myPrecipitationType

float	myGroundRainAccumulation

DtVector	myFogColor

float	myVisibilityDistance

float	myOvercast

bool	myLightningEnabled

Detailed Description

The weather area object represents a set localized environmental conditions such as local rain and fog.

The area is defined by a transformed bounds.

It is a distributed object.

These objects are created by using DtWeatherAreaObjectManager::addWeatherArea().

Changes to this object will produce signals in the DtWeatherAreaObjectManager.

Constructor & Destructor Documentation

makVrv::DtWeatherAreaObject::DtWeatherAreaObject	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtWeatherAreaObject::~DtWeatherAreaObject ( )

virtual

DTOR.

makVrv::DtWeatherAreaObject::DtWeatherAreaObject ( )

delete

Default Constructor not implemented � default constructor not allowed.

makVrv::DtWeatherAreaObject::DtWeatherAreaObject ( const DtWeatherAreaObject & )

delete

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

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

delete

Assignment Operator not implemented � Copy not allowed.

virtual void makVrv::DtWeatherAreaObject::setBounds	(	const DtVector &	bounds,
		const float	cornerRadius
	)

virtual

Sets the bounds of the area.

Parameters

bounds	The (x,y,z) of the bounds.
cornerRadius	The radius at each corner of the bounds.

virtual void makVrv::DtWeatherAreaObject::setTransform	(	const DtVector &	position,
		const float	orientation
	)

virtual

Sets the area transform.

Parameters

position	The transform position in world space.
orientation	The yaw orientation in degrees (0 = north).

virtual const DtVector& makVrv::DtWeatherAreaObject::position ( ) const

virtual

Returns the area origin position in world space.

virtual const float makVrv::DtWeatherAreaObject::orientation ( ) const

virtual

Returns yaw orientation in degrees (0 = north).

virtual const DtVector& makVrv::DtWeatherAreaObject::bounds ( ) const

virtual

Returns the bounds (x,y,z) of the area.

virtual const float makVrv::DtWeatherAreaObject::boundsCornerRadius ( ) const

virtual

Returns the bounds corner radius.

virtual void makVrv::DtWeatherAreaObject::setPrecipitationIntensity ( const float intensity )

virtual

Sets the precipitation intensity.

Parameters

intensity The precipitation intensity.

virtual const float makVrv::DtWeatherAreaObject::precipitationIntensity ( ) const

virtual

Returns the precipitation intensity.

virtual void makVrv::DtWeatherAreaObject::setPrecipitationType ( const unsigned int type )

virtual

Sets the precipitation type.

Parameters

type	The precipitation type.

virtual const unsigned int makVrv::DtWeatherAreaObject::precipitationType ( ) const

virtual

Returns the precipitation type.

virtual void makVrv::DtWeatherAreaObject::setGroundRainAccumulation ( const float depth )

virtual

Set the ground rain accumulation depth.

Parameters

depth The ground rain accumulation depth.

virtual const float makVrv::DtWeatherAreaObject::groundRainAccumulation ( ) const

virtual

Returns the ground rain accumulation depth.

virtual void makVrv::DtWeatherAreaObject::setFogColor ( const DtVector & color )

virtual

Sets a fog color for the area.

Parameters

color The fog color.

virtual const DtVector& makVrv::DtWeatherAreaObject::fogColor ( ) const

virtual

Returns the fog color for the area.

virtual void makVrv::DtWeatherAreaObject::setVisibilityDistance ( const float distance )

virtual

Sets a visibility distance for the area.

Parameters

distance The distance.

virtual const float makVrv::DtWeatherAreaObject::visibilityDistance ( ) const

virtual

Returns the visibility distance for the area.

virtual void makVrv::DtWeatherAreaObject::setOvercast ( const float overcast )

virtual

Sets an overcast lighting value for the area.

Parameters

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

virtual const float makVrv::DtWeatherAreaObject::overcast ( ) const

virtual

Returns the overcast for the area.

virtual void makVrv::DtWeatherAreaObject::setLightningEnabled ( const bool enabled )

virtual

Sets the lightning enabled flag for the area.

Parameters

enabled Set to true to enable lightning for the area.

virtual const bool makVrv::DtWeatherAreaObject::lightningEnabled ( ) const

virtual

Returns the lightning enabled flag for the area.

Member Data Documentation

DtDe& makVrv::DtWeatherAreaObject::myDe

protected

DtUniqueID makVrv::DtWeatherAreaObject::myUniqueId

protected

DtVector makVrv::DtWeatherAreaObject::myPosition

protected

float makVrv::DtWeatherAreaObject::myOrientation

protected

DtVector makVrv::DtWeatherAreaObject::myBounds

protected

float makVrv::DtWeatherAreaObject::myBoundsCornerRadius

protected

float makVrv::DtWeatherAreaObject::myPrecipitationIntensity

protected

unsigned int makVrv::DtWeatherAreaObject::myPrecipitationType

protected

float makVrv::DtWeatherAreaObject::myGroundRainAccumulation

protected

DtVector makVrv::DtWeatherAreaObject::myFogColor

protected

float makVrv::DtWeatherAreaObject::myVisibilityDistance

protected

float makVrv::DtWeatherAreaObject::myOvercast

protected

bool makVrv::DtWeatherAreaObject::myLightningEnabled

protected

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation