Class AcGeBox2d

constructor

• new AcGeBox2d(
      min?: undefined | AcGeVector2dLike,
      max?: undefined | AcGeVector2dLike,
  ): AcGeBox2d

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

  Parameters

  • min: undefined | AcGeVector2dLike = undefined

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

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

  Returns AcGeBox2d

max

min

center

• get center(): AcGeVector2d

• Center point of this box

  Returns AcGeVector2d

size

• get size(): AcGeVector2d

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

  Returns AcGeVector2d

clampPoint

• clampPoint(point: AcGeVector2dLike, target: AcGeVector2d): AcGeVector2d

• Clamp the point within the bounds of this box.

  Parameters

  • point: AcGeVector2dLike

    Input one 2d point
  • target: AcGeVector2d

    Input the result will be copied into this Vector2.

  Returns AcGeVector2d

  Return the target

clone

• clone(): AcGeBox2d

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

  Returns AcGeBox2d

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

containsBox

• containsBox(box: AcGeBox2d): boolean

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

  Parameters

  • box: AcGeBox2d

    Input 2d box to test for inclusion.

  Returns boolean

  Return true if this box includes the entirety of box.

containsPoint

• containsPoint(point: AcGeVector2dLike): boolean

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

  Parameters

  • point: AcGeVector2dLike

    Input 2d 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: AcGeBox2d): AcGeBox2d

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

  Parameters

  • box: AcGeBox2d

    Input the box to copy from

  Returns AcGeBox2d

  Return this box

distanceToPoint

• distanceToPoint(point: AcGeVector2dLike): number

• Return 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: AcGeVector2dLike

    Input 2d vector to measure distance to.

  Returns number

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

equals

• equals(box: AcGeBox2d): boolean

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

  Parameters

  • box: AcGeBox2d

    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: AcGeVector2dLike): AcGeBox2d

• Expand the boundaries of this box to include point.

  Parameters

  • point: AcGeVector2dLike

    Input one point that should be included in the box.

  Returns AcGeBox2d

  Return this box

expandByScalar

• expandByScalar(scalar: number): AcGeBox2d

• 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 AcGeBox2d

  Return this box

expandByVector

• expandByVector(vector: AcGeVector2dLike): AcGeBox2d

• 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.

  Parameters

  • vector: AcGeVector2dLike

    Input 2d vector to expand the box by.

  Returns AcGeBox2d

  Return this box

getCenter

• getCenter(target: AcGeVector2d): AcGeVector2d

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

  Parameters

  • target: AcGeVector2d

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

  Returns AcGeVector2d

  Return the center point of the box as a 2d vector.

getParameter

• getParameter(point: AcGeVector2dLike, target: AcGeVector2d): AcGeVector2d

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

  Parameters

  • point: AcGeVector2dLike

    Input one point
  • target: AcGeVector2d

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

  Returns AcGeVector2d

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

getSize

• getSize(target: AcGeVector2d): AcGeVector2d

• Return the width and height of this box.

  Parameters

  • target: AcGeVector2d

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

  Returns AcGeVector2d

  Return this box.

intersect

• intersect(box: AcGeBox2d): AcGeBox2d

• Return 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.

  Parameters

  • box: AcGeBox2d

    Input box to intersect with

  Returns AcGeBox2d

  Return this box

intersectsBox

• intersectsBox(box: AcGeBox2d): boolean

• Determine whether or not this box intersects box.

  Parameters

  • box: AcGeBox2d

    Input 2d box to check for intersection against.

  Returns boolean

  Return true if this box intersects box.

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(): AcGeBox2d

• Make this box empty.

  Returns AcGeBox2d

  Return this box

set

• set(min: AcGeVector2dLike, max: AcGeVector2dLike): AcGeBox2d

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

  Parameters

  • min: AcGeVector2dLike

    Input 2d vector representing the lower (x, y) boundary of the box.
  • max: AcGeVector2dLike

    Input 2d vector representing the upper (x, y) boundary of the box.

  Returns AcGeBox2d

  Return this box

setFromCenterAndSize

• setFromCenterAndSize(
      center: AcGeVector2dLike,
      size: AcGeVector2dLike,
  ): AcGeBox2d

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

  Parameters

  • center: AcGeVector2dLike

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

    Input the desired x and y dimensions of the box.

  Returns AcGeBox2d

  Return this box

setFromPoints

• setFromPoints(points: AcGeVector2dLike[]): AcGeBox2d

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

  Parameters

  • points: AcGeVector2dLike[]

    Input one array of 2d vector that the resulting box will contain.

  Returns AcGeBox2d

  Return this box

translate

• translate(offset: AcGeVector2dLike): AcGeBox2d

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

  Parameters

  • offset: AcGeVector2dLike

    Input direction and distance of offset.

  Returns AcGeBox2d

  Return this box

union

• union(box: AcGeBox2d): AcGeBox2d

• Union this box with 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: AcGeBox2d

    Input the box that will be unioned with this box.

  Returns AcGeBox2d

  Return this box