Base class for all nodes that produce image data. More...

#include <ImageNode.h>

Inheritance diagram for Frapper::ImageNode:

[legend]

Collaboration diagram for Frapper::ImageNode:

[legend]

Public Slots
void	clearImageCache ()
	Clears the image cache by freeing all memory allocated for the cache.

Public Slots inherited from Frapper::ViewNode
virtual void	setEvaluate (bool evaluate)
	Sets whether this node should be evaluated in the network.

virtual void	setView (bool view, bool suppressViewSetSignal=false)
	Sets whether the geometry of this node should be displayed in the viewport.

void	setStageIndex (unsigned int stageIndex)
	Sets the index of the stage in which this node should be contained.

Public Member Functions
	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.

Static Public Attributes
static const int	NumberUnknown = -1
	A constant value indicating that the number of images (to cache) is not known yet.

Protected Member Functions
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 ()

Protected Attributes
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.

Private Member Functions
void	updateCacheStatus ()
	Updates the cache status.

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.

Detailed Description

Base class for all nodes that produce image data.

Constructor & Destructor Documentation

Frapper::ImageNode::ImageNode	(	const QString &	name,
		ParameterGroup *	parameterRoot,
		bool	cacheEnabled = `true`,
		const QString &	outputImageName = `"Image"`
	)

Constructor of the ImageNode 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.
cacheEnabled	Flag to enable or disable the image cache for this node.
outputImageName	The name of the geometry output parameter.

Constructor of the ImageNode class.

Parameters

name	The name for the new node.
parameterRoot	A copy of the parameter tree specific for the type of the node.
cacheEnabled	Flag to enable or disable the image cache for this node.
outputImageName	The name of the geometry output parameter.

Frapper::ImageNode::~ImageNode ( )

virtual

Destructor of the ImageNode 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

Ogre::TexturePtr Frapper::ImageNode::getImage ( )

virtual

Returns the image that is generated by this node.

Public Functions.

Returns: The image that is generated by this node.

Returns the image that is generated by this node.

Returns: The image that is generated by this node.

Reimplemented from Frapper::ViewNode.

bool Frapper::ImageNode::isCached ( int index ) const

Returns whether a cached image is available for the frame with the given index.

Parameters

index The index of the frame for which to test whether a cached image is available.

Returns: True if a cached image is available for the frame with the given index, otherwise False.

Ogre::Image * Frapper::ImageNode::getCachedImage ( int index ) const

Returns the image cached for the frame with the given index.

Parameters

index The index of the frame for which to return the cached image.

Returns: The cached image, or 0 if no cached image is available for the frame with the given index.

void Frapper::ImageNode::clearImageCache ( )

slot

Clears the image cache by freeing all memory allocated for the cache.

Public Slots.

void Frapper::ImageNode::setNumberOfImagesToCache ( unsigned int numberOfImagesToCache )

protected

Sets the number of images to cache to the given value.

Protected Functions.

Parameters

numberOfImagesToCache The number of images to cache.

Sets the number of images to cache to the given value.

Parameters

numberOfImagesToCache The number of images to cache.

Ogre::Image * Frapper::ImageNode::createImageFromTexture ( Ogre::TexturePtr texturePointer )

protected

Creates an image from the given texture.

Parameters

texturePointer The texture from which to copy the image data.

Returns: The image created from the given texture, or 0 if the given texture is invalid.

void Frapper::ImageNode::cacheImage	(	int	index,
		Ogre::Image *	image
	)

protected

Stores the given image in the cache for the frame with the given index.

Parameters

index	The index of the frame for which to cache the image.
image	The image to cache for the frame with the given index.

void Frapper::ImageNode::setOutputImage ( Ogre::Image * image )

protected

Sets the given image as the output image in the output image parameter.

Parameters

image The image containing the pixel data to use for the texture.

void Frapper::ImageNode::updateCacheStatus ( )

private

Updates the cache status.

Private Functions.

Member Data Documentation

const int Frapper::ImageNode::NumberUnknown = -1

static

A constant value indicating that the number of images (to cache) is not known yet.

bool Frapper::ImageNode::m_cacheEnabled

protected

Flag that states whether the image cache for this node is enabled.

bool Frapper::ImageNode::m_cacheInvalid

protected

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

QString Frapper::ImageNode::m_outputImageName

protected

The name of the image output parameter.

int Frapper::ImageNode::m_numberOfImagesToCache

protected

The total number of images to cache.

QMap<int, Ogre::Image *> Frapper::ImageNode::m_imageCache

protected

The data structure to use for caching the loaded images.

The key for the map is the index of a frame.

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

Public Slots

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