This class provides an OSG-specific implementation of water drops on the screen. More...

Inheritance diagram for makVrv::DtWaterOnScreen:

Classes
struct	GridCell

Public Member Functions
	DtWaterOnScreen (DtDe &de, const std::string &postProcessType, bool handles2D)
	Constructor. More...

virtual	~DtWaterOnScreen ()
	Destructor. More...

virtual void	activateRaindrops (bool on)
	Activates or deactivates the raindrops-on-screen effect. More...

virtual void	activateSplashes (bool on)
	Activates or deactivates the splashes on screen effect. More...

virtual void	activateSpray (bool on)
	Activates or deactivates ocean spray on screen effect. More...

virtual void	setIsUnderwater (bool underwater)
	Tells effect we are underwater, and no screen effects should exist. More...

virtual void	addRainDrop (float x, float y, float radius)
	Add a single raindrop. More...

virtual void	addOceanSplash (float intensity)
	Adds one frame's worth of large splashes on the screen, in response to a submerging or surfacing viewpoint. More...

virtual void	setSplashIntensity (float intensity)
	Sets the overall intensity of the splash effect (0-1) More...

virtual void	setSprayIntensity (float intensity)
	Sets the overall intensity of the spray effect (0-1) More...

virtual bool	update (DtChannel *channel)
	Called once per frame from the DtPostProcessManager. More...

virtual int	numActiveDrops () const
	How many drops are currently on the screen. More...

virtual void	setWaterOnScreenSize (double size)
	Set the size of the water on screen effect(Rain Splash / Ocean Spray / Wave Splash) in percentage, default is 100(%) More...

virtual void	addSplashEffects (const DtObserverObject *observer, bool hasWaveSplashEffect)
	Query the DtOsgSkyObject, DtTritonManager, and channel observer to determine whether to draw screen space ocean splash effects. More...

virtual void	addSprayEffects (const DtObserverObject *observer, bool hasOceanSprayEffect)
	Query the DtOsgSkyObject, DtTritonManager, and channel observer to determine whether to draw screen space ocean spray effects (when near the surface of the ocean) More...

Public Member Functions inherited from makVrv::DtPostProcessor
	DtPostProcessor (DtDe &de, const std::string &postProcessType, bool handles2D)
	CTOR. More...

virtual	~DtPostProcessor ()
	DTOR. More...

virtual void	setFragmentShaderSource (const char *source)
	Sets fragment shader source for this post-processor. More...

virtual void	setVertexShaderSource (const char *source)
	Sets vertex shader source for this post-processor. More...

virtual void	setFragmentShaderFile (const std::string &fileName)
	Sets fragment shader file for this post-processor. More...

virtual void	setVertexShaderFile (const std::string &fileName)
	Sets vertex shader file for this post-processor. More...

virtual void	setInputTexture (const DtChannel channel, osg::Texture texture)
	Sets the image that is postprocessed; this may be the 3D scene rendered to a texture, or the output texture of a chained post processor. More...

virtual osg::Texture *	outputTexture ()
	Gets the output texture of this post processor, for use in chaining processors together. More...

virtual void	setIsFinalEffect (const DtChannel *channel, bool final)
	Called by the DtPostProcessManager to indicate if this is the last post processor in the chain, and should render to the framebuffer. More...

virtual osg::Camera *	cameraForChannel (const DtChannel *channel)
	Gets the Camera node associated with this effect and channel. More...

virtual void	slot_releaseResources ()
	used to call releaseGLObjects on this post processor's openGL related objects when the last window is removed. More...

virtual bool	hasEffect (const std::string &effect)
	Does this post processor support this effect? More...

virtual bool	effectEnabled (const std::string &effect)
	Is this effect (post processor sub-component) enabled? More...

virtual bool	anyEffectEnabled ()
	Are any effects enabled? More...

virtual std::list< std::string >	supportedEffects ()
	Get a list of supported effects for this post processor. More...

virtual bool	handles2D () const
	Retrieves whether this post processor should be used in 2D orthographic views, as specified in its constructor. More...

virtual const std::string &	type () const
	Gets the type of the post processor. More...

virtual bool	postProcessorEnabled () const
	Is this post processor enabled? More...

virtual bool	enableEffect (const std::string &effect)
	Enable a particular post processing technique For example, "wateroncamera" has techniques "rainsplash", "oceanspray", and "wavesplash". More...

virtual bool	disableEffect (const std::string &effect)

virtual void	enablePostProcessor ()
	Enable or disable the post processor. More...

virtual void	disablePostProcessor ()

Static Public Member Functions
static double	waterOnScreenSize ()
	Get the size of the water on screen effect(Rain Splash / Ocean Spray / Wave Splash) in percentage, default is 100(%) More...

Static Public Attributes
static double	theWaterOnScreenSize

Protected Member Functions
virtual void	initialize ()
	initialize More...

virtual void	clearNormalMap ()
	clear the normal map to 0 More...

virtual void	updateAndDrawDrops (double elapsedTime)
	generate the normal map by drawing all the active drops into it More...

virtual void	finalizeNormalMap (void)
	finalize the normal map (make a rgb float texture from the int normal map) More...

virtual void	addRaindrops (double time, float heading, float observerVelocity, const DtVector &observerLocation)
	add a rain drop More...

virtual void	addSpray (double time, float heading)
	add a spray particle More...

virtual void	clearDrops ()
	clear the drops More...

virtual void	reset ()
	reset More...

virtual void	setActiveStatus ()
	set active More...

virtual void	slot_waterOnScreenSizeChanged (double value)
	slot for when water on screen size changes More...

virtual void	releaseGLObjects () override
	cleanup graphics related objects More...

virtual void	cleanupGpuMemory (void)
	clean the gpu memory More...

virtual void	createNormalMapIfNecessary (void)
	create normal and initialize, if not already More...

virtual void	createNormalMapCombineProgramIfNecessary (void)
	create normal combine program and initialize, if not already More...

virtual void	createNormalMapFinalizeProgramIfNecessary (void)
	create normal finalize program and initialize, if not already More...

virtual void	initZeroNormals (void)
	init the vector of zero normals that are used to clear out the normal map More...

Protected Member Functions inherited from makVrv::DtPostProcessor
virtual bool	effectItrEnabled (const EffectMap::iterator &effect)

virtual void	addEffect (std::string effect)
	When constructing a post processor, add the names of the sub-components (effects) that can be enabled and disabled. More...

virtual void	setEnablePostProcessor (bool enabled)
	Set the post processor enabled state (true = enabled) More...

Protected Attributes
double	myLastUpdateTime

double	myLastDropEmissionTime

double	myLastSprayEmissionTime

bool	myRaindropsActiveFlag

bool	mySplashesActiveFlag

bool	mySprayActiveFlag

bool	myActiveFlag

bool	myUnderwaterFlag

float	mySplashIntensity

float	mySprayIntensity

int	myNumActiveDrops

DtGridCell	myGrid [GRID_DIMENSION][GRID_DIMENSION]

DtGlProgram *	myNormalMapCombineProgram
	The various normal map mod programs. More...

bool	myNormalMapCombineProgramTriedOnce

DtGlProgram *	myNormalMapFinalizeProgram

bool	myNormalMapFinalizeProgramTriedOnce

DtGlTexture *	myNormalMap
	The generated normal map texture. More...

DtGlBuffer *	myNormalMapBuffer
	The gpu buffer representing the interim normal map (ssbo) More...

DtGlBuffer *	myPrecomputedDropletNormalsBuffer
	The gpu buffer representing the constant pre-computed droplet normals. More...

bool	myPrecomputedDropletNormalsBufferDirty

DtGlBuffer *	myPrecomputedSplashNormalsBuffer
	The gpu buffer representing the constant pre-computed splash normals. More...

bool	myPrecomputedSplashNormalsBufferDirty

GridCell	myGridCells [GRID_DIMENSION][GRID_DIMENSION]
	The grid cells that end up into the gpu buffer next. More...

DtGlBuffer *	myCellsBuffer
	The cells' buffer on the gpu (ssbo) More...

DtVector4< unsigned int >	myZeroNormals [TEXSIZE][TEXSIZE]
	The zero normals buffer (used to clear the normal map to zero) More...

osg::ref_ptr < DtWaterOnScreenDrawable >	myWaterOnScreenDrawable

Protected Attributes inherited from makVrv::DtPostProcessor
osg::ref_ptr< osg::Texture >	myOutputTexture

osg::ref_ptr< osg::Texture >	myInputTexture

osg::ref_ptr< osg::Program >	myProgram

osg::ref_ptr< osg::Shader >	myFragmentShader

osg::ref_ptr< osg::Shader >	myVertexShader

osg::ref_ptr< osg::Geode >	myQuad

CameraMap	myCameraMap

bool	myHandles2DFlag

bool	myEnabledFlag

std::string	myType

EffectMap	myEffects

CallbackMap	myCullCallbackMap

DtDe &	myDe

DtSignalConnectionManager	mySignals

Private Member Functions
	DtWaterOnScreen ()=delete
	private default constructor. not allowed. More...

	DtWaterOnScreen (const DtWaterOnScreen &)=delete
	prevent copy-construction More...

DtWaterOnScreen &	operator= (const DtWaterOnScreen &)=delete
	prevent assignment More...

Additional Inherited Members
Protected Types inherited from makVrv::DtPostProcessor
typedef boost::unordered_map < std::string, bool >	EffectMap

typedef std::map< const DtChannel *, osg::ref_ptr < osg::Camera > >	CameraMap

typedef osg::ref_ptr < DtPostProcessorCullVistorCallback >	CallbackRefPtr

typedef std::map< const DtChannel *, CallbackRefPtr >	CallbackMap

Detailed Description

This class provides an OSG-specific implementation of water drops on the screen.

Constructor & Destructor Documentation

makVrv::DtWaterOnScreen::DtWaterOnScreen	(	DtDe &	de,
		const std::string &	postProcessType,
		bool	handles2D
	)

Constructor.

virtual makVrv::DtWaterOnScreen::~DtWaterOnScreen ( )

virtual

Destructor.

makVrv::DtWaterOnScreen::DtWaterOnScreen ( )

privatedelete

private default constructor. not allowed.

makVrv::DtWaterOnScreen::DtWaterOnScreen ( const DtWaterOnScreen & )

privatedelete

prevent copy-construction

Member Function Documentation

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

privatedelete

prevent assignment

virtual void makVrv::DtWaterOnScreen::activateRaindrops ( bool on )

virtual

Activates or deactivates the raindrops-on-screen effect.

virtual void makVrv::DtWaterOnScreen::activateSplashes ( bool on )

virtual

Activates or deactivates the splashes on screen effect.

(From a submerging observer.)

virtual void makVrv::DtWaterOnScreen::activateSpray ( bool on )

virtual

Activates or deactivates ocean spray on screen effect.

virtual void makVrv::DtWaterOnScreen::setIsUnderwater ( bool underwater )

virtual

Tells effect we are underwater, and no screen effects should exist.

virtual void makVrv::DtWaterOnScreen::addRainDrop	(	float	x,
		float	y,
		float	radius
	)

virtual

Add a single raindrop.

All parameters are normalized against the viewport dimensions (0-1)

virtual void makVrv::DtWaterOnScreen::addOceanSplash ( float intensity )

virtual

Adds one frame's worth of large splashes on the screen, in response to a submerging or surfacing viewpoint.

virtual void makVrv::DtWaterOnScreen::setSplashIntensity ( float intensity )

virtual

Sets the overall intensity of the splash effect (0-1)

virtual void makVrv::DtWaterOnScreen::setSprayIntensity ( float intensity )

virtual

Sets the overall intensity of the spray effect (0-1)

virtual bool makVrv::DtWaterOnScreen::update ( DtChannel * channel )

virtual

Called once per frame from the DtPostProcessManager.

Implements makVrv::DtPostProcessor.

virtual int makVrv::DtWaterOnScreen::numActiveDrops ( ) const

virtual

How many drops are currently on the screen.

virtual void makVrv::DtWaterOnScreen::setWaterOnScreenSize ( double size )

virtual

Set the size of the water on screen effect(Rain Splash / Ocean Spray / Wave Splash) in percentage, default is 100(%)

virtual void makVrv::DtWaterOnScreen::addSplashEffects	(	const DtObserverObject *	observer,
		bool	hasWaveSplashEffect
	)

virtual

Query the DtOsgSkyObject, DtTritonManager, and channel observer to determine whether to draw screen space ocean splash effects.

virtual void makVrv::DtWaterOnScreen::addSprayEffects	(	const DtObserverObject *	observer,
		bool	hasOceanSprayEffect
	)

virtual

Query the DtOsgSkyObject, DtTritonManager, and channel observer to determine whether to draw screen space ocean spray effects (when near the surface of the ocean)

static double makVrv::DtWaterOnScreen::waterOnScreenSize ( )

static

Get the size of the water on screen effect(Rain Splash / Ocean Spray / Wave Splash) in percentage, default is 100(%)

virtual void makVrv::DtWaterOnScreen::initialize ( )

protectedvirtual

initialize

Reimplemented from makVrv::DtPostProcessor.

virtual void makVrv::DtWaterOnScreen::clearNormalMap ( )

protectedvirtual

clear the normal map to 0

virtual void makVrv::DtWaterOnScreen::updateAndDrawDrops ( double elapsedTime )

protectedvirtual

generate the normal map by drawing all the active drops into it

virtual void makVrv::DtWaterOnScreen::finalizeNormalMap ( void )

protectedvirtual

finalize the normal map (make a rgb float texture from the int normal map)

virtual void makVrv::DtWaterOnScreen::addRaindrops	(	double	time,
		float	heading,
		float	observerVelocity,
		const DtVector &	observerLocation
	)

protectedvirtual

add a rain drop

virtual void makVrv::DtWaterOnScreen::addSpray	(	double	time,
		float	heading
	)

protectedvirtual

add a spray particle

virtual void makVrv::DtWaterOnScreen::clearDrops ( )

protectedvirtual

clear the drops

virtual void makVrv::DtWaterOnScreen::reset ( )

protectedvirtual

reset

virtual void makVrv::DtWaterOnScreen::setActiveStatus ( )

protectedvirtual

set active

virtual void makVrv::DtWaterOnScreen::slot_waterOnScreenSizeChanged ( double value )

protectedvirtual

slot for when water on screen size changes

virtual void makVrv::DtWaterOnScreen::releaseGLObjects ( )

overrideprotectedvirtual

cleanup graphics related objects

Reimplemented from makVrv::DtPostProcessor.

virtual void makVrv::DtWaterOnScreen::cleanupGpuMemory ( void )

protectedvirtual

clean the gpu memory

virtual void makVrv::DtWaterOnScreen::createNormalMapIfNecessary ( void )

protectedvirtual

create normal and initialize, if not already

virtual void makVrv::DtWaterOnScreen::createNormalMapCombineProgramIfNecessary ( void )

protectedvirtual

create normal combine program and initialize, if not already

virtual void makVrv::DtWaterOnScreen::createNormalMapFinalizeProgramIfNecessary ( void )

protectedvirtual

create normal finalize program and initialize, if not already

virtual void makVrv::DtWaterOnScreen::initZeroNormals ( void )

protectedvirtual

init the vector of zero normals that are used to clear out the normal map

Member Data Documentation

double makVrv::DtWaterOnScreen::myLastUpdateTime

protected

double makVrv::DtWaterOnScreen::myLastDropEmissionTime

protected

double makVrv::DtWaterOnScreen::myLastSprayEmissionTime

protected

bool makVrv::DtWaterOnScreen::myRaindropsActiveFlag

protected

bool makVrv::DtWaterOnScreen::mySplashesActiveFlag

protected

bool makVrv::DtWaterOnScreen::mySprayActiveFlag

protected

bool makVrv::DtWaterOnScreen::myActiveFlag

protected

bool makVrv::DtWaterOnScreen::myUnderwaterFlag

protected

float makVrv::DtWaterOnScreen::mySplashIntensity

protected

float makVrv::DtWaterOnScreen::mySprayIntensity

protected

int makVrv::DtWaterOnScreen::myNumActiveDrops

protected

DtGridCell makVrv::DtWaterOnScreen::myGrid[GRID_DIMENSION][GRID_DIMENSION]

protected

DtGlProgram* makVrv::DtWaterOnScreen::myNormalMapCombineProgram

protected

The various normal map mod programs.

bool makVrv::DtWaterOnScreen::myNormalMapCombineProgramTriedOnce

protected

DtGlProgram* makVrv::DtWaterOnScreen::myNormalMapFinalizeProgram

protected

bool makVrv::DtWaterOnScreen::myNormalMapFinalizeProgramTriedOnce

protected

DtGlTexture* makVrv::DtWaterOnScreen::myNormalMap

protected

The generated normal map texture.

DtGlBuffer* makVrv::DtWaterOnScreen::myNormalMapBuffer

protected

The gpu buffer representing the interim normal map (ssbo)

DtGlBuffer* makVrv::DtWaterOnScreen::myPrecomputedDropletNormalsBuffer

protected

The gpu buffer representing the constant pre-computed droplet normals.

bool makVrv::DtWaterOnScreen::myPrecomputedDropletNormalsBufferDirty

protected

DtGlBuffer* makVrv::DtWaterOnScreen::myPrecomputedSplashNormalsBuffer

protected

The gpu buffer representing the constant pre-computed splash normals.

bool makVrv::DtWaterOnScreen::myPrecomputedSplashNormalsBufferDirty

protected

GridCell makVrv::DtWaterOnScreen::myGridCells[GRID_DIMENSION][GRID_DIMENSION]

protected

The grid cells that end up into the gpu buffer next.

DtGlBuffer* makVrv::DtWaterOnScreen::myCellsBuffer

protected

The cells' buffer on the gpu (ssbo)

DtVector4<unsigned int> makVrv::DtWaterOnScreen::myZeroNormals[TEXSIZE][TEXSIZE]

protected

The zero normals buffer (used to clear the normal map to zero)

osg::ref_ptr<DtWaterOnScreenDrawable> makVrv::DtWaterOnScreen::myWaterOnScreenDrawable

protected

double makVrv::DtWaterOnScreen::theWaterOnScreenSize

static

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvPostProcessor/DtWaterOnScreenEffect.h

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation