sdf::v9::Contact Class Reference

Contact information for a surface. More...

#include <Surface.hh>

Public Member Functions
	Contact ()
	Default constructor. More...
	Contact (const Contact &_contact)
	Copy constructor. More...
	Contact (Contact &&_contact) noexcept
	Move constructor. More...
	~Contact ()
	Destructor. More...
uint16_t	CollideBitmask () const
	Get the collide bitmask parameter. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the contact based on a element pointer. More...
Contact &	operator= (const Contact &_contact)
	Copy assignment operator. More...
Contact &	operator= (Contact &&_contact)
	Move assignment operator. More...
void	SetCollideBitmask (const uint16_t _bitmask)
	Set the collide bitmask parameter. More...

Detailed Description

Contact information for a surface.

Constructor & Destructor Documentation

Contact() [1/3]

sdf::v9::Contact::Contact

(

)

Default constructor.

Contact() [2/3]

sdf::v9::Contact::Contact

(

const Contact &

_contact

)

Copy constructor.

Parameters

[in]

_contact

Contact to copy.

Contact() [3/3]

sdf::v9::Contact::Contact ( Contact &&  _contact )

noexcept

Move constructor.

Parameters

[in]

_contact

Contact to move.

~Contact()

sdf::v9::Contact::~Contact

(

)

Destructor.

Member Function Documentation

CollideBitmask()

uint16_t sdf::v9::Contact::CollideBitmask

(

)

const

Get the collide bitmask parameter.

Returns

The collide bitmask parameter.

Element()

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

(

ElementPtr

_sdf

)

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

Contact& sdf::v9::Contact::operator=

(

const Contact &

_contact

)

Copy assignment operator.

Parameters

[in]

_contact

Contact to copy.

Returns

Reference to this.

operator=() [2/2]

Contact& sdf::v9::Contact::operator=

(

Contact &&

_contact

)

Move assignment operator.

Parameters

[in]

_contact

Contact to move.

Returns

Reference to this.

SetCollideBitmask()

void sdf::v9::Contact::SetCollideBitmask

(

const uint16_t

_bitmask

)

Set the collide bitmask parameter.

---

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

• Surface.hh