Class Parameterized2DShape`Abstract`

A 2-dimensional path with parameter interval $t \in [0, 1]$ .

Note: Avoid extending this class outside of js-draw --- new abstract methods may be added between minor versions.

Hierarchy (view full)

Abstract2DShape
- Parameterized2DShape
  - LineSegment2

Index

Constructors

Methods

argIntersectsLineSegment at containsPoint distance getLooseBoundingBox getTightBoundingBox intersectsLineSegment nearestPointTo normalAt signedDistance splitAt tangentAt

Constructors

constructor

new Parameterized2DShape(): Parameterized2DShape
Returns Parameterized2DShape
Inherited from Abstract2DShape.constructor

Methods

`Abstract` argIntersectsLineSegment

argIntersectsLineSegment(lineSegment): number[]
Returns the parameter values at which lineSegment intersects this shape.

See also intersectsLineSegment
Parameters
- lineSegment: LineSegment2
Returns number[]
- Defined in shapes/Parameterized2DShape.ts:36

`Abstract` at

at(t): Vec3
Returns this at a given parameter. $t \in [0, 1]$
Parameters
- t: number
Returns Vec3
- Defined in shapes/Parameterized2DShape.ts:13

containsPoint

containsPoint(point, epsilon?): 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
Inherited from Abstract2DShape.containsPoint
- Defined in shapes/Abstract2DShape.ts:46

distance

distance(point): 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
Inherited from Abstract2DShape.distance
- Defined in 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
Inherited from Abstract2DShape.getLooseBoundingBox
- Defined in 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
Inherited from Abstract2DShape.getTightBoundingBox
- Defined in shapes/Abstract2DShape.ts:56

intersectsLineSegment

intersectsLineSegment(line): Vec3[]
Parameters
- line: 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.
Overrides Abstract2DShape.intersectsLineSegment
- Defined in shapes/Parameterized2DShape.ts:39

`Abstract` nearestPointTo

nearestPointTo(point): {
parameterValue: number;
point: Vec3;
}
Returns the nearest point on this to point and the parameterValue at which that point occurs.
Parameters
- point: Vec3
Returns {
parameterValue: number;
point: Vec3;
}
- parameterValue: number
- point: Vec3
- Defined in shapes/Parameterized2DShape.ts:29

`Abstract` normalAt

normalAt(t): Vec3
Computes the unit normal vector at $t$ .
Parameters
- t: number
Returns Vec3
- Defined in shapes/Parameterized2DShape.ts:16

`Abstract` signedDistance

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

`Abstract` splitAt

splitAt(t): [Parameterized2DShape] | [Parameterized2DShape, Parameterized2DShape]
Divides this shape into two separate shapes at parameter value $t$ .
Parameters
- t: number
Returns [Parameterized2DShape] | [Parameterized2DShape, Parameterized2DShape]
- Defined in shapes/Parameterized2DShape.ts:23

`Abstract` tangentAt

tangentAt(t): Vec3
Parameters
- t: number
Returns Vec3
- Defined in shapes/Parameterized2DShape.ts:18

Class Parameterized2DShapeAbstract

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Returns Parameterized2DShape

Methods

Abstract argIntersectsLineSegment

Parameters

lineSegment: LineSegment2

Returns number[]

Abstract at

Parameters

t: number

Returns Vec3

containsPoint

Parameters

point: Vec3

epsilon: number = Abstract2DShape.smallValue

Returns boolean

distance

Parameters

point: Vec3

Returns number

See

getLooseBoundingBox

Returns Rect2

Abstract getTightBoundingBox

Returns Rect2

intersectsLineSegment

Parameters

line: LineSegment2

Returns Vec3[]

Abstract nearestPointTo

Parameters

point: Vec3

Returns { parameterValue: number; point: Vec3; }

parameterValue: number

point: Vec3

Abstract normalAt

Parameters

t: number

Returns Vec3

Abstract signedDistance

Parameters

point: Vec3

Returns number

Abstract splitAt

Parameters

t: number

Returns [Parameterized2DShape] | [Parameterized2DShape, Parameterized2DShape]

Abstract tangentAt

Parameters

t: number

Returns Vec3

Settings

Member Visibility

Theme

On This Page

Class Parameterized2DShape`Abstract`

`Abstract` argIntersectsLineSegment

`Abstract` at

`Abstract` getTightBoundingBox

`Abstract` nearestPointTo

Returns {
parameterValue: number;
point: Vec3;
}

`Abstract` normalAt

`Abstract` signedDistance

`Abstract` splitAt

`Abstract` tangentAt