Entity Class Reference
[Server]
#include <Entity.hh>
Inheritance diagram for Entity:
Detailed Description
Base class for all objects in Gazebo.Public Member Functions | |
| Entity (Entity *parent=NULL) | |
| virtual | ~Entity () |
| int | GetId () const |
| int | GetParentId () const |
| void | SetParent (Entity *parent) |
| Entity * | GetParent () const |
| void | AddChild (Entity *child) |
| std::vector< Entity * > & | GetChildren () |
| Ogre::SceneNode * | GetSceneNode () const |
| void | SetSceneNode (Ogre::SceneNode *sceneNode) |
| void | SetName (const std::string &name) |
| std::string | GetName () const |
| void | SetStatic (bool s) |
| bool | IsStatic () const |
| bool | operator== (const Entity &ent) |
Public Attributes | |
| std::vector< Entity * > | children |
| dSpaceID | spaceId |
Protected Attributes | |
| Entity * | parent |
| Ogre::SceneNode * | sceneNode |
Constructor & Destructor Documentation
| virtual ~Entity | ( | ) | [virtual] |
Destructor
Member Function Documentation
| int GetId | ( | ) | const |
| int GetParentId | ( | ) | const |
Return the ID of the parent
- Returns:
- Integer ID
| void SetParent | ( | Entity * | parent | ) |
Set the parent
- Parameters:
-
parent Parent entity
| Entity* GetParent | ( | ) | const |
Get the parent
- Returns:
- Pointer to the parent entity
| void AddChild | ( | Entity * | child | ) |
Add a child to this entity
- Parameters:
-
child Child entity
| std::vector< Entity* >& GetChildren | ( | ) |
Get all children
- Returns:
- Vector of children entities
| Ogre::SceneNode* GetSceneNode | ( | ) | const |
Return this entity's sceneNode
- Returns:
- Ogre scene node
| void SetSceneNode | ( | Ogre::SceneNode * | sceneNode | ) |
Set the scene node
- Parameters:
-
sceneNode Ogre scene node
| void SetName | ( | const std::string & | name | ) |
Set the name of the entity
- Parameters:
-
name Body name
| std::string GetName | ( | ) | const |
Return the name of the entity
- Returns:
- Name of the entity
| void SetStatic | ( | bool | s | ) |
Set whether this entity is static: immovable
- Parameters:
-
s Bool, true = static
| bool IsStatic | ( | ) | const |
Return whether this entity is static
- Returns:
- bool True = static
| bool operator== | ( | const Entity & | ent | ) |
Returns true if the entities are the same. Checks only the name
Member Data Documentation
Ogre::SceneNode* sceneNode [protected] |
OGRE stuff
| dSpaceID spaceId |
ODE Stuff
The documentation for this class was generated from the following file: