Detailed Description

Class AABB is an axis aligned bounding box around a given set of geometric points of (template) type PNT_TYPE.

Let \(P = \{p_k \in \mathbb{R}^3, \ k=1, \dotsc, n\}\) a set of 3d points. The bounding volume is described by its lower, left, front point \(\ell\) and the upper, right, back point \(u\), i.e. the coordinates of \(\ell\) and \(u\) are computed as follows \(\ell_i = \min \limits_{p \in P} p_i\), \(u_i = \max \limits_{p \in P} p_i\), respectively. The bounding box consists of half-open intervals \([\ell_x, u_x) \times [\ell_y, u_y) \times [\ell_z, u_z).\) The bounding box is enlarged up to the next available floating point number such that all input points are contained in the bounding box.

Definition at line 44 of file AABB.h.

#include <AABB.h>

Inheritance diagram for GeoLib::AABB:

[legend]

Public Member Functions
template<typename PNT_TYPE>
	AABB (std::vector< PNT_TYPE * > const &pnts, std::vector< std::size_t > const &ids)
template<typename InputIterator>
	AABB (InputIterator first, InputIterator last)
template<typename PNT_TYPE>
bool	update (PNT_TYPE const &p)
template<typename T>
bool	containsPoint (T const &pnt, double eps) const
template<typename T>
bool	containsPointXY (T const &pnt) const
MinMaxPoints	getMinMaxPoints () const
Eigen::Vector3d const &	getMinPoint () const
Eigen::Vector3d const &	getMaxPoint () const
bool	containsAABB (AABB const &other_aabb) const

Private Member Functions
void	enlarge (std::bitset< 3 > to_update=7)
template<typename PNT_TYPE>
void	init (PNT_TYPE const &pnt)
template<typename PNT_TYPE>
void	init (PNT_TYPE *const &pnt)
template<typename PNT_TYPE>
void	updateWithoutEnlarge (PNT_TYPE const &p)
template<typename PNT_TYPE>
void	updateWithoutEnlarge (PNT_TYPE *const &pnt)
template<typename PNT_TYPE>
void	update (PNT_TYPE const *pnt)

Private Attributes
Eigen::Vector3d	_min_pnt
Eigen::Vector3d	_max_pnt

Friends
std::ostream &	operator<< (std::ostream &os, AABB const &aabb)

Constructor & Destructor Documentation

◆ AABB() [1/2]

template<typename PNT_TYPE>

GeoLib::AABB::AABB	(	std::vector< PNT_TYPE * > const &	pnts,
		std::vector< std::size_t > const &	ids )

inline

construction of object, initialization the axis aligned bounding box

Template Parameters

PNT_TYPE a point type supporting accessing the coordinates via operator[]

Definition at line 53 of file AABB.h.

    {
        assert(!ids.empty());
        init(pnts[ids[0]]);
        for (std::size_t i = 1; i < ids.size(); ++i)
        {
            updateWithoutEnlarge(*(pnts[ids[i]]));
        }
        enlarge();
    }

References enlarge(), init(), and updateWithoutEnlarge().

Referenced by GeoLib::Grid< POINT >::Grid(), GeoLib::SurfaceGrid::SurfaceGrid(), containsAABB(), and operator<<.

◆ AABB() [2/2]

template<typename InputIterator>

GeoLib::AABB::AABB	(	InputIterator	first,
		InputIterator	last )

inline

Construction of object using input iterators. In contrast to give a vector this approach is more generic. You can use every (stl) container and C arrays as input for constructing the object.

Attention: {The constructor requires that std::distance(first, last) > 0.}

Parameters

first	the input iterator to the initial position in the sequence
last	the input iterator to the final position in a container, i.e. [first, last).

Attention: {The iterator last must be reachable from first.}

Definition at line 76 of file AABB.h.

    {
        if (std::distance(first, last) <= 0)
        {
            OGS_FATAL(
                "AABB::AABB(InputIterator first, InputIterator last): first > "
                "last");
        }
        init(*first);
        InputIterator it(first);
        while (it != last)
        {
            updateWithoutEnlarge(*it);
            it++;
        }
        enlarge();
    }

References enlarge(), init(), OGS_FATAL, and updateWithoutEnlarge().

Member Function Documentation

◆ containsAABB()

bool GeoLib::AABB::containsAABB ( AABB const & other_aabb ) const

inline

Method checks if the given AABB object is contained within the AABB represented by this object.

Parameters

other_aabb the AABB to test with

Returns: true if the other AABB is contained in the AABB represented by this object

Definition at line 185 of file AABB.h.

    {
        return containsPoint(other_aabb.getMinPoint(), 0) &&
               containsPoint(other_aabb.getMaxPoint(), 0);
    }

References AABB(), containsPoint(), getMaxPoint(), and getMinPoint().

◆ containsPoint()

template<typename T>

bool GeoLib::AABB::containsPoint	(	T const &	pnt,
		double	eps ) const

inline

check if point is in the axis aligned bounding box

Definition at line 132 of file AABB.h.

    {
        if (pnt[0] < _min_pnt[0] - eps || _max_pnt[0] + eps <= pnt[0])
        {
            return false;
        }
        if (pnt[1] < _min_pnt[1] - eps || _max_pnt[1] + eps <= pnt[1])
        {
            return false;
        }
        if (pnt[2] < _min_pnt[2] - eps || _max_pnt[2] + eps <= pnt[2])
        {
            return false;
        }
        return true;
    }

References _max_pnt, and _min_pnt.

Referenced by containsAABB(), MeshToolsLib::findNodesInBoundedDomain(), main(), and anonymous_namespace{AddFaultToVoxelGrid.cpp}::markFaults().

◆ containsPointXY()

template<typename T>

bool GeoLib::AABB::containsPointXY ( T const & pnt ) const

inline

Definition at line 150 of file AABB.h.

    {
        if (pnt[0] < _min_pnt[0] || _max_pnt[0] <= pnt[0])
        {
            return false;
        }
        if (pnt[1] < _min_pnt[1] || _max_pnt[1] <= pnt[1])
        {
            return false;
        }
        return true;
    }

References _max_pnt, and _min_pnt.

Referenced by MeshToolsLib::Mesh2MeshPropertyInterpolation::interpolatePropertiesForMesh().

◆ enlarge()

void GeoLib::AABB::enlarge ( std::bitset< 3 > to_update = 7 )

inlineprivate

Enlarge the bounding box the smallest possible amount (modifying the unit in the last place). Only the coordinates of the maximum point are changed such that the half-open property will be preserved.

Definition at line 215 of file AABB.h.

    {
        for (std::size_t k = 0; k < 3; ++k)
        {
            if (to_update[k])
            {
                _max_pnt[k] = std::nextafter(
                    _max_pnt[k], std::numeric_limits<double>::max());
            }
        }
    }

References _max_pnt.

Referenced by AABB(), AABB(), and update().

◆ getMaxPoint()

Eigen::Vector3d const & GeoLib::AABB::getMaxPoint ( ) const

inline

returns a point that coordinates are maximal for each dimension within the given point set

Returns: a point

Definition at line 176 of file AABB.h.

176{ return _max_pnt; }

References _max_pnt.

Referenced by GeoLib::Grid< POINT >::Grid(), adjustExtent(), compute2DGaussBellCurveValues(), computeSinXSinY(), computeStepFunction(), containsAABB(), GeoLib::Grid< POINT >::createGridGeometry(), MeshGeoToolsLib::getCandidateElementsForLineSegmentIntersection(), getMeshExtent(), GeoLib::Grid< POINT >::getNearestPoint(), MeshToolsLib::Mesh2MeshPropertyInterpolation::interpolatePropertiesForMesh(), MeshGeoToolsLib::GeoMapper::mapStationData(), mergeSubdomainMeshes(), MeshElementRemovalDialog::on_boundingBoxCheckBox_toggled(), MeshToolsLib::partitionNodesByCoordinateMatch(), rotateGeometryToXY(), and Layers2GridDialog::updateExpectedVoxel().

◆ getMinMaxPoints()

MinMaxPoints GeoLib::AABB::getMinMaxPoints ( ) const

inline

Definition at line 163 of file AABB.h.

163{ return {_min_pnt, _max_pnt}; }

References _max_pnt, and _min_pnt.

Referenced by MeshElementRemovalDialog::accept(), anonymous_namespace{CoordinateSystem.cpp}::getCoordinateSystem(), GeoLib::Grid< POINT >::getGridCoords(), main(), MeshGeoToolsLib::GeoMapper::mapPointDataToMeshSurface(), anonymous_namespace{AddFaultToVoxelGrid.cpp}::markFaults(), operator<<, ElementTreeModel::setMesh(), and GeoLib::SurfaceGrid::sortTrianglesInGridCells().

◆ getMinPoint()

Eigen::Vector3d const & GeoLib::AABB::getMinPoint ( ) const

inline

returns a point that coordinates are minimal for each dimension for the given point set

Returns: a point

Definition at line 169 of file AABB.h.

169{ return _min_pnt; }

References _min_pnt.

Referenced by GeoLib::Grid< POINT >::Grid(), adjustExtent(), compute2DGaussBellCurveValues(), computeSinXSinY(), computeStepFunction(), containsAABB(), GeoLib::Grid< POINT >::createGridGeometry(), MeshGeoToolsLib::getCandidateElementsForLineSegmentIntersection(), GeoLib::SurfaceGrid::getGridCellCoordinates(), getMeshExtent(), GeoLib::Grid< POINT >::getNearestPoint(), GeoLib::Grid< POINT >::getPointCellBorderDistances(), MeshToolsLib::Mesh2MeshPropertyInterpolation::interpolatePropertiesForMesh(), MeshGeoToolsLib::GeoMapper::mapStationData(), mergeSubdomainMeshes(), MeshElementRemovalDialog::on_boundingBoxCheckBox_toggled(), MeshToolsLib::partitionNodesByCoordinateMatch(), rotateGeometryToXY(), and Layers2GridDialog::updateExpectedVoxel().

◆ init() [1/2]

template<typename PNT_TYPE>

void GeoLib::AABB::init ( PNT_TYPE *const & pnt )

inlineprivate

Definition at line 236 of file AABB.h.

    {
        init(*pnt);
    }

References init().

◆ init() [2/2]

template<typename PNT_TYPE>

void GeoLib::AABB::init ( PNT_TYPE const & pnt )

inlineprivate

Definition at line 228 of file AABB.h.

    {
        _min_pnt[0] = _max_pnt[0] = pnt[0];
        _min_pnt[1] = _max_pnt[1] = pnt[1];
        _min_pnt[2] = _max_pnt[2] = pnt[2];
    }

References _max_pnt, and _min_pnt.

Referenced by AABB(), AABB(), and init().

◆ update() [1/2]

template<typename PNT_TYPE>

bool GeoLib::AABB::update ( PNT_TYPE const & p )

inline

Checks if the bounding box has to be updated.

Returns: true if AABB is updated.

Definition at line 97 of file AABB.h.

    {
        // First component of the pair signals if the minimum point is changed
        // Second component signals not only if the max point is changed.
        // Furthermore it is signaled what coordinate (0,1,2) is changed.
        std::pair<bool, std::bitset<3>> updated(false, 0);
        for (std::size_t k(0); k < 3; k++)
        {
            // if the minimum point is updated pair.first==true
            if (p[k] < _min_pnt[k])
            {
                _min_pnt[k] = p[k];
                updated.first = true;
            }
            // if the kth coordinate of the maximum point is updated
            // pair.second[k]==true
            if (p[k] >= _max_pnt[k])
            {
                _max_pnt[k] = p[k];
                updated.second[k] = true;
            }
        }
 
        if (updated.second.any())
        {
            enlarge(updated.second);
            return true;
        }
        return updated.first;
    }

References _max_pnt, _min_pnt, and enlarge().

Referenced by update().

◆ update() [2/2]

template<typename PNT_TYPE>

void GeoLib::AABB::update ( PNT_TYPE const * pnt )

inlineprivate

Definition at line 269 of file AABB.h.

    {
        update(*pnt);
    }

References update().

◆ updateWithoutEnlarge() [1/2]

template<typename PNT_TYPE>

void GeoLib::AABB::updateWithoutEnlarge ( PNT_TYPE *const & pnt )

inlineprivate

Definition at line 263 of file AABB.h.

    {
        updateWithoutEnlarge(*pnt);
    }

References updateWithoutEnlarge().

◆ updateWithoutEnlarge() [2/2]

template<typename PNT_TYPE>

void GeoLib::AABB::updateWithoutEnlarge ( PNT_TYPE const & p )

inlineprivate

Private method that is used internally to update the min and max point of the bounding box using point \(p\) without enlarging the bounding box. Using this method the bounding box of the initial point set is enlarged only once.

Parameters

p	point that will possibly change the bounding box points

Definition at line 247 of file AABB.h.

    {
        for (std::size_t k(0); k < 3; k++)
        {
            if (p[k] < _min_pnt[k])
            {
                _min_pnt[k] = p[k];
            }
            if (p[k] >= _max_pnt[k])
            {
                _max_pnt[k] = p[k];
            }
        }
    }

References _max_pnt, and _min_pnt.

Referenced by AABB(), AABB(), and updateWithoutEnlarge().

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		AABB const &	aabb )

friend

Definition at line 191 of file AABB.h.

    {
        auto const [min, max] = aabb.getMinMaxPoints();
        os << "\tx [" << min[0] << ", " << max[0] << ") (extent "
           << max[0] - min[0] << ")\n";
        os << "\ty [" << min[1] << ", " << max[1] << ") (extent "
           << max[1] - min[1] << ")\n";
        os << "\tz [" << min[2] << ", " << max[2] << ") (extent "
           << max[2] - min[2] << ")";
        return os;
    }

References AABB(), and getMinMaxPoints().

Member Data Documentation

◆ _max_pnt

Eigen::Vector3d GeoLib::AABB::_max_pnt

private

Initial value:

{std::numeric_limits<double>::lowest(),
                             std::numeric_limits<double>::lowest(),
                             std::numeric_limits<double>::lowest()}

Definition at line 207 of file AABB.h.

                          {std::numeric_limits<double>::lowest(),
                             std::numeric_limits<double>::lowest(),
                             std::numeric_limits<double>::lowest()};

Referenced by containsPoint(), containsPointXY(), enlarge(), getMaxPoint(), getMinMaxPoints(), init(), update(), and updateWithoutEnlarge().

◆ _min_pnt

Eigen::Vector3d GeoLib::AABB::_min_pnt

private

Initial value:

{std::numeric_limits<double>::max(),
                             std::numeric_limits<double>::max(),
                             std::numeric_limits<double>::max()}

Definition at line 204 of file AABB.h.

                          {std::numeric_limits<double>::max(),
                             std::numeric_limits<double>::max(),
                             std::numeric_limits<double>::max()};

Referenced by containsPoint(), containsPointXY(), getMinMaxPoints(), getMinPoint(), init(), update(), and updateWithoutEnlarge().

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

AABB.h

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ AABB() [1/2]

◆ AABB() [2/2]

Member Function Documentation

◆ containsAABB()

◆ containsPoint()

◆ containsPointXY()

◆ enlarge()

◆ getMaxPoint()

◆ getMinMaxPoints()

◆ getMinPoint()

◆ init() [1/2]

◆ init() [2/2]

◆ update() [1/2]

◆ update() [2/2]

◆ updateWithoutEnlarge() [1/2]

◆ updateWithoutEnlarge() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ _max_pnt

◆ _min_pnt