sdf::v10::Plane Class Reference

Plane represents a plane shape, and is usually accessed through a Geometry. More...

#include <Plane.hh>

Public Member Functions
	Plane ()
	Constructor. More...
	Plane (const Plane &_plane)
	Copy constructor. More...
	Plane (Plane &&_plane) noexcept
	Move constructor. More...
virtual	~Plane ()
	Destructor. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the plane geometry based on a element pointer. More...
ignition::math::Vector3d	Normal () const
	Get the plane normal vector. More...
Plane &	operator= (const Plane &_plane)
	Assignment operator. More...
Plane &	operator= (Plane &&_plane)
	Move assignment operator. More...
void	SetNormal (const ignition::math::Vector3d &_normal)
	Set the plane normal vector. More...
void	SetSize (const ignition::math::Vector2d &_size)
	Set the plane size in meters. More...
ignition::math::Planed &	Shape ()
	Get a mutable Ignition Math representation of this Plane. More...
const ignition::math::Planed &	Shape () const
	Get the Ignition Math representation of this Plane. More...
ignition::math::Vector2d	Size () const
	Get the plane size in meters. More...

Detailed Description

Plane represents a plane shape, and is usually accessed through a Geometry.

Constructor & Destructor Documentation

Plane() [1/3]

sdf::v10::Plane::Plane

(

)

Constructor.

Plane() [2/3]

sdf::v10::Plane::Plane

(

const Plane &

_plane

)

Copy constructor.

Parameters

[in]

_plane

Plane to copy.

Plane() [3/3]

sdf::v10::Plane::Plane ( Plane &&  _plane )

noexcept

Move constructor.

Parameters

[in]

_plane

Plane to move.

~Plane()

virtual sdf::v10::Plane::~Plane ( )

virtual

Destructor.

Member Function Documentation

Element()

sdf::ElementPtr sdf::v10::Plane::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::v10::Plane::Load

(

ElementPtr

_sdf

)

Load the plane geometry 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.

Normal()

ignition::math::Vector3d sdf::v10::Plane::Normal

(

)

const

Get the plane normal vector.

When a Plane is used as a geometry for a Visual or Collision object, then the normal is specified in the Visual or Collision frame, respectively.

Returns

The plane normal vector.

operator=() [1/2]

Plane& sdf::v10::Plane::operator=

(

const Plane &

_plane

)

Assignment operator.

Parameters

[in]

_plane

The plane to set values from.

Returns

*this

operator=() [2/2]

Plane& sdf::v10::Plane::operator=

(

Plane &&

_plane

)

Move assignment operator.

Parameters

[in]

_plane

Plane to move.

Returns

Reference to this.

SetNormal()

void sdf::v10::Plane::SetNormal

(

const ignition::math::Vector3d &

_normal

)

Set the plane normal vector.

The _normal vector will be normalized. See ignition::math::Vector3d Normal() for more information about the normal vector, such as the frame in which it is specified.

Parameters

[in]

_normal

The plane normal vector.

SetSize()

void sdf::v10::Plane::SetSize

(

const ignition::math::Vector2d &

_size

)

Set the plane size in meters.

Parameters

[in]

_size

The plane size in meters.

Shape() [1/2]

ignition::math::Planed& sdf::v10::Plane::Shape

(

)

Get a mutable Ignition Math representation of this Plane.

Returns

A reference to an ignition::math::Planed object.

Shape() [2/2]

const ignition::math::Planed& sdf::v10::Plane::Shape

(

)

const

Get the Ignition Math representation of this Plane.

Returns

A const reference to an ignition::math::Planed object.

Size()

ignition::math::Vector2d sdf::v10::Plane::Size

(

)

const

Get the plane size in meters.

Returns

The plane size in meters.

---

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

• Plane.hh