top
all js glsl

AxisAlignedBoundingBox

AxisAlignedBoundingBox

new

Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.

Parameters:
Name Type Argument Default Description
minimum Cartesian3 <optional>
 Cartesian3.ZERO The minimum point along the x, y, and z axes.
maximum Cartesian3 <optional>
 Cartesian3.ZERO The maximum point along the x, y, and z axes.
center Cartesian3 <optional>
 The center of the box; automatically computed if not supplied.
See:
Source:

Members

:Cartesian3

The center point of the bounding box.

:Cartesian3

The maximum point defining the bounding box.
Default Value:

:Cartesian3

The minimum point defining the bounding box.
Default Value:

Methods

Duplicates this AxisAlignedBoundingBox instance.

Parameters:
Name Type Argument Description
result AxisAlignedBoundingBox <optional>
 The object onto which to store the result.
Returns:
AxisAlignedBoundingBox The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided.

Compares this AxisAlignedBoundingBox against the provided AxisAlignedBoundingBox componentwise and returns true if they are equal, false otherwise.

Parameters:
Name Type Argument Description
right AxisAlignedBoundingBox <optional>
 The right hand side AxisAlignedBoundingBox.
Returns:
Boolean true if they are equal, false otherwise.

Determines which side of a plane this box is located.

Parameters:
Name Type Description
plane Cartesian4 The coefficients of the plane in the form ax + by + cz + d = 0 where the coefficients a, b, c, and d are the components x, y, z, and w of the {Cartesian4}, respectively.
Returns:
Intersect {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing, {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING} if the box intersects the plane.

<static>

Duplicates a AxisAlignedBoundingBox instance.

Parameters:
Name Type Argument Description
box AxisAlignedBoundingBox The bounding box to duplicate.
result AxisAlignedBoundingBox <optional>
 The object onto which to store the result.
Returns:
AxisAlignedBoundingBox The modified result parameter or a new AxisAlignedBoundingBox instance if none was provided. (Returns undefined if box is undefined)

<static>

Compares the provided AxisAlignedBoundingBox componentwise and returns true if they are equal, false otherwise.

Parameters:
Name Type Argument Description
left AxisAlignedBoundingBox <optional>
 The first AxisAlignedBoundingBox.
right AxisAlignedBoundingBox <optional>
 The second AxisAlignedBoundingBox.
Returns:
Boolean true if left and right are equal, false otherwise.

<static>

Computes an instance of an AxisAlignedBoundingBox. The box is determined by finding the points spaced the farthest apart on the x, y, and z axes.

Parameters:
Name Type Argument Description
positions Array List of points that the bounding box will enclose. Each point must have a x, y, and z properties.
result AxisAlignedBoundingBox <optional>
 The object onto which to store the result.
Returns:
AxisAlignedBoundingBox The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided.
Example
// Compute an axis aligned bounding box enclosing two points.
var box = Cesium.AxisAlignedBoundingBox.fromPoints([new Cesium.Cartesian3(2, 0, 0), new Cesium.Cartesian3(-2, 0, 0)]);

<static>

Determines which side of a plane a box is located.

Parameters:
Name Type Description
box AxisAlignedBoundingBox The bounding box to test.
plane Cartesian4 The coefficients of the plane in the form ax + by + cz + d = 0 where the coefficients a, b, c, and d are the components x, y, z, and w of the {Cartesian4}, respectively.
Returns:
Intersect {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing, {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING} if the box intersects the plane.