OpenWalnut  1.4.0
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes
WGEPostprocessingNode Class Reference

This class enables you to add arbitrary nodes that get post-processed in screen space. More...

#include <WGEPostprocessingNode.h>

+ Inheritance diagram for WGEPostprocessingNode:

List of all members.

Public Types

typedef osg::ref_ptr
< WGEPostprocessingNode
RefPtr
 Convenience typedef for an osg::ref_ptr.
typedef osg::ref_ptr< const
WGEPostprocessingNode
ConstRefPtr
 Convenience typedef for an osg::ref_ptr; const.

Public Member Functions

 WGEPostprocessingNode (osg::ref_ptr< WGECamera > reference, size_t width=2048, size_t height=2048, bool noHud=false)
 Create a new post-processing node.
virtual ~WGEPostprocessingNode ()
 Destructor.
WPropGroup getProperties () const
 Returns the set of properties controlling the post-processing node.
void insert (osg::ref_ptr< osg::Node > node, WGEShader::RefPtr shader=NULL)
 Inserts a node to the post-processor and injects the needed code to the specified shader.
void remove (osg::ref_ptr< osg::Node > node)
 Removes the node from the post-processing.
void clear ()
 Removes all associated nodes.
WGEPostprocessor::SPtr getCurrentPostprocessor () const
 The post processor currently in use.

Private Types

typedef
WSharedAssociativeContainer
< std::map< osg::ref_ptr
< osg::Node >, std::pair
< WGEShader::RefPtr,
WGEShaderPreprocessor::SPtr > > > 
NodeShaderAssociation
 This type is used to actually store the association between a node and its associated shader and custom preprocessor.

Private Member Functions

void postprocessorSelected ()
 Callback for changes in m_activePostprocessor.

Private Attributes

NodeShaderAssociation m_nodeShaderAssociation
 List of nodes and their corresponding shader and preprocessor.
osg::ref_ptr< WGEGroupNodem_childs
 The group of child nodes to post-process.
WPropGroup m_properties
 All the properties of the post-processor.
WPropBool m_active
 If true, post-processing is enabled.
WPropBool m_showHud
 Activate to show the texture HUDs.
WPropSelection m_activePostprocessor
 The property containing the currently active method or a combination.
WGEPostprocessor::ProcessorList m_postprocs
 The postprocessors.

Detailed Description

This class enables you to add arbitrary nodes that get post-processed in screen space.

The only thing you need to take care of is your shader. You need some special parts in it. Please see the all-in-one super-shader-example module WMShaderExample in modules/template.

Notes:
Although this is an osg::Switch node, you should avoid using its inherited API unless you know what you do. Using the osg::Switch API might be useful for those who want to modify the post-processing pipeline.

Definition at line 54 of file WGEPostprocessingNode.h.


Member Typedef Documentation

Convenience typedef for an osg::ref_ptr; const.

Definition at line 65 of file WGEPostprocessingNode.h.

typedef WSharedAssociativeContainer< std::map< osg::ref_ptr< osg::Node >, std::pair< WGEShader::RefPtr, WGEShaderPreprocessor::SPtr > > > WGEPostprocessingNode::NodeShaderAssociation [private]

This type is used to actually store the association between a node and its associated shader and custom preprocessor.

Definition at line 141 of file WGEPostprocessingNode.h.

Convenience typedef for an osg::ref_ptr.

Definition at line 60 of file WGEPostprocessingNode.h.


Constructor & Destructor Documentation

WGEPostprocessingNode::WGEPostprocessingNode ( osg::ref_ptr< WGECamera reference,
size_t  width = 2048,
size_t  height = 2048,
bool  noHud = false 
)

Create a new post-processing node.

It uses the WGEOffscreenRenderNode to setup an offscreen, shader-based post-processing for rendered images. This is not limited to geometry but can also be used for ray-traced images.

Notes:
The width and hight define the offscreen texture size. The viewport if each rendering is automatically set to the one of the reference camera. This means, width and height only define the maximal supported resolution without upscaling of your postprocessor.
Parameters:
referencecamera used as reference
widththe width of the textures used in this rendering. Must be in [8,4096] and a power of two.
heightthe height of the textures used in this rendering. Must be in [8,4096] and a power of two.
noHudIf true, no hud gets displayed showing the created and used textures.

Definition at line 36 of file WGEPostprocessingNode.cpp.

References WPropertyHelper::PC_SELECTONLYONE::addTo(), WPropertyHelper::PC_NOTEMPTY::addTo(), WGEPostprocessor::PostprocessorInput::attach(), WGEPostprocessor::getPostprocessors(), m_active, m_activePostprocessor, m_childs, WGEPostprocessor::PostprocessorInput::m_depthTexture, m_postprocs, m_properties, m_showHud, and postprocessorSelected().

Destructor.

Definition at line 111 of file WGEPostprocessingNode.cpp.


Member Function Documentation

Removes all associated nodes.

Notes:
this is thread-safe and can be done from every thread

Definition at line 159 of file WGEPostprocessingNode.cpp.

References WSharedObject< T >::getWriteTicket(), m_childs, and m_nodeShaderAssociation.

The post processor currently in use.

Returns:
the current post processor

Definition at line 175 of file WGEPostprocessingNode.cpp.

References m_activePostprocessor, and m_postprocs.

Returns the set of properties controlling the post-processing node.

You can use them to provide them to the user for example.

Returns:
the properties as a group.

Definition at line 116 of file WGEPostprocessingNode.cpp.

References m_properties.

void WGEPostprocessingNode::insert ( osg::ref_ptr< osg::Node >  node,
WGEShader::RefPtr  shader = NULL 
)

Inserts a node to the post-processor and injects the needed code to the specified shader.

See class documentation for further details on how the shader gets modified. If you are using an group node, be yourself aware that all nodes in this group need to have the same shader! If not, post-processing will not work properly.

Notes:
this is thread-safe and can be done from every thread
Notes:
it does NOT apply the shader.
Parameters:
nodethe node to post-process
shaderthe shader used for the node

Definition at line 121 of file WGEPostprocessingNode.cpp.

References WSharedObject< T >::getWriteTicket(), m_active, m_childs, and m_nodeShaderAssociation.

Callback for changes in m_activePostprocessor.

Definition at line 180 of file WGEPostprocessingNode.cpp.

References m_active, m_activePostprocessor, and m_postprocs.

Referenced by WGEPostprocessingNode().

void WGEPostprocessingNode::remove ( osg::ref_ptr< osg::Node >  node)

Removes the node from the post-processing.

If it is not in the post-processing pipeline, nothing happens.

Notes:
this is thread-safe and can be done from every thread
Parameters:
nodethe node to remove

Definition at line 140 of file WGEPostprocessingNode.cpp.

References WSharedObject< T >::getWriteTicket(), m_childs, and m_nodeShaderAssociation.


Member Data Documentation

WPropBool WGEPostprocessingNode::m_active [private]

If true, post-processing is enabled.

Definition at line 161 of file WGEPostprocessingNode.h.

Referenced by insert(), postprocessorSelected(), and WGEPostprocessingNode().

The property containing the currently active method or a combination.

Definition at line 171 of file WGEPostprocessingNode.h.

Referenced by getCurrentPostprocessor(), postprocessorSelected(), and WGEPostprocessingNode().

osg::ref_ptr< WGEGroupNode > WGEPostprocessingNode::m_childs [private]

The group of child nodes to post-process.

Definition at line 151 of file WGEPostprocessingNode.h.

Referenced by clear(), insert(), remove(), and WGEPostprocessingNode().

List of nodes and their corresponding shader and preprocessor.

Definition at line 146 of file WGEPostprocessingNode.h.

Referenced by clear(), insert(), and remove().

The postprocessors.

Definition at line 176 of file WGEPostprocessingNode.h.

Referenced by getCurrentPostprocessor(), postprocessorSelected(), and WGEPostprocessingNode().

All the properties of the post-processor.

Definition at line 156 of file WGEPostprocessingNode.h.

Referenced by getProperties(), and WGEPostprocessingNode().

WPropBool WGEPostprocessingNode::m_showHud [private]

Activate to show the texture HUDs.

Definition at line 166 of file WGEPostprocessingNode.h.

Referenced by WGEPostprocessingNode().


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