A bounding rectangle given by a corner, width and height.
| Name | Type | Default | Description |
|---|---|---|---|
x |
number |
0.0
|
optional The x coordinate of the rectangle. |
y |
number |
0.0
|
optional The y coordinate of the rectangle. |
width |
number |
0.0
|
optional The width of the rectangle. |
height |
number |
0.0
|
optional The height of the rectangle. |
See:
Members
The number of elements used to pack the object into an array.
The height of the rectangle.
-
Default Value:
0.0
The width of the rectangle.
-
Default Value:
0.0
The x coordinate of the rectangle.
-
Default Value:
0.0
The y coordinate of the rectangle.
-
Default Value:
0.0
Methods
static Cesium.BoundingRectangle.clone(rectangle, result) → BoundingRectangle
Duplicates a BoundingRectangle instance.
| Name | Type | Description |
|---|---|---|
rectangle |
BoundingRectangle | The bounding rectangle to duplicate. |
result |
BoundingRectangle | optional 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)
Compares the provided BoundingRectangles componentwise and returns
true if they are equal, false otherwise.
| Name | Type | Description |
|---|---|---|
left |
BoundingRectangle | optional The first BoundingRectangle. |
right |
BoundingRectangle | optional The second BoundingRectangle. |
Returns:
true if left and right are equal, false otherwise.
static Cesium.BoundingRectangle.expand(rectangle, point, result) → BoundingRectangle
Computes a bounding rectangle by enlarging the provided rectangle until it contains the provided point.
| Name | Type | Description |
|---|---|---|
rectangle |
BoundingRectangle | A rectangle to expand. |
point |
Cartesian2 | A point to enclose in a bounding rectangle. |
result |
BoundingRectangle | optional The object onto which to store the result. |
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
static Cesium.BoundingRectangle.fromPoints(positions, result) → BoundingRectangle
Computes a bounding rectangle enclosing the list of 2D points.
The rectangle is oriented with the corner at the bottom left.
| Name | Type | Description |
|---|---|---|
positions |
Array.<Cartesian2> |
List of points that the bounding rectangle will enclose. Each point must have x and y properties. |
result |
BoundingRectangle | optional The object onto which to store the result. |
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
static Cesium.BoundingRectangle.fromRectangle(rectangle, projection, result) → BoundingRectangle
Computes a bounding rectangle from a rectangle.
| Name | Type | Default | Description |
|---|---|---|---|
rectangle |
Rectangle | The valid rectangle used to create a bounding rectangle. | |
projection |
object |
GeographicProjection
|
optional The projection used to project the rectangle into 2D. |
result |
BoundingRectangle | optional The object onto which to store the result. |
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
static Cesium.BoundingRectangle.intersect(left, right) → Intersect
Determines if two rectangles intersect.
| Name | Type | Description |
|---|---|---|
left |
BoundingRectangle | A rectangle to check for intersection. |
right |
BoundingRectangle | The other rectangle to check for intersection. |
Returns:
Intersect.INTERSECTING if the rectangles intersect, Intersect.OUTSIDE otherwise.
Stores the provided instance into the provided array.
| Name | Type | Default | Description |
|---|---|---|---|
value |
BoundingRectangle | The value to pack. | |
array |
Array.<number> | The array to pack into. | |
startingIndex |
number |
0
|
optional The index into the array at which to start packing the elements. |
Returns:
The array that was packed into
static Cesium.BoundingRectangle.union(left, right, result) → BoundingRectangle
Computes a bounding rectangle that is the union of the left and right bounding rectangles.
| Name | Type | Description |
|---|---|---|
left |
BoundingRectangle | A rectangle to enclose in bounding rectangle. |
right |
BoundingRectangle | A rectangle to enclose in a bounding rectangle. |
result |
BoundingRectangle | optional The object onto which to store the result. |
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
static Cesium.BoundingRectangle.unpack(array, startingIndex, result) → BoundingRectangle
Retrieves an instance from a packed array.
| Name | Type | Default | Description |
|---|---|---|---|
array |
Array.<number> | The packed array. | |
startingIndex |
number |
0
|
optional The starting index of the element to be unpacked. |
result |
BoundingRectangle | optional The object into which to store the result. |
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
clone(result) → BoundingRectangle
Duplicates this BoundingRectangle instance.
| Name | Type | Description |
|---|---|---|
result |
BoundingRectangle | optional The object onto which to store the result. |
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
Compares this BoundingRectangle against the provided BoundingRectangle componentwise and returns
true if they are equal, false otherwise.
| Name | Type | Description |
|---|---|---|
right |
BoundingRectangle | optional The right hand side BoundingRectangle. |
Returns:
true if they are equal, false otherwise.
intersect(right) → Intersect
Determines if this rectangle intersects with another.
| Name | Type | Description |
|---|---|---|
right |
BoundingRectangle | A rectangle to check for intersection. |
Returns:
Intersect.INTERSECTING if the rectangles intersect, Intersect.OUTSIDE otherwise.