CubbyFlow::SurfaceSet< N > Class Template Referencefinal
N-D surface set. More...
#include <Core/Geometry/SurfaceSet.hpp>
Inheritance diagram for CubbyFlow::SurfaceSet< N >:
Classes | |
| class | Builder |
| Front-end to create SurfaceSet objects step by step. More... | |
Public Member Functions | |
| SurfaceSet ()=default | |
| Constructs an empty surface set. More... | |
| SurfaceSet (const ConstArrayView1< std::shared_ptr< Surface< N >>> &others, const Transform< N > &_transform=Transform< N >{}, bool _isNormalFlipped=false) | |
| Constructs with a list of other surfaces. More... | |
| ~SurfaceSet () override=default | |
| Default virtual destructor. More... | |
| SurfaceSet (const SurfaceSet &other) | |
| Copy constructor. More... | |
| SurfaceSet (SurfaceSet &&other) noexcept | |
| Move constructor. More... | |
| SurfaceSet & | operator= (const SurfaceSet &other) |
| Copy assignment operator. More... | |
| SurfaceSet & | operator= (SurfaceSet &&other) noexcept |
| Move assignment operator. More... | |
| void | UpdateQueryEngine () override |
| Updates internal spatial query engine. More... | |
| bool | IsBounded () const override |
| Returns true if bounding box can be defined. More... | |
| bool | IsValidGeometry () const override |
| Returns true if the surface is a valid geometry. More... | |
| size_t | NumberOfSurfaces () const |
| Returns the number of surfaces. More... | |
| const std::shared_ptr< Surface< N > > & | SurfaceAt (size_t i) const |
| Returns the i-th surface. More... | |
| void | AddSurface (const std::shared_ptr< Surface< N >> &surface) |
| Adds a surface instance. More... | |
 Public Member Functions inherited from CubbyFlow::Surface< N > | |
| Surface (const Transform< N > &transform=Transform< N >(), bool isNormalFlipped=false) | |
| Constructs a surface with normal direction. More... | |
| virtual | ~Surface ()=default |
| Default virtual destructor. More... | |
| Surface (const Surface &other) | |
| Copy constructor. More... | |
| Surface (Surface &&other) noexcept | |
| Move constructor. More... | |
| Surface & | operator= (const Surface &other) |
| Copy assignment operator. More... | |
| Surface & | operator= (Surface &&other) noexcept |
| Move assignment operator. More... | |
| Vector< double, N > | ClosestPoint (const Vector< double, N > &otherPoint) const |
| BoundingBox< double, N > | GetBoundingBox () const |
| Returns the bounding box of this surface object. More... | |
| bool | Intersects (const Ray< double, N > &ray) const |
Returns true if the given ray intersects with this surface object. More... | |
| double | ClosestDistance (const Vector< double, N > &otherPoint) const |
| SurfaceRayIntersection< N > | ClosestIntersection (const Ray< double, N > &ray) const |
Returns the closest intersection point for given ray. More... | |
| Vector< double, N > | ClosestNormal (const Vector< double, N > &otherPoint) const |
| bool | IsInside (const Vector< double, N > &otherPoint) const |
Static Public Member Functions | |
| static Builder | GetBuilder () |
| Returns builder for SurfaceSet. More... | |
Additional Inherited Members | |
| Public Attributes inherited from CubbyFlow::Surface< N > | |
| Transform< N > | transform |
| Local-to-world transform. More... | |
| bool | isNormalFlipped = false |
| Flips normal. More... | |
Detailed Description
template<size_t N>
class CubbyFlow::SurfaceSet< N >
N-D surface set.
This class represents N-D surface set which extends Surface by overriding surface-related queries. This is class can hold a collection of other surface instances.
Constructor & Destructor Documentation
◆ SurfaceSet() [1/4]
template<size_t N>
|
default |
Constructs an empty surface set.
◆ SurfaceSet() [2/4]
template<size_t N>
|
explicit |
Constructs with a list of other surfaces.
◆ ~SurfaceSet()
template<size_t N>
|
overridedefault |
Default virtual destructor.
◆ SurfaceSet() [3/4]
template<size_t N>
| CubbyFlow::SurfaceSet< N >::SurfaceSet | ( | const SurfaceSet< N > & | other | ) |
Copy constructor.
◆ SurfaceSet() [4/4]
template<size_t N>
|
noexcept |
Move constructor.
Member Function Documentation
◆ AddSurface()
template<size_t N>
| void CubbyFlow::SurfaceSet< N >::AddSurface | ( | const std::shared_ptr< Surface< N >> & | surface | ) |
Adds a surface instance.
◆ GetBuilder()
template<size_t N>
|
static |
Returns builder for SurfaceSet.
◆ IsBounded()
template<size_t N>
|
overridevirtual |
Returns true if bounding box can be defined.
Reimplemented from CubbyFlow::Surface< N >.
◆ IsValidGeometry()
template<size_t N>
|
overridevirtual |
Returns true if the surface is a valid geometry.
Reimplemented from CubbyFlow::Surface< N >.
◆ NumberOfSurfaces()
template<size_t N>
| size_t CubbyFlow::SurfaceSet< N >::NumberOfSurfaces | ( | ) | const |
Returns the number of surfaces.
◆ operator=() [1/2]
template<size_t N>
| SurfaceSet& CubbyFlow::SurfaceSet< N >::operator= | ( | const SurfaceSet< N > & | other | ) |
Copy assignment operator.
◆ operator=() [2/2]
template<size_t N>
|
noexcept |
Move assignment operator.
◆ SurfaceAt()
template<size_t N>
| const std::shared_ptr<Surface<N> >& CubbyFlow::SurfaceSet< N >::SurfaceAt | ( | size_t | i | ) | const |
Returns the i-th surface.
◆ UpdateQueryEngine()
template<size_t N>
|
overridevirtual |
Updates internal spatial query engine.
Reimplemented from CubbyFlow::Surface< N >.
The documentation for this class was generated from the following file:
- Core/Geometry/SurfaceSet.hpp
