maliput
BoundingRegion< Coordinate > Class Template Referenceabstract

Detailed Description

template<typename Coordinate>
class maliput::math::BoundingRegion< Coordinate >

Abstract API for bounding description.

Template Parameters
CoordinateCoordinate in a given coordinate system.

#include <include/maliput/math/bounding_region.h>

Public Member Functions

virtual ~BoundingRegion ()=default
 
const Coordinate & position () const
 Obtains the bounding region's position in the Inertial-frame. More...
 
bool Contains (const Coordinate &position) const
 Determines whether a position in the Inertial-frame is contained in this bounding region. More...
 
OverlappingType Overlaps (const BoundingRegion< Coordinate > &other) const
 Determines the overlapping type with other BoundingRegion instance. More...
 

Protected Member Functions

 BoundingRegion ()=default
 

Constructor & Destructor Documentation

◆ ~BoundingRegion()

virtual ~BoundingRegion ( )
virtualdefault

◆ BoundingRegion()

BoundingRegion ( )
protecteddefault

Member Function Documentation

◆ Contains()

bool Contains ( const Coordinate &  position) const

Determines whether a position in the Inertial-frame is contained in this bounding region.

Parameters
positionInertial-frame's coordinate.
Returns
True when position is contained in this bounding region.

◆ Overlaps()

OverlappingType Overlaps ( const BoundingRegion< Coordinate > &  other) const

Determines the overlapping type with other BoundingRegion instance.

◆ position()

const Coordinate& position ( ) const

Obtains the bounding region's position in the Inertial-frame.

The position is expected to match the centroid of the bounding region.

Returns
The position coordinate.

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