DART physics engine. More...

#include <DARTPhysics.hh>

Inheritance diagram for gazebo::physics::DARTPhysics:

Public Types
enum	DARTParam { MAX_CONTACTS, MIN_STEP_SIZE }
	DART physics parameter types. More...

Public Member Functions
	DARTPhysics (WorldPtr _world)
	Constructor. More...

virtual	~DARTPhysics ()
	Destructor. More...

virtual CollisionPtr	CreateCollision (const std::string &_type, LinkPtr _body)
	Create a collision. More...

virtual JointPtr	CreateJoint (const std::string &_type, ModelPtr _parent)
	Create a new joint. More...

virtual LinkPtr	CreateLink (ModelPtr _parent)
	Create a new body. More...

virtual ModelPtr	CreateModel (BasePtr _parent)
	Create a new model. More...

virtual ShapePtr	CreateShape (const std::string &_shapeType, CollisionPtr _collision)
	Create a physics::Shape object. More...

virtual void	DebugPrint () const
	Debug print out of the physic engine state. More...

virtual void	Fini ()
	Finilize the physics engine. More...

dart::simulation::World *	GetDARTWorld ()
	Get pointer to DART World associated with this DART Physics. More...

virtual boost::any	GetParam (const std::string &_key) const
	Get an parameter of the physics engine. More...

virtual boost::any	GetParam (DARTParam _param) const GAZEBO_DEPRECATED(3.0)
	Get an parameter of the physics engine. More...

virtual std::string	GetType () const
	Return the physics engine type (ode\|bullet\|dart\|simbody). More...

virtual void	Init ()
	Initialize the physics engine. More...

virtual void	InitForThread ()
	Init the engine for threads. More...

virtual void	Load (sdf::ElementPtr _sdf)
	Load the physics engine. More...

virtual void	Reset ()
	Rest the physics engine. More...

virtual void	SetGravity (const gazebo::math::Vector3 &_gravity)
	Set the gavity vector. More...

virtual bool	SetParam (const std::string &_key, const boost::any &_value)
	Set a parameter of the physics engine. More...

virtual void	SetSeed (uint32_t _seed)
	Set the random number seed for the physics engine. More...

virtual void	UpdateCollision ()
	Update the physics engine collision. More...

virtual void	UpdatePhysics ()
	Update the physics engine. More...

Public Member Functions inherited from gazebo::physics::PhysicsEngine
	PhysicsEngine (WorldPtr _world)
	Default constructor. More...

virtual	~PhysicsEngine ()
	Destructor. More...

CollisionPtr	CreateCollision (const std::string &_shapeType, const std::string &_linkName)
	Create a collision. More...

virtual bool	GetAutoDisableFlag ()
	: Remove this function, and replace it with a more generic property map More...

ContactManager *	GetContactManager () const
	Get a pointer to the contact manger. More...

virtual double	GetContactMaxCorrectingVel ()
	: Remove this function, and replace it with a more generic property map. More...

virtual double	GetContactSurfaceLayer ()
	: Remove this function, and replace it with a more generic property map. More...

virtual math::Vector3	GetGravity () const
	Return the gavity 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...

boost::recursive_mutex *	GetPhysicsUpdateMutex () const
	returns a pointer to the PhysicsEngine::physicsUpdateMutex. More...

double	GetRealTimeUpdateRate () const
	Get real time update rate. More...

virtual int	GetSORPGSIters () GAZEBO_DEPRECATED(3.0)
	: Remove this function, and replace it with a more generic property map More...

virtual int	GetSORPGSPreconIters () GAZEBO_DEPRECATED(3.0)
	: Remove this function, and replace it with a more generic property map More...

virtual double	GetSORPGSW () GAZEBO_DEPRECATED(3.0)
	: Remove this function, and replace it with a more generic property map. More...

double	GetTargetRealTimeFactor () const
	Get target real time factor. More...

double	GetUpdatePeriod ()
	Get the simulation update period. More...

virtual double	GetWorldCFM ()
	: Remove this function, and replace it with a more generic property map More...

virtual double	GetWorldERP ()
	: Remove this function, and replace it with a more generic property map More...

virtual void	SetAutoDisableFlag (bool _autoDisable)
	: Remove this function, and replace it with a more generic property map More...

virtual void	SetContactMaxCorrectingVel (double _vel)
	: Remove this function, and replace it with a more generic property map More...

virtual void	SetContactSurfaceLayer (double _layerDepth)
	: Remove this function, and replace it with a more generic property map 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...

void	SetRealTimeUpdateRate (double _rate)
	Set real time update rate. More...

virtual void	SetSORPGSIters (unsigned int _iters) GAZEBO_DEPRECATED(3.0)
	: Remove this function, and replace it with a more generic property map More...

virtual void	SetSORPGSPreconIters (unsigned int _iters) GAZEBO_DEPRECATED(3.0)
	: Remove this function, and replace it with a more generic property map More...

virtual void	SetSORPGSW (double _w) GAZEBO_DEPRECATED(3.0)
	: Remove this function, and replace it with a more generic property map More...

void	SetTargetRealTimeFactor (double _factor)
	Set target real time factor. More...

virtual void	SetWorldCFM (double _cfm)
	: Remove this function, and replace it with a more generic property map More...

virtual void	SetWorldERP (double _erp)
	: Remove this function, and replace it with a more generic property map 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...

Additional Inherited Members
Protected Attributes inherited from gazebo::physics::PhysicsEngine
ContactManager *	contactManager
	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

DART physics engine.

Member Enumeration Documentation

enum gazebo::physics::DARTPhysics::DARTParam

DART physics parameter types.

Enumerator
MAX_CONTACTS	Maximum number of contacts.
MIN_STEP_SIZE	Minimum step size.

Constructor & Destructor Documentation

gazebo::physics::DARTPhysics::DARTPhysics ( WorldPtr _world)

Constructor.

virtual gazebo::physics::DARTPhysics::~DARTPhysics ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Create a collision.

Parameters

[in]	_shapeType	Type of collision to create.
[in]	_link	Parent link.

Implements gazebo::physics::PhysicsEngine.

virtual JointPtr gazebo::physics::DARTPhysics::CreateJoint	(	const std::string &	_type,
		ModelPtr	_parent
	)

virtual

Create a new joint.

Parameters

[in]	_type	Type of joint to create.
[in]	_parent	Model parent.

Implements gazebo::physics::PhysicsEngine.

virtual LinkPtr gazebo::physics::DARTPhysics::CreateLink ( ModelPtr _parent)

virtual

Create a new body.

Parameters

[in] _parent Parent model for the link.

Implements gazebo::physics::PhysicsEngine.

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

virtual

Create a new model.

Parameters

[in] _base Boost shared pointer to a new model.

Reimplemented from gazebo::physics::PhysicsEngine.

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

virtual

Create a physics::Shape object.

Parameters

[in]	_shapeType	Type of shape to create.
[in]	_collision	Collision parent.

Implements gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::DebugPrint ( ) const

virtual

Debug print out of the physic engine state.

Implements gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::Fini ( )

virtual

Finilize the physics engine.

Reimplemented from gazebo::physics::PhysicsEngine.

dart::simulation::World* gazebo::physics::DARTPhysics::GetDARTWorld ( )

Get pointer to DART World associated with this DART Physics.

Returns: The pointer to DART World.

virtual boost::any gazebo::physics::DARTPhysics::GetParam ( const std::string & _key) const

virtual

Get an parameter of the physics engine.

Parameters

[in] _attr String key

See Also: SetParam

Returns: The value of the parameter

Reimplemented from gazebo::physics::PhysicsEngine.

virtual boost::any gazebo::physics::DARTPhysics::GetParam ( DARTParam _param) const

virtual

Get an parameter of the physics engine.

See Also: boost::any GetParam(const std::string &_key) const

Parameters

[in] _param A parameter listed in the ODEParam enum

Returns: The value of the parameter

virtual std::string gazebo::physics::DARTPhysics::GetType ( ) const

virtual

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

Returns: Type of the physics engine.

Implements gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::Init ( )

virtual

Initialize the physics engine.

Implements gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::InitForThread ( )

virtual

Init the engine for threads.

Implements gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::Load ( sdf::ElementPtr _sdf)

virtual

Load the physics engine.

Parameters

[in] _sdf Pointer to the SDF parameters.

Reimplemented from gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::OnPhysicsMsg ( ConstPhysicsPtr & _msg)

protectedvirtual

virtual callback for gztopic "~/physics".

Parameters

[in] _msg Physics message.

Reimplemented from gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::OnRequest ( ConstRequestPtr & _msg)

protectedvirtual

virtual callback for gztopic "~/request".

Parameters

[in] _msg Request message.

Reimplemented from gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::Reset ( )

virtual

Rest the physics engine.

Reimplemented from gazebo::physics::PhysicsEngine.

virtual void gazebo::physics::DARTPhysics::SetGravity ( const gazebo::math::Vector3 & _gravity)

virtual

Set the gavity vector.

Parameters

[in] _gravity New gravity vector.

Implements gazebo::physics::PhysicsEngine.

virtual bool gazebo::physics::DARTPhysics::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]	_key	String key Below is a list of _key parameter definitions: "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. -# "type" (string) - deprecated, use keyword "solver_type". -# "cfm" (double) - global CFM -# "erp" (double) - global ERP -# "precon_iters" (bool) - precondition iterations (experimental). "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. "sor" (double) - relaxation parameter for Projected Gauss-Seidel (PGS) updates. "contact_max_correcting_vel" (double) - truncates correction impulses from ERP by this value. "contact_surface_layer" (double) - ERP is 0 for interpenetration depths below this value. "max_contacts" (int) - max number of contact constraints between any pair of collision bodies. "min_step_size" (double) - minimum internal step size. (defined but not used in ode). "max_step_size" (double) - maximum physics step size when physics update step must return.
[in]	_value	The value to set to