sdf::v10::Box Class Reference

Box represents a box shape, and is usually accessed through a Geometry. More...

#include <Box.hh>

Public Member Functions
	Box ()
	Constructor. More...
	Box (Box &&_box) noexcept
	Move constructor. More...
	Box (const Box &_box)
	Copy constructor. More...
virtual	~Box ()
	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 box geometry based on a element pointer. More...
Box &	operator= (Box &&_box)
	Move assignment operator. More...
Box &	operator= (const Box &_box)
	Assignment operator. More...
void	SetSize (const ignition::math::Vector3d &_size)
	Set the box size in meters. More...
ignition::math::Boxd &	Shape ()
	Get a mutable Ignition Math representation of this Box. More...
const ignition::math::Boxd &	Shape () const
	Get the Ignition Math representation of this Box. More...
ignition::math::Vector3d	Size () const
	Get the box size in meters. More...

Detailed Description

Box represents a box shape, and is usually accessed through a Geometry.

Constructor & Destructor Documentation

Box() [1/3]

sdf::v10::Box::Box

(

)

Constructor.

Box() [2/3]

sdf::v10::Box::Box

(

const Box &

_box

)

Copy constructor.

Parameters

[in]

_box

Box to copy.

Box() [3/3]

sdf::v10::Box::Box ( Box &&  _box )

noexcept

Move constructor.

Parameters

[in]

_box

Box to move.

~Box()

virtual sdf::v10::Box::~Box ( )

virtual

Destructor.

Member Function Documentation

Element()

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

(

ElementPtr

_sdf

)

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

operator=() [1/2]

Box& sdf::v10::Box::operator=

(

Box &&

_box

)

Move assignment operator.

Parameters

[in]

_box

Box to move.

Returns

Reference to this.

operator=() [2/2]

Box& sdf::v10::Box::operator=

(

const Box &

_box

)

Assignment operator.

Parameters

[in]

_box

The box to set values from.

Returns

*this

SetSize()

void sdf::v10::Box::SetSize

(

const ignition::math::Vector3d &

_size

)

Set the box size in meters.

Parameters

[in]

_size

Size of the box in meters.

Shape() [1/2]

ignition::math::Boxd& sdf::v10::Box::Shape

(

)

Get a mutable Ignition Math representation of this Box.

Returns

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

Shape() [2/2]

const ignition::math::Boxd& sdf::v10::Box::Shape

(

)

const

Get the Ignition Math representation of this Box.

Returns

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

Size()

ignition::math::Vector3d sdf::v10::Box::Size

(

)

const

Get the box size in meters.

Returns

Size of the box in meters.

---

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

• Box.hh