This class simulates and renders a rain shaft area. More...

Inheritance diagram for makVrv::DtWeatherRainShaft:

Classes
struct	DrawData
	A structure used to hold data for drawing. More...

struct	MeshGroup
	A structure used to define a mesh group (voa, positions, coords). More...

struct	Particle
	A structure used to define a particle. More...

struct	SortJobData
	A structure to hold data for a sorting job. More...

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

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

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

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

virtual void	init ()
	Called after creation to initialize effects. More...

virtual void	releaseGLObjects (osg::State *state) const
	Release all gl objects used by items in this layer. More...

virtual bool	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...

virtual bool	isPositionAboveArea (const osg::Vec3d &position)
	Returns true if the given position is above the rain shaft. More...

virtual void	draw (DtWeatherRainShaft::DrawData &drawData)
	Draw rain shafts. More...

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

virtual void	setTransform (const osg::Vec3d &position, const osg::Matrixd &rotation)
	Sets the object transform. More...

virtual void	setIntensity (const float intensity)
	Sets the intensity. More...

virtual void	setBaseColor (const DtVector &color)
	Sets a base color for the rain shaft lighting. More...

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

virtual void	runSort (const osg::Vec3 &localCamPos)
	Sorts particles for the current view. More...

virtual void	setEnabled (bool enabled)
	Enables or disables the rain shaft. More...

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

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

virtual void	computeBounds (osg::Vec4 &bounds, osg::Vec3d &position, osg::Matrixd &rotation) const
	Computes the bounds of the area. More...

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

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

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

virtual bool	positionInBounds2D (const float x, const float y, const osg::Vec3 &bounds)
	Checks to see if the local 2D position is within the bounds. More...

virtual float	computeRandomMinMax (float fMin, float fMax)
	Computes a random floating point value in the min max range. More...

virtual void	computeSortDepth (const osg::Vec3 &reference)
	Computes the sort depth for all cells. More...

virtual void	fillSortedParticles ()
	Fills the gpu buffer with sorted particle data. More...

virtual bool	bindMeshGroupData (MeshGroup *meshGroup, osg::RenderInfo &renderInfo) const
	Binds the mesh group data to the vbo's. More...

virtual bool	bindDynamicMeshGroupData (MeshGroup *meshGroup, osg::RenderInfo &renderInfo) const
	Binds the dynamic mesh group data to the vbo's. More...

virtual bool	bindVaoToMeshGroup (GLuint vao, MeshGroup *meshGroup, osg::RenderInfo &renderInfo) const
	Binds the given voa to vbo's for a mesh group. 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...

Static Protected Member Functions
static int	theSortBackToFront (const void arg0, const void arg1)
	sort function used for qsorting particles More...

static void	theSortJob (void *data)
	sort job function used as a callback for job splitting More...

Protected Attributes
DtDe &	myDe

bool	myEnabled

bool	myCulled

MeshGroup *	myMeshGroup

DtGlVaoManager *	myVaoManager

osg::Vec3d	myPosition

osg::Matrixd	myRotation

float	myBoundsX

float	myBoundsY

float	myBoundsZ

float	myBoundsCornerRadius

float	myParticleWidth

float	myIntensity

osg::Vec3	myBaseColor

Particle *	myParticles

int	myParticlePoolCount

int	myParticleActiveCount

SortJobData	mySortJobData

DtJobSplitterJob	mySortJob

DtRandomNumberGenerator	myRandomNumberGen

unsigned int	myRandomSeed

float	myWindDirectionRad

float	myWindSpeedMps

Friends
class	DtWeatherRainShaftFactory

Detailed Description

This class simulates and renders a rain shaft area.

The area volume is filled with a density of particles that are as tall as the bounds. The particles use a shader to give the illusion of falling rain. The particles bend in the wind direction depending on wind strength. An intensity value can be set to increase or decrease the visibility of the effect.

Constructor & Destructor Documentation

virtual makVrv::DtWeatherRainShaft::~DtWeatherRainShaft ( )

virtual

DTOR.

makVrv::DtWeatherRainShaft::DtWeatherRainShaft ( )

delete

Default Constructor not implemented.

makVrv::DtWeatherRainShaft::DtWeatherRainShaft ( const DtWeatherRainShaft & other )

delete

Copy Constructor not implemented - Copy not allowed.

makVrv::DtWeatherRainShaft::DtWeatherRainShaft ( makVrv::DtDe & de )

protected

CTOR.

Member Function Documentation

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

delete

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtWeatherRainShaft::init ( )

virtual

Called after creation to initialize effects.

virtual void makVrv::DtWeatherRainShaft::releaseGLObjects ( osg::State * state ) const

virtual

Release all gl objects used by items in this layer.

virtual bool makVrv::DtWeatherRainShaft::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. Returns true if visible.

virtual bool makVrv::DtWeatherRainShaft::isPositionAboveArea ( const osg::Vec3d & position )

virtual

Returns true if the given position is above the rain shaft.

Parameters

position The position to test.

virtual void makVrv::DtWeatherRainShaft::draw ( DtWeatherRainShaft::DrawData & drawData )

virtual

Draw rain shafts.

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

virtual

Sets the bounds of the object.

Parameters

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

virtual void makVrv::DtWeatherRainShaft::setTransform	(	const osg::Vec3d &	position,
		const osg::Matrixd &	rotation
	)

virtual

Sets the object transform.

Parameters

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

virtual void makVrv::DtWeatherRainShaft::setIntensity ( const float intensity )

virtual

Sets the intensity.

Parameters

intensity The intensity (affects visibility).

virtual void makVrv::DtWeatherRainShaft::setBaseColor ( const DtVector & color )

virtual

Sets a base color for the rain shaft lighting.

Parameters

color The rgb color values (0.0 - 1.0 scale).

virtual void makVrv::DtWeatherRainShaft::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.

virtual void makVrv::DtWeatherRainShaft::runSort ( const osg::Vec3 & localCamPos )

virtual

Sorts particles for the current view.

Fills indice buffer.

Parameters

localCamPos The local camera position.

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

virtual

Enables or disables the rain shaft.

Parameters

enabled Set to true to enable the rain shaft.

virtual bool makVrv::DtWeatherRainShaft::enabled ( ) const

virtual

Returns the enabled state.

virtual bool makVrv::DtWeatherRainShaft::culled ( ) const

virtual

Returns the culled state.

This will indicate if the rain shaft was culled during the last scenegraph culling pass.

virtual void makVrv::DtWeatherRainShaft::computeBounds	(	osg::Vec4 &	bounds,
		osg::Vec3d &	position,
		osg::Matrixd &	rotation
	)		const

virtual

Computes the bounds of the area.

Parameters

bounds	The output (width, length, height, corner radius).
position	The output world postition.
rotation	The output world rotation.

virtual bool makVrv::DtWeatherRainShaft::positionInBounds2D	(	const float	x,
		const float	y,
		const osg::Vec3 &	bounds
	)

protectedvirtual

Checks to see if the local 2D position is within the bounds.

Uses the current bound corner radius.

Parameters

x	The local x position
y	The local y position.
bounds	The (x, y, corner radius) bounds.

virtual float makVrv::DtWeatherRainShaft::computeRandomMinMax	(	float	fMin,
		float	fMax
	)

protectedvirtual

Computes a random floating point value in the min max range.

Parameters

min	The minimum value.
max	The maximum value.

virtual void makVrv::DtWeatherRainShaft::computeSortDepth ( const osg::Vec3 & reference )

protectedvirtual

Computes the sort depth for all cells.

Parameters

reference The reference position to compute sort depth from.

virtual void makVrv::DtWeatherRainShaft::fillSortedParticles ( )

protectedvirtual

Fills the gpu buffer with sorted particle data.

virtual bool makVrv::DtWeatherRainShaft::bindMeshGroupData	(	MeshGroup *	meshGroup,
		osg::RenderInfo &	renderInfo
	)		const

protectedvirtual

Binds the mesh group data to the vbo's.

Parameters

meshGroup	The mesh group object to bind.
renderInfo	The current rendering info.

virtual bool makVrv::DtWeatherRainShaft::bindDynamicMeshGroupData	(	MeshGroup *	meshGroup,
		osg::RenderInfo &	renderInfo
	)		const

protectedvirtual

Binds the dynamic mesh group data to the vbo's.

Parameters

meshGroup	The mesh group object to bind.
renderInfo	The current rendering info.

virtual bool makVrv::DtWeatherRainShaft::bindVaoToMeshGroup	(	GLuint	vao,
		MeshGroup *	meshGroup,
		osg::RenderInfo &	renderInfo
	)		const

protectedvirtual

Binds the given voa to vbo's for a mesh group.

Parameters

vao	The GL VAO handle.
meshGroup	The mesh group to bind.
renderInfo	The current rendering info.

virtual bool makVrv::DtWeatherRainShaft::isSphereVisible	(	const std::vector< osg::Vec4d > &	planes,
		const osg::Vec3d &	center,
		double	radius
	)		const

protectedvirtual

Tests to see if a sphere is visible using the given frustum planes.

Parameters

planes	The frustum planes to test the sphere against.
center	The sphere center position.
radius	the sphere radius.

static int makVrv::DtWeatherRainShaft::theSortBackToFront	(	const void *	arg0,
		const void *	arg1
	)

staticprotected

sort function used for qsorting particles

static void makVrv::DtWeatherRainShaft::theSortJob ( void * data )

staticprotected

sort job function used as a callback for job splitting

Friends And Related Function Documentation

friend class DtWeatherRainShaftFactory

friend

Member Data Documentation

DtDe& makVrv::DtWeatherRainShaft::myDe

protected

bool makVrv::DtWeatherRainShaft::myEnabled

protected

bool makVrv::DtWeatherRainShaft::myCulled

protected

MeshGroup* makVrv::DtWeatherRainShaft::myMeshGroup

protected

DtGlVaoManager* makVrv::DtWeatherRainShaft::myVaoManager

protected

osg::Vec3d makVrv::DtWeatherRainShaft::myPosition

protected

osg::Matrixd makVrv::DtWeatherRainShaft::myRotation

protected

float makVrv::DtWeatherRainShaft::myBoundsX

protected

float makVrv::DtWeatherRainShaft::myBoundsY

protected

float makVrv::DtWeatherRainShaft::myBoundsZ

protected

float makVrv::DtWeatherRainShaft::myBoundsCornerRadius

protected

float makVrv::DtWeatherRainShaft::myParticleWidth

protected

float makVrv::DtWeatherRainShaft::myIntensity

protected

osg::Vec3 makVrv::DtWeatherRainShaft::myBaseColor

protected

Particle* makVrv::DtWeatherRainShaft::myParticles

protected

int makVrv::DtWeatherRainShaft::myParticlePoolCount

protected

int makVrv::DtWeatherRainShaft::myParticleActiveCount

protected

SortJobData makVrv::DtWeatherRainShaft::mySortJobData

protected

DtJobSplitterJob makVrv::DtWeatherRainShaft::mySortJob

protected

DtRandomNumberGenerator makVrv::DtWeatherRainShaft::myRandomNumberGen

protected

unsigned int makVrv::DtWeatherRainShaft::myRandomSeed

protected

float makVrv::DtWeatherRainShaft::myWindDirectionRad

protected

float makVrv::DtWeatherRainShaft::myWindSpeedMps

protected

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

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

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation