##

Region Class Reference

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

`#include <Region.hh>`

## Public Member Functions

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

## Public Attributes

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

## Friends

std::ostream & | operator<< (std::ostream &_out, const Region &_region)
| Output operator to print a region to the console. More...

## Detailed Description

A region, made of a list of boxes.

## Constructor & Destructor Documentation

## Region()

Region | ( |  | ) |

default

Constructor.

## ~Region()

virtual ~Region | ( |  | ) |

virtual default

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

## Friends And Related Function Documentation

## operator<<

std::ostream& operator<< | ( | std::ostream & | _out,
|  | const Region & | _region
| ) |  |

friend

Output operator to print a region to the console.

Parameters

  [in] | _out | The output stream.
  [in] | _region | The instance to write out.

Returns
  the stream

## 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