this class is used to create weather effects around the eye to represent effects such as mist, rain and hail. More...

Classes
struct	BlendData
	A structure to hold blending control data for things like particle amount per intensity. More...

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

struct	SimulationUpdateJobData
	A structure to hold data for a simluation update job. More...

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

Public Types
enum	EffectType { EffectTypePrecipitation = 0, EffectTypeParticle }
	An enumeration to define the effect type. More...

enum	SurfaceHitType { SurfaceHitTypeNone = 0, SurfaceHitTypeHail, SurfaceHitTypeWindBlown }
	An enumeration to define a surface hit effect. More...

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

virtual	~DtWeatherEffect ()
	DTOR. More...

virtual void	init (int particleCount, float particleSize, float radius, EffectType type, unsigned int randomSeed)
	Initialize the effect. More...

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

virtual void	simulationUpdate (float timeStep, double currentTime, DtJobSplitter *jobSplitter)
	Run a simulation update to simulate particle movement. More...

virtual void	postSimulationUpdate (float timeStep, double currentTime)
	Run a post simulation update. More...

virtual void	draw (DtWeatherEffect::DrawData &drawData, float cullFade=1.0f) const
	Issues the drawing command for the effect. More...

virtual void	cullUpdate (const osg::Vec3d &camPos, const osg::Matrixd &basis, DtJobSplitter *jobSplitter)
	Prepares the effect for drawing based on the camera position. More...

virtual void	setSurfaceHitType (SurfaceHitType type)
	Sets a type used to generate hit particles on the ground surface. More...

virtual void	setSurfaceHitOffset (float offset)
	Sets a position offset used for particles that hit a surface. More...

virtual void	setSurfaceHitMaxSlope (float degrees)
	Sets the max surface slope angle allowed for a particle to spawn for a surface hit. More...

virtual void	setWindBlownParameters (int spawnCount, float minSpeed, float maxSpeed, float minTime, float maxTime)
	Sets the parameters used for the SurfaceHitTypeWindBlown surface hit type. More...

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

virtual void	setWindSpeedMultiplier (float multiplier)
	Sets a wind speed multiplier used for particle physics. More...

virtual void	setWindLiftMultiplier (float multiplier)
	Sets a wind lift multiplier used for particle physics. More...

virtual void	setWindTurbulence (float multiplier)
	Sets a wind turbulence multiplier for particle physics. More...

virtual void	setWindVariation (float minWind, float maxWind)
	Sets the particle wind response variation when physics are enabled. More...

virtual void	setScaleAnimation (float minX, float maxX, float minY, float maxY, float time)
	Sets parameters for animated shrink/grow on the particle axis. More...

virtual void	setStreak (float multiplier)
	Sets a streak value to control particle streaking based on movement. More...

virtual void	setCameraStreakEnable (bool enable)
	Sets the flag to enable particle camera movement streak effect. More...

virtual void	setStreakAdjustmentEnable (bool enable)
	Sets the flag to enable streak effect framerate adjustment. More...

virtual void	setOrientFlat (bool enable)
	Sets the particles to be rendered in a flat orientation. More...

virtual void	setIntensity (float intensity)
	Sets a (0.0 - 1.0) value to control the effect intensity. More...

virtual void	setFadePerIntensity (float fadeMin, float fadeMax, float intensityMin, float intensityMax)
	Sets an effect fade ramp based on the current intensity. More...

virtual void	setFadePerWind (float fadeMin, float fadeMax, float windMin, float windMax)
	Sets an effect fade ramp based on the current wind in mps. More...

virtual void	setTextureCoordAnimationPerWind (float multMin, float multMax, float windMin, float windMax)
	Sets an effect texture coordinate animation speed ramp based on the current wind in mps. More...

virtual void	setParticlesPerIntensity (float percentMin, float percentMax, float intensityMin, float intensityMax)
	Sets a particles percentage ramp based on the current intensity. More...

virtual void	setBaseColor (const osg::Vec3 &color)
	Sets a base color for the effect. More...

virtual void	setAdditiveBlend (bool enable)
	Enables additive blending mode for rendering. More...

virtual bool	additiveBlend () const
	Returns the additive blend mode flag. More...

virtual void	setVelocity (float x, float y, float z)
	Sets a velocity for all effect particles. More...

virtual void	setInitRotationVariation (float rotationDeg)
	Sets particle +- initial random rotation. More...

virtual void	setRotationVelocity (float velDeg)
	Sets particle maximum rotation velocity. More...

virtual float	radius () const
	Returns the radius of the effect. More...

virtual void	setTextureAtlasCell (unsigned char numColumns, unsigned char numRows, unsigned char col, unsigned char row)
	Sets the texture cell to use for a texture atlas transparency mask channel. More...

virtual void	setTextureCoordinateAnimation (float dirSpeedU, float dirSpeedV, float scale0, float scale1)
	Sets texture uv coordinate animation settings applied to the transpancey pattern channels. More...

virtual void	setTexturePatternChannelMix (float mix0, float mix1)
	Sets the texture channel mix values for the transparancy patterns. More...

virtual void	setDepthSoftness (float softness)
	Sets the softness for transparency fade when close to a surface. More...

virtual float	depthSoftness () const
	Returns the softness for transparency fade when close to a surface. More...

virtual void	setDepthProximity (float startFade, float fadeEnd, float mix)
	Sets depth proximity values, to fade particle at it moves away from a surface. More...

virtual void	setDragCoefficient (float coefficient)
	Sets the drag coefficient for particles. More...

virtual float	dragCoefficient () const
	Returns the drag coefficient for particles. More...

virtual void	setSortEnable (bool enable)
	Sets the flag to enable sorting particles within the effect. More...

virtual bool	sortEnable () const
	Returns the flag to enable sorting particles within the effect. More...

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

virtual void	setClampToSurface (bool enable)
	Sets the flag to enable particles to clamp to a surface in the shader. More...

virtual bool	clampToSurface () const
	Returns the flag to enable particles to clamp to a surface in the shader. More...

virtual void	setGravity (const osg::Vec3 &gravity)
	Sets the gravity (mps^2) used when particle physics are enabled. More...

virtual void	setRadiusFading (float fadeInStart, float fadeInEnd, float fadeOutStart, float fadeOutEnd)
	Sets radius linear fading values for fading in/out particles based on distance. More...

Protected Member Functions
virtual void	runSimulationUpdateJob (float timeStep, double currentTime)
	Called during a muti-thread update job to run a simulation update. More...

virtual void	updateHailSurfaceHit (float timeStep)
	Does an update for the Hail surface hit type. More...

virtual void	updateWindBlownSurfaceHit (float timeStep)
	Does an update for the WindBlown surface hit type. 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 void	simulatePrecipitationParticles (float timeStep, double currentTime)
	Simulates particles (movements, etc...) for precipitation. More...

virtual void	simulateParticles (float timeStep, double currentTime, osg::Vec3d &basisPosChange)
	Simulates particles (life, movements, etc...). More...

void	wrapPosition (float &posX, float &posY, float &posZ)
	Keeps the given position in the effect radius. More...

Particle *	getFreeParticle (void)
	Returns a particle from the free list. More...

void	freeParticle (Particle *particle)
	Adds the given particle to the free list. More...

void	spawnHailParticle (const osg::Vec3d &position, const osg::Vec3 &normal, const unsigned char usePhysics)
	Spawns a hail particle at the given location. More...

void	spawnWindBlownParticle (const osg::Vec3d &position, const osg::Vec3 &normal, float windRandom, float cosAng)
	Spawns a wind blown particle at the given location. More...

const osg::Vec3	crossProduct (const osg::Vec3 &v0, const osg::Vec3 &v1)
	Returns the cross product of the given 2 vectors. More...

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

void	computeRandomPointInRadius (osg::Vec2 &point, float radius)
	Computes a random point in a radius with even distribution. More...

bool	clampPosition (osg::Vec3d &position, osg::Vec3 &normal, const osg::Vec3 &up)
	Clamps the given position to a ground surface. More...

virtual float	computeBlendControl (const BlendData &data, float blendPos) const
	Computes an ouput value based on the given blending data and blend position. More...

Static Protected Member Functions
static void	theSimulationUpdateJob (void *data)
	simulation update job function used as a callback for job splitting More...

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

osg::Matrixd	myBasisRot

osg::Vec3d	myBasisPos

osg::Vec3d	myLastBasisPos

bool	myBasisDirty

EffectType	myEffectType

SurfaceHitType	mySurfaceHitType

float	mySurfaceHitOffset

float	mySurfaceHitMaxSlope

float	mySurfaceHitTimer

unsigned int	myRandomSeed

osg::Vec3	myScroll

float	myRadius

float	myWindDirectionRad

float	myWindSpeedMps

float	myWindSpeedMultiplier

float	myWindLiftMultiplier

float	myWindTurbulence

float	myWindMin

float	myWindMax

float	myDragCoefficient

osg::Vec3	myVelocity

float	myInitRotationRad

float	myRotationVelocity

float	myEffectFade

float	myIntensity

BlendData	myFadeByIntensity

BlendData	myFadeByWind

BlendData	myTexCoordAnimSpeedByWind

BlendData	myParticlesByIntensity

float	myParticleSize

osg::Vec3	myBaseColor

bool	myAdditiveBlend

osg::ref_ptr< osg::BlendFunc >	myBlendFunc

float	myStreak

float	myStreakAdjustment

bool	myStreakAdjustmentEnable

bool	myCameraStreak

float	myScaleAnimMinX

float	myScaleAnimMaxX

float	myScaleAnimMinY

float	myScaleAnimMaxY

float	myScaleSpeed

float	myTextureAtlasCols

float	myTextureAtlasRows

float	myTextureAtlasCol

float	myTextureAtlasRow

float	myTexCoordAnimDirSpeedU

float	myTexCoordAnimDirSpeedV

float	myTexCoordAnimScale0

float	myTexCoordAnimScale1

float	myTexCoordAnimDirOffsetU

float	myTexCoordAnimDirOffsetV

float	myTexturePatternMix0

float	myTexturePatternMix1

float	myDepthSoftness

float	myDepthProximityMix

float	myDepthProximityStart

float	myDepthProximityRange

float	myDepthProximityInvRange

bool	mySortEnable

bool	myClampToSurface

bool	myOrientFlat

osg::Vec3	myGravity

float	myRadiusFadeInStart

float	myRadiusFadeInFalloff

float	myRadiusFadeOutStart

float	myRadiusFadeOutFalloff

int	myWindBlownSpawnCount

float	myWindBlownMinSpeed

float	myWindBlownMaxSpeed

float	myWindBlownMinTime

float	myWindBlownMaxTime

MeshGroup *	myMeshGroup

DtGlVaoManager *	myVaoManager

Particle *	myParticlesMemoryPool

int	myParticleMemoryPoolCount

Particle *	myParticlesFree

Particle *	myParticlesActive

int	myParticleActiveCount

Particle **	myRenderList

int	myRenderParticleCount

SimulationUpdateJobData	mySimulationUpdateJobData

DtJobSplitterJob	mySimulationUpdateJob

SortJobData	mySortJobData

DtJobSplitterJob	mySortJob

DtRandomNumberGenerator	myRandomNumberGen

Private Member Functions
	DtWeatherEffect ()=delete
	Default Constructor not implemented. More...

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

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

Detailed Description

this class is used to create weather effects around the eye to represent effects such as mist, rain and hail.

The effect is made from a particle system with simple physics applied. There are 2 initialiation types for this class: precipitation and particles. The precipitation type is an infinite scolling box of particles around the eye used for items such as mist or falling rain. The particle type is for dynamic particles such as surface hits. This class is not a stand-alone class as it relies on a larger system to initiate drawing and update methods (see DtWeatherLayerGroup and DtWeatherEffectDrawable).

Member Enumeration Documentation

enum makVrv::DtWeatherEffect::EffectType

An enumeration to define the effect type.

Precipitation is an ageless effect that's infinite in a scrolling box. Precipitation would be used for something like falling rain. Particle is a particle simulation that has a life span. Particle would be used for something like splashes at a specific location.

Enumerator
EffectTypePrecipitation
EffectTypeParticle

enum makVrv::DtWeatherEffect::SurfaceHitType

An enumeration to define a surface hit effect.

A surface hit effect creates particles based on surface heights around the weather effect's current location. Note that the weather effect must be of type EffectTypeParticle to use surface hits. The Hail type spawns a few hail particles at a surface location. The WindBlown type spawns wind blown particles at a surface location.

Enumerator
SurfaceHitTypeNone
SurfaceHitTypeHail
SurfaceHitTypeWindBlown

Constructor & Destructor Documentation

makVrv::DtWeatherEffect::DtWeatherEffect ( makVrv::DtDe & de )

CTOR.

virtual makVrv::DtWeatherEffect::~DtWeatherEffect ( )

virtual

DTOR.

makVrv::DtWeatherEffect::DtWeatherEffect ( )

privatedelete

Default Constructor not implemented.

makVrv::DtWeatherEffect::DtWeatherEffect ( const DtWeatherEffect & other )

privatedelete

Copy Constructor not implemented - Copy not allowed.

Member Function Documentation

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

privatedelete

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtWeatherEffect::init	(	int	particleCount,
		float	particleSize,
		float	radius,
		EffectType	type,
		unsigned int	randomSeed
	)

virtual

Initialize the effect.

Parameters

particleCount	The maximum number of particles to simulate.
particleSize	The base particle size.
radius	The effect radius.
type	the type of effect.
randomSeed	Sets a random seed used during initialization. The random seed value is set by the current time, but this seed is an offset that is added to that to allow multiple effects created at the same time, to look different.

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

virtual

Release all gl objects used by this object.

virtual void makVrv::DtWeatherEffect::simulationUpdate	(	float	timeStep,
		double	currentTime,
		DtJobSplitter *	jobSplitter
	)

virtual

Run a simulation update to simulate particle movement.

Parameters

timeStep	The time step to simulate.
currentTime	The current simulation time.
jobSplitter	A job splitter to add simulation jobs to.

virtual void makVrv::DtWeatherEffect::postSimulationUpdate	(	float	timeStep,
		double	currentTime
	)

virtual

Run a post simulation update.

This is specifically here to update things that might not be job thread safe.

Parameters

timeStep The time step to simulate.

virtual void makVrv::DtWeatherEffect::draw	(	DtWeatherEffect::DrawData &	drawData,
		float	cullFade = `1.0f`
	)		const

virtual

Issues the drawing command for the effect.

Parameters

drawData	The drawing data structure containing draw parameters.
cullFade	An addition fade value used for culling falloff.

virtual void makVrv::DtWeatherEffect::cullUpdate	(	const osg::Vec3d &	camPos,
		const osg::Matrixd &	basis,
		DtJobSplitter *	jobSplitter
	)

virtual

Prepares the effect for drawing based on the camera position.

Parameters

camPos	The camera position.
basisRot	The basis rotation at the camera location.
jobSplitter	A job splitter to add predraw jobs to.

virtual void makVrv::DtWeatherEffect::setSurfaceHitType ( SurfaceHitType type )

virtual

Sets a type used to generate hit particles on the ground surface.

A surface hit effect creates particles based on surface heights around the weather effect's current location. The weather effect must be of type EffectTypeParticle to use surface hits.

Parameters

type	The type of surface hit to enable.

virtual void makVrv::DtWeatherEffect::setSurfaceHitOffset ( float offset )

virtual

Sets a position offset used for particles that hit a surface.

Parameters

offset The amount to offset the hit position by the suface normal direction.

virtual void makVrv::DtWeatherEffect::setSurfaceHitMaxSlope ( float degrees )

virtual

Sets the max surface slope angle allowed for a particle to spawn for a surface hit.

Parameters

angleDeg The maximum slope angle in degrees (0 - 90).

virtual void makVrv::DtWeatherEffect::setWindBlownParameters	(	int	spawnCount,
		float	minSpeed,
		float	maxSpeed,
		float	minTime,
		float	maxTime
	)

virtual

Sets the parameters used for the SurfaceHitTypeWindBlown surface hit type.

Parameters

spawnCount	The number of particles to spawn.
minSpeed	The minimum wind speed multiplier.
maxSpeed	The maximum wind speed multiplier.
minTime	The minimum alive time.
maxTime	The maximum alive time.

virtual void makVrv::DtWeatherEffect::setWind	(	float	windDirectionRad,
		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::DtWeatherEffect::setWindSpeedMultiplier ( float multiplier )

virtual

Sets a wind speed multiplier used for particle physics.

Parameters

multiplier The multiplier value.

virtual void makVrv::DtWeatherEffect::setWindLiftMultiplier ( float multiplier )

virtual

Sets a wind lift multiplier used for particle physics.

Parameters

multiplier The lift multiplier value can be positive (up) or negative (down).

virtual void makVrv::DtWeatherEffect::setWindTurbulence ( float multiplier )

virtual

Sets a wind turbulence multiplier for particle physics.

Parameters

multiplier The multiplier value (basically height deviation in meters).

virtual void makVrv::DtWeatherEffect::setWindVariation	(	float	minWind,
		float	maxWind
	)

virtual

Sets the particle wind response variation when physics are enabled.

Parameters

minWind	The minimum (scalar) a particle is affected by wind.
maxWind	The maximum (scalar) a particle is affected by wind.

virtual void makVrv::DtWeatherEffect::setScaleAnimation	(	float	minX,
		float	maxX,
		float	minY,
		float	maxY,
		float	time
	)

virtual

Sets parameters for animated shrink/grow on the particle axis.

Scale is cycled back and forth over time from normal to scaled value.

Parameters

minX	The minimum x axis size multiplier.
maxX	The maximum x axis size multiplier.
minY	The minimum y axis size multiplier.
maxX	The maximum y axis size multiplier.
speed	The time of 1 animation cycle in seconds.

virtual void makVrv::DtWeatherEffect::setStreak ( float multiplier )

virtual

Sets a streak value to control particle streaking based on movement.

A streak value of 0 disables streaking. A value greater than 0 lengthens the particle based on how fast it is moving.

Parameters

multiplier The streak multiplier value.

virtual void makVrv::DtWeatherEffect::setCameraStreakEnable ( bool enable )

virtual

Sets the flag to enable particle camera movement streak effect.

If streak is enabled (see setStreak()), then this method enables or disables the camera movement streak effect.

Parameters

enable Set to true to enable camera streak (default is not enabled).

virtual void makVrv::DtWeatherEffect::setStreakAdjustmentEnable ( bool enable )

virtual

Sets the flag to enable streak effect framerate adjustment.

If enabled, the streak length will be adjusted when frame rate dips below 60hz. This keeps particles from stretching too much at low frame rates. This should only be enabled for fast moving particles.

Parameters

enable Set to true to enable adjustment. (default is enabled).

virtual void makVrv::DtWeatherEffect::setOrientFlat ( bool enable )

virtual

Sets the particles to be rendered in a flat orientation.

virtual void makVrv::DtWeatherEffect::setIntensity ( float intensity )

virtual

Sets a (0.0 - 1.0) value to control the effect intensity.

Parameters

intensity The intensity scalar (0.0 - 1.0).

virtual void makVrv::DtWeatherEffect::setFadePerIntensity	(	float	fadeMin,
		float	fadeMax,
		float	intensityMin,
		float	intensityMax
	)

virtual

Sets an effect fade ramp based on the current intensity.

Fade will be fadeMin if intensity < intensityMin. Fade will be fadeMax if intensityMin = intensityMax.

Parameters

fadeMin	The fade value (0.0 to 1.0) when intensity = intensityMin.
fadeMax	The fade value (0.0 to 1.0) when intensity = intensityMax.
intensityMin	The intensity (0.0 to 1.0) at which the ramp begins.
intensityMax	The intensity (0.0 to 1.0) at which the ramp ends.

virtual void makVrv::DtWeatherEffect::setFadePerWind	(	float	fadeMin,
		float	fadeMax,
		float	windMin,
		float	windMax
	)

virtual

Sets an effect fade ramp based on the current wind in mps.

Fade will be fadeMin if wind < windMin. Fade will be fadeMax if windMin = windMax.

Parameters

fadeMin	The fade value (0.0 to 1.0) when wind = windMin.
fadeMax	The fade value (0.0 to 1.0) when wind = windMax.
windMin	The wind speed at which the ramp begins.
windMax	The wind speed at which the ramp ends.

virtual void makVrv::DtWeatherEffect::setTextureCoordAnimationPerWind	(	float	multMin,
		float	multMax,
		float	windMin,
		float	windMax
	)

virtual

Sets an effect texture coordinate animation speed ramp based on the current wind in mps.

Computed output will be multMin if wind < windMin. Computed output will be multMax if windMin = windMax.

Parameters

multMin	The texture animation speed multiplier value (0.0 to 1.0) when wind = windMin.
multMax	The texture animation speed value (0.0 to 1.0) when wind = windMax.
windMin	The wind speed at which the ramp begins.
windMax	The wind speed at which the ramp ends.

virtual void makVrv::DtWeatherEffect::setParticlesPerIntensity	(	float	percentMin,
		float	percentMax,
		float	intensityMin,
		float	intensityMax
	)

virtual

Sets a particles percentage ramp based on the current intensity.

Percent will be percentMin if intensity < intensityMin. Percent will be percentMax if intensityMin = intensityMax.

Parameters

percentMin	The percent value (0.0 to 1.0) when intensity = intensityMin.
percentMax	The percent value (0.0 to 1.0) when intensity = intensityMax.
intensityMin	The intensity (0.0 to 1.0) at which the ramp begins.
intensityMax	The intensity (0.0 to 1.0) at which the ramp ends.

virtual void makVrv::DtWeatherEffect::setBaseColor ( const osg::Vec3 & color )

virtual

Sets a base color for the effect.

Parameters

color The r,g,b color values.

virtual void makVrv::DtWeatherEffect::setAdditiveBlend ( bool enable )

virtual

Enables additive blending mode for rendering.

Parameters

enable Set to true for additive or false for alphablend.

virtual bool makVrv::DtWeatherEffect::additiveBlend ( ) const

virtual

Returns the additive blend mode flag.

virtual void makVrv::DtWeatherEffect::setVelocity	(	float	x,
		float	y,
		float	z
	)

virtual

Sets a velocity for all effect particles.

Parameters

(x,y,z) The x,y,z local space velocity values.

virtual void makVrv::DtWeatherEffect::setInitRotationVariation ( float rotationDeg )

virtual

Sets particle +- initial random rotation.

Parameters

rotationDeg The initial rotation variation in degrees.

virtual void makVrv::DtWeatherEffect::setRotationVelocity ( float velDeg )

virtual

Sets particle maximum rotation velocity.

Parameters

velDeg The rotation velocity in degrees per second.

virtual float makVrv::DtWeatherEffect::radius ( ) const

virtual

Returns the radius of the effect.

virtual void makVrv::DtWeatherEffect::setTextureAtlasCell	(	unsigned char	numColumns,
		unsigned char	numRows,
		unsigned char	col,
		unsigned char	row
	)

virtual

Sets the texture cell to use for a texture atlas transparency mask channel.

Parameters

numColumns	The number of columns in the texture.
numRows	The number of rows in the texture.
col	The cell column to use.
row	The cell row to use.

virtual void makVrv::DtWeatherEffect::setTextureCoordinateAnimation	(	float	dirSpeedU,
		float	dirSpeedV,
		float	scale0,
		float	scale1
	)

virtual

Sets texture uv coordinate animation settings applied to the transpancey pattern channels.

Parameters

dirSpeedU	The U scrolling speed (u space per second).
dirSpeedV	The V scrolling speed (v space per second).
scale	The uv scale for pattern 0. (1.0 = one full texture)
scale	The uv scale for pattern 1. (1.0 = one full texture)

virtual void makVrv::DtWeatherEffect::setTexturePatternChannelMix	(	float	mix0,
		float	mix1
	)

virtual

Sets the texture channel mix values for the transparancy patterns.

This is used to mix between the r and g channels of the transparency patterns.

Parameters

mix	A rg mixing value in the range of (0.0 to 1.0) for pattern 0.
mix	A rg mixing value in the range of (0.0 to 1.0) for pattern 1.

virtual void makVrv::DtWeatherEffect::setDepthSoftness ( float softness )

virtual

Sets the softness for transparency fade when close to a surface.

Parameters

softness The distance in meters to start the softness fade.

virtual float makVrv::DtWeatherEffect::depthSoftness ( ) const

virtual

Returns the softness for transparency fade when close to a surface.

virtual void makVrv::DtWeatherEffect::setDepthProximity	(	float	startFade,
		float	fadeEnd,
		float	mix
	)

virtual

Sets depth proximity values, to fade particle at it moves away from a surface.

Parameters

startFade	The depth distance to start fading out.
fadeRange	The depth distance to end fading out.
mix	The amount of the fading value to use. (0 = full off, 1 = full on)

virtual void makVrv::DtWeatherEffect::setDragCoefficient ( float coefficient )

virtual

Sets the drag coefficient for particles.

Parameters

coefficient The coefficient value.

virtual float makVrv::DtWeatherEffect::dragCoefficient ( ) const

virtual

Returns the drag coefficient for particles.

virtual void makVrv::DtWeatherEffect::setSortEnable ( bool enable )

virtual

Sets the flag to enable sorting particles within the effect.

Parameters

enable Set to true to enable sorting.

virtual bool makVrv::DtWeatherEffect::sortEnable ( ) const

virtual

Returns the flag to enable sorting particles within the effect.

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

virtual

Sorts particles for the current view.

Fills indice buffer.

Parameters

localCamPos The local camera position.

virtual void makVrv::DtWeatherEffect::setClampToSurface ( bool enable )

virtual

Sets the flag to enable particles to clamp to a surface in the shader.

Parameters

enable Set to true to enable clamping.

virtual bool makVrv::DtWeatherEffect::clampToSurface ( ) const

virtual

Returns the flag to enable particles to clamp to a surface in the shader.

virtual void makVrv::DtWeatherEffect::setGravity ( const osg::Vec3 & gravity )

virtual

Sets the gravity (mps^2) used when particle physics are enabled.

Parameters

gravity The acceleration value.

virtual void makVrv::DtWeatherEffect::setRadiusFading	(	float	fadeInStart,
		float	fadeInEnd,
		float	fadeOutStart,
		float	fadeOutEnd
	)

virtual

Sets radius linear fading values for fading in/out particles based on distance.

Parameters

fadeInStart	The distance to begin fading in.
fadeInEnd	The distance to be fully faded in.
fadeOutStart	The distance to begin fading out.
fadeOutEnd	The distance to be fully faded out.

virtual void makVrv::DtWeatherEffect::runSimulationUpdateJob	(	float	timeStep,
		double	currentTime
	)

protectedvirtual

Called during a muti-thread update job to run a simulation update.

Parameters

timeStep	The change in time.
currentTime	The current simulation time.

virtual void makVrv::DtWeatherEffect::updateHailSurfaceHit ( float timeStep )

protectedvirtual

Does an update for the Hail surface hit type.

Parameters

timeStep The simulation time step.

virtual void makVrv::DtWeatherEffect::updateWindBlownSurfaceHit ( float timeStep )

protectedvirtual

Does an update for the WindBlown surface hit type.

Parameters

timeStep The simulation time step.

virtual void makVrv::DtWeatherEffect::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::DtWeatherEffect::fillSortedParticles ( )

protectedvirtual

Fills the gpu buffer with sorted particle data.

virtual bool makVrv::DtWeatherEffect::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::DtWeatherEffect::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::DtWeatherEffect::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 void makVrv::DtWeatherEffect::simulatePrecipitationParticles	(	float	timeStep,
		double	currentTime
	)

protectedvirtual

Simulates particles (movements, etc...) for precipitation.

Parameters

timeStep	The change in time.
currentTime	The current simulation time.

virtual void makVrv::DtWeatherEffect::simulateParticles	(	float	timeStep,
		double	currentTime,
		osg::Vec3d &	basisPosChange
	)

protectedvirtual

Simulates particles (life, movements, etc...).

Parameters

timeStep	The change in time.
currentTime	The current simulation time.
basisPosChange	The change in basis position.

void makVrv::DtWeatherEffect::wrapPosition	(	float &	posX,
		float &	posY,
		float &	posZ
	)

protected

Keeps the given position in the effect radius.

Parameters

posX	The X position to constrain.
posY	The Y position to constrain.
posZ	The Z position to constrain.

Particle* makVrv::DtWeatherEffect::getFreeParticle ( void )

protected

Returns a particle from the free list.

Makes the particle the head of the active list. NULL(0) if no particles are available.

void makVrv::DtWeatherEffect::freeParticle ( Particle * particle )

protected

Adds the given particle to the free list.

Handles unlinking from the active list.

void makVrv::DtWeatherEffect::spawnHailParticle	(	const osg::Vec3d &	position,
		const osg::Vec3 &	normal,
		const unsigned char	usePhysics
	)

protected

Spawns a hail particle at the given location.

Parameters

position	The world location.
normal	The spawn direction.
usePhysics	Set to 1 if the particle should use physics otherwise 0.

void makVrv::DtWeatherEffect::spawnWindBlownParticle	(	const osg::Vec3d &	position,
		const osg::Vec3 &	normal,
		float	windRandom,
		float	cosAng
	)

protected

Spawns a wind blown particle at the given location.

Parameters

position	The world surface location.
normal	The world surface normal.
windRandom	A +- wind random direction offset in radians.
cosAngle	The cosine of the surface normal vs world up.

const osg::Vec3 makVrv::DtWeatherEffect::crossProduct	(	const osg::Vec3 &	v0,
		const osg::Vec3 &	v1
	)

protected

Returns the cross product of the given 2 vectors.

Parameters

v0	The first vector.
v1	The second vector.

float makVrv::DtWeatherEffect::computeRandomMinMax	(	float	fMin,
		float	fMax
	)

protected

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

Parameters

min	The minimum value.
max	The maximum value.

void makVrv::DtWeatherEffect::computeRandomPointInRadius	(	osg::Vec2 &	point,
		float	radius
	)

protected

Computes a random point in a radius with even distribution.

Parameters

point	The computed point (output).
radius	The radius.

bool makVrv::DtWeatherEffect::clampPosition	(	osg::Vec3d &	position,
		osg::Vec3 &	normal,
		const osg::Vec3 &	up
	)

protected

Clamps the given position to a ground surface.

Returns true if successful.

Parameters

position	The input/output position to clamp.
normal	The output surface normal.
up	The up vector to use for detecting surfaces below the position.

virtual float makVrv::DtWeatherEffect::computeBlendControl	(	const BlendData &	data,
		float	blendPos
	)		const

protectedvirtual

Computes an ouput value based on the given blending data and blend position.

Parameters

data	The blending data (see BlendData struct for details).
blendPos	The blend position.

static void makVrv::DtWeatherEffect::theSimulationUpdateJob ( void * data )

staticprotected

simulation update job function used as a callback for job splitting

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

staticprotected

sort function used for qsorting particles

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

staticprotected

sort job function used as a callback for job splitting

Member Data Documentation

DtDe& makVrv::DtWeatherEffect::myDe

protected

osg::Matrixd makVrv::DtWeatherEffect::myBasisRot

protected

osg::Vec3d makVrv::DtWeatherEffect::myBasisPos

protected

osg::Vec3d makVrv::DtWeatherEffect::myLastBasisPos

protected

bool makVrv::DtWeatherEffect::myBasisDirty

protected

EffectType makVrv::DtWeatherEffect::myEffectType

protected

SurfaceHitType makVrv::DtWeatherEffect::mySurfaceHitType

protected

float makVrv::DtWeatherEffect::mySurfaceHitOffset

protected

float makVrv::DtWeatherEffect::mySurfaceHitMaxSlope

protected

float makVrv::DtWeatherEffect::mySurfaceHitTimer

protected

unsigned int makVrv::DtWeatherEffect::myRandomSeed

protected

osg::Vec3 makVrv::DtWeatherEffect::myScroll

protected

float makVrv::DtWeatherEffect::myRadius

protected

float makVrv::DtWeatherEffect::myWindDirectionRad

protected

float makVrv::DtWeatherEffect::myWindSpeedMps

protected

float makVrv::DtWeatherEffect::myWindSpeedMultiplier

protected

float makVrv::DtWeatherEffect::myWindLiftMultiplier

protected

float makVrv::DtWeatherEffect::myWindTurbulence

protected

float makVrv::DtWeatherEffect::myWindMin

protected

float makVrv::DtWeatherEffect::myWindMax

protected

float makVrv::DtWeatherEffect::myDragCoefficient

protected

osg::Vec3 makVrv::DtWeatherEffect::myVelocity

protected

float makVrv::DtWeatherEffect::myInitRotationRad

protected

float makVrv::DtWeatherEffect::myRotationVelocity

protected

float makVrv::DtWeatherEffect::myEffectFade

protected

float makVrv::DtWeatherEffect::myIntensity

protected

BlendData makVrv::DtWeatherEffect::myFadeByIntensity

protected

BlendData makVrv::DtWeatherEffect::myFadeByWind

protected

BlendData makVrv::DtWeatherEffect::myTexCoordAnimSpeedByWind

protected

BlendData makVrv::DtWeatherEffect::myParticlesByIntensity

protected

float makVrv::DtWeatherEffect::myParticleSize

protected

osg::Vec3 makVrv::DtWeatherEffect::myBaseColor

protected

bool makVrv::DtWeatherEffect::myAdditiveBlend

protected

osg::ref_ptr<osg::BlendFunc> makVrv::DtWeatherEffect::myBlendFunc

protected

float makVrv::DtWeatherEffect::myStreak

protected

float makVrv::DtWeatherEffect::myStreakAdjustment

protected

bool makVrv::DtWeatherEffect::myStreakAdjustmentEnable

protected

bool makVrv::DtWeatherEffect::myCameraStreak

protected

float makVrv::DtWeatherEffect::myScaleAnimMinX

protected

float makVrv::DtWeatherEffect::myScaleAnimMaxX

protected

float makVrv::DtWeatherEffect::myScaleAnimMinY

protected

float makVrv::DtWeatherEffect::myScaleAnimMaxY

protected

float makVrv::DtWeatherEffect::myScaleSpeed

protected

float makVrv::DtWeatherEffect::myTextureAtlasCols

protected

float makVrv::DtWeatherEffect::myTextureAtlasRows

protected

float makVrv::DtWeatherEffect::myTextureAtlasCol

protected

float makVrv::DtWeatherEffect::myTextureAtlasRow

protected

float makVrv::DtWeatherEffect::myTexCoordAnimDirSpeedU

protected

float makVrv::DtWeatherEffect::myTexCoordAnimDirSpeedV

protected

float makVrv::DtWeatherEffect::myTexCoordAnimScale0

protected

float makVrv::DtWeatherEffect::myTexCoordAnimScale1

protected

float makVrv::DtWeatherEffect::myTexCoordAnimDirOffsetU

protected

float makVrv::DtWeatherEffect::myTexCoordAnimDirOffsetV

protected

float makVrv::DtWeatherEffect::myTexturePatternMix0

protected

float makVrv::DtWeatherEffect::myTexturePatternMix1

protected

float makVrv::DtWeatherEffect::myDepthSoftness

protected

float makVrv::DtWeatherEffect::myDepthProximityMix

protected

float makVrv::DtWeatherEffect::myDepthProximityStart

protected

float makVrv::DtWeatherEffect::myDepthProximityRange

protected

float makVrv::DtWeatherEffect::myDepthProximityInvRange

protected

bool makVrv::DtWeatherEffect::mySortEnable

protected

bool makVrv::DtWeatherEffect::myClampToSurface

protected

bool makVrv::DtWeatherEffect::myOrientFlat

protected

osg::Vec3 makVrv::DtWeatherEffect::myGravity

protected

float makVrv::DtWeatherEffect::myRadiusFadeInStart

protected

float makVrv::DtWeatherEffect::myRadiusFadeInFalloff

protected

float makVrv::DtWeatherEffect::myRadiusFadeOutStart

protected

float makVrv::DtWeatherEffect::myRadiusFadeOutFalloff

protected

int makVrv::DtWeatherEffect::myWindBlownSpawnCount

protected

float makVrv::DtWeatherEffect::myWindBlownMinSpeed

protected

float makVrv::DtWeatherEffect::myWindBlownMaxSpeed

protected

float makVrv::DtWeatherEffect::myWindBlownMinTime

protected

float makVrv::DtWeatherEffect::myWindBlownMaxTime

protected

MeshGroup* makVrv::DtWeatherEffect::myMeshGroup

protected

DtGlVaoManager* makVrv::DtWeatherEffect::myVaoManager

protected

Particle* makVrv::DtWeatherEffect::myParticlesMemoryPool

protected

int makVrv::DtWeatherEffect::myParticleMemoryPoolCount

protected

Particle* makVrv::DtWeatherEffect::myParticlesFree

protected

Particle* makVrv::DtWeatherEffect::myParticlesActive

protected

int makVrv::DtWeatherEffect::myParticleActiveCount

protected

Particle** makVrv::DtWeatherEffect::myRenderList

protected

int makVrv::DtWeatherEffect::myRenderParticleCount

protected

SimulationUpdateJobData makVrv::DtWeatherEffect::mySimulationUpdateJobData

protected

DtJobSplitterJob makVrv::DtWeatherEffect::mySimulationUpdateJob

protected

SortJobData makVrv::DtWeatherEffect::mySortJobData

protected

DtJobSplitterJob makVrv::DtWeatherEffect::mySortJob

protected

DtRandomNumberGenerator makVrv::DtWeatherEffect::myRandomNumberGen

protected

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

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation