Class Box

constructor

• new Box(): Box

• Returns Box

area

center

isValid

volume

closestPoint

• closestPoint(point): number[]

• Parameters

  • point: number[]

    Sample point.

  Returns number[]

  The point on or in the box that is closest to the sample point.

  Description

  Finds the closest point on or in the Box. The box should be Valid for this to work.

pointAt

• pointAt(x, y, z): number[]

• Parameters

  • x: number

    Unitized parameter (between 0 and 1 is inside the box) along box X direction.
  • y: number

    Unitized parameter (between 0 and 1 is inside the box) along box Y direction.
  • z: number

    Unitized parameter (between 0 and 1 is inside the box) along box Z direction.

  Returns number[]

  The point at (x,y,z).

  Description

  Evaluates the box volume at the given unitized parameters. The box has idealized side length of 1x1x1.

transform

• transform(xform): boolean

• Parameters

  • xform: Transform

    Transformation matrix to apply to this Box.

  Returns boolean

  true if the Box was successfully transformed, false if otherwise.

  Description

  Transforms this Box using a Transformation matrix. If the Transform does not preserve Similarity, the dimensions of the resulting box cannot be trusted.