Jet  v1.3.3
Classes | Public Member Functions | Static Public Member Functions | List of all members
jet::SurfaceSet3 Class Referencefinal

3-D surface set. More...

#include <jet/surface_set3.h>

Inheritance diagram for jet::SurfaceSet3:
jet::Surface3

Classes

class  Builder
 Front-end to create SurfaceSet3 objects step by step. More...
 

Public Member Functions

 SurfaceSet3 ()
 Constructs an empty surface set. More...
 
 SurfaceSet3 (const std::vector< Surface3Ptr > &others, const Transform3 &transform=Transform3(), bool isNormalFlipped=false)
 Constructs with a list of other surfaces. More...
 
 SurfaceSet3 (const SurfaceSet3 &other)
 Copy constructor. 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 Surface3PtrsurfaceAt (size_t i) const
 Returns the i-th surface. More...
 
void addSurface (const Surface3Ptr &surface)
 Adds a surface instance. More...
 
- Public Member Functions inherited from jet::Surface3
 Surface3 (const Transform3 &transform=Transform3(), bool isNormalFlipped=false)
 Constructs a surface with normal direction. More...
 
 Surface3 (const Surface3 &other)
 Copy constructor. More...
 
virtual ~Surface3 ()
 Default destructor. More...
 
Vector3D closestPoint (const Vector3D &otherPoint) const
 
BoundingBox3D boundingBox () const
 Returns the bounding box of this surface object. More...
 
bool intersects (const Ray3D &ray) const
 Returns true if the given ray intersects with this surface object. More...
 
double closestDistance (const Vector3D &otherPoint) const
 
SurfaceRayIntersection3 closestIntersection (const Ray3D &ray) const
 Returns the closest intersection point for given ray. More...
 
Vector3D closestNormal (const Vector3D &otherPoint) const
 
bool isInside (const Vector3D &otherPoint) const
 

Static Public Member Functions

static Builder builder ()
 Returns builder for SurfaceSet3. More...
 

Additional Inherited Members

- Public Attributes inherited from jet::Surface3
Transform3 transform
 Local-to-world transform. More...
 
bool isNormalFlipped = false
 Flips normal when calling Surface3::closestNormal(...). More...
 

Detailed Description

3-D surface set.

This class represents 3-D surface set which extends Surface3 by overriding surface-related queries. This is class can hold a collection of other surface instances.

Constructor & Destructor Documentation

◆ SurfaceSet3() [1/3]

jet::SurfaceSet3::SurfaceSet3 ( )

Constructs an empty surface set.

◆ SurfaceSet3() [2/3]

jet::SurfaceSet3::SurfaceSet3 ( const std::vector< Surface3Ptr > &  others,
const Transform3 transform = Transform3(),
bool  isNormalFlipped = false 
)
explicit

Constructs with a list of other surfaces.

◆ SurfaceSet3() [3/3]

jet::SurfaceSet3::SurfaceSet3 ( const SurfaceSet3 other)

Copy constructor.

Member Function Documentation

◆ addSurface()

void jet::SurfaceSet3::addSurface ( const Surface3Ptr surface)

Adds a surface instance.

◆ builder()

static Builder jet::SurfaceSet3::builder ( )
static

Returns builder for SurfaceSet3.

◆ isBounded()

bool jet::SurfaceSet3::isBounded ( ) const
overridevirtual

Returns true if bounding box can be defined.

Reimplemented from jet::Surface3.

◆ isValidGeometry()

bool jet::SurfaceSet3::isValidGeometry ( ) const
overridevirtual

Returns true if the surface is a valid geometry.

Reimplemented from jet::Surface3.

◆ numberOfSurfaces()

size_t jet::SurfaceSet3::numberOfSurfaces ( ) const

Returns the number of surfaces.

◆ surfaceAt()

const Surface3Ptr& jet::SurfaceSet3::surfaceAt ( size_t  i) const

Returns the i-th surface.

◆ updateQueryEngine()

void jet::SurfaceSet3::updateQueryEngine ( )
overridevirtual

Updates internal spatial query engine.

Reimplemented from jet::Surface3.


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