Used by the weather system to define an environmental area. More...

Inheritance diagram for makVrv::DtWeatherAreaEnvironmental:

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

	DtWeatherAreaEnvironmental ()=delete
	Default Constructor not implemented. More...

	DtWeatherAreaEnvironmental (const DtWeatherAreaEnvironmental &other)=delete
	Copy Constructor not implemented - Copy not allowed. More...

DtWeatherAreaEnvironmental &	operator= (const DtWeatherAreaEnvironmental &other)=delete
	Assignment Operator not implemented - Assignment not allowed. More...

virtual void	setEnabled (bool enabled)
	Enables or disables the weather area. More...

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

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

virtual void	cullUpdate (const osg::Vec3d &camPos, const osg::Matrixd &viewMatrixI, const std::vector< osg::Vec4d > &cullingPlanes, DtJobSplitter *jobSplitter)
	Culls the area based on the current camera. More...

bool	usesWeatherLayerType (DtWeatherLayer::LayerType layerType) const
	Returns true if this area uses the give weather layer type. More...

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

virtual void	setPrecipitationType (const DtSkyObject::PrecipitationType type)
	Sets a precipitation type for the area. More...

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

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

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

virtual void	setWind (const float windDirectionRad, const float windSpeedMps)
	Sets the current wind. More...

virtual void	setLightningEnabled (const bool enabled)
	Enables or disables lightning. More...

Public Member Functions inherited from makVrv::DtWeatherArea
virtual	~DtWeatherArea ()
	DTOR. More...

	DtWeatherArea ()=delete
	Default Constructor not implemented. More...

	DtWeatherArea (const DtWeatherArea &other)=delete
	Copy Constructor not implemented - Copy not allowed. More...

DtWeatherArea &	operator= (const DtWeatherArea &other)=delete
	Assignment Operator not implemented - Assignment not allowed. More...

virtual bool	enabled () const
	Returns the enabled state. More...

virtual bool	culled () const
	Returns the culled state. More...

virtual const osg::Vec3d &	position () const
	Returns the area origin position in world space. More...

virtual const osg::Matrixd &	rotation () const
	Returns the area origin rotation in world space. More...

virtual float	boundsX () const
	Returns the bounds X size. More...

virtual float	boundsY () const
	Returns the bounds Y size. More...

virtual float	boundsZ () const
	Returns the bounds Z size. More...

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

virtual const unsigned int *	packedData (int &sizeX, int &sizeY) const
	Returns the grid heights/blend packedData array used for terrain clamping. More...

virtual float	computeBoundsDistance2D (const osg::Vec3d &position)
	Computes the xy distance from the given world position to the edge of the bounds. More...

virtual float	computeBoundsDistance3D (const osg::Vec3d &position)
	Computes the distance from the given world position to the edge of the bounds The bounds is a rounded rect. More...

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

virtual const DtSkyObject::PrecipitationType	precipitationType () const
	Returns the precipitation type for the area. 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 const DtVector &	fogColor () const
	Returns the fog color for the area. More...

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

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

virtual const bool	lightningEnabled () const
	Returns true if lightning is enabled for the area. More...

virtual bool	computeLocalPrecipitation (const osg::Vec3d &location, int &type, float &intensity)
	Computes the precipitation at the given location. More...

virtual bool	computeLocalGroundRainAccumulation (const osg::Vec3d &location, float &depth, float &blend)
	Computes the ground rain accumulation at the given location. More...

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

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

Protected Member Functions
	DtWeatherAreaEnvironmental (makVrv::DtDe &de)
	CTOR. More...

virtual void	computeRainShaftBounds (osg::Vec3d &position, DtVector &bounds, float &cornerRadius)
	Computes the bounds specifically for a rainshaft. More...

virtual void	onAreaChanged ()
	Called when the area bounds or transform has changed. More...

virtual float	computeFogDensity (const float precipitaionIintensity, const float distance) const
	Computes a fog density from the given precipitation intensity and visibility distance values. More...

virtual void	computeRainShaftBaseColor (DtVector &color)
	Computes a rain shaft base color based on current overcast value. More...

Protected Member Functions inherited from makVrv::DtWeatherArea
	DtWeatherArea (makVrv::DtDe &de)
	CTOR. More...

virtual void	updateTransform ()
	Updates the current transform based on current settings. More...

virtual void	computeBasis (const osg::Vec3d &inGeocentricPos, osg::Matrixd &rotOut) const
	Computes a basis rotation matrix for the given geocentric position. More...

virtual bool	clampPositionToTerrain (osg::Vec3d &position, float clampDistance) const
	Clamps the given position to the terrain surface. More...

virtual bool	isSphereVisible (const std::vector< osg::Vec4d > &planes, const osg::Vec3d &center, double radius) const
	Tests to see if a sphere is visible using the given frustum planes. More...

Protected Attributes
DtDe &	myDe

DtUniqueID	myRainShaftId

DtUniqueID	myHeightFogId

DtUniqueID	myLightningId

DtVector	myHeightFogColor

Protected Attributes inherited from makVrv::DtWeatherArea
DtDe &	myDe

bool	myEnabled

bool	myCulled

DtVector	mySetPosition

float	mySetOrientation

bool	mySetRelativeToCamera

osg::Vec3d	myPosition

osg::Matrixd	myRotation

float	myBoundsX

float	myBoundsY

float	myBoundsZ

float	myBoundsCornerRadius

float	myPrecipitationBoundsScale

float	myPrecipitationIntensity

DtSkyObject::PrecipitationType	myPrecipitationType

float	myGroundRainAccumulation

bool	myLightningEnabled

DtVector	myFogColor

float	myVisibilityDistance

float	myOvercast

float	myWindDirectionRad

float	myWindSpeedMps

Friends
class	DtWeatherAreaFactory

Additional Inherited Members
Static Public Member Functions inherited from makVrv::DtWeatherArea
static float	computeBoundsDistance2D (const osg::Vec3d &position, const osg::Vec4d &bounds, const osg::Vec3d &boundsPosition, const osg::Matrixd &boundsRotation)
	Computes the xy distance from the given world position to the edge of the bounds. More...

static float	computeBoundsDistance3D (const osg::Vec3d &position, const osg::Vec4d &bounds, const osg::Vec3d &boundsPosition, const osg::Matrixd &boundsRotation)
	Computes the distance from the given world position to the edge of the bounds The bounds is a rounded rect with transform at bottom. More...

Detailed Description

Used by the weather system to define an environmental area.

These areas can contain items such as precipitation and fog.

A environment weather area is created using the following: DtWeatherAreaFactory::instance(myDe).create(DtWeatherAreaFactory::AreaTypeEnvironmental)

Constructor & Destructor Documentation

virtual makVrv::DtWeatherAreaEnvironmental::~DtWeatherAreaEnvironmental ( )

virtual

DTOR.

makVrv::DtWeatherAreaEnvironmental::DtWeatherAreaEnvironmental ( )

delete

Default Constructor not implemented.

makVrv::DtWeatherAreaEnvironmental::DtWeatherAreaEnvironmental ( const DtWeatherAreaEnvironmental & other )

delete

Copy Constructor not implemented - Copy not allowed.

makVrv::DtWeatherAreaEnvironmental::DtWeatherAreaEnvironmental ( makVrv::DtDe & de )

protected

CTOR.

Member Function Documentation

DtWeatherAreaEnvironmental& makVrv::DtWeatherAreaEnvironmental::operator= ( const DtWeatherAreaEnvironmental & other )

delete

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtWeatherAreaEnvironmental::setEnabled ( bool enabled )

virtual

Enables or disables the weather area.

Parameters

enabled Set to true to enable the area.

Reimplemented from makVrv::DtWeatherArea.

virtual void makVrv::DtWeatherAreaEnvironmental::setBounds	(	const DtVector &	bounds,
		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.

Reimplemented from makVrv::DtWeatherArea.

virtual void makVrv::DtWeatherAreaEnvironmental::setTransform	(	const DtVector &	position,
		float	orientation,
		bool	relativeToCamera = `false`
	)

virtual

Sets the area transform.

Parameters

position	The transform position in world space.
oritantation	The yaw orientation in degrees (0 = north).
relativeToCamera	Set to true if the position is relative to the current camera.

Reimplemented from makVrv::DtWeatherArea.

virtual void makVrv::DtWeatherAreaEnvironmental::cullUpdate	(	const osg::Vec3d &	camPos,
		const osg::Matrixd &	viewMatrixI,
		const std::vector< osg::Vec4d > &	cullingPlanes,
		DtJobSplitter *	jobSplitter
	)

virtual

Culls the area based on the current camera.

Parameters

cam	The current camera being drawn.
jobSplitter	A job splitter to add predraw jobs to.

Reimplemented from makVrv::DtWeatherArea.

bool makVrv::DtWeatherAreaEnvironmental::usesWeatherLayerType ( DtWeatherLayer::LayerType layerType ) const

virtual

Returns true if this area uses the give weather layer type.

Parameters

layerType The layer type to check.

Reimplemented from makVrv::DtWeatherArea.

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

virtual

Sets a precipitation intensity for the area.

Parameters

intensity The precipitation intensity.

Reimplemented from makVrv::DtWeatherArea.

virtual void makVrv::DtWeatherAreaEnvironmental::setPrecipitationType ( const DtSkyObject::PrecipitationType type )

virtual

Sets a precipitation type for the area.

Parameters

type	The precipitation type.

Reimplemented from makVrv::DtWeatherArea.

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

virtual

Sets a fog color for the area.

Parameters

color The fog color.

Reimplemented from makVrv::DtWeatherArea.

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

virtual

Sets a visibility distance for the area.

Parameters

distance The distance.

Reimplemented from makVrv::DtWeatherArea.

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

virtual

Sets a overcast (lighting) for the area.

Parameters

overcast The overcast value.

Reimplemented from makVrv::DtWeatherArea.

virtual void makVrv::DtWeatherAreaEnvironmental::setWind	(	const float	windDirectionRad,
		const float	windSpeedMps
	)

virtual

Sets the current wind.

Parameters

windDirectionRad	The wind direction in radians.
windSpeedMps	The wind speed in meters per second.

Reimplemented from makVrv::DtWeatherArea.

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

virtual

Enables or disables lightning.

Parameters

enabled Set to true to enable lightning.

Reimplemented from makVrv::DtWeatherArea.

virtual void makVrv::DtWeatherAreaEnvironmental::computeRainShaftBounds	(	osg::Vec3d &	position,
		DtVector &	bounds,
		float &	cornerRadius
	)

protectedvirtual

Computes the bounds specifically for a rainshaft.

Parameters

position	The computed output bounds origin.
bounds	The computed output (width, length, height) bounds.
cornerRadius	The computed output bounds corner radius.

virtual void makVrv::DtWeatherAreaEnvironmental::onAreaChanged ( )

protectedvirtual

Called when the area bounds or transform has changed.

virtual float makVrv::DtWeatherAreaEnvironmental::computeFogDensity	(	const float	precipitaionIintensity,
		const float	distance
	)		const

protectedvirtual

Computes a fog density from the given precipitation intensity and visibility distance values.

Parameters

intensity	The precipitation intensity.
distance	The visibility distance.

virtual void makVrv::DtWeatherAreaEnvironmental::computeRainShaftBaseColor ( DtVector & color )

protectedvirtual

Computes a rain shaft base color based on current overcast value.

Parameters

color The computed output rgb (0.0 - 1.0 scale).

Friends And Related Function Documentation

friend class DtWeatherAreaFactory

friend

Member Data Documentation

DtDe& makVrv::DtWeatherAreaEnvironmental::myDe

protected

DtUniqueID makVrv::DtWeatherAreaEnvironmental::myRainShaftId

protected

DtUniqueID makVrv::DtWeatherAreaEnvironmental::myHeightFogId

protected

DtUniqueID makVrv::DtWeatherAreaEnvironmental::myLightningId

protected

DtVector makVrv::DtWeatherAreaEnvironmental::myHeightFogColor

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvOsg/DtWeatherAreaEnvironmental.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation