Class Bounds

Base class for all bounds.

Either a value or a Point can be bounded.

A Bounds must be able to:

store a boundary
check if a value or point is contained within the boundary
clip a value or point to within the boundary
find the intersect between the boundary and a value or point in some direction

Hierarchy (View Summary)

Bounds

Index

Constructors

Methods

_dup contains intersect clip

Constructors

constructor

new Bounds(boundary?: any, precision?: number): Bounds
Parameters
- boundary: any = {}
- precision: number = 8
  default precision for calculations
Returns Bounds
- Defined in src/js/tools/geometry/Bounds.ts:80

Methods

_dup

_dup(): Bounds
Duplicate the bounds object

Returns Bounds
- Defined in src/js/tools/geometry/Bounds.ts:93

contains

contains(
valueOrPosition: number | TypeParsablePoint,
projectToPlane?: boolean,
): boolean
Returns true if a value or Point is within the bounds.
Parameters
- valueOrPosition: number | TypeParsablePoint
- OptionalprojectToPlane: boolean
  optional flag used by some bounds types
Returns boolean
- Defined in src/js/tools/geometry/Bounds.ts:112

intersect

intersect(
valueOrPosition: number | TypeParsablePoint,
direction?: number | TypeParsablePoint,
): BoundsIntersect
Returns true if a value or Point is within the bounds.
Parameters
- valueOrPosition: number | TypeParsablePoint
- direction: number | TypeParsablePoint = 0
Returns BoundsIntersect
- Defined in src/js/tools/geometry/Bounds.ts:122

clip

clip(valueOrPosition: number | TypeParsablePoint): number | Point
Clips a value or Point to be within a boundary.
Parameters
- valueOrPosition: number | TypeParsablePoint
Returns number | Point
- Defined in src/js/tools/geometry/Bounds.ts:145