org.cesiumjs.cs.core

Class BoundingRectangle

java.lang.Object

org.cesiumjs.cs.core.BoundingRectangle

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	height The height of the rectangle.

Constructor Summary

Constructors

Constructor and Description
BoundingRectangle()
BoundingRectangle(double x, double y, double width, double height) A bounding rectangle given by a corner, width and height.

Method Summary

Modifier and Type	Method and Description
BoundingRectangle	clone() Duplicates this BoundingRectangle instance.
static BoundingRectangle	clone(BoundingRectangle rectangle) Duplicates a BoundingRectangle instance.
static BoundingRectangle	clone(BoundingRectangle rectangle, BoundingRectangle result) Duplicates a BoundingRectangle instance.
boolean	equals(BoundingRectangle right) Compares this BoundingRectangle against the provided BoundingRectangle componentwise and returns true if they are equal, false otherwise.
static boolean	equals(BoundingRectangle left, BoundingRectangle right) Compares the provided BoundingRectangles componentwise and returns true if they are equal, false otherwise.
static BoundingRectangle	expand(BoundingRectangle rectangle, Cartesian2 point) Computes a bounding rectangle by enlarging the provided rectangle until it contains the provided point.
static BoundingRectangle	expand(BoundingRectangle rectangle, Cartesian2 point, BoundingRectangle result) Computes a bounding rectangle by enlarging the provided rectangle until it contains the provided point.
static BoundingRectangle	fromPoints(Cartesian2[] positions) Computes a bounding rectangle enclosing the list of 2D points.
static BoundingRectangle	fromPoints(Cartesian2[] positions, BoundingRectangle result) Computes a bounding rectangle enclosing the list of 2D points.
static BoundingRectangle	fromRectangle(Rectangle rectangle, MapProjection projection) Computes a bounding rectangle from an rectangle.
static BoundingRectangle	fromRectangle(Rectangle rectangle, MapProjection projection, BoundingRectangle result) Computes a bounding rectangle from an rectangle.
int	intersect(BoundingRectangle right) Determines if this rectangle intersects with another.
static int	intersect(BoundingRectangle left, BoundingRectangle right) Determines if two rectangles intersect.
static double[]	pack(BoundingRectangle value, double[] array) Stores the provided instance into the provided array.
static double[]	pack(BoundingRectangle value, double[] array, int startingIndex) Stores the provided instance into the provided array.
static int	packedLength() The number of elements used to pack the object into an array.
static BoundingRectangle	union(BoundingRectangle left, BoundingRectangle right) Computes a bounding rectangle that is the union of the left and right bounding rectangles.
static BoundingRectangle	union(BoundingRectangle left, BoundingRectangle right, BoundingRectangle result) Computes a bounding rectangle that is the union of the left and right bounding rectangles.
static BoundingRectangle	unpack(double[] array) Retrieves an instance from a packed array.
static BoundingRectangle	unpack(double[] array, int startingIndex) Retrieves an instance from a packed array.
static BoundingRectangle	unpack(double[] array, int startingIndex, BoundingRectangle 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

height

@JsProperty
public double height

The height of the rectangle. Default: 0.0

Constructor Detail

BoundingRectangle

@JsConstructor
public BoundingRectangle()

BoundingRectangle

@JsConstructor
public BoundingRectangle(double x,
                                        double y,
                                        double width,
                                        double height)

A bounding rectangle given by a corner, width and height.

Parameters:

x - The x coordinate of the rectangle.

y - The y coordinate of the rectangle.

width - The width of the rectangle.

height - The height of the rectangle.

Method Detail

packedLength

@JsProperty(name="packedLength")
public static int packedLength()

The number of elements used to pack the object into an array.

clone

@JsMethod
public static BoundingRectangle clone(BoundingRectangle rectangle)

Duplicates a BoundingRectangle instance.

Parameters:

rectangle - The bounding rectangle to duplicate.

Returns:

The modified result parameter or a new BoundingRectangle instance if one was not provided. (Returns undefined if rectangle is undefined)

clone

@JsMethod
public static BoundingRectangle clone(BoundingRectangle rectangle,
                                                BoundingRectangle result)

Duplicates a BoundingRectangle instance.

Parameters:

rectangle - The bounding rectangle to duplicate.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new BoundingRectangle instance if one was not provided. (Returns undefined if rectangle is undefined)

equals

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

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

Parameters:

left - The first BoundingRectangle.

right - The second BoundingRectangle.

Returns:

true if left and right are equal, false otherwise.

expand

@JsMethod
public static BoundingRectangle expand(BoundingRectangle rectangle,
                                                 Cartesian2 point)

Computes a bounding rectangle by enlarging the provided rectangle until it contains the provided point.

Parameters:

rectangle - A rectangle to expand.

point - A point to enclose in a bounding rectangle.

Returns:

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

expand

@JsMethod
public static BoundingRectangle expand(BoundingRectangle rectangle,
                                                 Cartesian2 point,
                                                 BoundingRectangle result)

Computes a bounding rectangle by enlarging the provided rectangle until it contains the provided point.

Parameters:

rectangle - A rectangle to expand.

point - A point to enclose in a bounding rectangle.

result - The object onto which to store the result.

Returns:

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

fromPoints

@JsMethod
public static BoundingRectangle fromPoints(Cartesian2[] positions)

Computes a bounding rectangle enclosing the list of 2D points. The rectangle is oriented with the corner at the bottom left.

Parameters:

positions - List of points that the bounding rectangle will enclose. Each point must have x and y properties.

Returns:

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

fromPoints

@JsMethod
public static BoundingRectangle fromPoints(Cartesian2[] positions,
                                                     BoundingRectangle result)

Computes a bounding rectangle enclosing the list of 2D points. The rectangle is oriented with the corner at the bottom left.

Parameters:

positions - List of points that the bounding rectangle will enclose. Each point must have x and y properties.

result - The object onto which to store the result.

Returns:

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

fromRectangle

@JsMethod
public static BoundingRectangle fromRectangle(Rectangle rectangle,
                                                        MapProjection projection)

Computes a bounding rectangle from an rectangle.

Parameters:

rectangle - The valid rectangle used to create a bounding rectangle.

projection - The projection used to project the rectangle into 2D. Default: GeographicProjection

Returns:

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

fromRectangle

@JsMethod
public static BoundingRectangle fromRectangle(Rectangle rectangle,
                                                        MapProjection projection,
                                                        BoundingRectangle result)

Computes a bounding rectangle from an rectangle.

Parameters:

rectangle - The valid rectangle used to create a bounding rectangle.

projection - The projection used to project the rectangle into 2D. Default: GeographicProjection

result - The object onto which to store the result.

Returns:

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

intersect

@JsMethod
public static int intersect(BoundingRectangle left,
                                      BoundingRectangle right)

Determines if two rectangles intersect.

Parameters:

left - A rectangle to check for intersection.

right - The other rectangle to check for intersection.

Returns:

Intersect.INTERSECTING() if the rectangles intersect, Intersect.OUTSIDE() otherwise.

pack

@JsMethod
public static double[] pack(BoundingRectangle 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(BoundingRectangle 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

union

@JsMethod
public static BoundingRectangle union(BoundingRectangle left,
                                                BoundingRectangle right)

Computes a bounding rectangle that is the union of the left and right bounding rectangles.

Parameters:

left - A rectangle to enclose in bounding rectangle.

right - A rectangle to enclose in a bounding rectangle.

Returns:

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

union

@JsMethod
public static BoundingRectangle union(BoundingRectangle left,
                                                BoundingRectangle right,
                                                BoundingRectangle result)

Computes a bounding rectangle that is the union of the left and right bounding rectangles.

Parameters:

left - A rectangle to enclose in bounding rectangle.

right - A rectangle to enclose in a bounding rectangle.

result - The object onto which to store the result.

Returns:

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

unpack

@JsMethod
public static BoundingRectangle unpack(double[] array)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

Returns:

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

unpack

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

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

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

Returns:

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

unpack

@JsMethod
public static BoundingRectangle unpack(double[] array,
                                                 int startingIndex,
                                                 BoundingRectangle 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 BoundingRectangle instance if one was not provided.

clone

@JsMethod
public BoundingRectangle clone()

Duplicates this BoundingRectangle instance.

Overrides:

clone in class Object

Returns:

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

equals

@JsMethod
public boolean equals(BoundingRectangle right)

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

Parameters:

right - The right hand side BoundingRectangle.

Returns:

true if they are equal, false otherwise.

intersect

@JsMethod
public int intersect(BoundingRectangle right)

Determines if this rectangle intersects with another.

Parameters:

right - A rectangle to check for intersection.

Returns:

Intersect.INTERSECTING() if the rectangles intersect, Intersect.OUTSIDE() otherwise}.