org.cesiumjs.cs.core

Class AxisAlignedBoundingBox

java.lang.Object

org.cesiumjs.cs.core.AxisAlignedBoundingBox

@JsType(isNative=true,
        namespace="Cesium",
        name="AxisAlignedBoundingBox")
public class AxisAlignedBoundingBox
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Cartesian3	center The center point of the bounding box.
Cartesian3	maximum The maximum point defining the bounding box.
Cartesian3	minimum The minimum point defining the bounding box.

Constructor Summary

Constructors

Constructor and Description
AxisAlignedBoundingBox() Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.
AxisAlignedBoundingBox(Cartesian3 minimum) Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.
AxisAlignedBoundingBox(Cartesian3 minimum, Cartesian3 maximum) Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.
AxisAlignedBoundingBox(Cartesian3 minimum, Cartesian3 maximum, Cartesian3 center) Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.

Method Summary

Modifier and Type	Method and Description
static AxisAlignedBoundingBox	clone(AxisAlignedBoundingBox box) Duplicates a AxisAlignedBoundingBox instance.
static AxisAlignedBoundingBox	clone(AxisAlignedBoundingBox box, AxisAlignedBoundingBox result) Duplicates a AxisAlignedBoundingBox instance.
static boolean	equals(AxisAlignedBoundingBox left) Compares the provided AxisAlignedBoundingBox componentwise and returns true if they are equal, false otherwise.
static boolean	equals(AxisAlignedBoundingBox left, AxisAlignedBoundingBox right) Compares the provided AxisAlignedBoundingBox componentwise and returns true if they are equal, false otherwise.
static AxisAlignedBoundingBox	fromPoints(Cartesian3[] positions, AxisAlignedBoundingBox result) Computes an instance of an AxisAlignedBoundingBox.
static Integer	intersectPlane(AxisAlignedBoundingBox box, Plane plane) Determines which side of a plane a box is located.
int	intersectPlane(Plane plane) Determines which side of a plane this box is located.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

center

@JsProperty
public Cartesian3 center

The center point of the bounding box.

maximum

@JsProperty
public Cartesian3 maximum

The maximum point defining the bounding box. Default: Cartesian3.ZERO()

minimum

@JsProperty
public Cartesian3 minimum

The minimum point defining the bounding box. Default: Cartesian3.ZERO()

Constructor Detail

AxisAlignedBoundingBox

@JsConstructor
public AxisAlignedBoundingBox()

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

See Also:

BoundingSphere, BoundingRectangle

AxisAlignedBoundingBox

@JsConstructor
public AxisAlignedBoundingBox(Cartesian3 minimum)

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

Parameters:

minimum - The minimum point along the x, y, and z axes.

See Also:

BoundingSphere, BoundingRectangle

AxisAlignedBoundingBox

@JsConstructor
public AxisAlignedBoundingBox(Cartesian3 minimum,
                                             Cartesian3 maximum)

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

Parameters:

minimum - The minimum point along the x, y, and z axes.

maximum - The maximum point along the x, y, and z axes.

See Also:

BoundingSphere, BoundingRectangle

AxisAlignedBoundingBox

@JsConstructor
public AxisAlignedBoundingBox(Cartesian3 minimum,
                                             Cartesian3 maximum,
                                             Cartesian3 center)

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

Parameters:

minimum - The minimum point along the x, y, and z axes.

maximum - The maximum point along the x, y, and z axes.

center - The center of the box; automatically computed if not supplied.

See Also:

BoundingSphere, BoundingRectangle

Method Detail

clone

@JsMethod
public static AxisAlignedBoundingBox clone(AxisAlignedBoundingBox box)

Duplicates a AxisAlignedBoundingBox instance.

Parameters:

box - The bounding box to duplicate.

Returns:

The modified result parameter or a new AxisAlignedBoundingBox instance if none was provided. (Returns undefined if box is undefined)

clone

@JsMethod
public static AxisAlignedBoundingBox clone(AxisAlignedBoundingBox box,
                                                     AxisAlignedBoundingBox result)

Duplicates a AxisAlignedBoundingBox instance.

Parameters:

box - The bounding box to duplicate.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new AxisAlignedBoundingBox instance if none was provided. (Returns undefined if box is undefined)

equals

@JsMethod
public static boolean equals(AxisAlignedBoundingBox left)

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

Parameters:

left - The first AxisAlignedBoundingBox.

Returns:

true if left and right are equal, false otherwise.

equals

@JsMethod
public static boolean equals(AxisAlignedBoundingBox left,
                                       AxisAlignedBoundingBox right)

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

Parameters:

left - The first AxisAlignedBoundingBox.

right - The second AxisAlignedBoundingBox.

Returns:

true if left and right are equal, false otherwise.

fromPoints

@JsMethod
public static AxisAlignedBoundingBox fromPoints(Cartesian3[] positions,
                                                          AxisAlignedBoundingBox result)

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:

positions - List of points that the bounding box will enclose. Each point must have a x, y, and z properties.

result - The object onto which to store the result.

Returns:

The object onto which to store the result.

intersectPlane

@JsMethod
public static Integer intersectPlane(AxisAlignedBoundingBox box,
                                               Plane plane)

Determines which side of a plane a box is located.

Parameters:

box - The bounding box to test.

plane - The plane to test against.

Returns:

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.INTERSECTING() if the box intersects the plane.

intersectPlane

@JsMethod
public int intersectPlane(Plane plane)

Determines which side of a plane this box is located.

Parameters:

plane - The plane to test against.

Returns:

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.INTERSECTING() if the box intersects the plane.