ogre_tools::Shape Class Reference
#include <shape.h>
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
- 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 73 of file shape.cpp.
ogre_tools::Shape::~Shape |
( |
|
) |
[virtual] |
Member Function Documentation
Ogre::Entity * ogre_tools::Shape::createEntity |
( |
const std::string & |
name, |
|
|
Type |
shape_type, |
|
|
Ogre::SceneManager * |
scene_manager | |
|
) |
| | [static] |
Ogre::Entity* ogre_tools::Shape::getEntity |
( |
|
) |
[inline] |
const Ogre::Quaternion & ogre_tools::Shape::getOrientation |
( |
|
) |
[virtual] |
const Ogre::Vector3 & ogre_tools::Shape::getPosition |
( |
|
) |
[virtual] |
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] |
void ogre_tools::Shape::setColor |
( |
const Ogre::ColourValue & |
c |
) |
|
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 144 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 149 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 159 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 154 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 164 of file shape.cpp.
void ogre_tools::Shape::setUserData |
( |
const Ogre::Any & |
data |
) |
[virtual] |
Member Data Documentation
The documentation for this class was generated from the following files: