ogre_tools::Shape Class Reference

#include <shape.h>

Inheritance diagram for ogre_tools::Shape:

[legend]

List of all members.

Public Types
enum	Type { Cone, Cube, Cylinder, Sphere }
Public Member Functions
Ogre::Entity *	getEntity ()
virtual const Ogre::Quaternion &	getOrientation ()
	Get the local orientation of this object.
virtual const Ogre::Vector3 &	getPosition ()
	Get the local position of this object.
Ogre::SceneNode *	getRootNode ()
	Get the root scene node (pivot node) for this object.
Type	getType ()
void	setColor (const Ogre::ColourValue &c)
virtual void	setColor (float r, float g, float b, float a)
	Set the color of the object. Values are in the range [0, 1].
void	setOffset (const Ogre::Vector3 &offset)
	Set the offset for this shape.
virtual void	setOrientation (const Ogre::Quaternion &orientation)
	Set the orientation of the object.
virtual void	setPosition (const Ogre::Vector3 &position)
	Set the position of this object.
virtual void	setScale (const Ogre::Vector3 &scale)
	Set the scale of the object. Always relative to the identity orientation of the object.
void	setUserData (const Ogre::Any &data)
	Sets user data on all ogre objects we own.
	Shape (Type shape_type, Ogre::SceneManager *scene_manager, Ogre::SceneNode *parent_node=NULL)
	Constructor.
virtual	~Shape ()
Static Public Member Functions
static Ogre::Entity *	createEntity (const std::string &name, Type shape_type, Ogre::SceneManager *scene_manager)
Private Attributes
Ogre::Entity *	entity_
Ogre::MaterialPtr	material_
std::string	material_name_
Ogre::SceneNode *	offset_node_
Ogre::SceneNode *	scene_node_
Type	type_

---

Detailed Description

Definition at line 51 of file shape.h.

---

Member Enumeration Documentation

enum ogre_tools::Shape::Type

Enumerator:

Cone
Cube
Cylinder
Sphere

Definition at line 54 of file shape.h.

---

Constructor & Destructor Documentation

ogre_tools::Shape::Shape	(	Type	shape_type,
		Ogre::SceneManager *	scene_manager,
		Ogre::SceneNode *	parent_node = NULL
	)

Constructor.

Parameters:

	scene_manager	The scene manager this object is associated with
	parent_node	A scene node to use as the parent of this object. If NULL, uses the root scene node.

Definition at line 68 of file shape.cpp.

ogre_tools::Shape::~Shape

(

)

[virtual]

Definition at line 101 of file shape.cpp.

---

Member Function Documentation

Ogre::Entity * ogre_tools::Shape::createEntity	(	const std::string &	name,
		Type	shape_type,
		Ogre::SceneManager *	scene_manager
	)			[static]

Definition at line 40 of file shape.cpp.

Ogre::Entity* ogre_tools::Shape::getEntity

(

)

[inline]

Definition at line 102 of file shape.h.

const Ogre::Quaternion & ogre_tools::Shape::getOrientation

(

)

[virtual]

Get the local orientation of this object.

Returns:

The orientation

Implements ogre_tools::Object.

Definition at line 169 of file shape.cpp.

const Ogre::Vector3 & ogre_tools::Shape::getPosition

(

)

[virtual]

Get the local position of this object.

Returns:

The position

Implements ogre_tools::Object.

Definition at line 164 of file shape.cpp.

Ogre::SceneNode* ogre_tools::Shape::getRootNode

(

)

[inline]

Get the root scene node (pivot node) for this object.

Returns:

The root scene node of this object

Definition at line 95 of file shape.h.

Type ogre_tools::Shape::getType

(

)

[inline]

Definition at line 71 of file shape.h.

void ogre_tools::Shape::setColor

(

const Ogre::ColourValue &

c

)

Definition at line 122 of file shape.cpp.

void ogre_tools::Shape::setColor	(	float	r,
		float	g,
		float	b,
		float	a
	)			[virtual]

Set the color of the object. Values are in the range [0, 1].

Parameters:

	r	Red component
	g	Green component
	b	Blue component

Implements ogre_tools::Object.

Definition at line 139 of file shape.cpp.

void ogre_tools::Shape::setOffset

(

const Ogre::Vector3 &

offset

)

Set the offset for this shape.

The default is no offset, which puts the pivot point directly in the center of the object.

Parameters:

offset

Amount to offset the center of the object from the pivot point

Definition at line 144 of file shape.cpp.

void ogre_tools::Shape::setOrientation

(

const Ogre::Quaternion &

orientation

)

[virtual]

Set the orientation of the object.

Parameters:

Orientation

quaternion orientation to set to.

Implements ogre_tools::Object.

Definition at line 154 of file shape.cpp.

void ogre_tools::Shape::setPosition

(

const Ogre::Vector3 &

position

)

[virtual]

Set the position of this object.

Parameters:

Position

vector position to set to.

Implements ogre_tools::Object.

Definition at line 149 of file shape.cpp.

void ogre_tools::Shape::setScale

(

const Ogre::Vector3 &

scale

)

[virtual]

Set the scale of the object. Always relative to the identity orientation of the object.

Parameters:

Scale

vector scale to set to.

Implements ogre_tools::Object.

Definition at line 159 of file shape.cpp.

void ogre_tools::Shape::setUserData

(

const Ogre::Any &

data

)

[virtual]

Sets user data on all ogre objects we own.

Implements ogre_tools::Object.

Definition at line 174 of file shape.cpp.

---

Member Data Documentation

Ogre::Entity* ogre_tools::Shape::entity_ [private]

Definition at line 109 of file shape.h.

Ogre::MaterialPtr ogre_tools::Shape::material_ [private]

Definition at line 110 of file shape.h.

std::string ogre_tools::Shape::material_name_ [private]

Definition at line 111 of file shape.h.

Ogre::SceneNode* ogre_tools::Shape::offset_node_ [private]

Definition at line 108 of file shape.h.

Ogre::SceneNode* ogre_tools::Shape::scene_node_ [private]

Definition at line 107 of file shape.h.

Type ogre_tools::Shape::type_ [private]

Definition at line 113 of file shape.h.

---

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

• shape.h
• shape.cpp