Class for a basic render node. More...

#include <SimpleRenderNode.h>

Inheritance diagram for SimpleRenderNode::SimpleRenderNode:

[legend]

Collaboration diagram for SimpleRenderNode::SimpleRenderNode:

[legend]

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

Public Member Functions
	SimpleRenderNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the SimpleRenderNode class.

virtual	~SimpleRenderNode ()
	Destructor of the SimpleRenderNode class.

Public Member Functions inherited from Frapper::GeometryRenderNode
	GeometryRenderNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the GeometryRenderNode class.

virtual	~GeometryRenderNode ()
	Destructor of the GeometryRenderNode 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 Attributes
Ogre::Light *	m_sceneLight

Ogre::Image	m_defaultTextureImage

Ogre::Camera *	m_cameraCopy
	Camera for RenderNode scene.

Protected Attributes inherited from Frapper::GeometryRenderNode
Ogre::SceneNode *	m_cameraSceneNode
	The camera's scene node.

Ogre::SceneNode *	m_lightSceneNode
	The light's scene node.

Protected Attributes inherited from Frapper::RenderNode
Parameter *	m_outputParameter
	The Pointer to the Parameter containing the main render target.

Ogre::SceneManager *	m_sceneManager
	The scene manager for building the scene to render.

Ogre::Viewport *	m_viewport
	The viewport.

Ogre::Camera *	m_camera
	The renderer's own camera.

Ogre::TexturePtr	m_renderTexture
	The renderer's render texture.

Ogre::String	m_renderTextureName
	The render texture name.

int	m_renderWidth
	The width of the image to render.

int	m_renderHeight
	The height of the image to render.

float	m_targetMultiplier
	The multiplier for the render target size.

Ogre::TexturePtr	m_defaultTexture
	The default texture.

QHash< QString, Ogre::TexturePtr >	m_textureHash
	Qt map of Ogre textures.

QHash< QString, Ogre::Viewport * >	m_viewportHash
	Qt hash of Ogre viewports.

QList< QString >	m_outParameterNameList
	Qt hash of output parameter names.

Protected Attributes inherited from Frapper::ImageNode
bool	m_cacheEnabled
	Flag that states whether the image cache for this node is enabled.

bool	m_cacheInvalid
	Flag that states whether the cache is invalid and should be cleared.

QString	m_outputImageName
	The name of the image output parameter.

int	m_numberOfImagesToCache
	The total number of images to cache.

QMap< int, Ogre::Image * >	m_imageCache
	The data structure to use for caching the loaded images.

Protected Attributes inherited from Frapper::ViewNode
unsigned int	m_stageIndex
	The index of the stage in which this node is contained.

bool	m_view
	Flag that states whether the result of this node should be displayed in the viewport.

Protected Attributes inherited from Frapper::CurveEditorDataNode
ParameterGroup *	m_parameterGroup
	The parameter group containing informations about datastructure.

Protected Attributes inherited from Frapper::Node
QString	m_name
	The name of the node.

QString	m_typeName
	The type of the node.

bool	m_dirty
	The dirty bit.

Parameter *	m_timeParameter
	The global time parameter to use when addressing image sequences.

bool	m_typeUnknown
	Flag that states whether a plugin for the node's type is available.

bool	m_evaluate
	Flag that states whether this node should be evaluated in the network.

bool	m_selected
	Flag that states whether this node is currently selected.

bool	m_selfEvaluating
	Flag that states whether the node is self-evaluating.

QString	m_searchText
	The text to use for filtering parameters of this node before creating editing widgets in a parameter editor panel.

bool	m_saveable
	Flag that states whether the node is saveable.

Additional Inherited Members
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 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.

Static Protected Attributes inherited from Frapper::GeometryRenderNode
static const QString	InputGeometryParameterName = "Geometry to Render"
	The name of the input geometry parameter.

static const QString	InputLightsParameterName = "Lights"
	The name of the input lights parameter.

static const QString	InputCameraParameterName = "Camera"
	The name of the input camera parameter.

static const QString	CameraLightToggleParameterName = "Use camera light instead of input lights"
	The name of the camera light toggle parameter.

static const QString	BackgroundColorParameterName = "Background Color"
	The name of the background color parameter.

Detailed Description

Class for a basic render node.

Constructor & Destructor Documentation

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

Constructor of the SimpleRenderNode 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 SimpleRenderNode class.

Parameters

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

SimpleRenderNode::SimpleRenderNode::~SimpleRenderNode ( )

virtual

Destructor of the SimpleRenderNode 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 SimpleRenderNode::SimpleRenderNode::processOutputImage ( )

slot

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

Public Slots.

Member Data Documentation

Ogre::Light* SimpleRenderNode::SimpleRenderNode::m_sceneLight

protected

Ogre::Image SimpleRenderNode::SimpleRenderNode::m_defaultTextureImage

protected

Ogre::Camera* SimpleRenderNode::SimpleRenderNode::m_cameraCopy

protected

Camera for RenderNode scene.

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

Public Slots

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation