Class Bbox

Hierarchy

Bbox

Index

Constructors

Properties

_geom _oc _ocBbox bounds position

Constructors

constructor

new Bbox(min?: PointLike, max?: PointLike): Bbox
Create 2D or 3D Bbox from two Point spanning up the box
Parameters
- min: PointLike = null
- max: PointLike = null
Returns Bbox
- Defined in Bbox.ts:28

Properties

_geom

_geom: any

_oc

_oc: any

_ocBbox

_ocBbox: any = null

bounds

bounds: number[] = null

position

position: Point

Methods

_containsBbox

_containsBbox(other: Bbox): boolean
Parameters
- other: Bbox
Returns boolean
- Defined in Bbox.ts:513

_getSide

_getSide(side: string): Vertex | Edge | Face
Get side of Bbox - NOTE: Some sides can be zero length
Parameters
- side: string
Returns Vertex | Edge | Face
- Defined in Bbox.ts:538

added

added(other: Bbox): Bbox
Return a new Bbox by adding another
Parameters
- other: Bbox
Returns Bbox
- Defined in Bbox.ts:328

area

area(): number
Get area of bbox

Returns number
- Defined in Bbox.ts:480

axisMissingIn2D

axisMissingIn2D(): MainAxis
The axis that is missing in 2D bbox

Returns MainAxis
- Defined in Bbox.ts:374

back

back(): Vertex | Edge | Face
Get back Face (3D) or Edge (2D)

Returns Vertex | Edge | Face
- Defined in Bbox.ts:203

bottom

bottom(): Vertex | Edge | Face
Get left Face (3D) or Edge (2D)

Returns Vertex | Edge | Face
- Defined in Bbox.ts:227

box

box(): Solid
returns a Box Shape for this Bbox

Returns Solid
- Defined in Bbox.ts:401

center

center(): Point
Get center of Bounding Box

Returns Point
- Defined in Bbox.ts:169

contains

contains(other: Shape): boolean
Parameters
- other: Shape
Returns boolean
- Defined in Bbox.ts:493

copy

copy(): Bbox
Copy this Bounding Box

Returns Bbox
- Defined in Bbox.ts:114

corner

corner(where: string): Point
Get one of the 8 Vertices of the Bbox
Parameters
- where: string
Returns Point
- Defined in Bbox.ts:236

create

create(min: PointLike, max: PointLike): any
Parameters
- min: PointLike
- max: PointLike
Returns any
- Defined in Bbox.ts:43

depth

depth(): number
Get depth of Bounding Box

Returns number
- Defined in Bbox.ts:183

depthHalfLine

depthHalfLine(): Edge
Gets the Edge seperating depth in two equal halves

Returns Edge
- Defined in Bbox.ts:415

diagonal

diagonal(): Vertex | Edge
Get the diagonal of Bounding Box as Vertex (zero size Bbox) or Edge

Returns Vertex | Edge
- Defined in Bbox.ts:287

enlarged

enlarged(amount: number): Bbox
Enlarge by offsetting current Bbox in all direction a given amount. Returns a new Bbox.
Parameters
- amount: number
Returns Bbox
- Defined in Bbox.ts:316

front

front(): Vertex | Edge | Face
Get frontal Face (3D) or Edge (2D)

Returns Vertex | Edge | Face
- Defined in Bbox.ts:197

getPositionAtPerc

getPositionAtPerc(p: PointLike, ...args: any[]): Point
Get position of Bbox based on percentages of x,y,z
Parameters
- p: PointLike
- Rest ...args: any[]
Returns Point
- Defined in Bbox.ts:303

getSidesShape

getSidesShape(sidesString: string): Vertex | Edge | Face
Get Sub Shapes associated with given sides
Parameters
- sidesString: string
Returns Vertex | Edge | Face
- Defined in Bbox.ts:425

height

height(): number
Get height of Bounding Box

Returns number
- Defined in Bbox.ts:176

is2D

is2D(): boolean
Check if Bounding Box is 2D

Returns boolean
- Defined in Bbox.ts:361

isPoint

isPoint(): boolean
Check if Bounding Box of zero size so a Point

Returns boolean
- Defined in Bbox.ts:353

left

left(): Vertex | Edge | Face
Get left Face (3D) or Edge (2D)

Returns Vertex | Edge | Face
- Defined in Bbox.ts:209

max

max(): Point
Get maximum point (right,top,back)

Returns Point
- Defined in Bbox.ts:133

maxX

maxX(): number
Returns number
- Defined in Bbox.ts:143

maxY

maxY(): number
Returns number
- Defined in Bbox.ts:153

maxZ

maxZ(): number
Returns number
- Defined in Bbox.ts:163

min

min(): Point
Get Point of left, front, bottom corner

Returns Point
- Defined in Bbox.ts:127

minX

minX(): number
Returns number
- Defined in Bbox.ts:138

minY

minY(): number
Returns number
- Defined in Bbox.ts:148

minZ

minZ(): number
Returns number
- Defined in Bbox.ts:158

rect

rect(): Face
Create 2D Rectangle Face from Bbox (DEBUG)

Returns Face
- Defined in Bbox.ts:395

right

right(): Vertex | Edge | Face
Get left Face (3D) or Edge (2D)

Returns Vertex | Edge | Face
- Defined in Bbox.ts:215

setBounds

setBounds(): number[]
Set boundaries of Bbox from OC Bbox

Returns number[]
- Defined in Bbox.ts:96

toData

toData(): number[]
Returns number[]
- Defined in Bbox.ts:524

toString

toString(): string
Returns string
- Defined in Bbox.ts:529

top

top(): Vertex | Edge | Face
Get left Face (3D) or Edge (2D)

Returns Vertex | Edge | Face
- Defined in Bbox.ts:221

updateFromOcBbox

updateFromOcBbox(): void
Update properties (bounds and position) based on _ocBbox

Returns void
- Defined in Bbox.ts:120

width

width(): number
Get width of Bounding Box

Returns number
- Defined in Bbox.ts:190

widthHalfLine

widthHalfLine(): Edge
Gets the Edge seperating width in two equal halves

Returns Edge
- Defined in Bbox.ts:408

Generated using TypeDoc