BoxVolume

• webVis API Reference
• BoxVolume

Interface BoxVolume

This interfaces provides functions for working with BoxVolumes. BoxVolumes are Axis Aligned Bounding Boxes (AABB) and describe the minimal Bounding Box of a Node. They consist of six values, 3 for the minimum and 3 for the maximum corner.

Hierarchy

• BoxVolume

Index

Methods

contains copy equals extend extendByTransformedVolume extendByVolume fromArray getCenter getCornerPoints getDiameter getMax getMin getRadialVec getSize includePoint isValid overlaps reset setFromCenterSize setMax setMin setValid transformFrom transformFromArray

Methods

contains

• contains(other): boolean

• Returns true if the given BoxVolume contains the other BoxVolume.

  Parameters

  • other: BoxVolume

    the other BoxVolume

  Returns boolean

copy

• copy(other): void

• Parameters

  • other: BoxVolume

  Returns void

equals

• equals(other): boolean

• Returns true if the given BoxVolume equals the other BoxVolume.

  Parameters

  • other: BoxVolume

    the other BoxVolume

  Returns boolean

extend

• extend(newMin, newMax): void

• Parameters

  • newMin: Float32Array | [number, number, number]

  • newMax: Float32Array | [number, number, number]

  Returns void

extendByTransformedVolume

• extendByTransformedVolume(other, transform?): void

• Parameters

  • other: BoxVolume

  • Optional transform: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  Returns void

extendByVolume

• extendByVolume(other): void

• Extends a BoxVolume by another BoxVolume. The resulting BoxVolume will span over the other BoxVolume too.

  Parameters

  • other: BoxVolume

  Returns void

fromArray

• fromArray(array): boolean

• Creates a BoxVolume from an array.

  Parameters

  • array: Float32Array | number[]

    the number array with 6 values

  Returns boolean

getCenter

• getCenter(): Float32Array

• Returns the center of the BoxVolume.

  Returns Float32Array

getCornerPoints

• getCornerPoints(): Float32Array[]

• Returns the corner points of a BoxVolume.

  Returns Float32Array[]

getDiameter

• getDiameter(): number

• Returns number

getMax

• getMax(): Float32Array

• Returns the maximum of the BoxVolume.

  Returns Float32Array

getMin

• getMin(): Float32Array

• Returns the minimum of the BoxVolume.

  Returns Float32Array

getRadialVec

• getRadialVec(): Float32Array

• Returns Float32Array

getSize

• getSize(): Float32Array

• Returns the size of the BoxVolume.

  Returns Float32Array

includePoint

• includePoint(p): void

• Parameters

  • p: Float32Array

  Returns void

isValid

• isValid(): boolean

• Returns true, if the BoxVolume is valid.

  Returns boolean

overlaps

• overlaps(other): boolean

• Returns true if two BoxVolumes are overlapping.

  Parameters

  • other: BoxVolume

  Returns boolean

reset

• reset(): void

• Returns void

setFromCenterSize

• setFromCenterSize(center, size): BoxVolume

• Parameters

  • center: Float32Array | [number, number, number]

  • size: Float32Array | [number, number, number]

  Returns BoxVolume

setMax

• setMax(max): void

• Parameters

  • max: Float32Array | [number, number, number]

  Returns void

setMin

• setMin(min): void

• Parameters

  • min: Float32Array | [number, number, number]

  Returns void

setValid

• setValid(valid?): void

• Parameters

  • Optional valid: boolean

  Returns void

transformFrom

• transformFrom(matrix, other): BoxVolume

• Parameters

  • matrix: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  • other: BoxVolume

  Returns BoxVolume

transformFromArray

• transformFromArray(matrix, otherVolume): BoxVolume

• Parameters

  • matrix: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  • otherVolume: number[]

  Returns BoxVolume