org.cesiumjs.cs.core

Class OrientedBoundingBox

java.lang.Object

org.cesiumjs.cs.core.OrientedBoundingBox

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Cartesian3	center The center of the box.
Matrix3	halfAxes The transformation matrix, to rotate the box to the right position.

Constructor Summary

Constructors

Constructor and Description
OrientedBoundingBox() Creates an instance of an OrientedBoundingBox.
OrientedBoundingBox(Cartesian3 center, Matrix3 halfAxes) Creates an instance of an OrientedBoundingBox.

Method Summary

Modifier and Type	Method and Description
OrientedBoundingBox	clone() Duplicates this OrientedBoundingBox instance.
static OrientedBoundingBox	clone(OrientedBoundingBox box, OrientedBoundingBox result) Duplicates a OrientedBoundingBox instance.
Interval	computePlaneDistances(Cartesian3 position, Cartesian3 direction) The distances calculated by the vector from the center of the bounding box to position projected onto direction.
Interval	computePlaneDistances(Cartesian3 position, Cartesian3 direction, Interval result) The distances calculated by the vector from the center of the bounding box to position projected onto direction.
static Interval	computePlaneDistances(OrientedBoundingBox box, Cartesian3 position, Cartesian3 direction) The distances calculated by the vector from the center of the bounding box to position projected onto direction.
static Interval	computePlaneDistances(OrientedBoundingBox box, Cartesian3 position, Cartesian3 direction, Interval result) The distances calculated by the vector from the center of the bounding box to position projected onto direction.
double	distanceSquaredTo(Cartesian3 cartesian) Computes the estimated distance squared from the closest point on a bounding box to a point.
static double	distanceSquaredTo(OrientedBoundingBox box, Cartesian3 cartesian) Computes the estimated distance squared from the closest point on a bounding box to a point.
boolean	equals(OrientedBoundingBox right) Compares this OrientedBoundingBox against the provided OrientedBoundingBox componentwise and returns true if they are equal, false otherwise.
static boolean	equals(OrientedBoundingBox left, OrientedBoundingBox right) Compares the provided OrientedBoundingBox componentwise and returns true if they are equal, false otherwise.
static OrientedBoundingBox	fromPoints(Cartesian3[] positions) Computes an instance of an OrientedBoundingBox of the given positions.
static OrientedBoundingBox	fromPoints(Cartesian3[] positions, OrientedBoundingBox result) Computes an instance of an OrientedBoundingBox of the given positions.
static OrientedBoundingBox	fromRectangle(Rectangle rectangle) Computes an OrientedBoundingBox that bounds a Rectangle on the surface of an Ellipsoid.
static OrientedBoundingBox	fromRectangle(Rectangle rectangle, double minimumHeight, double maximumHeight, Ellipsoid ellipsoid) Computes an OrientedBoundingBox that bounds a Rectangle on the surface of an Ellipsoid.
static OrientedBoundingBox	fromRectangle(Rectangle rectangle, double minimumHeight, double maximumHeight, Ellipsoid ellipsoid, OrientedBoundingBox result) Computes an OrientedBoundingBox that bounds a Rectangle on the surface of an Ellipsoid.
static Integer	intersectPlane(OrientedBoundingBox box, Plane plane) Determines which side of a plane the oriented bounding box is located.
Number	intersectPlane(Plane plane) Determines which side of a plane the oriented bounding box is located.
boolean	isOccluded(Occluder occluder) Determines whether or not a bounding box is hidden from view by the occluder.
static boolean	isOccluded(OrientedBoundingBox box, Occluder occluder) Determines whether or not a bounding box is hidden from view by the occluder.
static double[]	pack(OrientedBoundingBox value, double[] array) Stores the provided instance into the provided array.
static double[]	pack(OrientedBoundingBox value, double[] array, int startingIndex) Stores the provided instance into the provided array.
static OrientedBoundingBox	unpack(double[] array, int startingIndex, OrientedBoundingBox result) Retrieves an instance from a packed array.

Methods inherited from class java.lang.Object

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

Field Detail

center

public Cartesian3 center

The center of the box. Default: Cartesian3.ZERO()

halfAxes

public Matrix3 halfAxes

The transformation matrix, to rotate the box to the right position. Default: Matrix3.IDENTITY()

Constructor Detail

OrientedBoundingBox

@JsConstructor
public OrientedBoundingBox()

Creates an instance of an OrientedBoundingBox. An OrientedBoundingBox of some object is a closed and convex cuboid. It can provide a tighter bounding volume than BoundingSphere or AxisAlignedBoundingBox in many cases.

See Also:

BoundingSphere, BoundingRectangle

OrientedBoundingBox

@JsConstructor
public OrientedBoundingBox(Cartesian3 center,
                                          Matrix3 halfAxes)

Creates an instance of an OrientedBoundingBox. An OrientedBoundingBox of some object is a closed and convex cuboid. It can provide a tighter bounding volume than BoundingSphere or AxisAlignedBoundingBox in many cases.

     Example:
     
     // Create an OrientedBoundingBox using a transformation matrix, a position where the box will be translated, and a scale.
     Cartesian3 center = new Cartesian3(1.0, 0.0, 0.0);
     Matrix3 halfAxes = Matrix3.fromScale(new Cartesian3(1.0, 3.0, 2.0), new Matrix3());
     OrientedBoundingBox obb = new OrientedBoundingBox(center, halfAxes);
     
 

Parameters:

center - The center of the box. Default: Cartesian3.ZERO()

halfAxes - The three orthogonal half-axes of the bounding box. Equivalently, the transformation matrix, to rotate and scale a 2x2x2 cube centered at the origin. Default: Matrix3.ZERO()

See Also:

BoundingSphere, BoundingRectangle

Method Detail

clone

public static OrientedBoundingBox clone(OrientedBoundingBox box,
                                        OrientedBoundingBox result)

Duplicates a OrientedBoundingBox 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 OrientedBoundingBox instance if none was provided. (Returns undefined if box is undefined)

computePlaneDistances

public static Interval computePlaneDistances(OrientedBoundingBox box,
                                             Cartesian3 position,
                                             Cartesian3 direction)

The distances calculated by the vector from the center of the bounding box to position projected onto direction. If you imagine the infinite number of planes with normal direction, this computes the smallest distance to the closest and farthest planes from position that intersect the bounding box.

Parameters:

box - The bounding box to calculate the distance to.

position - The position to calculate the distance from.

direction - The direction from position.

Returns:

The nearest and farthest distances on the bounding box from position in direction.

computePlaneDistances

public static Interval computePlaneDistances(OrientedBoundingBox box,
                                             Cartesian3 position,
                                             Cartesian3 direction,
                                             Interval result)

The distances calculated by the vector from the center of the bounding box to position projected onto direction. If you imagine the infinite number of planes with normal direction, this computes the smallest distance to the closest and farthest planes from position that intersect the bounding box.

Parameters:

box - The bounding box to calculate the distance to.

position - The position to calculate the distance from.

direction - The direction from position.

result - A Interval to store the nearest and farthest distances.

Returns:

The nearest and farthest distances on the bounding box from position in direction.

distanceSquaredTo

public static double distanceSquaredTo(OrientedBoundingBox box,
                                       Cartesian3 cartesian)

Computes the estimated distance squared from the closest point on a bounding box to a point.

Parameters:

box - The box.

cartesian - The point.

Returns:

The estimated distance squared from the bounding sphere to the point.

equals

public static boolean equals(OrientedBoundingBox left,
                             OrientedBoundingBox right)

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

Parameters:

left - The first OrientedBoundingBox.

right - The second OrientedBoundingBox.

Returns:

true if left and right are equal, false otherwise.

fromPoints

public static OrientedBoundingBox fromPoints(Cartesian3[] positions)

Computes an instance of an OrientedBoundingBox of the given positions. This is an implementation of Stefan Gottschalk's Collision Queries using Oriented Bounding Boxes solution (PHD thesis). Reference: http://gamma.cs.unc.edu/users/gottschalk/main.pdf

     Example:
     
     // Compute an object oriented bounding box enclosing two points.
     OrientedBoundingBox box = OrientedBoundingBox.fromPoints([new Cartesian3(2, 0, 0), new Cartesian3(-2, 0, 0)]);
     
 

Parameters:

positions - List of Cartesian3 points that the bounding box will enclose.

Returns:

The modified result parameter or a new OrientedBoundingBox instance if one was not provided.

fromPoints

public static OrientedBoundingBox fromPoints(Cartesian3[] positions,
                                             OrientedBoundingBox result)

Computes an instance of an OrientedBoundingBox of the given positions. This is an implementation of Stefan Gottschalk's Collision Queries using Oriented Bounding Boxes solution (PHD thesis). Reference: http://gamma.cs.unc.edu/users/gottschalk/main.pdf

     Example:
     
     // Compute an object oriented bounding box enclosing two points.
     OrientedBoundingBox box = OrientedBoundingBox.fromPoints([new Cartesian3(2, 0, 0), new Cartesian3(-2, 0, 0)]);
     
 

Parameters:

positions - List of Cartesian3 points that the bounding box will enclose.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new OrientedBoundingBox instance if one was not provided.

fromRectangle

public static OrientedBoundingBox fromRectangle(Rectangle rectangle)

Computes an OrientedBoundingBox that bounds a Rectangle on the surface of an Ellipsoid. There are no guarantees about the orientation of the bounding box.

Parameters:

rectangle - The cartographic rectangle on the surface of the ellipsoid.

Returns:

The modified result parameter or a new OrientedBoundingBox instance if none was provided.

fromRectangle

public static OrientedBoundingBox fromRectangle(Rectangle rectangle,
                                                double minimumHeight,
                                                double maximumHeight,
                                                Ellipsoid ellipsoid)

Computes an OrientedBoundingBox that bounds a Rectangle on the surface of an Ellipsoid. There are no guarantees about the orientation of the bounding box.

Parameters:

rectangle - The cartographic rectangle on the surface of the ellipsoid.

minimumHeight - The minimum height (elevation) within the tile. Default: 0.0

maximumHeight - The maximum height (elevation) within the tile. Default: 0.0

ellipsoid - The ellipsoid on which the rectangle is defined. Default: Ellipsoid.WGS84()

Returns:

The modified result parameter or a new OrientedBoundingBox instance if none was provided.

fromRectangle

public static OrientedBoundingBox fromRectangle(Rectangle rectangle,
                                                double minimumHeight,
                                                double maximumHeight,
                                                Ellipsoid ellipsoid,
                                                OrientedBoundingBox result)

Computes an OrientedBoundingBox that bounds a Rectangle on the surface of an Ellipsoid. There are no guarantees about the orientation of the bounding box.

Parameters:

rectangle - The cartographic rectangle on the surface of the ellipsoid.

minimumHeight - The minimum height (elevation) within the tile. Default: 0.0

maximumHeight - The maximum height (elevation) within the tile. Default: 0.0

ellipsoid - The ellipsoid on which the rectangle is defined. Default: Ellipsoid.WGS84()

result - The object onto which to store the result.

Returns:

The modified result parameter or a new OrientedBoundingBox instance if none was provided.

intersectPlane

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

Determines which side of a plane the oriented bounding box is located.

Parameters:

box - The oriented 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.

isOccluded

@JsMethod
public static boolean isOccluded(OrientedBoundingBox box,
                                           Occluder occluder)

Determines whether or not a bounding box is hidden from view by the occluder.

Parameters:

box - The bounding box surrounding the occludee object.

occluder - The occluder.

Returns:

true if the box is not visible; otherwise false.

pack

@JsMethod
public static double[] pack(OrientedBoundingBox value,
                                      double[] array)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

Returns:

The array that was packed into

pack

@JsMethod
public static double[] pack(OrientedBoundingBox value,
                                      double[] array,
                                      int startingIndex)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

startingIndex - The index into the array at which to start packing the elements.

Returns:

The array that was packed into

unpack

@JsMethod
public static OrientedBoundingBox unpack(double[] array,
                                                   int startingIndex,
                                                   OrientedBoundingBox result)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

startingIndex - The starting index of the element to be unpacked.

result - The object into which to store the result.

Returns:

The modified result parameter or a new OrientedBoundingBox instance if one was not provided.

clone

@JsMethod
public OrientedBoundingBox clone()

Duplicates this OrientedBoundingBox instance.

Overrides:

clone in class Object

Returns:

a new OrientedBoundingBox instance if one was not provided.

computePlaneDistances

@JsMethod
public Interval computePlaneDistances(Cartesian3 position,
                                                Cartesian3 direction)

The distances calculated by the vector from the center of the bounding box to position projected onto direction. If you imagine the infinite number of planes with normal direction, this computes the smallest distance to the closest and farthest planes from position that intersect the bounding box.

Parameters:

position - The position to calculate the distance from.

direction - The direction from position.

Returns:

The nearest and farthest distances on the bounding box from position in direction.

computePlaneDistances

@JsMethod
public Interval computePlaneDistances(Cartesian3 position,
                                                Cartesian3 direction,
                                                Interval result)

The distances calculated by the vector from the center of the bounding box to position projected onto direction. If you imagine the infinite number of planes with normal direction, this computes the smallest distance to the closest and farthest planes from position that intersect the bounding box.

Parameters:

position - The position to calculate the distance from.

direction - The direction from position.

result - A Interval to store the nearest and farthest distances.

Returns:

The nearest and farthest distances on the bounding box from position in direction.

distanceSquaredTo

@JsMethod
public double distanceSquaredTo(Cartesian3 cartesian)

Computes the estimated distance squared from the closest point on a bounding box to a point.

Parameters:

cartesian - The point

Returns:

The estimated distance squared from the bounding sphere to the point.

equals

@JsMethod
public boolean equals(OrientedBoundingBox right)

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

Parameters:

right - The right hand side OrientedBoundingBox.

Returns:

true if they are equal, false otherwise.

intersectPlane

@JsMethod
public Number intersectPlane(Plane plane)

Determines which side of a plane the oriented bounding 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.

isOccluded

@JsMethod
public boolean isOccluded(Occluder occluder)

Determines whether or not a bounding box is hidden from view by the occluder.

Parameters:

occluder - The occluder.

Returns:

true if the sphere is not visible; otherwise false.