Public Member Functions | List of all members
sdf::SDF_VERSION_NAMESPACE::ODE Class Reference

ODE information for a friction. More...

#include <Surface.hh>

Public Member Functions

 ODE ()
 Default constructor. More...
 
sdf::ElementPtr Element () const
 Get a pointer to the SDF element that was used during load. More...
 
const gz::math::Vector3d & Fdir1 () const
 Get the fdir. More...
 
Errors Load (ElementPtr _sdf)
 Load the ODE based on a element pointer. More...
 
double Mu () const
 Set the Mu. More...
 
double Mu2 () const
 Get the Mu2. More...
 
void SetFdir1 (const gz::math::Vector3d &_fdir)
 Set fdir. More...
 
void SetMu (double _mu)
 Set Mu. More...
 
void SetMu2 (double _mu2)
 Set Mu2. More...
 
void SetSlip1 (double _slip1)
 Set Slip1. More...
 
void SetSlip2 (double _slip2)
 Set Slip2. More...
 
double Slip1 () const
 Get the slip1. More...
 
double Slip2 () const
 Get the Slip2. More...
 

Detailed Description

ODE information for a friction.

Constructor & Destructor Documentation

◆ ODE()

sdf::SDF_VERSION_NAMESPACE::ODE::ODE ( )

Default constructor.

Member Function Documentation

◆ Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::ODE::Element ( ) const

Get a pointer to the SDF element that was used during load.

Returns
SDF element pointer. The value will be nullptr if Load has not been called.

◆ Fdir1()

const gz::math::Vector3d& sdf::SDF_VERSION_NAMESPACE::ODE::Fdir1 ( ) const

Get the fdir.

Returns
ODE fdir

◆ Load()

Errors sdf::SDF_VERSION_NAMESPACE::ODE::Load ( ElementPtr  _sdf)

Load the ODE based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters
[in]_sdfThe SDF Element pointer
Returns
Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

◆ Mu()

double sdf::SDF_VERSION_NAMESPACE::ODE::Mu ( ) const

Set the Mu.

Returns
ODE mu

◆ Mu2()

double sdf::SDF_VERSION_NAMESPACE::ODE::Mu2 ( ) const

Get the Mu2.

Returns
ODE mu2

◆ SetFdir1()

void sdf::SDF_VERSION_NAMESPACE::ODE::SetFdir1 ( const gz::math::Vector3d &  _fdir)

Set fdir.

Parameters
[in]_fdirODE fdir

◆ SetMu()

void sdf::SDF_VERSION_NAMESPACE::ODE::SetMu ( double  _mu)

Set Mu.

Parameters
[in]_muODE mu

◆ SetMu2()

void sdf::SDF_VERSION_NAMESPACE::ODE::SetMu2 ( double  _mu2)

Set Mu2.

Parameters
[in]_mu2ODE mu2

◆ SetSlip1()

void sdf::SDF_VERSION_NAMESPACE::ODE::SetSlip1 ( double  _slip1)

Set Slip1.

Parameters
[in]_slip1ODE Slip1

◆ SetSlip2()

void sdf::SDF_VERSION_NAMESPACE::ODE::SetSlip2 ( double  _slip2)

Set Slip2.

Parameters
[in]_slip2ODE Slip2

◆ Slip1()

double sdf::SDF_VERSION_NAMESPACE::ODE::Slip1 ( ) const

Get the slip1.

Returns
ODE slip1

◆ Slip2()

double sdf::SDF_VERSION_NAMESPACE::ODE::Slip2 ( ) const

Get the Slip2.

Returns
ODE Slip2

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