PPL API Reference
Overview Core Algorithm Abstractions Utilities Parallel Methods
Modules Class Hierarchy Classes Functions
Todo List Bug List Dead Code
List of all members
Terrain Class Reference

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

Public Member Functions

Construction
 Terrain ()
 
 Terrain (XMLNode &_node)
 
 Terrain (const Terrain &_terrain)
 
Accessors
const glutils::color & Color () const noexcept
 Get the color for visualization.
 
BoundaryGetBoundary () const noexcept
 Get the single enclosing boundary of the terrain.
 
const std::vector< std::unique_ptr< Boundary > > & GetBoundaries () const noexcept
 Get the single enclosing boundaries of the terrain.
 
double GetPerimeter ()
 Find the perimeter of all the boundaries.
 
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
 

Public Types

Local Types
enum  Axis { X , Y , Z }
 

Detailed Description

Workspace representation of terrain within the world.

Member Function Documentation

◆ InTerrain() [1/2]

bool Terrain::InTerrain ( const Point3d  _p) const
noexcept

Check if point is in terrain

Parameters
_pThe point to check
Returns
True if _p within m_boundaries

◆ InTerrain() [2/2]

bool Terrain::InTerrain ( const Cfg  _cfg) const
noexcept

Check if configuration is in terrain

Parameters
_cfgThe configuration to check
Returns
True if _cfg within m_boundaries

◆ IsNeighbor()

bool Terrain::IsNeighbor ( const Terrain _terrain)

Check if terrain is a neighbor of this terrain

Parameters
_terrainThe 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

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