Region Class Reference

A region, made of a list of boxes. More...

#include <Region.hh>

Public Member Functions
	Region ()=default
	Constructor.
virtual	~Region ()=default
	Destructor.
bool	Contains (const ignition::math::Vector3d &_p) const
	Check if a point lies inside the region.
void	Load (const sdf::ElementPtr &_sdf)
	Load from a world file (inside a SimEvent plugin element)

Public Attributes
std::vector< ignition::math::Box >	boxes
	The list of volumes inside this region.
std::string	name
	Name of the region (as defined in the world file)

Detailed Description

A region, made of a list of boxes.

Constructor & Destructor Documentation

Region()

Region ( )

default

Constructor.

Referenced by operator<<.

~Region()

virtual ~Region ( )

virtualdefault

Destructor.

Member Function Documentation

Contains()

bool Contains

(

const ignition::math::Vector3d &

_p

)

const

Check if a point lies inside the region.

Parameters

[in]

_p

Point to check

Returns

True if point is in region

Load()

void Load

(

const sdf::ElementPtr &

_sdf

)

Load from a world file (inside a SimEvent plugin element)

Parameters

[in]

_sdf

The <region> element

Member Data Documentation

boxes

std::vector<ignition::math::Box> boxes

The list of volumes inside this region.

name

std::string name

Name of the region (as defined in the world file)

---

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

• Region.hh