axom::bump::PolyhedralFaces< T > Struct Template Reference

This struct is a simpler way of representing a polyhedron if we only need to know about it as set of planes. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/PrimalAdaptor.hpp>

Public Types
using	PlaneType = axom::primal::Plane< T, 3 >

Public Member Functions
AXOM_HOST_DEVICE int	size () const
AXOM_HOST_DEVICE const PlaneType &	operator[] (size_t i) const
AXOM_HOST_DEVICE PlaneType &	operator[] (size_t i)
AXOM_HOST_DEVICE void	push_back (const PlaneType &plane)
AXOM_HOST_DEVICE axom::ArrayView< PlaneType >	getFaces () const

Public Attributes
axom::StaticArray< PlaneType, MAX_PLANES >	m_planes

Static Public Attributes
static constexpr int	MAX_PLANES = 64

Detailed Description

template<typename T>
struct axom::bump::PolyhedralFaces< T >

This struct is a simpler way of representing a polyhedron if we only need to know about it as set of planes.

Member Typedef Documentation

PlaneType

template<typename T >

using axom::bump::PolyhedralFaces< T >::PlaneType = axom::primal::Plane<T, 3>

Member Function Documentation

size()

template<typename T >

AXOM_HOST_DEVICE int axom::bump::PolyhedralFaces< T >::size ( ) const

inline

References axom::bump::PolyhedralFaces< T >::m_planes.

operator[]() [1/2]

template<typename T >

AXOM_HOST_DEVICE const PlaneType& axom::bump::PolyhedralFaces< T >::operator[] ( size_t  i ) const

inline

References axom::bump::PolyhedralFaces< T >::m_planes.

operator[]() [2/2]

template<typename T >

AXOM_HOST_DEVICE PlaneType& axom::bump::PolyhedralFaces< T >::operator[] ( size_t  i )

inline

References axom::bump::PolyhedralFaces< T >::m_planes.

push_back()

template<typename T >

AXOM_HOST_DEVICE void axom::bump::PolyhedralFaces< T >::push_back ( const PlaneType &  plane )

inline

References axom::bump::PolyhedralFaces< T >::m_planes.

getFaces()

template<typename T >

AXOM_HOST_DEVICE axom::ArrayView<PlaneType> axom::bump::PolyhedralFaces< T >::getFaces ( ) const

inline

References axom::bump::PolyhedralFaces< T >::m_planes.

Member Data Documentation

MAX_PLANES

template<typename T >

constexpr int axom::bump::PolyhedralFaces< T >::MAX_PLANES = 64

staticconstexpr

m_planes

template<typename T >

axom::StaticArray<PlaneType, MAX_PLANES> axom::bump::PolyhedralFaces< T >::m_planes

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/PrimalAdaptor.hpp