sdf::v9::Surface Class Reference

Surface information for a collision. More...

#include <Surface.hh>

Public Member Functions
	Surface ()
	Default constructor. More...
	Surface (const Surface &_surface)
	Copy constructor. More...
	Surface (Surface &&_surface) noexcept
	Move constructor. More...
	~Surface ()
	Destructor. More...
sdf::Contact *	Contact () const
	Get the associated contact object. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the surface based on a element pointer. More...
Surface &	operator= (Surface &&_surface)
	Move assignment operator. More...
Surface &	operator= (const Surface &_surface)
	Copy assignment operator. More...
void	SetContact (const sdf::Contact &_contact)
	Set the associated contact object. More...

Detailed Description

Surface information for a collision.

Constructor & Destructor Documentation

Surface() [1/3]

sdf::v9::Surface::Surface

(

)

Default constructor.

Surface() [2/3]

sdf::v9::Surface::Surface

(

const Surface &

_surface

)

Copy constructor.

Parameters

[in]

_surface

Surface to copy.

Surface() [3/3]

sdf::v9::Surface::Surface ( Surface &&  _surface )

noexcept

Move constructor.

Parameters

[in]

_surface

Surface to move.

~Surface()

sdf::v9::Surface::~Surface

(

)

Destructor.

Member Function Documentation

Contact()

sdf::Contact* sdf::v9::Surface::Contact

(

)

const

Get the associated contact object.

Returns

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

Element()

sdf::ElementPtr sdf::v9::Surface::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::v9::Surface::Load

(

ElementPtr

_sdf

)

Load the surface 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.

operator=() [1/2]

Surface& sdf::v9::Surface::operator=

(

Surface &&

_surface

)

Move assignment operator.

Parameters

[in]

_surface

Surface to move.

Returns

Reference to this.

operator=() [2/2]

Surface& sdf::v9::Surface::operator=

(

const Surface &

_surface

)

Copy assignment operator.

Parameters

[in]

_surface

Surface to copy.

Returns

Reference to this.

SetContact()

void sdf::v9::Surface::SetContact

(

const sdf::Contact &

_contact

)

Set the associated contact object.

Parameters

[in]

_cont

The contact object.

---

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

• Surface.hh