AnimatableMeshNode::AnimatableMeshNode Class Reference

Class representing nodes that can contain OGRE entities with animation. More...

#include <AnimatableMeshNode.h>

Inheritance diagram for AnimatableMeshNode::AnimatableMeshNode:

Collaboration diagram for AnimatableMeshNode::AnimatableMeshNode:

Classes
struct	BoneTransform
	Bone transformation struct. More...

Public Slots
void	updateAnimation ()
	Update an animation.
void	updateBones ()
	Update bones.
void	updatePoses ()
	Update poses.
void	updateAll ()
	Update animations, bones and poses.
void	updateObjectId ()
	Update object id.

Public Member Functions
	AnimatableMeshNode (const QString &name, ParameterGroup *parameterRoot)
	Constructor of the AnimatableMeshNode class.
	~AnimatableMeshNode ()
	Destructor of the AnimatableMeshNode class.
Public Member Functions inherited from Frapper::GeometryNode
	GeometryNode (const QString &name, ParameterGroup *parameterRoot, const QString &outputGeometryName="Geometry")
	Constructor of the GeometryNode class.
virtual	~GeometryNode ()
	Destructor of the GeometryNode class.
virtual Ogre::SceneNode *	getSceneNode ()
	Returns the scene node that contains scene objects created or modified by this node.
double	getBoundingSphereRadius () const
	Returns the radius of the bounding sphere surrounding this object.
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::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.
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.

Private Slots
void	geometryFileChanged ()
	Change function for the Geometry File parameter.
void	setInterpolationMode ()
	Set interpolation mode.
void	setMaterialParameter ()
	Change function for the Material parameters.
void	reloadTexture ()
	Texture Reload Function.
bool	setupMaterial ()
	Check existing material for BRDF shader and set the loaded light textures.
bool	loadLightDescriptionFile ()
	Loads an light description file.
void	setSwitches ()
	Sets the internal config switches.

Private Member Functions
bool	initAnimationStates ()
	Initialize all animation states of this object (OGRE-specific).
QStringList	getAnimationNames ()
	Retrieve the names of all animations of skeleton.
QStringList	getBoneNames ()
	Returns the names of all bones in the skeleton for the mesh.
void	initializeBones (QStringList boneNames)
	Initialize a bunch of bones.
bool	loadMesh ()
	Loads the animation mesh from file.
void	updateStatistics ()
	Retrieves the numbers of vertices and triangles from the mesh and stores them in parameters of this node.
void	destroyEntity ()
	Removes the OGRE entity containing the mesh geometry from the scene and destroys it along with the OGRE scene node.
void	progressAnimation (const QString &animationName, float timeToAdd, float weight=1.0)
	Adds the given time value to the animation state with the given name in order to progess the animation (OGRE-specific).
void	transformBone (const QString &name, float &tx, float &ty, float &tz, float &rx, float &ry, float &rz)
	Transforms a given bone.
void	parseMaterialParameters ()
	Parse the Material Parameters and add to Material Parameter Group.
Ogre::HardwareVertexBufferSharedPtr	writeDataToVertices (Ogre::SubMesh *mesh)
	Insert unique IDs in a texture coordinate for every vertex of the mesh that is on the same spatial position.
bool	compareVectors (QVector3D *v1, QVector3D *v2)
	Compare two QVector3D instances.
bool	isAnimated () const
	Checks the Ogre entity if it is animatable.

Private Attributes
Ogre::SceneNode *	m_sceneNode
	OGRE scene node.
Ogre::Entity *	m_entity
	OGRE entity.
QString	m_oldResourceGroupName
	Old resource group name.
OgreContainer *	m_entityContainer
	The container for the entity.
QMap< QString, Ogre::AnimationState * >	m_animStates
	OGRE animation states.
QMap< QString, double >	m_animProgresses
	Animation progresses.
QStringList	m_animationNames
	List of animation names.
QStringList	m_weightNames
	List of animation names.
QStringList	m_poseNames
	List of pose names.
QStringList	m_boneNames
	List of bone names.
QMap< QString, Ogre::AnimationState * >	m_animStatesVertex
	OGRE animation states for vertex animations.
ParameterGroup *	m_animationGroup
	Parameter group for skeletal animations.
ParameterGroup *	m_animationWeightGroup
ParameterGroup *	m_poseGroup
	Parameter group for pose animations.
ParameterGroup *	m_poseWeightGroup
ParameterGroup *	m_boneGroup
	Parameter group bone groups.
ParameterGroup *	m_materialGroup
	Parameter group material parameters.
ParameterGroup *	m_objectIdGroup
	Parameter group object ids.
Ogre::TexturePtr	m_lightDirsTexture
	Texture containing light directions (BRDF)
Ogre::TexturePtr	m_lightPowsTexture
	Texture containing light powers (BRDF)
bool	m_manual
	The switch for the manual animaion triggering.
bool	m_bones
	The switch for the bone triggering.
bool	m_autoPose
	The switch for the auto pose triggering.
bool	m_manualMat
	The switch for the manual material parameter triggering.

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::Node
static int	s_numberOfInstances
static int	s_totalNumberOfInstances
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 Attributes inherited from Frapper::GeometryNode
QString	m_outputGeometryName
	The name of the geometry output parameter.

Detailed Description

Class representing nodes that can contain OGRE entities with animation.

Constructor & Destructor Documentation

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

Constructor of the AnimatableMeshNode class.

Constructors and Destructors.

Parameters

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

Constructor of the AnimatableMeshNode class.

Parameters

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

AnimatableMeshNode::AnimatableMeshNode::~AnimatableMeshNode

(

)

Destructor of the AnimatableMeshNode class.

Member Function Documentation

void AnimatableMeshNode::AnimatableMeshNode::updateAnimation ( )

slot

Update an animation.

Public Slots.

void AnimatableMeshNode::AnimatableMeshNode::updateBones ( )

slot

Update bones.

void AnimatableMeshNode::AnimatableMeshNode::updatePoses ( )

slot

Update poses.

void AnimatableMeshNode::AnimatableMeshNode::updateAll ( )

slot

Update animations, bones and poses.

Update animation, bones and poses.

void AnimatableMeshNode::AnimatableMeshNode::updateObjectId ( )

slot

Update object id.

bool AnimatableMeshNode::AnimatableMeshNode::initAnimationStates ( )

private

Initialize all animation states of this object (OGRE-specific).

Private Functions.

Returns

True if the animation states where successfully initialized, otherwise False.

Initialize all animation states of this object (OGRE-specific).

Returns

True if the animation states where successfully initialized, otherwise False.

QStringList AnimatableMeshNode::AnimatableMeshNode::getAnimationNames ( )

private

Retrieve the names of all animations of skeleton.

Returns

List with names of animations.

QStringList AnimatableMeshNode::AnimatableMeshNode::getBoneNames ( )

private

Returns the names of all bones in the skeleton for the mesh.

Returns

The names of all bones in the skeleton for the mesh.

void AnimatableMeshNode::AnimatableMeshNode::initializeBones ( QStringList  boneNames )

private

Initialize a bunch of bones.

Parameters

boneNames

The list of names of bones to initialize.

bool AnimatableMeshNode::AnimatableMeshNode::loadMesh ( )

private

Loads the animation mesh from file.

Loads animation mesh.

Returns

True if the animation mesh was successfully loaded, otherwise False.

True, if successful loading of ogre mesh False, otherwise.

void AnimatableMeshNode::AnimatableMeshNode::updateStatistics ( )

private

Retrieves the numbers of vertices and triangles from the mesh and stores them in parameters of this node.

void AnimatableMeshNode::AnimatableMeshNode::destroyEntity ( )

private

Removes the OGRE entity containing the mesh geometry from the scene and destroys it along with the OGRE scene node.

void AnimatableMeshNode::AnimatableMeshNode::progressAnimation ( const QString &  animationName, float  timeToAdd, float  weight = 1.0  )

private

Adds the given time value to the animation state with the given name in order to progess the animation (OGRE-specific).

Parameters

aUnitName	The name of the animation state to progress.
timeToAdd	The time to add to the animation state with the given name.

void AnimatableMeshNode::AnimatableMeshNode::transformBone ( const QString &  name, float &  tx, float &  ty, float &  tz, float &  rx, float &  ry, float &  rz  )

private

Transforms a given bone.

Parameters

name	The name of the bone.
tx	Translation x axis.
ty	Translation y axis.
tz	Translation z axis.
rx	Rotation x axis.
ry	Rotation y axis.
rz	Rotation z axis.

void AnimatableMeshNode::AnimatableMeshNode::parseMaterialParameters ( )

private

Parse the Material Parameters and add to Material Parameter Group.

Ogre::HardwareVertexBufferSharedPtr AnimatableMeshNode::AnimatableMeshNode::writeDataToVertices ( Ogre::SubMesh *  mesh )

private

Insert unique IDs in a texture coordinate for every vertex of the mesh that is on the same spatial position.

Parameters

mesh	Submesh that contains the vertices (typically the skin submesh)

Returns

Pointer to the VertexBuffer that gets modified by this function

bool AnimatableMeshNode::AnimatableMeshNode::compareVectors ( QVector3D *  v1, QVector3D *  v2  )

private

Compare two QVector3D instances.

Parameters

First	vector.
Second	vector.

Returns

True if vectors are component-wise equal.

bool AnimatableMeshNode::AnimatableMeshNode::isAnimated ( ) const

private

Checks the Ogre entity if it is animatable.

Returns

True if the entity is animated

void AnimatableMeshNode::AnimatableMeshNode::geometryFileChanged ( )

privateslot

Change function for the Geometry File parameter.

Private Slots.

void AnimatableMeshNode::AnimatableMeshNode::setInterpolationMode ( )

privateslot

Set interpolation mode.

void AnimatableMeshNode::AnimatableMeshNode::setMaterialParameter ( )

privateslot

Change function for the Material parameters.

void AnimatableMeshNode::AnimatableMeshNode::reloadTexture ( )

privateslot

Texture Reload Function.

bool AnimatableMeshNode::AnimatableMeshNode::setupMaterial ( )

privateslot

Check existing material for BRDF shader and set the loaded light textures.

Returns

True when BRDF material was found.

bool AnimatableMeshNode::AnimatableMeshNode::loadLightDescriptionFile ( )

privateslot

Loads an light description file.

Returns

True when light description file has been successfully loaded.

void AnimatableMeshNode::AnimatableMeshNode::setSwitches ( )

privateslot

Sets the internal config switches.

Member Data Documentation

Ogre::SceneNode* AnimatableMeshNode::AnimatableMeshNode::m_sceneNode

private

OGRE scene node.

Ogre::Entity* AnimatableMeshNode::AnimatableMeshNode::m_entity

private

OGRE entity.

QString AnimatableMeshNode::AnimatableMeshNode::m_oldResourceGroupName

private

Old resource group name.

OgreContainer* AnimatableMeshNode::AnimatableMeshNode::m_entityContainer

private

The container for the entity.

QMap<QString, Ogre::AnimationState *> AnimatableMeshNode::AnimatableMeshNode::m_animStates

private

OGRE animation states.

QMap<QString, double> AnimatableMeshNode::AnimatableMeshNode::m_animProgresses

private

Animation progresses.

QStringList AnimatableMeshNode::AnimatableMeshNode::m_animationNames

private

List of animation names.

QStringList AnimatableMeshNode::AnimatableMeshNode::m_weightNames

private

List of animation names.

QStringList AnimatableMeshNode::AnimatableMeshNode::m_poseNames

private

List of pose names.

QStringList AnimatableMeshNode::AnimatableMeshNode::m_boneNames

private

List of bone names.

QMap<QString, Ogre::AnimationState *> AnimatableMeshNode::AnimatableMeshNode::m_animStatesVertex

private

OGRE animation states for vertex animations.

ParameterGroup* AnimatableMeshNode::AnimatableMeshNode::m_animationGroup

private

Parameter group for skeletal animations.

ParameterGroup* AnimatableMeshNode::AnimatableMeshNode::m_animationWeightGroup

private

ParameterGroup* AnimatableMeshNode::AnimatableMeshNode::m_poseGroup

private

Parameter group for pose animations.

ParameterGroup* AnimatableMeshNode::AnimatableMeshNode::m_poseWeightGroup

private

ParameterGroup* AnimatableMeshNode::AnimatableMeshNode::m_boneGroup

private

Parameter group bone groups.

ParameterGroup* AnimatableMeshNode::AnimatableMeshNode::m_materialGroup

private

Parameter group material parameters.

ParameterGroup* AnimatableMeshNode::AnimatableMeshNode::m_objectIdGroup

private

Parameter group object ids.

Ogre::TexturePtr AnimatableMeshNode::AnimatableMeshNode::m_lightDirsTexture

private

Texture containing light directions (BRDF)

Ogre::TexturePtr AnimatableMeshNode::AnimatableMeshNode::m_lightPowsTexture

private

Texture containing light powers (BRDF)

bool AnimatableMeshNode::AnimatableMeshNode::m_manual

private

The switch for the manual animaion triggering.

bool AnimatableMeshNode::AnimatableMeshNode::m_bones

private

The switch for the bone triggering.

bool AnimatableMeshNode::AnimatableMeshNode::m_autoPose

private

The switch for the auto pose triggering.

bool AnimatableMeshNode::AnimatableMeshNode::m_manualMat

private

The switch for the manual material parameter triggering.

---

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

• AnimatableMeshNode.h
• AnimatableMeshNode.cpp