ImageSaverNode::ImageSaverNode Class Reference

Class representing nodes that save input images. More...

#include <ImageSaverNode.h>

Inheritance diagram for ImageSaverNode::ImageSaverNode:

Collaboration diagram for ImageSaverNode::ImageSaverNode:

Public Member Functions
	ImageSaverNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the ImageFilterNode class.
virtual	~ImageSaverNode ()
	Destructor of the ImageFilterNode class.
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 Protected Attributes
static const unsigned int	NumImages = 4
	number of image files

Private Slots
void	saveAllImages ()
	Saves the node's input images to file.

Private Member Functions
void	saveImage (Ogre::TexturePtr tex, std::string filename)
	Converts a texture to an image and then saves it to a file.

Private Attributes
int	m_currentFrame
	Image counter.

Additional Inherited Members
Public Slots inherited from Frapper::Node
virtual void	setEvaluate (bool evaluate)
	Sets whether this node should be evaluated in the network.
virtual void	loadReady ()
	Executed when scene loading is ready.
virtual void	saveStart ()
	Executed when scene saving is ready.
Signals inherited from Frapper::Node
void	frameChanged (int)
	Signal that is emitted when current frame has changed.
void	nodeChanged ()
	Signal that is emitted when something has changed in the node. (Parameters added/deleted)
void	nodeNameChanged (const QString &name)
	Signal that is emitted when the node's name has changed.
void	selectedChanged (bool selected)
	Signal that is emitted when the selected state of the node has changed.
void	sendDeleteConnection (Connection *connection)
	Signal that is emitted in order to delete a connection (through SceneModel)
void	updateFrame ()
	Update frame.
void	selectDeselectObject (const QString &name)
	Seim.
void	loadSceneElementsReady ()
	Signal that is emitted when the scene loading is ready.
Static Public Attributes inherited from Frapper::Node
static int	s_numberOfInstances
static int	s_totalNumberOfInstances
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 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.

Detailed Description

Class representing nodes that save input images.

Constructor & Destructor Documentation

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

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

Parameters

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

/todo Christopher: Add user interface for saving options (e.g. compression quality, bit depth, alpha options etc.)

ImageSaverNode::ImageSaverNode::~ImageSaverNode ( )

virtual

Destructor of the ImageFilterNode class.

Destructor of the ImageSaverNode 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 ImageSaverNode::ImageSaverNode::saveImage ( Ogre::TexturePtr  tex, std::string  filename  )

private

Converts a texture to an image and then saves it to a file.

Private Slots.

Saves the a texture to a file.

NOTE: This code snippet is based on the function Ogre::Texture::convertToImage() that is intruduced with OGRE v.17 RC1

/todo Christopher: Once FRAPPER is migrated to OGRE v1.7, use Ogre::Texture::convertToImage() instead to avoid duplicate code

void ImageSaverNode::ImageSaverNode::saveAllImages ( )

privateslot

Saves the node's input images to file.

Member Data Documentation

const unsigned int ImageSaverNode::ImageSaverNode::NumImages = 4

staticprotected

number of image files

Protected Static Constants.

int ImageSaverNode::ImageSaverNode::m_currentFrame

private

Image counter.

---

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

• ImageSaverNode.h
• ImageSaverNode.cpp