Class representing a container for OGRE objects like scene nodes and various types of movable objects. More...

#include <OgreContainer.h>

Inheritance diagram for Frapper::OgreContainer:

Collaboration diagram for Frapper::OgreContainer:

Public Slots
void	updateSceneNode ()
	Synchronizes the scene node contained in this container to the scene node contained in the OgreContainer calling this slot.

void	updateCamera ()
	Synchronizes the camera contained in this container to the camera contained in the OgreContainer calling this slot.

void	updateLight ()
	Synchronizes the light contained in this container to the light contained in the OgreContainer calling this slot.

void	updateAnimationState (const QString &name, double progress, float weight=1.0)
	Updates the animation state with the given name for the entity contained in this container to the given progress.

void	updateBoneTransform (const QString &name, const float &tx, const float &ty, const float &tz, const float &rx, const float &ry, const float &rz)
	Transforms a given bone. Necessary to update all existing copys!

void	updateVertexBuffer (ParameterGroup *vertexBufferGroup)
	Updates the vertex buffers used by a manual object Necessary to update all existing copys!

Signals
void	sceneNodeUpdated ()
	Signal to notify connected objects that the scene node contained in this container has changed.

void	animationStateUpdated (const QString &name, double progress, float weight)
	Signal to notify connected objects that the animation state for the entity contained in this container has been updated.

void	boneTransformUpdated (const QString &name, const float &tx, const float &ty, const float &tz, const float &rx, const float &ry, const float &rz)
	Signal to notify connected objects that the bone transformation of the entity contained in this container has been updated.

void	vertexBufferUpdated (ParameterGroup *vertexBufferGroup)
	Signal to notify connected objects that the vertex buffer of the manual object contained in this container has been updated.

Public Member Functions
	OgreContainer (Ogre::SceneNode *sceneNode)
	Constructor of the OgreContainer class.

	OgreContainer (Ogre::Entity *entity)
	Constructor of the OgreContainer class.

	OgreContainer (Ogre::ManualObject *manualObject)
	Constructor of the OgreContainer class.

	OgreContainer (Ogre::Light *light)
	Constructor of the OgreContainer class.

	OgreContainer (Ogre::Camera *camera)
	Constructor of the OgreContainer class.

	~OgreContainer ()
	Destructor of the OgreContainer class.

Ogre::SceneNode *	getSceneNode ()
	Returns the scene node contained in this container.

void	setSceneNode (Ogre::SceneNode *sceneNode)
	Sets the scene node to be contained in this container.

Ogre::Entity *	getEntity ()
	Returns the entity contained in this container.

void	setEntity (Ogre::Entity *entity)
	Sets the entity to be contained in this container.

Ogre::ManualObject *	getManualObject ()
	Returns the manual object contained in this container.

void	setManualObject (Ogre::ManualObject *manualObject)
	Sets the manual object to be contained in this container.

Ogre::Light *	getLight ()
	Returns the light contained in this container.

void	setLight (Ogre::Light *light)
	Sets the light to be contained in this container.

Ogre::Camera *	getCamera ()
	Returns the camera contained in this container.

void	setCamera (Ogre::Camera *camera)
	Sets the camera to be contained in this container.

void	updateCopies ()
	Emits the signal to notify connected objects that the scene node contained in this container has been updated.

void	updateCopies (const QString &name, double progress, float weight)
	Emits the signal to notify connected objects that the animation state of the entity contained in this container has been updated.

void	updateCopies (ParameterGroup *vertexBufferGroup)
	Emits the signal to notify connected objects that the vertex buffer of the manual object contained in this container has been updated.

void	updateCopies (const QString &name, const float &tx, const float &ty, const float &tz, const float &rx, const float &ry, const float &rz)
	Emits the signal to notify connected objects that the bone transformation of the entity contained in this container has been updated.

void	updateCopies (const QString &name, float &tx)
	Emits the signal to notify connected objects the vertex buffer of the manual object contained in this container has been updated.

Private Attributes
Ogre::SceneNode *	m_sceneNode
	The scene node contained in the container.

Ogre::Entity *	m_entity
	The entity contained in the container.

Ogre::ManualObject *	m_manualObject
	The manual object contained in the container.

Ogre::Light *	m_light
	The light contained in the container.

Ogre::Camera *	m_camera
	The camera contained in the container.

Detailed Description

Class representing a container for OGRE objects like scene nodes and various types of movable objects.

Constructor & Destructor Documentation

Frapper::OgreContainer::OgreContainer ( Ogre::SceneNode * sceneNode )

Constructor of the OgreContainer class.

Constructors and Destructor.

Parameters

sceneNode The scene node to be contained in the container.

Constructor of the OgreContainer class.

Parameters

sceneNode The scene node to be contained in the container.

Frapper::OgreContainer::OgreContainer ( Ogre::Entity * entity )

Constructor of the OgreContainer class.

Parameters

entity The entity to be contained in the container.

Frapper::OgreContainer::OgreContainer ( Ogre::ManualObject * manualObject )

Constructor of the OgreContainer class.

Parameters

manualObject The manual object to be contained in the container.

Frapper::OgreContainer::OgreContainer ( Ogre::Light * light )

Constructor of the OgreContainer class.

Parameters

light The light to be contained in the container.

Frapper::OgreContainer::OgreContainer ( Ogre::Camera * camera )

Constructor of the OgreContainer class.

Parameters

camera The camera to be contained in the container.

Frapper::OgreContainer::~OgreContainer ( )

Destructor of the OgreContainer class.

Member Function Documentation

Ogre::SceneNode * Frapper::OgreContainer::getSceneNode ( )

Returns the scene node contained in this container.

Public Functions.

Returns: The scene node contained in this container.

Returns the scene node contained in this container.

Returns: The scene node contained in this container.

void Frapper::OgreContainer::setSceneNode ( Ogre::SceneNode * sceneNode )

Sets the scene node to be contained in this container.

Parameters

sceneNode The scene node to be contained in this container.

Ogre::Entity * Frapper::OgreContainer::getEntity ( )

Returns the entity contained in this container.

Returns: The entity contained in this container.

void Frapper::OgreContainer::setEntity ( Ogre::Entity * entity )

Sets the entity to be contained in this container.

Parameters

entity The entity to be contained in this container.

Ogre::ManualObject * Frapper::OgreContainer::getManualObject ( )

Returns the manual object contained in this container.

Returns: The manual object contained in this container.

void Frapper::OgreContainer::setManualObject ( Ogre::ManualObject * manualObject )

Sets the manual object to be contained in this container.

Parameters

manualObject The manual object to be contained in this container.

Ogre::Light * Frapper::OgreContainer::getLight ( )

Returns the light contained in this container.

Returns: The light contained in this container.

void Frapper::OgreContainer::setLight ( Ogre::Light * light )

Sets the light to be contained in this container.

Parameters

light The light to be contained in this container.

Ogre::Camera * Frapper::OgreContainer::getCamera ( )

Returns the camera contained in this container.

Returns: The camera contained in this container.

void Frapper::OgreContainer::setCamera ( Ogre::Camera * camera )

Sets the camera to be contained in this container.

Parameters

camera The camera to be contained in this container.

void Frapper::OgreContainer::updateCopies ( )

Emits the signal to notify connected objects that the scene node contained in this container has been updated.

void Frapper::OgreContainer::updateCopies	(	const QString &	name,
		double	progress,
		float	weight
	)

Emits the signal to notify connected objects that the animation state of the entity contained in this container has been updated.

Parameters

name	The name of the animation state that has been updated.
progress	The progress value for the animation state that has been updated.

void Frapper::OgreContainer::updateCopies ( ParameterGroup * vertexBufferGroup )

Emits the signal to notify connected objects that the vertex buffer of the manual object contained in this container has been updated.

Emits the signal to notify connected objects that the animation state of the entity contained in this container has been updated.

Parameters

vertexBufferGroup The new vertex buffer for the manual object that has been updated.

void Frapper::OgreContainer::updateCopies	(	const QString &	name,
		const float &	tx,
		const float &	ty,
		const float &	tz,
		const float &	rx,
		const float &	ry,
		const float &	rz
	)

Emits the signal to notify connected objects that the bone transformation of the entity contained in this container has been updated.

Parameters

name	The name of the bone that has been updated.
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 Frapper::OgreContainer::updateCopies	(	const QString &	name,
		float &	tx
	)

Emits the signal to notify connected objects the vertex buffer of the manual object contained in this container has been updated.

Parameters

name	The name of the bone that has been updated.
tx	Translation x axis.

void Frapper::OgreContainer::sceneNodeUpdated ( )

signal

Signal to notify connected objects that the scene node contained in this container has changed.

void Frapper::OgreContainer::animationStateUpdated	(	const QString &	name,
		double	progress,
		float	weight
	)

signal

Signal to notify connected objects that the animation state for the entity contained in this container has been updated.

Parameters

name	The name of the animation state that was updated.
progress	The progress value for the animation state that was updated.

void Frapper::OgreContainer::boneTransformUpdated	(	const QString &	name,
		const float &	tx,
		const float &	ty,
		const float &	tz,
		const float &	rx,
		const float &	ry,
		const float &	rz
	)

signal

Signal to notify connected objects that the bone transformation of the entity contained in this container has been updated.

Parameters

name	The name of the bone that has been updated.
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 Frapper::OgreContainer::vertexBufferUpdated ( ParameterGroup * vertexBufferGroup )

signal

Signal to notify connected objects that the vertex buffer of the manual object contained in this container has been updated.

Parameters

vertexBufferGroup The new vertex buffer for the manual object that has been updated.

void Frapper::OgreContainer::updateSceneNode ( )

slot

Synchronizes the scene node contained in this container to the scene node contained in the OgreContainer calling this slot.

Public Slots.

void Frapper::OgreContainer::updateCamera ( )

slot

Synchronizes the camera contained in this container to the camera contained in the OgreContainer calling this slot.

void Frapper::OgreContainer::updateLight ( )

slot

Synchronizes the light contained in this container to the light contained in the OgreContainer calling this slot.

void Frapper::OgreContainer::updateAnimationState	(	const QString &	name,
		double	progress,
		float	weight = `1.0`
	)

slot

Updates the animation state with the given name for the entity contained in this container to the given progress.

Parameters

name	The name of the animation state to update.
progress	The progress value for the animation state to update.

void Frapper::OgreContainer::updateBoneTransform	(	const QString &	name,
		const float &	tx,
		const float &	ty,
		const float &	tz,
		const float &	rx,
		const float &	ry,
		const float &	rz
	)

slot

Transforms a given bone. Necessary to update all existing copys!

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 Frapper::OgreContainer::updateVertexBuffer ( ParameterGroup * vertexBufferGroup )

slot

Updates the vertex buffers used by a manual object Necessary to update all existing copys!

Member Data Documentation

Ogre::SceneNode* Frapper::OgreContainer::m_sceneNode

private

The scene node contained in the container.

Ogre::Entity* Frapper::OgreContainer::m_entity

private

The entity contained in the container.

Ogre::ManualObject* Frapper::OgreContainer::m_manualObject

private

The manual object contained in the container.

Ogre::Light* Frapper::OgreContainer::m_light

private

The light contained in the container.

Ogre::Camera* Frapper::OgreContainer::m_camera

private

The camera contained in the container.

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

Public Slots

Signals

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation