All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::physics::BoxShape Class Reference

Box geometry primitive. More...

#include <physics/physcs.hh>

Inheritance diagram for gazebo::physics::BoxShape:
Inheritance graph

Public Member Functions

 BoxShape (CollisionPtr _parent)
virtual ~BoxShape ()
void FillMsg (msgs::Geometry &_msg)
 Fill in the values for a geomertry message.
void FillShapeMsg (msgs::Geometry &_msg) GAZEBO_DEPRECATED
virtual void GetInertial (double _mass, InertialPtr _inertial) const
 Get inertial for a shape.
virtual double GetMass (double _density) const
 Get the mass of the box give a density value.
math::Vector3 GetSize () const
 Get the size of the box.
virtual void Init ()
 Initialize the box.
virtual void ProcessMsg (const msgs::Geometry &_msg)
 Process a geometry message.
virtual void SetSize (const math::Vector3 &_size)
 Set the size of the box.
- Public Member Functions inherited from gazebo::physics::Shape
 Shape (CollisionPtr p)
virtual ~Shape ()
- Public Member Functions inherited from gazebo::physics::Base
 Base (BasePtr parent)
virtual ~Base ()
void AddChild (BasePtr _child)
 Add a child to this entity.
void AddType (EntityType _type)
 Add a type specifier.
virtual void Fini ()
 Finialize the object.
BasePtr GetById (unsigned int _id) const
 Get a child or self by id.
BasePtr GetByName (const std::string &_name)
 Get by name.
BasePtr GetChild (unsigned int _i) const
 Get a child by index.
BasePtr GetChild (const std::string &_name)
 Get a child by name.
unsigned int GetChildCount () const
 Get the number of children.
unsigned int GetId () const
 Return the ID of this entity.
std::string GetName () const
 Return the name of the entity.
BasePtr GetParent () const
 Get the parent.
int GetParentId () const
 Return the ID of the parent.
bool GetSaveable () const
 Get whether the object should be "saved", when the user selects to save the world to xml.
std::string GetScopedName () const
 Return the name of this entity with the model scope world::model1::...::modelN::entityName.
virtual const sdf::ElementPtr GetSDF ()
 Get the SDF values for the object.
unsigned int GetType () const
 Get the full type definition.
const WorldPtrGetWorld () const
 Get the World this object is in.
bool HasType (const EntityType &_t) const
 Returns true if this object's type definition has the given type.
bool IsSelected () const
 True if the entity is selected by the user.
virtual void Load (sdf::ElementPtr _sdf)
bool operator== (const Base &_ent) const
 Returns true if the entities are the same.
void Print (const std::string &_prefix)
 Print this object to screen via gzmsg.
virtual void RemoveChild (unsigned int _id)
 Remove a child from this entity.
void RemoveChild (const std::string &_name)
 Remove a child by name.
void RemoveChildren ()
 Remove all children.
virtual void Reset ()
 Reset the object.
virtual void Reset (Base::EntityType _resetType)
 Calls recursive Reset on one of the Base::EntityType's.
virtual void SetName (const std::string &_name)
 Set the name of the entity.
void SetParent (BasePtr _parent)
 Set the parent.
void SetSaveable (bool _v)
 Set whether the object should be "saved", when the user selects to save the world to xml.
virtual bool SetSelected (bool _show)
 Set whether this entity has been selected by the user through the gui.
void SetWorld (const WorldPtr &_newWorld)
 Set the world this object belongs to.
virtual void Update ()
 Update the object.
virtual void UpdateParameters (sdf::ElementPtr _sdf)
 Update the parameters using new sdf values.

Additional Inherited Members

- Public Types inherited from gazebo::physics::Base
enum  EntityType {
  BASE = 0x00000000, ENTITY = 0x00000001, MODEL = 0x00000002, LINK = 0x00000004,
  COLLISION = 0x00000008, ACTOR = 0x00000016, LIGHT = 0x00000010, VISUAL = 0x00000020,
  JOINT = 0x00000040, BALL_JOINT = 0x00000080, HINGE2_JOINT = 0x00000100, HINGE_JOINT = 0x00000200,
  SLIDER_JOINT = 0x00000400, SCREW_JOINT = 0x00000800, UNIVERSAL_JOINT = 0x00001000, SHAPE = 0x00002000,
  BOX_SHAPE = 0x00004000, CYLINDER_SHAPE = 0x00008000, HEIGHTMAP_SHAPE = 0x00010000, MAP_SHAPE = 0x00020000,
  MULTIRAY_SHAPE = 0x00040000, RAY_SHAPE = 0x00080000, PLANE_SHAPE = 0x00100000, SPHERE_SHAPE = 0x00200000,
  TRIMESH_SHAPE = 0x00400000
 Unique identifiers for all entity types. More...
- Public Attributes inherited from gazebo::physics::Shape
CollisionPtr collisionParent
- Protected Attributes inherited from gazebo::physics::Base
Base_V children
 Children of this entity.
Base_V::iterator childrenEnd
 End of the children vector.
BasePtr parent
 Parent of this entity.
sdf::ElementPtr sdf
 The SDF values for this object.
WorldPtr world
 Pointer to the world.

Detailed Description

Box geometry primitive.

Constructor & Destructor Documentation

gazebo::physics::BoxShape::BoxShape ( CollisionPtr  _parent)


[in]_parentParent Collision.
virtual gazebo::physics::BoxShape::~BoxShape ( )


Member Function Documentation

void gazebo::physics::BoxShape::FillMsg ( msgs::Geometry &  _msg)

Fill in the values for a geomertry message.

[out]_msgThe geometry message to fill.

Implements gazebo::physics::Shape.

void gazebo::physics::BoxShape::FillShapeMsg ( msgs::Geometry &  _msg)


Reimplemented from gazebo::physics::Shape.

virtual void gazebo::physics::BoxShape::GetInertial ( double  _mass,
InertialPtr  _inertial 
) const

Get inertial for a shape.

[in]_massMass of the box.
[out]_inertialInertial element to populate with the result.

Reimplemented from gazebo::physics::Shape.

virtual double gazebo::physics::BoxShape::GetMass ( double  _density) const

Get the mass of the box give a density value.

[in]_densityDensity to compute a mass from.

Reimplemented from gazebo::physics::Shape.

math::Vector3 gazebo::physics::BoxShape::GetSize ( ) const

Get the size of the box.

The size of each side of the box.
virtual void gazebo::physics::BoxShape::Init ( )

Initialize the box.

Implements gazebo::physics::Shape.

virtual void gazebo::physics::BoxShape::ProcessMsg ( const msgs::Geometry &  _msg)

Process a geometry message.

[in]_msgThe message to set values from.

Implements gazebo::physics::Shape.

virtual void gazebo::physics::BoxShape::SetSize ( const math::Vector3 _size)

Set the size of the box.

[in]_sizeSize of each side of the box.

Reimplemented in gazebo::physics::BulletBoxShape, and gazebo::physics::ODEBoxShape.

Referenced by gazebo::physics::ODEBoxShape::SetSize(), and gazebo::physics::BulletBoxShape::SetSize().

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