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

2-D surface set. More...

#include <jet/surface_set2.h>

Inheritance diagram for jet::SurfaceSet2:
jet::Surface2

Classes

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

Public Member Functions

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

Static Public Member Functions

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

Additional Inherited Members

- Public Attributes inherited from jet::Surface2
Transform2 transform
 Local-to-world transform. More...
 
bool isNormalFlipped = false
 Flips normal. More...
 

Detailed Description

2-D surface set.

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

Constructor & Destructor Documentation

◆ SurfaceSet2() [1/3]

jet::SurfaceSet2::SurfaceSet2 ( )

Constructs an empty surface set.

◆ SurfaceSet2() [2/3]

jet::SurfaceSet2::SurfaceSet2 ( const std::vector< Surface2Ptr > &  others,
const Transform2 transform = Transform2(),
bool  isNormalFlipped = false 
)
explicit

Constructs with a list of other surfaces.

◆ SurfaceSet2() [3/3]

jet::SurfaceSet2::SurfaceSet2 ( const SurfaceSet2 other)

Copy constructor.

Member Function Documentation

◆ addSurface()

void jet::SurfaceSet2::addSurface ( const Surface2Ptr surface)

Adds a surface instance.

◆ builder()

static Builder jet::SurfaceSet2::builder ( )
static

Returns builder for SurfaceSet2.

◆ isBounded()

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

Returns true if bounding box can be defined.

Reimplemented from jet::Surface2.

◆ isValidGeometry()

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

Returns true if the surface is a valid geometry.

Reimplemented from jet::Surface2.

◆ numberOfSurfaces()

size_t jet::SurfaceSet2::numberOfSurfaces ( ) const

Returns the number of surfaces.

◆ surfaceAt()

const Surface2Ptr& jet::SurfaceSet2::surfaceAt ( size_t  i) const

Returns the i-th surface.

◆ updateQueryEngine()

void jet::SurfaceSet2::updateQueryEngine ( )
overridevirtual

Updates internal spatial query engine.

Reimplemented from jet::Surface2.


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