Terrain Class Reference

Workspace representation of terrain within the world. More...

#include <Environment.h>

Public Types
Local Types
enum	Axis { X , Y , Z }

Public Member Functions
Construction
	Terrain ()
	Terrain (XMLNode &_node)
	Terrain (const Terrain &_terrain)
Assignment
Terrain &	operator= (const Terrain &_terrain)
Accessors
const glutils::color &	Color () const noexcept
	Get the color for visualization. More...
Boundary *	GetBoundary () const noexcept
	Get the single enclosing boundary of the terrain. More...
const std::vector< std::unique_ptr< Boundary > > &	GetBoundaries () const noexcept
	Get the single enclosing boundaries of the terrain. More...
double	GetPerimeter ()
	Find the perimeter of all the boundaries. More...
bool	InTerrain (const Point3d _p) const noexcept
bool	InTerrain (const Cfg _cfg) const noexcept
bool	IsNeighbor (const Terrain &_terrain)
bool	IsVirtual () const noexcept
bool	IsWired () const noexcept

Detailed Description

Workspace representation of terrain within the world.

Member Enumeration Documentation

Axis

enum Terrain::Axis

Enumerator
X
Y
Z

Constructor & Destructor Documentation

Terrain() [1/3]

Terrain::Terrain ( )

default

Terrain() [2/3]

Terrain::Terrain

(

XMLNode &

_node

)

Terrain() [3/3]

Terrain::Terrain

(

const Terrain &

_terrain

)

Member Function Documentation

Color()

const glutils::color & Terrain::Color ( ) const

noexcept

Get the color for visualization.

GetBoundaries()

const std::vector< std::unique_ptr< Boundary > > & Terrain::GetBoundaries ( ) const

noexcept

Get the single enclosing boundaries of the terrain.

GetBoundary()

Boundary * Terrain::GetBoundary ( ) const

noexcept

Get the single enclosing boundary of the terrain.

GetPerimeter()

double Terrain::GetPerimeter

(

)

Find the perimeter of all the boundaries.

InTerrain() [1/2]

bool Terrain::InTerrain ( const Cfg  _cfg ) const

noexcept

Check if configuration is in terrain

Parameters

_cfg	The configuration to check

Returns

True if _cfg within m_boundaries

InTerrain() [2/2]

bool Terrain::InTerrain ( const Point3d  _p ) const

noexcept

Check if point is in terrain

Parameters

_p	The point to check

Returns

True if _p within m_boundaries

IsNeighbor()

bool Terrain::IsNeighbor

(

const Terrain &

_terrain

)

Check if terrain is a neighbor of this terrain

Parameters

_terrain

The terrain to check for neighboring

Returns

True if _terrain is touching this terrain

IsVirtual()

bool Terrain::IsVirtual ( ) const

noexcept

Check if terrain considered virtual

Returns

Value of m_virtual

IsWired()

bool Terrain::IsWired ( ) const

noexcept

Check if mesh will be wired

Returns

Value of m_wire

operator=()

Terrain & Terrain::operator=

(

const Terrain &

_terrain

)

---

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

• /opt/actions-runner/_work/open-ppl/open-ppl/src/MPProblem/Environment/Environment.h
• /opt/actions-runner/_work/open-ppl/open-ppl/src/MPProblem/Environment/Environment.cpp