This class provides the OSG-specific implementation of a post processor. More...

Inheritance diagram for makVrv::DtPostProcessor:

Public Member Functions
	DtPostProcessor (const std::string &postProcessType, bool handles2D)
	CTOR.
virtual	~DtPostProcessor ()
	DTOR.
virtual void	setFragmentShaderSource (const char *source)
	Sets fragment shader source for this post-processor.
virtual void	setVertexShaderSource (const char *source)
	Sets vertex shader source for this post-processor.
virtual void	setFragmentShaderFile (const std::string &fileName)
	Sets fragment shader file for this post-processor.
virtual void	setVertexShaderFile (const std::string &fileName)
	Sets vertex shader file for this post-processor.
virtual void	setInputTexture (const DtChannel channel, osg::Texture2D 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.
virtual bool	update (DtChannel *channel)=0
	Called once per frame, per channel.
virtual osg::Texture2D *	outputTexture ()
	Gets the output texture of this post processor, for use in chaining processors together.
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.
virtual osg::Camera *	cameraForChannel (const DtChannel *channel)
	Gets the Camera node associated with this effect and channel.
virtual void	releaseGLObjects ()
virtual bool	hasEffect (const std::string &effect)
	Does this post processor support this effect?
virtual bool	effectEnabled (const std::string &effect)
	Is this effect (post processor sub-component) enabled?
virtual bool	anyEffectEnabled ()
	Are any effects enabled?
virtual std::list< std::string >	supportedEffects ()
	Get a list of supported effects for this post processor.
virtual bool	handles2D () const
	Retrieves whether this post processor should be used in 2D orthographic views, as specified in its constructor.
virtual const std::string &	type () const
	Gets the type of the post processor.
virtual bool	postProcessorEnabled () const
	Is this post processor enabled?

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

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

Protected Types
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

Protected Member Functions
virtual bool	effectItrEnabled (EffectMap::iterator &effect)
virtual void	initialize ()
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.
virtual void	setEnablePostProcessor (bool enabled)
	Set the post processor enabled state (true = enabled)

Protected Attributes
osg::ref_ptr< osg::Texture2D >	myOutputTexture
osg::ref_ptr< osg::Texture2D >	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

Friends
class	DtPostProcessManager

Detailed Description

This class provides the OSG-specific implementation of a post processor.

A post processor has a type (ex. "wateronscreen") and a list of effects which are components that can be turned on or off (ex. "oceanspray", "rainsplash"). A post processor should register at least one effect. The post processor order is created in the DtPostProcessorFactory On channel creation, the DtPostProcessManagerInterface will create an instance of each post processor added to the factory's post processor list.

Member Typedef Documentation

typedef boost::unordered_map<std::string, bool> makVrv::DtPostProcessor::EffectMap

protected

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

protected

typedef osg::ref_ptr<DtPostProcessorCullVistorCallback> makVrv::DtPostProcessor::CallbackRefPtr

protected

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

protected

Constructor & Destructor Documentation

makVrv::DtPostProcessor::DtPostProcessor	(	const std::string &	postProcessType,
		bool	handles2D
	)

CTOR.

Parameters

handles2D Whether this post processor should be used in 2D orthographic views.

virtual makVrv::DtPostProcessor::~DtPostProcessor ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtPostProcessor::setFragmentShaderSource ( const char * source )

virtual

Sets fragment shader source for this post-processor.

The following uniforms will be automatically set for you: sampler2D inputImage; float aspectRatio; // (width over height) float fovy; // Vertical field of view (radians)

virtual void makVrv::DtPostProcessor::setVertexShaderSource ( const char * source )

virtual

Sets vertex shader source for this post-processor.

The following uniforms will be automatically set for you: sampler2D inputImage; float aspectRatio; // (width over height) float fovy; // Vertical field of view (radians)

virtual void makVrv::DtPostProcessor::setFragmentShaderFile ( const std::string & fileName )

virtual

Sets fragment shader file for this post-processor.

The following uniforms will be automatically set for you: sampler2D inputImage; float aspectRatio; // (width over height) float fovy; // Vertical field of view (radians)

virtual void makVrv::DtPostProcessor::setVertexShaderFile ( const std::string & fileName )

virtual

Sets vertex shader file for this post-processor.

The following uniforms will be automatically set for you: sampler2D inputImage; float aspectRatio; // (width over height) float fovy; // Vertical field of view (radians)

virtual void makVrv::DtPostProcessor::setInputTexture	(	const DtChannel *	channel,
		osg::Texture2D *	texture
	)

virtual

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.

Managed by the DtPostProcessManager, you shouldn't need to call this yourself.

Reimplemented in makVrv::DtHdrPostProcessor.

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

pure virtual

Called once per frame, per channel.

Implemented in makVrv::DtSenSimPostProcessor, makVrv::DtWaterOnScreen, makVrv::DtHdrPostProcessor, makVrv::DtVirtualRealityPostProcessor, makVrv::DtDepthOfField, makVrv::DtVolumetricLighting, and makVrv::DtReverseDepthBuffer.

virtual osg::Texture2D* makVrv::DtPostProcessor::outputTexture ( )

virtual

Gets the output texture of this post processor, for use in chaining processors together.

It may be null if this is the last post processor, rendering directly to the frame buffer.

Reimplemented in makVrv::DtVolumetricLighting.

virtual void makVrv::DtPostProcessor::setIsFinalEffect	(	const DtChannel *	channel,
		bool	final
	)

virtual

Called by the DtPostProcessManager to indicate if this is the last post processor in the chain, and should render to the framebuffer.

virtual osg::Camera* makVrv::DtPostProcessor::cameraForChannel ( const DtChannel * channel )

virtual

Gets the Camera node associated with this effect and channel.

Use their statesets to set shader uniforms for your effect.

virtual void makVrv::DtPostProcessor::releaseGLObjects ( )

virtual

virtual bool makVrv::DtPostProcessor::hasEffect ( const std::string & effect )

virtual

Does this post processor support this effect?

virtual bool makVrv::DtPostProcessor::effectEnabled ( const std::string & effect )

virtual

Is this effect (post processor sub-component) enabled?

virtual bool makVrv::DtPostProcessor::anyEffectEnabled ( )

virtual

Are any effects enabled?

virtual bool makVrv::DtPostProcessor::enableEffect ( const std::string & effect )

virtual

Enable a particular post processing technique For example, "wateroncamera" has techniques "rainsplash", "oceanspray", and "wavesplash".

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

virtual

virtual std::list<std::string> makVrv::DtPostProcessor::supportedEffects ( )

virtual

Get a list of supported effects for this post processor.

virtual bool makVrv::DtPostProcessor::handles2D ( ) const

virtual

Retrieves whether this post processor should be used in 2D orthographic views, as specified in its constructor.

virtual const std::string& makVrv::DtPostProcessor::type ( ) const

virtual

Gets the type of the post processor.

virtual void makVrv::DtPostProcessor::enablePostProcessor ( )

virtual

Enable or disable the post processor.

virtual void makVrv::DtPostProcessor::disablePostProcessor ( )

virtual

virtual bool makVrv::DtPostProcessor::postProcessorEnabled ( ) const

virtual

Is this post processor enabled?

Reimplemented in makVrv::DtHdrPostProcessor, and makVrv::DtVolumetricLighting.

virtual bool makVrv::DtPostProcessor::effectItrEnabled ( EffectMap::iterator & effect )

protectedvirtual

Reimplemented in makVrv::DtHdrPostProcessor, and makVrv::DtVolumetricLighting.

virtual void makVrv::DtPostProcessor::initialize ( )

protectedvirtual

Reimplemented in makVrv::DtWaterOnScreen.

virtual void makVrv::DtPostProcessor::addEffect ( std::string effect )

protectedvirtual

When constructing a post processor, add the names of the sub-components (effects) that can be enabled and disabled.

virtual void makVrv::DtPostProcessor::setEnablePostProcessor ( bool enabled )

protectedvirtual

Set the post processor enabled state (true = enabled)

Friends And Related Function Documentation

friend class DtPostProcessManager

friend

Member Data Documentation

osg::ref_ptr<osg::Texture2D> makVrv::DtPostProcessor::myOutputTexture

protected

osg::ref_ptr<osg::Texture2D> makVrv::DtPostProcessor::myInputTexture

protected

osg::ref_ptr<osg::Program> makVrv::DtPostProcessor::myProgram

protected

osg::ref_ptr<osg::Shader> makVrv::DtPostProcessor::myFragmentShader

protected

osg::ref_ptr<osg::Shader> makVrv::DtPostProcessor::myVertexShader

protected

osg::ref_ptr<osg::Geode> makVrv::DtPostProcessor::myQuad

protected

CameraMap makVrv::DtPostProcessor::myCameraMap

protected

bool makVrv::DtPostProcessor::myHandles2DFlag

protected

bool makVrv::DtPostProcessor::myEnabledFlag

protected

std::string makVrv::DtPostProcessor::myType

protected

EffectMap makVrv::DtPostProcessor::myEffects

protected

CallbackMap makVrv::DtPostProcessor::myCullCallbackMap

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvPostProcessor/DtPostProcessor.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation