Public Member Functions | Public Attributes | List of all members
gazebo::physics::SurfaceParams Class Reference

SurfaceParams defines various Surface contact parameters. More...

#include <physics/physics.hh>

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

Public Member Functions

 SurfaceParams ()
 Constructor. More...
 
virtual ~SurfaceParams ()
 Destructor. More...
 
virtual void FillMsg (msgs::Surface &_msg)
 Fill in a surface message. More...
 
virtual FrictionPyramidPtr FrictionPyramid () const
 Get access to FrictionPyramid data, if available. More...
 
virtual FrictionPyramidPtr GetFrictionPyramid () const GAZEBO_DEPRECATED(7.0)
 Get access to FrictionPyramid data, if available. More...
 
virtual void Load (sdf::ElementPtr _sdf)
 Load the contact params. More...
 
virtual void ProcessMsg (const msgs::Surface &_msg)
 Process a surface message. More...
 

Public Attributes

unsigned int collideBitmask
 Custom collision filtering. More...
 
bool collideWithoutContact
 Allow collision checking without generating a contact joint. More...
 
unsigned int collideWithoutContactBitmask
 Custom collision filtering used when collideWithoutContact is true. More...
 

Detailed Description

SurfaceParams defines various Surface contact parameters.

These parameters defines the properties of a physics::Contact constraint.

Constructor & Destructor Documentation

gazebo::physics::SurfaceParams::SurfaceParams ( )

Constructor.

virtual gazebo::physics::SurfaceParams::~SurfaceParams ( )
virtual

Destructor.

Member Function Documentation

virtual void gazebo::physics::SurfaceParams::FillMsg ( msgs::Surface &  _msg)
virtual

Fill in a surface message.

Parameters
[in]_msgMessage to fill with this object's values.

Reimplemented in gazebo::physics::DARTSurfaceParams, gazebo::physics::BulletSurfaceParams, and gazebo::physics::ODESurfaceParams.

virtual FrictionPyramidPtr gazebo::physics::SurfaceParams::FrictionPyramid ( ) const
virtual

Get access to FrictionPyramid data, if available.

Returns
Pointer to FrictionPyramid data or NULL if class does not use FrictionPyramid data.

Reimplemented in gazebo::physics::DARTSurfaceParams, gazebo::physics::BulletSurfaceParams, and gazebo::physics::ODESurfaceParams.

virtual FrictionPyramidPtr gazebo::physics::SurfaceParams::GetFrictionPyramid ( ) const
virtual

Get access to FrictionPyramid data, if available.

Returns
Pointer to FrictionPyramid data or NULL if class does not use FrictionPyramid data.
Deprecated:
See function FrictionPyramid

Reimplemented in gazebo::physics::DARTSurfaceParams, gazebo::physics::BulletSurfaceParams, and gazebo::physics::ODESurfaceParams.

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

Load the contact params.

Parameters
[in]_sdfSDF values to load from.

Reimplemented in gazebo::physics::DARTSurfaceParams, gazebo::physics::BulletSurfaceParams, and gazebo::physics::ODESurfaceParams.

virtual void gazebo::physics::SurfaceParams::ProcessMsg ( const msgs::Surface &  _msg)
virtual

Process a surface message.

Parameters
[in]_msgMessage to read values from.

Reimplemented in gazebo::physics::DARTSurfaceParams, gazebo::physics::BulletSurfaceParams, and gazebo::physics::ODESurfaceParams.

Member Data Documentation

unsigned int gazebo::physics::SurfaceParams::collideBitmask

Custom collision filtering.

Will override collideWithoutContact.

bool gazebo::physics::SurfaceParams::collideWithoutContact

Allow collision checking without generating a contact joint.

unsigned int gazebo::physics::SurfaceParams::collideWithoutContactBitmask

Custom collision filtering used when collideWithoutContact is true.


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