sdf::SDF_VERSION_NAMESPACE::Contact Class Reference

Contact information for a surface. More...

#include <Surface.hh>

Public Member Functions
	Contact ()
	Default constructor.
std::optional< uint16_t >	CategoryBitmask () const
	Get the category bitmask parameter.
uint16_t	CollideBitmask () const
	Get the collide bitmask parameter.
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load.
Errors	Load (ElementPtr _sdf)
	Load the contact based on a element pointer.
void	SetCategoryBitmask (const uint16_t _bitmask)
	Set the category bitmask parameter.
void	SetCollideBitmask (const uint16_t _bitmask)
	Set the collide bitmask parameter.

Detailed Description

Contact information for a surface.

Constructor & Destructor Documentation

Contact()

sdf::SDF_VERSION_NAMESPACE::Contact::Contact

(

)

Default constructor.

Member Function Documentation

CategoryBitmask()

std::optional< uint16_t > sdf::SDF_VERSION_NAMESPACE::Contact::CategoryBitmask

(

)

const

Get the category bitmask parameter.

Returns

The category bitmask parameter.

CollideBitmask()

uint16_t sdf::SDF_VERSION_NAMESPACE::Contact::CollideBitmask

(

)

const

Get the collide bitmask parameter.

Returns

The collide bitmask parameter.

Element()

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

SetCategoryBitmask()

void sdf::SDF_VERSION_NAMESPACE::Contact::SetCategoryBitmask

(

const uint16_t

_bitmask

)

Set the category bitmask parameter.

Parameters

[in]

_bitmask

Category bitmask to set

SetCollideBitmask()

void sdf::SDF_VERSION_NAMESPACE::Contact::SetCollideBitmask

(

const uint16_t

_bitmask

)

Set the collide bitmask parameter.

Parameters

[in]

_bitmask

Category bitmask to set

---

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

• Surface.hh