Public Member Functions | List of all members
sdf::v12::Surface Class Reference

Surface information for a collision. More...

#include <Surface.hh>

Public Member Functions

 Surface ()
 Default constructor. More...
 
const sdf::ContactContact () 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...
 
void SetContact (const sdf::Contact &_contact)
 Set the associated contact object. More...
 

Detailed Description

Surface information for a collision.

Constructor & Destructor Documentation

◆ Surface()

sdf::v12::Surface::Surface ( )

Default constructor.

Member Function Documentation

◆ Contact()

const sdf::Contact* sdf::v12::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::v12::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::v12::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]_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.

◆ SetContact()

void sdf::v12::Surface::SetContact ( const sdf::Contact _contact)

Set the associated contact object.

Parameters
[in]_contThe contact object.

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