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.

interface BoxVolume {
    contains(other: BoxVolume): boolean;
    copy(other: BoxVolume): void;
    equals(other: BoxVolume): boolean;
    extend(
        newMin: Float32Array<ArrayBufferLike> | [number, number, number],
        newMax: Float32Array<ArrayBufferLike> | [number, number, number],
    ): void;
    extendByTransformedVolume(
        other: BoxVolume,
        transform?:
            | Float32Array<ArrayBufferLike>
            | [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ],
    ): void;
    extendByVolume(other: BoxVolume): void;
    fromArray(array: number[] | Float32Array<ArrayBufferLike>): boolean;
    getCenter(): Float32Array<ArrayBufferLike>;
    getCornerPoints(): Float32Array<ArrayBufferLike>[];
    getDiameter(): number;
    getMax(): Float32Array<ArrayBufferLike>;
    getMin(): Float32Array<ArrayBufferLike>;
    getRadialVec(): Float32Array<ArrayBufferLike>;
    getSize(): Float32Array<ArrayBufferLike>;
    includePoint(p: Float32Array<ArrayBufferLike>): void;
    isValid(): boolean;
    overlaps(other: BoxVolume): boolean;
    reset(): void;
    setFromCenterSize(
        center: Float32Array<ArrayBufferLike> | [number, number, number],
        size: Float32Array<ArrayBufferLike> | [number, number, number],
    ): BoxVolume;
    setMax(max: Float32Array<ArrayBufferLike> | [number, number, number]): void;
    setMin(min: Float32Array<ArrayBufferLike> | [number, number, number]): void;
    setValid(valid?: boolean): void;
    transformFrom(
        matrix:
            | Float32Array<ArrayBufferLike>
            | [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ],
        other: BoxVolume,
    ): BoxVolume;
    transformFromArray(
        matrix:
            | Float32Array<ArrayBufferLike>
            | [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ],
        otherVolume: number[],
    ): 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: BoxVolume): boolean

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

  Parameters

  • other: BoxVolume

    the other BoxVolume

  Returns boolean

copy

• copy(other: BoxVolume): void

• Parameters

  • other: BoxVolume

  Returns void

equals

• equals(other: BoxVolume): boolean

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

  Parameters

  • other: BoxVolume

    the other BoxVolume

  Returns boolean

extend

• extend(
      newMin: Float32Array<ArrayBufferLike> | [number, number, number],
      newMax: Float32Array<ArrayBufferLike> | [number, number, number],
  ): void

• Parameters

  • newMin: Float32Array<ArrayBufferLike> | [number, number, number]
  • newMax: Float32Array<ArrayBufferLike> | [number, number, number]

  Returns void

extendByTransformedVolume

• extendByTransformedVolume(
      other: BoxVolume,
      transform?:
          | Float32Array<ArrayBufferLike>
          | [
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
          ],
  ): void

• Parameters

  • other: BoxVolume
  • Optionaltransform:
        | Float32Array<ArrayBufferLike>
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]

  Returns void

extendByVolume

• extendByVolume(other: BoxVolume): 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: number[] | Float32Array<ArrayBufferLike>): boolean

• Creates a BoxVolume from an array.

  Parameters

  • array: number[] | Float32Array<ArrayBufferLike>

    the number array with 6 values

  Returns boolean

getCenter

• getCenter(): Float32Array<ArrayBufferLike>

• Returns the center of the BoxVolume.

  Returns Float32Array<ArrayBufferLike>

getCornerPoints

• getCornerPoints(): Float32Array<ArrayBufferLike>[]

• Returns the corner points of a BoxVolume.

  Returns Float32Array<ArrayBufferLike>[]

getDiameter

• getDiameter(): number

• Returns number

getMax

• getMax(): Float32Array<ArrayBufferLike>

• Returns the maximum of the BoxVolume.

  Returns Float32Array<ArrayBufferLike>

getMin

• getMin(): Float32Array<ArrayBufferLike>

• Returns the minimum of the BoxVolume.

  Returns Float32Array<ArrayBufferLike>

getRadialVec

• getRadialVec(): Float32Array<ArrayBufferLike>

• Returns Float32Array<ArrayBufferLike>

getSize

• getSize(): Float32Array<ArrayBufferLike>

• Returns the size of the BoxVolume.

  Returns Float32Array<ArrayBufferLike>

includePoint

• includePoint(p: Float32Array<ArrayBufferLike>): void

• Parameters

  • p: Float32Array<ArrayBufferLike>

  Returns void

isValid

• isValid(): boolean

• Returns true, if the BoxVolume is valid.

  Returns boolean

overlaps

• overlaps(other: BoxVolume): boolean

• Returns true if two BoxVolumes are overlapping.

  Parameters

  • other: BoxVolume

  Returns boolean

reset

• reset(): void

• Returns void

setFromCenterSize

• setFromCenterSize(
      center: Float32Array<ArrayBufferLike> | [number, number, number],
      size: Float32Array<ArrayBufferLike> | [number, number, number],
  ): BoxVolume

• Parameters

  • center: Float32Array<ArrayBufferLike> | [number, number, number]
  • size: Float32Array<ArrayBufferLike> | [number, number, number]

  Returns BoxVolume

setMax

• setMax(max: Float32Array<ArrayBufferLike> | [number, number, number]): void

• Parameters

  • max: Float32Array<ArrayBufferLike> | [number, number, number]

  Returns void

setMin

• setMin(min: Float32Array<ArrayBufferLike> | [number, number, number]): void

• Parameters

  • min: Float32Array<ArrayBufferLike> | [number, number, number]

  Returns void

setValid

• setValid(valid?: boolean): void

• Parameters

  • Optionalvalid: boolean

  Returns void

transformFrom

• transformFrom(
      matrix:
          | Float32Array<ArrayBufferLike>
          | [
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
          ],
      other: BoxVolume,
  ): BoxVolume

• Parameters

  • matrix:
        | Float32Array<ArrayBufferLike>
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
  • other: BoxVolume

  Returns BoxVolume

transformFromArray

• transformFromArray(
      matrix:
          | Float32Array<ArrayBufferLike>
          | [
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
          ],
      otherVolume: number[],
  ): BoxVolume

• Parameters

  • matrix:
        | Float32Array<ArrayBufferLike>
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
  • otherVolume: number[]

  Returns BoxVolume

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)