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

3-D cylinder geometry. More...

#include <jet/cylinder3.h>

Inheritance diagram for jet::Cylinder3:
jet::Surface3

Classes

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

Public Member Functions

 Cylinder3 (const Transform3 &transform=Transform3(), bool isNormalFlipped=false)
 Constructs a cylinder with. More...
 
 Cylinder3 (const Vector3D &center, double radius, double height, const Transform3 &transform=Transform3(), bool isNormalFlipped=false)
 Constructs a cylinder with center, radius, and height. More...
 
 Cylinder3 (const Cylinder3 &other)
 Copy constructor. 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
 
virtual void updateQueryEngine ()
 Updates internal spatial query engine. More...
 
virtual bool isBounded () const
 Returns true if bounding box can be defined. More...
 
virtual bool isValidGeometry () const
 Returns true if the surface is a valid geometry. More...
 
bool isInside (const Vector3D &otherPoint) const
 

Static Public Member Functions

static Builder builder ()
 Returns builder fox Cylinder3. More...
 

Public Attributes

Vector3D center
 Center of the cylinder. More...
 
double radius = 1.0
 Radius of the cylinder. More...
 
double height = 1.0
 Height of the cylinder. More...
 
- Public Attributes inherited from jet::Surface3
Transform3 transform
 Local-to-world transform. More...
 
bool isNormalFlipped = false
 Flips normal when calling Surface3::closestNormal(...). More...
 

Protected Member Functions

Vector3D closestPointLocal (const Vector3D &otherPoint) const override
 
double closestDistanceLocal (const Vector3D &otherPoint) const override
 
bool intersectsLocal (const Ray3D &ray) const override
 
BoundingBox3D boundingBoxLocal () const override
 Returns the bounding box of this surface object in local frame. More...
 
Vector3D closestNormalLocal (const Vector3D &otherPoint) const override
 
SurfaceRayIntersection3 closestIntersectionLocal (const Ray3D &ray) const override
 Returns the closest intersection point for given ray in local frame. More...
 
- Protected Member Functions inherited from jet::Surface3
virtual bool isInsideLocal (const Vector3D &otherPoint) const
 

Detailed Description

3-D cylinder geometry.

This class represents 3-D cylinder geometry which extends Surface3 by overriding surface-related queries. The cylinder is aligned with the y-axis.

Constructor & Destructor Documentation

◆ Cylinder3() [1/3]

jet::Cylinder3::Cylinder3 ( const Transform3 transform = Transform3(),
bool  isNormalFlipped = false 
)

Constructs a cylinder with.

◆ Cylinder3() [2/3]

jet::Cylinder3::Cylinder3 ( const Vector3D center,
double  radius,
double  height,
const Transform3 transform = Transform3(),
bool  isNormalFlipped = false 
)

Constructs a cylinder with center, radius, and height.

◆ Cylinder3() [3/3]

jet::Cylinder3::Cylinder3 ( const Cylinder3 other)

Copy constructor.

Member Function Documentation

◆ boundingBoxLocal()

BoundingBox3D jet::Cylinder3::boundingBoxLocal ( ) const
overrideprotectedvirtual

Returns the bounding box of this surface object in local frame.

Implements jet::Surface3.

◆ builder()

static Builder jet::Cylinder3::builder ( )
static

Returns builder fox Cylinder3.

◆ closestDistanceLocal()

double jet::Cylinder3::closestDistanceLocal ( const Vector3D otherPoint) const
overrideprotectedvirtual

Returns the closest distance from the given point otherPoint to the point on the surface in local frame.

Reimplemented from jet::Surface3.

◆ closestIntersectionLocal()

SurfaceRayIntersection3 jet::Cylinder3::closestIntersectionLocal ( const Ray3D ray) const
overrideprotectedvirtual

Returns the closest intersection point for given ray in local frame.

Implements jet::Surface3.

◆ closestNormalLocal()

Vector3D jet::Cylinder3::closestNormalLocal ( const Vector3D otherPoint) const
overrideprotectedvirtual

Returns the normal to the closest point on the surface from the given point otherPoint in local frame.

Implements jet::Surface3.

◆ closestPointLocal()

Vector3D jet::Cylinder3::closestPointLocal ( const Vector3D otherPoint) const
overrideprotectedvirtual

Returns the closest point from the given point otherPoint to the surface in local frame.

Implements jet::Surface3.

◆ intersectsLocal()

bool jet::Cylinder3::intersectsLocal ( const Ray3D ray) const
overrideprotectedvirtual

Returns true if the given ray intersects with this surface object in local frame.

Reimplemented from jet::Surface3.

Member Data Documentation

◆ center

Vector3D jet::Cylinder3::center

Center of the cylinder.

◆ height

double jet::Cylinder3::height = 1.0

Height of the cylinder.

◆ radius

double jet::Cylinder3::radius = 1.0

Radius of the cylinder.


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