AmbientOcclusionNode::AmbientOcclusionNode Class Reference

Class implementing Screen Space Ambient Occlusion operations. More...

#include <AmbientOcclusionNode.h>

Inheritance diagram for AmbientOcclusionNode::AmbientOcclusionNode:

Collaboration diagram for AmbientOcclusionNode::AmbientOcclusionNode:

Public Member Functions
	AmbientOcclusionNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the AmbientOcclusionNode class.
virtual	~AmbientOcclusionNode ()
	Destructor of the AmbientOcclusionNode class.
void	redrawTriggered ()
	Redraw of ogre scene has been triggered.
Public Member Functions inherited from Frapper::CompositorNode
	CompositorNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the CompositorNode class.
virtual	~CompositorNode ()
	Destructor of the CompositorNode class.
Public Member Functions inherited from Frapper::RenderNode
	RenderNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the RenderNode class.
virtual	~RenderNode ()
	Destructor of the RenderNode class.
unsigned int	getWidth () const
	Returns the width of the render target.
unsigned int	getHeight () const
	Returns the height of the render target.
Public Member Functions inherited from Frapper::ImageNode
	ImageNode (const QString &name, ParameterGroup *parameterRoot, bool cacheEnabled=true, const QString &outputImageName="Image")
	Constructor of the ImageNode class.
virtual	~ImageNode ()
	Destructor of the ImageNode class.
virtual Ogre::TexturePtr	getImage ()
	Returns the image that is generated by this node.
bool	isCached (int index) const
	Returns whether a cached image is available for the frame with the given index.
Ogre::Image *	getCachedImage (int index) const
	Returns the image cached for the frame with the given index.
Public Member Functions inherited from Frapper::ViewNode
	ViewNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the ViewNode class.
virtual	~ViewNode ()
	Destructor of the ViewNode class.
unsigned int	getStageIndex () const
	Returns the index of the stage in which this node is contained.
bool	isViewed () const
	Returns whether the result of this node should be displayed in the viewport.
virtual Ogre::SceneNode *	getSceneNode ()
	Returns the scene node that contains scene objects created or modified by this node.
Public Member Functions inherited from Frapper::CurveEditorDataNode
	CurveEditorDataNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the CurveEditorDataNode class.
virtual	~CurveEditorDataNode ()
	Destructor of the CurveEditorDataNode class.
ParameterGroup *	getCurveEditorGoup () const
	Public Functions.
void	setCurveEditorGoup (ParameterGroup *parameterGroup)
Public Member Functions inherited from Frapper::Node
	Node (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the Node class.
virtual	~Node ()
	Destructor of the Node class.
virtual void	run (const QString &parameterName)
	Execute function for threading.
virtual bool	process (const QString &parameterName)
	Processes the node's input data to generate the data for the parameter with the given name.
bool	getTypeUnknown () const
Parameter *	getTimeParameter () const
	Returns the actual timeline intex.
QString	getName () const
	Returns the name of the node. The name must be unique in the node network so that each node object can be uniquely identified by its name.
void	setName (const QString &name)
	Sets the name of the node. The name must be unique in the node network so that each node object can be uniquely identified by its name.
QString	getTypeName () const
	Returns the name of the node's type.
void	setTypeName (const QString &typeName)
	Set the name of the node's type.
bool	isTypeUnknown () const
	Returns whether a plugin for the node's type is available.
void	setTypeUnknown (bool typeUnknown=true)
	Sets the flag that indicates whether a plugin for the node's type is available.
bool	isEvaluated () const
	Returns whether this node should be evaluated in the network.
bool	isSelected () const
	Returns whether this node is currently selected.
virtual void	setSelected (bool selected)
	Sets whether this node is currently selected.
bool	isSelfEvaluating () const
	Returns whether the node is self-evaluating.
bool	isSaveable () const
	Returns whether the node is saveable.
void	setSelfEvaluating (bool selfEvaluating)
	Sets whether the node is self-evaluating.
void	setSaveable (bool saveable)
	Sets whether the node is saveable.
QString	getSearchText () const
	Returns the search text currently set for the node.
void	setSearchText (const QString &searchText)
	Sets the text to use when filtering parameters of the node before creating editing widgets in a parameter editor panel.
ParameterGroup *	getParameterRoot () const
	Returns the root of the tree of parameters and parameter groups for the node.
ParameterGroup *	getParameterGroup (const QString &name) const
	Returns the parameter group with the given name.
void	fillParameterLists (AbstractParameter::List *inputParameters, AbstractParameter::List *outputParameters)
	Iterates over the children of the parameter root and fills the given lists with input and output parameters and parameter groups containing input and output parameters.
void	fillParameterLists (AbstractParameter::List *connectedInputParameters, AbstractParameter::List *connectedOutputParameters, bool *unconnectedInputParametersAvailable, bool *unconnectedOutputParametersAvailable)
	Iterates over the children of the parameter root and fills the given lists with connected input and output parameters and parameter groups containing connected input and output parameters.
AbstractParameter::List	getParameters (Parameter::PinType pinType, bool connected, ParameterGroup *parameterGroup=0)
	Returns a list of parameters contained in the given parameter group that are of the given pin type and that are connected or not.
bool	hasParameter (const QString &name) const
	Returns whether the node contains a parameter with the given name.
Parameter *	getParameter (const QString &name) const
	Returns the parameter with the given name.
NumberParameter *	getNumberParameter (const QString &name) const
	Returns the number parameter with the given name.
FilenameParameter *	getFilenameParameter (const QString &name) const
	Returns the filename parameter with the given name.
EnumerationParameter *	getEnumerationParameter (const QString &name) const
	Returns the enumeration parameter with the given name.
GeometryParameter *	getGeometryParameter (const QString &name) const
	Returns the geometry parameter with the given name.
LightParameter *	getLightParameter (const QString &name) const
	Returns the light parameter with the given name.
CameraParameter *	getCameraParameter (const QString &name) const
	Returns the camera parameter with the given name.
void	setDirty (const QString &name, bool dirty)
	Sets the dirty state of the parameter with the given name to the given state.
void	setDirty (bool dirty)
	Sets the dirty state of the node and all child parameters.
void	setNodeDirty (bool dirty)
	Sets the dirty state of the node.
bool	isNodeDirty ()
	Returns the dirty state of the node.
void	removeParameter (const QString &name, bool diveInGroups=true)
	Removes and deletes the parameter with the given name.
void	removeParameter (Parameter *parameter, bool diveInGroups=true)
	Removes and deletes the given parameter.
void	addAffection (const QString &parameterName, const QString &affectedParameterName)
	Adds a affection between two parameters.
QVariant	getValue (const QString &name, bool triggerEvaluation=false)
	Returns the value of the parameter with the given name while optionally triggering the evaluation chain.
bool	getBoolValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of a boolean parameter while optionally triggering the evaluation chain.
int	getIntValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of an integer parameter while optionally triggering the evaluation chain.
unsigned int	getUnsignedIntValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of an unsigned integer parameter while optionally triggering the evaluation chain.
float	getFloatValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of a 32bit-precision floating point parameter while optionally triggering the evaluation chain.
double	getDoubleValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of a double-precision floating point parameter while optionally triggering the evaluation chain.
QString	getStringValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of a string parameter while optionally triggering the evaluation chain.
QColor	getColorValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of a color parameter while optionally triggering the evaluation chain.
Ogre::Vector3	getVectorValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of an OGRE vector parameter while optionally triggering the evaluation chain.
Ogre::SceneNode *	getSceneNodeValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of a scene node parameter while optionally triggering the evaluation chain.
Ogre::TexturePtr	getTextureValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of an OGRE texture parameter while optionally triggering the evaluation chain.
ParameterGroup *	getGroupValue (const QString &name, bool triggerEvaluation=false)
	Convenience function for getting the value of a parameter group parameter while optionally triggering the evaluation chain.
void	setValue (const QString &name, const QVariant &value, bool triggerDirtying=false)
	Sets the value of the parameter with the given name to the given value while optionally triggering the dirtying chain.
void	setValue (const QString &name, bool value, bool triggerDirtying=false)
	Convenience function for setting the value of a boolean parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, int value, bool triggerDirtying=false)
	Convenience function for setting the value of an integer parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, unsigned int value, bool triggerDirtying=false)
	Convenience function for setting the value of an unsigned integer parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, double value, bool triggerDirtying=false)
	Convenience function for setting the value of a double-precision floating point parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, char *value, bool triggerDirtying=false)
	Convenience function for setting the value of a string parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, const char *value, bool triggerDirtying=false)
	Convenience function for setting the value of a string parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, const QString &value, bool triggerDirtying=false)
	Convenience function for setting the value of a string parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, const QColor &value, bool triggerDirtying=false)
	Convenience function for setting the value of a color parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, const Ogre::Vector3 &value, bool triggerDirtying=false)
	Convenience function for setting the value of an OGRE vector parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, Ogre::SceneNode *value, bool triggerDirtying=false)
	Convenience function for setting the value of a scene node parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, const Ogre::TexturePtr value, bool triggerDirtying=false)
	Convenience function for setting the value of an OGRE texture parameter while optionally triggering the dirtying chain.
void	setValue (const QString &name, ParameterGroup *value, bool triggerDirtying=false)
	Convenience function for setting the value of a parameter group parameter while optionally triggering the dirtying chain.
void	setParameterEnabled (const QString &name, bool enabled)
	Convenience function for setting the enabled flag of a string parameter.
void	setChangeFunction (const QString &name, const char *changeFunction)
	Sets the function to call when a parameter's value changes.
void	setProcessingFunction (const QString &name, const char *processingFunction)
	Sets the function to use for computing a parameter's value.
void	setAuxProcessingFunction (const QString &name, const char *processingFunction)
	Sets the auxiliary function to use for computing a parameter's value.
void	setCommandFunction (const QString &name, const char *commandFunction)
	Sets the function to use for executing the command represented by a parameter.
void	setOnConnectFunction (const QString &name, const char *onConnectFunction)
	Sets the function which should be called on parameter's connection.
void	setOnDisconnectFunction (const QString &name, const char *onDisconnectFunction)
	Sets the function which should be called on parameter's disconnection.
void	notifyChange ()
	Notify when something has changed in the node. (Parameters added/deleted)
virtual void	setUpTimeDependencies (Parameter *timeParameter)
	Sets up time dependencies for node parameters.
virtual void	evaluateConnection (Connection *connection)
	Evaluates the given new connection for the node.
void	deleteConnection (Connection *connection)
	Signal that is emitted in order to delete a connection (through SceneModel)
void	renderSingleFrame ()
	Render a single frame.

Protected Member Functions
virtual void	notifyMaterialRender (Ogre::uint32 pass_id, Ogre::MaterialPtr &mat)
	Callback when instance of this class is registered as Ogre::CompositorListener.
Protected Member Functions inherited from Frapper::CompositorNode
virtual void	resizeRenderTexture (int width, int height, Ogre::PixelFormat pixelFormat=Ogre::PF_R8G8B8)
	Resizes the main render texture (m_renderTexture).
Ogre::GpuProgramParametersSharedPtr	getShaderParameters (Ogre::MaterialPtr &mat)
	Get shader parameters.
void	setTexture (Ogre::MaterialPtr &mat, Ogre::TexturePtr texture, unsigned int slot)
	Assign texture to texture slot.
void	setShaderParameter (Ogre::GpuProgramParametersSharedPtr fpParams, Ogre::String name, int value)
	Set integer shader parameter.
void	setShaderParameter (Ogre::GpuProgramParametersSharedPtr fpParams, Ogre::String name, Ogre::Real value)
	Set float shader parameter.
void	setShaderParameter (Ogre::GpuProgramParametersSharedPtr fpParams, Ogre::String name, Ogre::Vector2 vector)
	Set vector with 2 components shader parameter.
void	setShaderParameter (Ogre::GpuProgramParametersSharedPtr fpParams, Ogre::String name, Ogre::Vector3 vector)
	Set vector (3 components) shader parameter.
void	setShaderParameter (Ogre::GpuProgramParametersSharedPtr fpParams, Ogre::String name, Ogre::Vector4 vector)
	Set vector (4 components) shader parameter.
void	setShaderParameter (Ogre::GpuProgramParametersSharedPtr fpParams, Ogre::String name, Ogre::Matrix4 matrix)
	Set matrix (4x4 components) shader parameter.
Protected Member Functions inherited from Frapper::RenderNode
Ogre::String	generateTexture (const QString &name, Ogre::TextureType texType, Ogre::uint width, Ogre::uint height, int num_mips, Ogre::PixelFormat format, int usage=Ogre::TU_DEFAULT)
	Generates a Ogre RenderTexture by using the createManual(...) function.
void	initializeRenderTarget (Ogre::Camera *cam, Ogre::ColourValue bkColor=Ogre::ColourValue(0, 0, 0), Ogre::PixelFormat format=Ogre::PF_R8G8B8, bool clearFrame=true, int fsaa=4)
	Create a viewport for all RenderTextures (RenderTargets) in m_textureHash.
void	initializeRenderTargetsInHash (Ogre::Camera *cam=0, bool clearFrame=true)
	Create a viewport for all RenderTextures (RenderTargets) in m_textureHash.
void	initializeAllTargets (Ogre::Camera *cam)
	Initializes all textures.
void	resizeAllTargets (int width, int height)
	Resizes all textures.
void	resizeAllTexturesInHash (int width, int height)
	Resizes all textures in m_textureHash.
void	resizeRenderTexture (int width, int height, Ogre::PixelFormat pixelFormat=Ogre::PF_R8G8B8, int fsaa=4)
	Resizes the main render texture (m_renderTexture).
void	finalizeRenderTargets ()
	Clean up all textures.
void	removeRenderTexture (Ogre::TexturePtr &texture)
	Clean up the render texture.
void	removeViewportsFromRenderTargets ()
	Remove all viewports from the rendertargets of all textures in the m_textureHash.
Protected Member Functions inherited from Frapper::ImageNode
void	setNumberOfImagesToCache (unsigned int numberOfImagesToCache)
	Sets the number of images to cache to the given value.
Ogre::Image *	createImageFromTexture (Ogre::TexturePtr texturePointer)
	Creates an image from the given texture.
void	cacheImage (int index, Ogre::Image *image)
	Stores the given image in the cache for the frame with the given index.
void	setOutputImage (Ogre::Image *image)
	Sets the given image as the output image in the output image parameter.
Protected Member Functions inherited from Frapper::ViewNode
void	addOutputParameter (Parameter *outputParameter)
	Adds the given parameter as output parameter to this view node.
void	removeOutputParameter (Parameter *outputParameter)
	Removes the given parameter as output parameter from this view node.
void	requestRedraw ()
	Request a redraw of the current ogre scene.
Protected Member Functions inherited from Frapper::CurveEditorDataNode
void	clearDatabase ()
	Clears all data from the motion data database.
Protected Member Functions inherited from Frapper::Node
Ogre::String	createUniqueName (const QString &objectName)
	Creates a unique name from the given object name by adding the Node number.
virtual void	finalize ()

Private Slots
void	processOutputImage ()
	Processes the node's input data to generate the node's output image.

Additional Inherited Members
Public Slots inherited from Frapper::RenderNode
void	setTargetMultiplier ()
	Set the multiplier for the render targets.
Signals inherited from Frapper::ViewNode
void	triggerRedraw ()
	Trigger redraw of ogre scene.
void	viewSet (unsigned int stageIndex, ViewNode *viewNode)
	Signal that is emitted when the view flag of this node has been set.
void	viewNodeUpdated ()
	Signal that is emitted when the currently viewed view node has been updated.
Static Public Attributes inherited from Frapper::ImageNode
static const int	NumberUnknown = -1
	A constant value indicating that the number of images (to cache) is not known yet.
Protected Slots inherited from Frapper::CompositorNode
virtual void	reload ()
	Reload resources.
Protected Attributes inherited from Frapper::CompositorNode
Ogre::CompositorInstance *	m_compositor
	The compositor to use for rendering.
QString	m_resourceGroupName
	The resource group name.
Static Protected Attributes inherited from Frapper::RenderNode
static const QString	BackgroundColorParameterName
	The name of the background color parameter.
static const int	DefaultRenderWidth = 1200
	The default render width.
static const int	DefaultRenderHeight = 720
	The default render height.
static float	DefaultGamma = 2.2f
	The default gamma.
static QStringList	resLiterals = QStringList() << "4x" << "2x" << "none" << "1/2" << "1/4" << "1/8"
	The default resolution multiplier literals.
static QStringList	resValues = QStringList() << "4.0" << "2.0" << "1.0" << "0.5" << "0.25" << "0.125"
	The default resolution multiplier values.

Detailed Description

Class implementing Screen Space Ambient Occlusion operations.

Constructor & Destructor Documentation

AmbientOcclusionNode::AmbientOcclusionNode::AmbientOcclusionNode	(	const QString &	name,
		ParameterGroup *	parameterRoot
	)

Constructor of the AmbientOcclusionNode class.

Constructors and Destructors.

Parameters

name	The name for the new node.
parameterRoot	A copy of the parameter tree specific for the type of the node.

Constructor of the AqtBlendNode class.

Parameters

name	The name for the new node.
parameterRoot	A copy of the parameter tree specific for the type of the node.

AmbientOcclusionNode::AmbientOcclusionNode::~AmbientOcclusionNode ( )

virtual

Destructor of the AmbientOcclusionNode class.

Destructor of the AqtBlendNode class.

Defined virtual to guarantee that the destructor of a derived class will be called if the instance of the derived class is saved in a variable of its parent class type.

Member Function Documentation

void AmbientOcclusionNode::AmbientOcclusionNode::notifyMaterialRender ( Ogre::uint32  pass_id, Ogre::MaterialPtr &  mat  )

protectedvirtual

Callback when instance of this class is registered as Ogre::CompositorListener.

Protected Functions.

Parameters

pass_id	Id to identifiy current compositor pass.
mat	Material this pass is currently using.

Callback when instance of this class is registered as Ogre::CompositorListener.

Parameters

pass_id	Id to identifiy current compositor pass.
mat	Material this pass is currently using.

Reimplemented from Frapper::CompositorNode.

void AmbientOcclusionNode::AmbientOcclusionNode::redrawTriggered ( )

virtual

Redraw of ogre scene has been triggered.

Reimplemented from Frapper::RenderNode.

void AmbientOcclusionNode::AmbientOcclusionNode::processOutputImage ( )

privateslot

Processes the node's input data to generate the node's output image.

Private Slots.

---

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

• AmbientOcclusionNode.h
• AmbientOcclusionNode.cpp