Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gazebo::physics::PhysicsEngine Class Referenceabstract

Base class for a physics engine. More...

#include <physics/physics.hh>

Inheritance diagram for gazebo::physics::PhysicsEngine:
Inheritance graph
[legend]

Public Member Functions

 PhysicsEngine (WorldPtr _world)
 Default constructor. More...
 
virtual ~PhysicsEngine ()
 Destructor. More...
 
virtual CollisionPtr CreateCollision (const std::string &_shapeType, LinkPtr _link)=0
 Create a collision. More...
 
CollisionPtr CreateCollision (const std::string &_shapeType, const std::string &_linkName)
 Create a collision. More...
 
virtual JointPtr CreateJoint (const std::string &_type, ModelPtr _parent=ModelPtr())=0
 Create a new joint. More...
 
virtual LinkPtr CreateLink (ModelPtr _parent)=0
 Create a new body. More...
 
virtual ModelPtr CreateModel (BasePtr _base)
 Create a new model. More...
 
virtual ShapePtr CreateShape (const std::string &_shapeType, CollisionPtr _collision)=0
 Create a physics::Shape object. More...
 
virtual void DebugPrint () const =0
 Debug print out of the physic engine state. More...
 
virtual void Fini ()
 Finilize the physics engine. More...
 
virtual bool GetAutoDisableFlag ()
 : Remove this function, and replace it with a more generic property map More...
 
ContactManagerGetContactManager () const
 Get a pointer to the contact manger. More...
 
virtual double GetContactMaxCorrectingVel () GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map. More...
 
virtual double GetContactSurfaceLayer () GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map. More...
 
virtual math::Vector3 GetGravity () const
 Return the gravity vector. More...
 
virtual unsigned int GetMaxContacts ()
 : Remove this function, and replace it with a more generic property map. More...
 
double GetMaxStepSize () const
 Get max step size. More...
 
virtual boost::any GetParam (const std::string &_key) const
 Get an parameter of the physics engine. More...
 
virtual bool GetParam (const std::string &_key, boost::any &_value) const
 Get a parameter from the physics engine with a boolean to indicate success or failure. More...
 
boost::recursive_mutex * GetPhysicsUpdateMutex () const
 returns a pointer to the PhysicsEngine::physicsUpdateMutex. More...
 
double GetRealTimeUpdateRate () const
 Get real time update rate. More...
 
sdf::ElementPtr GetSDF () const
 Get a pointer to the SDF element for this physics engine. More...
 
double GetTargetRealTimeFactor () const
 Get target real time factor. More...
 
virtual std::string GetType () const =0
 Return the physics engine type (ode|bullet|dart|simbody). More...
 
double GetUpdatePeriod ()
 Get the simulation update period. More...
 
virtual double GetWorldCFM () GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map More...
 
virtual double GetWorldERP () GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map More...
 
virtual void Init ()=0
 Initialize the physics engine. More...
 
virtual void InitForThread ()=0
 Init the engine for threads. More...
 
virtual void Load (sdf::ElementPtr _sdf)
 Load the physics engine. More...
 
virtual ignition::math::Vector3d MagneticField () const
 Return the magnetic field vector. More...
 
virtual void Reset ()
 Rest the physics engine. More...
 
virtual void SetAutoDisableFlag (bool _autoDisable)
 : Remove this function, and replace it with a more generic property map More...
 
virtual void SetContactMaxCorrectingVel (double) GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map More...
 
virtual void SetContactSurfaceLayer (double) GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map More...
 
virtual void SetGravity (const gazebo::math::Vector3 &_gravity)=0
 Set the gravity vector. More...
 
virtual void SetMaxContacts (unsigned int _maxContacts)
 : Remove this function, and replace it with a more generic property map More...
 
void SetMaxStepSize (double _stepSize)
 Set max step size. More...
 
virtual bool SetParam (const std::string &_key, const boost::any &_value)
 Set a parameter of the physics engine. More...
 
void SetRealTimeUpdateRate (double _rate)
 Set real time update rate. More...
 
virtual void SetSeed (uint32_t _seed)=0
 Set the random number seed for the physics engine. More...
 
void SetTargetRealTimeFactor (double _factor)
 Set target real time factor. More...
 
virtual void SetWorldCFM (double) GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map More...
 
virtual void SetWorldERP (double) GAZEBO_DEPRECATED(6.0)
 : Remove this function, and replace it with a more generic property map More...
 
virtual void UpdateCollision ()=0
 Update the physics engine collision. More...
 
virtual void UpdatePhysics ()
 Update the physics engine. More...
 

Protected Member Functions

virtual void OnPhysicsMsg (ConstPhysicsPtr &_msg)
 virtual callback for gztopic "~/physics". More...
 
virtual void OnRequest (ConstRequestPtr &_msg)
 virtual callback for gztopic "~/request". More...
 

Protected Attributes

ContactManagercontactManager
 Class that handles all contacts generated by the physics engine. More...
 
double maxStepSize
 Real time update rate. More...
 
transport::NodePtr node
 Node for communication. More...
 
transport::SubscriberPtr physicsSub
 Subscribe to the physics topic. More...
 
boost::recursive_mutex * physicsUpdateMutex
 Mutex to protect the update cycle. More...
 
double realTimeUpdateRate
 Real time update rate. More...
 
transport::SubscriberPtr requestSub
 Subscribe to the request topic. More...
 
transport::PublisherPtr responsePub
 Response publisher. More...
 
sdf::ElementPtr sdf
 Our SDF values. More...
 
double targetRealTimeFactor
 Target real time factor. More...
 
WorldPtr world
 Pointer to the world. More...
 

Detailed Description

Base class for a physics engine.

Constructor & Destructor Documentation

gazebo::physics::PhysicsEngine::PhysicsEngine ( WorldPtr  _world)
explicit

Default constructor.

Parameters
[in]_worldPointer to the world.
virtual gazebo::physics::PhysicsEngine::~PhysicsEngine ( )
virtual

Destructor.

Member Function Documentation

virtual CollisionPtr gazebo::physics::PhysicsEngine::CreateCollision ( const std::string &  _shapeType,
LinkPtr  _link 
)
pure virtual

Create a collision.

Parameters
[in]_shapeTypeType of collision to create.
[in]_linkParent link.

Implemented in gazebo::physics::ODEPhysics, gazebo::physics::DARTPhysics, gazebo::physics::BulletPhysics, and gazebo::physics::SimbodyPhysics.

CollisionPtr gazebo::physics::PhysicsEngine::CreateCollision ( const std::string &  _shapeType,
const std::string &  _linkName 
)

Create a collision.

Parameters
[in]_shapeTypeType of collision to create.
[in]_linkNameName of the parent link.
virtual JointPtr gazebo::physics::PhysicsEngine::CreateJoint ( const std::string &  _type,
ModelPtr  _parent = ModelPtr() 
)
pure virtual

Create a new joint.

Parameters
[in]_typeType of joint to create.
[in]_parentModel parent.

Implemented in gazebo::physics::ODEPhysics, gazebo::physics::DARTPhysics, gazebo::physics::BulletPhysics, and gazebo::physics::SimbodyPhysics.

virtual LinkPtr gazebo::physics::PhysicsEngine::CreateLink ( ModelPtr  _parent)
pure virtual

Create a new body.

Parameters
[in]_parentParent model for the link.

Implemented in gazebo::physics::ODEPhysics, gazebo::physics::DARTPhysics, gazebo::physics::BulletPhysics, and gazebo::physics::SimbodyPhysics.

virtual ModelPtr gazebo::physics::PhysicsEngine::CreateModel ( BasePtr  _base)
virtual

Create a new model.

Parameters
[in]_baseBoost shared pointer to a new model.

Reimplemented in gazebo::physics::DARTPhysics, and gazebo::physics::SimbodyPhysics.

virtual ShapePtr gazebo::physics::PhysicsEngine::CreateShape ( const std::string &  _shapeType,
CollisionPtr  _collision 
)
pure virtual

Create a physics::Shape object.

Parameters
[in]_shapeTypeType of shape to create.
[in]_collisionCollision parent.

Implemented in gazebo::physics::ODEPhysics, gazebo::physics::DARTPhysics, gazebo::physics::BulletPhysics, and gazebo::physics::SimbodyPhysics.

virtual void gazebo::physics::PhysicsEngine::DebugPrint ( ) const
pure virtual
virtual void gazebo::physics::PhysicsEngine::Fini ( )
virtual
virtual bool gazebo::physics::PhysicsEngine::GetAutoDisableFlag ( )
inlinevirtual

: Remove this function, and replace it with a more generic property map

access functions to set ODE parameters..

Returns
Auto disable flag.
ContactManager* gazebo::physics::PhysicsEngine::GetContactManager ( ) const

Get a pointer to the contact manger.

Returns
Pointer to the contact manager.
virtual double gazebo::physics::PhysicsEngine::GetContactMaxCorrectingVel ( )
inlinevirtual

: Remove this function, and replace it with a more generic property map.

access functions to set ODE parameters.

Returns
Max correcting velocity.

Reimplemented in gazebo::physics::ODEPhysics.

virtual double gazebo::physics::PhysicsEngine::GetContactSurfaceLayer ( )
inlinevirtual

: Remove this function, and replace it with a more generic property map.

access functions to set ODE parameters.

Returns
Contact suerface layer depth.

Reimplemented in gazebo::physics::ODEPhysics.

virtual math::Vector3 gazebo::physics::PhysicsEngine::GetGravity ( ) const
virtual

Return the gravity vector.

Returns
The gravity vector.
virtual unsigned int gazebo::physics::PhysicsEngine::GetMaxContacts ( )
inlinevirtual

: Remove this function, and replace it with a more generic property map.

access functions to set ODE parameters.

Returns
Maximum number of allows contacts.

Reimplemented in gazebo::physics::ODEPhysics.

double gazebo::physics::PhysicsEngine::GetMaxStepSize ( ) const

Get max step size.

Returns
Max step size.
virtual boost::any gazebo::physics::PhysicsEngine::GetParam ( const std::string &  _key) const
virtual

Get an parameter of the physics engine.

Parameters
[in]_attrString key
See Also
SetParam
Returns
The value of the parameter

Reimplemented in gazebo::physics::SimbodyPhysics, gazebo::physics::ODEPhysics, gazebo::physics::BulletPhysics, and gazebo::physics::DARTPhysics.

virtual bool gazebo::physics::PhysicsEngine::GetParam ( const std::string &  _key,
boost::any &  _value 
) const
virtual

Get a parameter from the physics engine with a boolean to indicate success or failure.

Parameters
[in]_keyKey of the accessed param
[out]_valueValue of the accessed param
Returns
True if the parameter was successfully retrieved

Reimplemented in gazebo::physics::SimbodyPhysics, gazebo::physics::ODEPhysics, gazebo::physics::BulletPhysics, and gazebo::physics::DARTPhysics.

boost::recursive_mutex* gazebo::physics::PhysicsEngine::GetPhysicsUpdateMutex ( ) const
inline

returns a pointer to the PhysicsEngine::physicsUpdateMutex.

Returns
Pointer to the physics mutex.
double gazebo::physics::PhysicsEngine::GetRealTimeUpdateRate ( ) const

Get real time update rate.

Returns
Update rate
sdf::ElementPtr gazebo::physics::PhysicsEngine::GetSDF ( ) const

Get a pointer to the SDF element for this physics engine.

Returns
Pointer to the physics SDF element.
double gazebo::physics::PhysicsEngine::GetTargetRealTimeFactor ( ) const

Get target real time factor.

Returns
Target real time factor
virtual std::string gazebo::physics::PhysicsEngine::GetType ( ) const
pure virtual

Return the physics engine type (ode|bullet|dart|simbody).

Returns
Type of the physics engine.

Implemented in gazebo::physics::ODEPhysics, gazebo::physics::BulletPhysics, gazebo::physics::DARTPhysics, and gazebo::physics::SimbodyPhysics.

double gazebo::physics::PhysicsEngine::GetUpdatePeriod ( )

Get the simulation update period.

Returns
Simulation update period.
virtual double gazebo::physics::PhysicsEngine::GetWorldCFM ( )
inlinevirtual

: Remove this function, and replace it with a more generic property map

Get World CFM.

Returns
World CFM.

Reimplemented in gazebo::physics::ODEPhysics, and gazebo::physics::BulletPhysics.

virtual double gazebo::physics::PhysicsEngine::GetWorldERP ( )
inlinevirtual

: Remove this function, and replace it with a more generic property map

Get World ERP.

Returns
World ERP.

Reimplemented in gazebo::physics::ODEPhysics.

virtual void gazebo::physics::PhysicsEngine::Init ( )
pure virtual
virtual void gazebo::physics::PhysicsEngine::InitForThread ( )
pure virtual
virtual void gazebo::physics::PhysicsEngine::Load ( sdf::ElementPtr  _sdf)
virtual

Load the physics engine.

Parameters
[in]_sdfPointer to the SDF parameters.

Reimplemented in gazebo::physics::ODEPhysics, gazebo::physics::BulletPhysics, gazebo::physics::DARTPhysics, and gazebo::physics::SimbodyPhysics.

virtual ignition::math::Vector3d gazebo::physics::PhysicsEngine::MagneticField ( ) const
virtual

Return the magnetic field vector.

Returns
The magnetic field vector.
virtual void gazebo::physics::PhysicsEngine::OnPhysicsMsg ( ConstPhysicsPtr &  _msg)
protectedvirtual

virtual callback for gztopic "~/physics".

Parameters
[in]_msgPhysics message.

Reimplemented in gazebo::physics::ODEPhysics, gazebo::physics::SimbodyPhysics, gazebo::physics::DARTPhysics, and gazebo::physics::BulletPhysics.

virtual void gazebo::physics::PhysicsEngine::OnRequest ( ConstRequestPtr &  _msg)
protectedvirtual

virtual callback for gztopic "~/request".

Parameters
[in]_msgRequest message.

Reimplemented in gazebo::physics::ODEPhysics, gazebo::physics::SimbodyPhysics, gazebo::physics::DARTPhysics, and gazebo::physics::BulletPhysics.

virtual void gazebo::physics::PhysicsEngine::Reset ( )
inlinevirtual
virtual void gazebo::physics::PhysicsEngine::SetAutoDisableFlag ( bool  _autoDisable)
virtual

: Remove this function, and replace it with a more generic property map

Access functions to set ODE parameters.

Parameters
[in]_autoDisableTrue to enable auto disabling of bodies.
virtual void gazebo::physics::PhysicsEngine::SetContactMaxCorrectingVel ( double  )
inlinevirtual

: Remove this function, and replace it with a more generic property map

Access functions to set ODE parameters.

Parameters
[in]_velMax correcting velocity.

Reimplemented in gazebo::physics::ODEPhysics.

virtual void gazebo::physics::PhysicsEngine::SetContactSurfaceLayer ( double  )
inlinevirtual

: Remove this function, and replace it with a more generic property map

Access functions to set ODE parameters.

Parameters
[in]_layerDepthSurface layer depth

Reimplemented in gazebo::physics::ODEPhysics.

virtual void gazebo::physics::PhysicsEngine::SetGravity ( const gazebo::math::Vector3 _gravity)
pure virtual

Set the gravity vector.

Parameters
[in]_gravityNew gravity vector.

Implemented in gazebo::physics::BulletPhysics, gazebo::physics::ODEPhysics, gazebo::physics::DARTPhysics, and gazebo::physics::SimbodyPhysics.

virtual void gazebo::physics::PhysicsEngine::SetMaxContacts ( unsigned int  _maxContacts)
virtual

: Remove this function, and replace it with a more generic property map

access functions to set ODE parameters

Parameters
[in]_maxContactsMaximum number of contacts.

Reimplemented in gazebo::physics::ODEPhysics.

void gazebo::physics::PhysicsEngine::SetMaxStepSize ( double  _stepSize)

Set max step size.

Parameters
[in]_stepSizeMax step size.
virtual bool gazebo::physics::PhysicsEngine::SetParam ( const std::string &  _key,
const boost::any &  _value 
)
virtual

Set a parameter of the physics engine.

See SetParam documentation for descriptions of duplicate parameters.

Parameters
[in]_keyString key Below is a list of _key parameter definitions:
  1. "solver_type" (string) - returns solver used by engine, e.g. "sequential_impulse' for Bullet, "quick" for ODE "Featherstone and Lemkes" for DART and "Spatial Algebra and Elastic Foundation" for Simbody. -# "cfm" (double) - global CFM (ODE/Bullet) -# "erp" (double) - global ERP (ODE/Bullet) -# "precon_iters" (bool) - precondition iterations (experimental). (ODE)
  2. "iters" (int) - number of LCP PGS iterations. If sor_lcp_tolerance is negative, full iteration count is executed. Otherwise, PGS may stop iteration early if sor_lcp_tolerance is satisfied by the total RMS residual.
  3. "sor" (double) - relaxation parameter for Projected Gauss-Seidel (PGS) updates. (ODE/Bullet)
  4. "contact_max_correcting_vel" (double) - truncates correction impulses from ERP by this value. (ODE)
  5. "contact_surface_layer" (double) - ERP is 0 for interpenetration depths below this value. (ODE/Bullet)
  6. "max_contacts" (int) - max number of contact constraints between any pair of collision bodies.
  7. "min_step_size" (double) - minimum internal step size. (defined but not used in ode).
  8. "max_step_size" (double) - maximum physics step size when physics update step must return.
[in]_valueThe value to set to
Returns
true if SetParam is successful, false if operation fails.

Reimplemented in gazebo::physics::SimbodyPhysics, gazebo::physics::ODEPhysics, gazebo::physics::BulletPhysics, and gazebo::physics::DARTPhysics.

void gazebo::physics::PhysicsEngine::SetRealTimeUpdateRate ( double  _rate)

Set real time update rate.

Parameters
[in]_rateUpdate rate
virtual void gazebo::physics::PhysicsEngine::SetSeed ( uint32_t  _seed)
pure virtual

Set the random number seed for the physics engine.

Parameters
[in]_seedThe random number seed.

Implemented in gazebo::physics::ODEPhysics, gazebo::physics::BulletPhysics, gazebo::physics::DARTPhysics, and gazebo::physics::SimbodyPhysics.

void gazebo::physics::PhysicsEngine::SetTargetRealTimeFactor ( double  _factor)

Set target real time factor.

Parameters
[in]_factorTarget real time factor
virtual void gazebo::physics::PhysicsEngine::SetWorldCFM ( double  )
inlinevirtual

: Remove this function, and replace it with a more generic property map

Access functions to set ODE parameters.

Parameters
[in]_cfmConstraint force mixing.

Reimplemented in gazebo::physics::BulletPhysics, and gazebo::physics::ODEPhysics.

virtual void gazebo::physics::PhysicsEngine::SetWorldERP ( double  )
inlinevirtual

: Remove this function, and replace it with a more generic property map

Access functions to set ODE parameters.

Parameters
[in]_erpError reduction parameter.

Reimplemented in gazebo::physics::ODEPhysics.

virtual void gazebo::physics::PhysicsEngine::UpdateCollision ( )
pure virtual
virtual void gazebo::physics::PhysicsEngine::UpdatePhysics ( )
inlinevirtual

Member Data Documentation

ContactManager* gazebo::physics::PhysicsEngine::contactManager
protected

Class that handles all contacts generated by the physics engine.

double gazebo::physics::PhysicsEngine::maxStepSize
protected

Real time update rate.

transport::NodePtr gazebo::physics::PhysicsEngine::node
protected

Node for communication.

transport::SubscriberPtr gazebo::physics::PhysicsEngine::physicsSub
protected

Subscribe to the physics topic.

boost::recursive_mutex* gazebo::physics::PhysicsEngine::physicsUpdateMutex
protected

Mutex to protect the update cycle.

double gazebo::physics::PhysicsEngine::realTimeUpdateRate
protected

Real time update rate.

transport::SubscriberPtr gazebo::physics::PhysicsEngine::requestSub
protected

Subscribe to the request topic.

transport::PublisherPtr gazebo::physics::PhysicsEngine::responsePub
protected

Response publisher.

sdf::ElementPtr gazebo::physics::PhysicsEngine::sdf
protected

Our SDF values.

double gazebo::physics::PhysicsEngine::targetRealTimeFactor
protected

Target real time factor.

WorldPtr gazebo::physics::PhysicsEngine::world
protected

Pointer to the world.


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