3-D box geometry. More...

#include <jet/box3.h>

Inheritance diagram for jet::Box3:

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

Public Member Functions
	Box3 (const Transform3 &transform=Transform3(), bool isNormalFlipped=false)
	Constructs (0, 0, 0) x (1, 1, 1) box. More...

	Box3 (const Vector3D &lowerCorner, const Vector3D &upperCorner, const Transform3 &transform=Transform3(), bool isNormalFlipped=false)
	Constructs a box with given `lowerCorner` and `upperCorner`. More...

	Box3 (const BoundingBox3D &boundingBox, const Transform3 &transform=Transform3(), bool isNormalFlipped=false)
	Constructs a box with BoundingBox3D instance. More...

	Box3 (const Box3 &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 Box3. More...

Public Attributes
BoundingBox3D	bound = BoundingBox3D(Vector3D(), Vector3D(1.0, 1.0, 1.0))
	Bounding box of this box. 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

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 double	closestDistanceLocal (const Vector3D &otherPoint) const

virtual bool	isInsideLocal (const Vector3D &otherPoint) const

Detailed Description

3-D box geometry.

This class represents 3-D box geometry which extends Surface3 by overriding surface-related queries. This box implementation is an axis-aligned box that wraps lower-level primitive type, BoundingBox3D.

Constructor & Destructor Documentation

◆ Box3() [1/4]

jet::Box3::Box3	(	const Transform3 &	transform = `Transform3()`,
		bool	isNormalFlipped = `false`
	)

Constructs (0, 0, 0) x (1, 1, 1) box.

◆ Box3() [2/4]

jet::Box3::Box3	(	const Vector3D &	lowerCorner,
		const Vector3D &	upperCorner,
		const Transform3 &	transform = `Transform3()`,
		bool	isNormalFlipped = `false`
	)

Constructs a box with given lowerCorner and upperCorner.

◆ Box3() [3/4]

jet::Box3::Box3	(	const BoundingBox3D &	boundingBox,
		const Transform3 &	transform = `Transform3()`,
		bool	isNormalFlipped = `false`
	)

explicit

Constructs a box with BoundingBox3D instance.

◆ Box3() [4/4]

jet::Box3::Box3 ( const Box3 & other )

Copy constructor.

Member Function Documentation

◆ boundingBoxLocal()

BoundingBox3D jet::Box3::boundingBoxLocal ( ) const

overrideprotectedvirtual

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

Implements jet::Surface3.

◆ builder()

static Builder jet::Box3::builder ( )

static

Returns builder fox Box3.

◆ closestIntersectionLocal()

SurfaceRayIntersection3 jet::Box3::closestIntersectionLocal ( const Ray3D & ray ) const

overrideprotectedvirtual

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

Implements jet::Surface3.

◆ closestNormalLocal()

Vector3D jet::Box3::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::Box3::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::Box3::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

◆ bound

BoundingBox3D jet::Box3::bound = BoundingBox3D(Vector3D(), Vector3D(1.0, 1.0, 1.0))

Bounding box of this box.

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

jet/box3.h

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Box3() [1/4]

◆ Box3() [2/4]

◆ Box3() [3/4]

◆ Box3() [4/4]

Member Function Documentation

◆ boundingBoxLocal()

◆ builder()

◆ closestIntersectionLocal()

◆ closestNormalLocal()

◆ closestPointLocal()

◆ intersectsLocal()

Member Data Documentation

◆ bound