new OrthographicFrustum()
The viewing frustum is defined by 6 planes.
Each plane is represented by a
Cartesian4
object, where the x, y, and z components
define the unit vector normal to the plane, and the w component is the distance of the
plane from the origin/camera position.
- Source:
Example
var maxRadii = ellipsoid.maximumRadius;
var frustum = new Cesium.OrthographicFrustum();
frustum.right = maxRadii * Cesium.Math.PI;
frustum.left = -c.frustum.right;
frustum.top = c.frustum.right * (canvas.clientHeight / canvas.clientWidth);
frustum.bottom = -c.frustum.top;
frustum.near = 0.01 * maxRadii;
frustum.far = 50.0 * maxRadii;
Members
bottom :Number
The bottom clipping plane.
Type:
- Number
- Default Value:
- undefined
- Source:
far :Number
The distance of the far plane.
Type:
- Number
- Default Value:
- 500000000.0;
- Source:
left :Number
The left clipping plane.
Type:
- Number
- Default Value:
- undefined
- Source:
near :Number
The distance of the near plane.
Type:
- Number
- Default Value:
- 1.0
- Source:
(readonly) projectionMatrix :Matrix4
Gets the orthographic projection matrix computed from the view frustum.
Type:
- Source:
right :Number
The right clipping plane.
Type:
- Number
- Default Value:
- undefined
- Source:
top :Number
The top clipping plane.
Type:
- Number
- Default Value:
- undefined
- Source:
Methods
clone(resultopt) → {OrthographicFrustum}
Returns a duplicate of a OrthographicFrustum instance.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
result |
OrthographicFrustum |
<optional> |
The object onto which to store the result. |
- Source:
Returns:
The modified result parameter or a new PerspectiveFrustum instance if one was not provided.
- Type
- OrthographicFrustum
computeCullingVolume(position, direction, up) → {CullingVolume}
Creates a culling volume for this frustum.
Parameters:
Name | Type | Description |
---|---|---|
position |
Cartesian3 | The eye position. |
direction |
Cartesian3 | The view direction. |
up |
Cartesian3 | The up direction. |
- Source:
Returns:
A culling volume at the given position and orientation.
- Type
- CullingVolume
Example
// Check if a bounding volume intersects the frustum.
var cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
var intersect = cullingVolume.computeVisibility(boundingVolume);
equals(otheropt) → {Boolean}
Compares the provided OrthographicFrustum componentwise and returns
true
if they are equal, false
otherwise.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
other |
OrthographicFrustum |
<optional> |
The right hand side OrthographicFrustum. |
- Source:
Returns:
true
if they are equal, false
otherwise.
- Type
- Boolean
getPixelDimensions(drawingBufferWidth, drawingBufferHeight, distance, result) → {Cartesian2}
Returns the pixel's width and height in meters.
Parameters:
Name | Type | Description |
---|---|---|
drawingBufferWidth |
Number | The width of the drawing buffer. |
drawingBufferHeight |
Number | The height of the drawing buffer. |
distance |
Number | The distance to the near plane in meters. |
result |
Cartesian2 | The object onto which to store the result. |
- Source:
Throws:
-
-
drawingBufferWidth must be greater than zero.
- Type
- DeveloperError
-
-
-
drawingBufferHeight must be greater than zero.
- Type
- DeveloperError
-
Returns:
The modified result parameter or a new instance of
Cartesian2
with the pixel's width and height in the x and y properties, respectively.
- Type
- Cartesian2
Example
// Example 1
// Get the width and height of a pixel.
var pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 0.0, new Cesium.Cartesian2());