2-D plane geometry. More...
#include <jet/plane2.h>
Inheritance diagram for jet::Plane2:
Classes | |
| class | Builder |
| Front-end to create Plane2 objects step by step. More... | |
Public Member Functions | |
| Plane2 (const Transform2 &transform=Transform2(), bool isNormalFlipped=false) | |
| Constructs a plane that crosses (0, 0) with surface normal (0, 1). More... | |
| Plane2 (const Vector2D &normal, const Vector2D &point, const Transform2 &transform=Transform2(), bool isNormalFlipped=false) | |
Constructs a plane that cross point with surface normal normal. More... | |
| Plane2 (const Plane2 &other) | |
| Copy constructor. More... | |
| bool | isBounded () const override |
| Returns true if bounding box can be defined. 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 |
| virtual void | updateQueryEngine () |
| Updates internal spatial query engine. More... | |
| virtual bool | isValidGeometry () const |
| Returns true if the surface is a valid geometry. More... | |
| bool | isInside (const Vector2D &otherPoint) const |
Static Public Member Functions | |
| static Builder | builder () |
| Returns builder fox Plane2. More... | |
Public Attributes | |
| Vector2D | normal = Vector2D(0, 1) |
| Plane normal. More... | |
| Vector2D | point |
| Point that lies on the plane. More... | |
| Public Attributes inherited from jet::Surface2 | |
| Transform2 | transform |
| Local-to-world transform. More... | |
| bool | isNormalFlipped = false |
| Flips normal. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from jet::Surface2 | |
| virtual double | closestDistanceLocal (const Vector2D &otherPoint) const |
| virtual bool | isInsideLocal (const Vector2D &otherPoint) const |
Detailed Description
2-D plane geometry.
This class represents 2-D plane geometry which extends Surface2 by overriding surface-related queries.
Constructor & Destructor Documentation
◆ Plane2() [1/3]
| jet::Plane2::Plane2 | ( | const Transform2 & | transform = Transform2(), |
| bool | isNormalFlipped = false |
||
| ) |
Constructs a plane that crosses (0, 0) with surface normal (0, 1).
◆ Plane2() [2/3]
| jet::Plane2::Plane2 | ( | const Vector2D & | normal, |
| const Vector2D & | point, | ||
| const Transform2 & | transform = Transform2(), |
||
| bool | isNormalFlipped = false |
||
| ) |
Constructs a plane that cross point with surface normal normal.
◆ Plane2() [3/3]
| jet::Plane2::Plane2 | ( | const Plane2 & | other | ) |
Copy constructor.
Member Function Documentation
◆ builder()
◆ isBounded()
|
overridevirtual |
Returns true if bounding box can be defined.
Reimplemented from jet::Surface2.
Member Data Documentation
◆ normal
◆ point
The documentation for this class was generated from the following file:
- jet/plane2.h
