Class AcGeBox3d

constructor

• new AcGeBox3d(
      min?: undefined | AcGeVector3dLike,
      max?: undefined | AcGeVector3dLike,
  ): AcGeBox3d

• Create a 3d box bounded by min and max.

  Parameters

  • min: undefined | AcGeVector3dLike = undefined

    (optional) Input the lower (x, y, z) boundary of the box. Set it to ( + Infinity, + Infinity, + Infinity ) if undefined or null provided.
  • max: undefined | AcGeVector3dLike = undefined

    (optional) Input the upper (x, y, z) boundary of the box. Set it to ( - Infinity, - Infinity, - Infinity ) if undefined or null provided.

  Returns AcGeBox3d

max

min

center

• get center(): AcGeVector3d

• Center point of this box

  Returns AcGeVector3d

size

• get size(): AcGeVector3d

• Return the width, height and depth of this box.

  Returns AcGeVector3d

applyMatrix4

• applyMatrix4(matrix: AcGeMatrix3d): AcGeBox3d

• Transform this box with the supplied matrix.

  Parameters

  • matrix: AcGeMatrix3d

    Input 4x4 matrix to apply

  Returns AcGeBox3d

  Return this box

clampPoint

• clampPoint(point: AcGeVector3dLike, target: AcGeVector3d): AcGeVector3d

• Clamp the point within the bounds of this box.

  Parameters

  • point: AcGeVector3dLike

    Input the point to clamp.
  • target: AcGeVector3d

    Input the result will be copied into this 3d vector.

  Returns AcGeVector3d

  Return the target

clone

• clone(): AcGeBox3d

• Return a new box with the same min and max as this one.

  Returns AcGeBox3d

  Return a new box with the same min and max as this one.

containsBox

• containsBox(box: AcGeBox3d): boolean

• Return true if this box includes the entirety of box. If this and box are identical, this function also returns true.

  Parameters

  • box: AcGeBox3d

    Input 3d box to test for inclusion.

  Returns boolean

  Return true if this box includes the entirety of box.

containsPoint

• containsPoint(point: AcGeVector3dLike): boolean

• Return true if the specified point lies within or on the boundaries of this box.

  Parameters

  • point: AcGeVector3dLike

    Input point to check for inclusion.

  Returns boolean

  Return true if the specified point lies within or on the boundaries of this box.

copy

• copy(box: AcGeBox3d): AcGeBox3d

• Copy the min and max from box to this box.

  Parameters

  • box: AcGeBox3d

    Input box to copy.

  Returns AcGeBox3d

  Return this box

distanceToPoint

• distanceToPoint(point: AcGeVector3dLike): number

• Returns the distance from any edge of this box to the specified point. If the point lies inside of this box, the distance will be 0.

  Parameters

  • point: AcGeVector3dLike

    Input one 3d point to measure distance to.

  Returns number

  Return the distance from any edge of this box to the specified point.

equals

• equals(box: AcGeBox3d): boolean

• Return true if this box and box share the same lower and upper bounds.

  Parameters

  • box: AcGeBox3d

    Input box to compare with this one.

  Returns boolean

  Return true if this box and box share the same lower and upper bounds.

expandByPoint

• expandByPoint(point: AcGeVector3dLike): AcGeBox3d

• Expand the boundaries of this box to include point.

  Parameters

  • point: AcGeVector3dLike

  Returns AcGeBox3d

expandByScalar

• expandByScalar(scalar: number): AcGeBox3d

• Expand each dimension of the box by scalar. If negative, the dimensions of the box will be contracted.

  Parameters

  • scalar: number

    Input distance to expand the box by.

  Returns AcGeBox3d

  Return this box

expandByVector

• expandByVector(vector: AcGeVector3dLike): AcGeBox3d

• Expand this box equilaterally by vector. The width of this box will be expanded by the x component of vector in both directions. The height of this box will be expanded by the y component of vector in both directions. The depth of this box will be expanded by the z component of vector in both directions.

  Parameters

  • vector: AcGeVector3dLike

    Input one 3d vector to expand the box by.

  Returns AcGeBox3d

  Return this box

getCenter

• getCenter(target: AcGeVector3d): AcGeVector3d

• Return the center point of the box as a 3d vector.

  Parameters

  • target: AcGeVector3d

    Input the result copied into this 3d vector.

  Returns AcGeVector3d

  Return the center point of the box

getParameter

• getParameter(point: AcGeVector3dLike, target: AcGeVector3d): AcGeVector3d

• Return a point as a proportion of this box's width, height and depth.

  Parameters

  • point: AcGeVector3dLike

    Input one point
  • target: AcGeVector3d

    Input the result will be copied into this Vector3.

  Returns AcGeVector3d

  Return one point

getSize

• getSize(target: AcGeVector3d): AcGeVector3d

• Return the width, height and depth of this box.

  Parameters

  • target: AcGeVector3d

    Return the result copied into this 3d vector.

  Returns AcGeVector3d

  Return the width, height and depth of this box.

intersect

• intersect(box: AcGeBox3d): AcGeBox3d

• Compute the intersection of this and box, setting the upper bound of this box to the lesser of the two boxes' upper bounds and the lower bound of this box to the greater of the two boxes' lower bounds. If there's no overlap, makes this box empty.

  Parameters

  • box: AcGeBox3d

    Input 3d box to intersect with.

  Returns AcGeBox3d

  Return this box

intersectsBox

• intersectsBox(box: AcGeBox3d): boolean

• Determine whether or not this box intersects box.

  Parameters

  • box: AcGeBox3d

    Input 3d box to check for intersection against.

  Returns boolean

  Return true if this box intersects the specified box.

intersectsPlane

• intersectsPlane(plane: AcGePlane): boolean

• Determine whether or not this box intersects plane.

  Parameters

  • plane: AcGePlane

    Input the plane to check for intersection against.

  Returns boolean

  Return true if this box intersects the specified plane.

isEmpty

• isEmpty(): boolean

• Return true if this box includes zero points within its bounds. Note that a box with equal lower and upper bounds still includes one point, the one both bounds share.

  Returns boolean

  Return true if this box includes zero points within its bounds.

makeEmpty

• makeEmpty(): AcGeBox3d

• Make this box empty.

  Returns AcGeBox3d

  Return this box

set

• set(min: AcGeVector3dLike, max: AcGeVector3dLike): AcGeBox3d

• Set the lower and upper (x, y, z) boundaries of this box. Please note that this method only copies the values from the given objects.

  Parameters

  • min: AcGeVector3dLike

    Input the lower (x, y, z) boundary of the box.
  • max: AcGeVector3dLike

    Input the upper (x, y, z) boundary of the box.

  Returns AcGeBox3d

  Return this box.

setFromArray

• setFromArray(array: number[]): AcGeBox3d

• Set the upper and lower bounds of this box to include all of the data in array.

  Parameters

  • array: number[]

    Input an array of position data that the resulting box will envelop.

  Returns AcGeBox3d

  Return this box

setFromCenterAndSize

• setFromCenterAndSize(
      center: AcGeVector3dLike,
      size: AcGeVector3dLike,
  ): AcGeBox3d

• Center this box on center and set this box's width, height and depth to the values specified in size

  Parameters

  • center: AcGeVector3dLike

    Input the desired center position of the box.
  • size: AcGeVector3dLike

    Input the desired x, y and z dimensions of the box.

  Returns AcGeBox3d

  Return this box

setFromPoints

• setFromPoints(points: AcGeVector3dLike[]): AcGeBox3d

• Set the upper and lower bounds of this box to include all of the points in points.

  Parameters

  • points: AcGeVector3dLike[]

    Input an array of 3d point or 3d vector that the resulting box will contain.

  Returns AcGeBox3d

  Return this box

translate

• translate(offset: AcGeVector3dLike): AcGeBox3d

• Add offset to both the upper and lower bounds of this box, effectively moving this box offset units in 3d space.

  Parameters

  • offset: AcGeVector3dLike

    Input direction and distance of offset.

  Returns AcGeBox3d

  Return this box

union

• union(box: AcGeBox3d): AcGeBox3d

• Compute the union of this box and box, setting the upper bound of this box to the greater of the two boxes' upper bounds and the lower bound of this box to the lesser of the two boxes' lower bounds.

  Parameters

  • box: AcGeBox3d

    Input the 3d box that will be unioned with this box.

  Returns AcGeBox3d

  Return this box