Frapper  1.0a
Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Private Slots | List of all members
Frapper::ViewNode Class Reference

Abstract base class for all nodes whose results can be viewed in a viewport. More...

#include <ViewNode.h>

Inheritance diagram for Frapper::ViewNode:
Inheritance graph
[legend]
Collaboration diagram for Frapper::ViewNode:
Collaboration graph
[legend]

Public Slots

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.
 

Signals

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.
 

Public Member Functions

 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::SceneNodegetSceneNode ()
 Returns the scene node that contains scene objects created or modified by this node.
 
virtual Ogre::TexturePtr getImage ()
 Returns the image that is generated 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.
 
ParameterGroupgetCurveEditorGoup () 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
 
ParametergetTimeParameter () 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.
 
ParameterGroupgetParameterRoot () const
 Returns the root of the tree of parameters and parameter groups for the node.
 
ParameterGroupgetParameterGroup (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.
 
ParametergetParameter (const QString &name) const
 Returns the parameter with the given name.
 
NumberParametergetNumberParameter (const QString &name) const
 Returns the number parameter with the given name.
 
FilenameParametergetFilenameParameter (const QString &name) const
 Returns the filename parameter with the given name.
 
EnumerationParametergetEnumerationParameter (const QString &name) const
 Returns the enumeration parameter with the given name.
 
GeometryParametergetGeometryParameter (const QString &name) const
 Returns the geometry parameter with the given name.
 
LightParametergetLightParameter (const QString &name) const
 Returns the light parameter with the given name.
 
CameraParametergetCameraParameter (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::SceneNodegetSceneNodeValue (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.
 
ParameterGroupgetGroupValue (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

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

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
ParameterGroupm_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.
 
Parameterm_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 Slots

void checkViewFlag ()
 Checks if the view flag is currently set for this node and if so notifies connected objects that the view node has been updated by emitting the viewNodeUpdated signal.
 

Additional Inherited Members

- Static Public Attributes inherited from Frapper::Node
static int s_numberOfInstances
 
static int s_totalNumberOfInstances
 

Detailed Description

Abstract base class for all nodes whose results can be viewed in a viewport.

ViewNodes can either produce 3D scene geometry or 2D images (/textures).

Constructor & Destructor Documentation

Frapper::ViewNode::ViewNode ( const QString &  name,
ParameterGroup parameterRoot 
)

Constructor of the ViewNode class.

Constructors and Destructors.

Parameters
nameThe name for the new node.
parameterRootA copy of the parameter tree specific for the type of the node.

Constructor of the ViewNode class.

Parameters
nameThe name for the new node.
parameterRootA copy of the parameter tree specific for the type of the node.
Frapper::ViewNode::~ViewNode ( )
virtual

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

unsigned int Frapper::ViewNode::getStageIndex ( ) const

Returns the index of the stage in which this node is contained.

Public Functions.

Returns
The index of the stage in which this node is contained.

Returns the index of the stage in which this node is contained.

Returns
The index of the stage in which this node is contained.
bool Frapper::ViewNode::isViewed ( ) const

Returns whether the result of this node should be displayed in the viewport.

Returns
True if the result of this node should be displayed in the viewport, otherwise False.
Ogre::SceneNode * Frapper::ViewNode::getSceneNode ( )
virtual

Returns the scene node that contains scene objects created or modified by this node.

The default implementation returns 0. To be implemented in derived classes that work on scene geometry data.

Returns
The scene node containing objects created or modified by this node.

Reimplemented in TransformNode::TransformNode, S3DGameNode::S3DGameNode, CameraNode::CameraNode, LightNode::LightNode, FiveViewCameraNode::FiveViewCamera, StereoCameraNode::StereoCamera, and Frapper::GeometryNode.

Ogre::TexturePtr Frapper::ViewNode::getImage ( )
virtual

Returns the image that is generated by this node.

The default implementation returns an empty texture pointer. To be implemented in derived classes that work on image data.

Returns
The image that is generated by this node.

Reimplemented in Frapper::ImageNode.

void Frapper::ViewNode::setEvaluate ( bool  evaluate)
virtualslot

Sets whether this node should be evaluated in the network.

Public Slots.

Parameters
evaluateThe new value for eval flag of this node.

Sets whether this node should be evaluated in the network.

Parameters
evaluateThe new value for eval flag of this node.
void Frapper::ViewNode::setView ( bool  view,
bool  suppressViewSetSignal = false 
)
virtualslot

Sets whether the geometry of this node should be displayed in the viewport.

Sets whether the result of this node should be displayed in the viewport.

Parameters
viewThe new value for view flag of this node.
suppressViewSetSignalFlag to control whether the viewSet signal is emitted from this function.
void Frapper::ViewNode::setStageIndex ( unsigned int  stageIndex)
slot

Sets the index of the stage in which this node should be contained.

Parameters
stageIndexThe index of the stage in which this node should be contained.
void Frapper::ViewNode::triggerRedraw ( )
signal

Trigger redraw of ogre scene.

void Frapper::ViewNode::viewSet ( unsigned int  stageIndex,
ViewNode viewNode 
)
signal

Signal that is emitted when the view flag of this node has been set.

Parameters
stageIndexThe index of the stage to display the node in.
viewNodeThis node.
void Frapper::ViewNode::viewNodeUpdated ( )
signal

Signal that is emitted when the currently viewed view node has been updated.

void Frapper::ViewNode::addOutputParameter ( Parameter outputParameter)
protected

Adds the given parameter as output parameter to this view node.

Protected Functions.

The viewNodeUpdated signal will be emitted when the given parameter is made dirty.

Parameters
outputParameterThe parameter that when dirtied will trigger the viewNodeUpdated signal.

Adds the given parameter as output parameter to this view node.

The viewNodeUpdated signal will be emitted when the given parameter is made dirty.

Parameters
outputParameterThe parameter that when dirtied will trigger the viewNodeUpdated signal.
void Frapper::ViewNode::removeOutputParameter ( Parameter outputParameter)
protected

Removes the given parameter as output parameter from this view node.

Parameters
outputParameterThe parameter that will be removed
void Frapper::ViewNode::requestRedraw ( )
protected

Request a redraw of the current ogre scene.

void Frapper::ViewNode::checkViewFlag ( )
privateslot

Checks if the view flag is currently set for this node and if so notifies connected objects that the view node has been updated by emitting the viewNodeUpdated signal.

Private Slots.

Member Data Documentation

unsigned int Frapper::ViewNode::m_stageIndex
protected

The index of the stage in which this node is contained.

bool Frapper::ViewNode::m_view
protected

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


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