Class SectionBox

Hierarchy

SectionBox

Index

Methods

clear getBoundingBox getMatrix setToBoundingBox setToBox setToInfinity setToPlanes

Constructors

Accessors

isSet lengthX lengthY lengthZ location rotationX rotationY rotationZ

Methods

clear

clear(): void
Alias for setToInfinity(). Makes the section box infinitely large so it doesn't crop anything in the view

Returns void
- Defined in src/section-box.ts:88

getBoundingBox

getBoundingBox(wcs: vec3): Float32Array
Returns bounding box of the section box. This is usefull for zooming and similar operations
Parameters
- wcs: vec3
Returns Float32Array
- Defined in src/section-box.ts:314

getMatrix

getMatrix(wcs: vec3): mat4
Matrix representation of this box. Can be used for simple test of points.
Parameters
- wcs: vec3
Returns mat4
- Defined in src/section-box.ts:56

setToBoundingBox

setToBoundingBox(box: ArrayLike<number>): void
Parameters
- box: ArrayLike<number>
Returns void
- Defined in src/section-box.ts:120

setToBox

setToBox(box: SectionBox): void
Sets all values for section box in one go as a copy from supplied box
Parameters
- box: SectionBox
  
  Section box values to be used
Returns void
- Defined in src/section-box.ts:108

setToInfinity

setToInfinity(): void
Sets frustum to maximum extens so that it shouldn't cut anything in the view.

Returns void
- Defined in src/section-box.ts:95

setToPlanes

setToPlanes(planes: ClippingPlane[]): boolean
Computes section box from 6 clipping planes if these form a box

Returns
true if succeeded, false if planes don't form a box
Parameters
- planes: ClippingPlane[]
  
  6 clipping planes representing the box
Returns boolean
- Defined in src/section-box.ts:137

Constructors

constructor

new SectionBox(onChange: (() => void)): SectionBox
Parameters
- onChange: (() => void)
  - - (): void
    - Returns void
Returns SectionBox
- Defined in src/section-box.ts:18

Accessors

isSet

get isSet(): boolean
True when section box is set, false otherwise

Returns boolean
- Defined in src/section-box.ts:81

lengthX

get lengthX(): number
Returns number
- Defined in src/section-box.ts:43
set lengthX(value: number): void
Parameters
- value: number
Returns void
- Defined in src/section-box.ts:44

lengthY

get lengthY(): number
Returns number
- Defined in src/section-box.ts:46
set lengthY(value: number): void
Parameters
- value: number
Returns void
- Defined in src/section-box.ts:47

lengthZ

get lengthZ(): number
Returns number
- Defined in src/section-box.ts:49
set lengthZ(value: number): void
Parameters
- value: number
Returns void
- Defined in src/section-box.ts:50

location

get location(): vec3
Returns vec3
- Defined in src/section-box.ts:31
set location(value: vec3): void
Parameters
- value: vec3
Returns void
- Defined in src/section-box.ts:32

rotationX

get rotationX(): number
Returns number
- Defined in src/section-box.ts:34
set rotationX(value: number): void
Parameters
- value: number
Returns void
- Defined in src/section-box.ts:35

rotationY

get rotationY(): number
Returns number
- Defined in src/section-box.ts:37
set rotationY(value: number): void
Parameters
- value: number
Returns void
- Defined in src/section-box.ts:38

rotationZ

get rotationZ(): number
Returns number
- Defined in src/section-box.ts:40
set rotationZ(value: number): void
Parameters
- value: number
Returns void
- Defined in src/section-box.ts:41

Generated using TypeDoc