Class Abstract2DShape`Abstract`

An abstract base class for 2D shapes.

Hierarchy (View Summary)

Abstract2DShape
- Rect2
- Parameterized2DShape

Index

Constructors

Methods

containsPoint distance getLooseBoundingBox getTightBoundingBox intersectsLineSegment signedDistance

Constructors

constructor

new Abstract2DShape(): Abstract2DShape
Returns Abstract2DShape

Methods

containsPoint

containsPoint(point: Vec3, epsilon?: number): boolean
Returns true if and only if the given point is contained within this shape.

epsilon is a small number used to counteract floating point error. Thus, if point is within epsilon of the inside of this shape, containsPoint may also return true.

The default implementation relies on signedDistance. Subclasses may override this method to provide a more efficient implementation.
Parameters
- point: Vec3
- epsilon: number = Abstract2DShape.smallValue
Returns boolean
- Defined in math/src/shapes/Abstract2DShape.ts:46

distance

distance(point: Vec3): number
Parameters
- point: Vec3
Returns number
the distance from point to this shape. If point is within this shape, this returns the distance from point to the edge of this shape.

See
signedDistance
- Defined in math/src/shapes/Abstract2DShape.ts:18

getLooseBoundingBox

getLooseBoundingBox(): Rect2
Returns a bounding box that loosely fits the content of this shape.

The result of this call can be larger than the result of getTightBoundingBox, but should not be smaller. Thus, a call to getLooseBoundingBox can be significantly faster than a call to getTightBoundingBox for some shapes.

Returns Rect2
- Defined in math/src/shapes/Abstract2DShape.ts:65

`Abstract`getTightBoundingBox

getTightBoundingBox(): Rect2
Returns a bounding box that precisely fits the content of this shape.

Note: This bounding box should aligned with the x/y axes. (Thus, it may be possible to find a tighter bounding box not axes-aligned).

Returns Rect2
- Defined in math/src/shapes/Abstract2DShape.ts:56

`Abstract`intersectsLineSegment

intersectsLineSegment(lineSegment: LineSegment2): Vec3[]
Parameters
- lineSegment: LineSegment2
Returns Vec3[]
points at which this shape intersects the given lineSegment.

If this is a closed shape, returns points where the given lineSegment intersects the boundary of this.
- Defined in math/src/shapes/Abstract2DShape.ts:34

`Abstract`signedDistance

signedDistance(point: Vec3): number
Computes the signed distance function for this shape.
Parameters
- point: Vec3
Returns number
- Defined in math/src/shapes/Abstract2DShape.ts:26

OpenSource licenses