sdf::SDF_VERSION_NAMESPACE::Friction Class Reference

Friction information for a surface. More...

#include <Surface.hh>

Public Member Functions
	Friction ()
	Default constructor.
const sdf::BulletFriction *	BulletFriction () const
	Get the associated BulletFriction object.
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load.
Errors	Load (ElementPtr _sdf)
	Load the friction based on a element pointer.
const sdf::ODE *	ODE () const
	Get the associated ODE object.
void	SetBulletFriction (const sdf::BulletFriction &_bullet)
	Set the associated BulletFriction object.
void	SetODE (const sdf::ODE &_ode)
	Set the associated ODE object.
void	SetTorsional (const sdf::Torsional &_torsional)
	Set the torsional friction.
const sdf::Torsional *	Torsional () const
	Get the torsional friction.

Detailed Description

Friction information for a surface.

Constructor & Destructor Documentation

Friction()

sdf::SDF_VERSION_NAMESPACE::Friction::Friction

(

)

Default constructor.

Member Function Documentation

BulletFriction()

const sdf::BulletFriction * sdf::SDF_VERSION_NAMESPACE::Friction::BulletFriction

(

)

const

Get the associated BulletFriction object.

Returns

Pointer to the associated BulletFriction object, nullptr if the Surface doesn't contain a BulletFriction element.

Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Friction::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.

Load()

Errors sdf::SDF_VERSION_NAMESPACE::Friction::Load

(

ElementPtr

_sdf

)

Load the friction 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]

_sdf

The 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.

ODE()

const sdf::ODE * sdf::SDF_VERSION_NAMESPACE::Friction::ODE

(

)

const

Get the associated ODE object.

Returns

Pointer to the associated ODE object, nullptr if the Surface doesn't contain a ODE element.

SetBulletFriction()

void sdf::SDF_VERSION_NAMESPACE::Friction::SetBulletFriction

(

const sdf::BulletFriction &

_bullet

)

Set the associated BulletFriction object.

Parameters

[in]

_bullet

The BulletFriction object.

SetODE()

void sdf::SDF_VERSION_NAMESPACE::Friction::SetODE

(

const sdf::ODE &

_ode

)

Set the associated ODE object.

Parameters

[in]

_ode

The ODE object.

SetTorsional()

void sdf::SDF_VERSION_NAMESPACE::Friction::SetTorsional

(

const sdf::Torsional &

_torsional

)

Set the torsional friction.

Parameters

[in]

_torsional

The torsional friction.

Torsional()

const sdf::Torsional * sdf::SDF_VERSION_NAMESPACE::Friction::Torsional

(

)

const

Get the torsional friction.

Returns

Pointer to the torsional friction nullptr if the Surface doesn't contain a torsional friction element.

---

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

• Surface.hh