top
all js glsl

OrthographicFrustum

OrthographicFrustum

new

The culling volume defined by planes.

Parameters:
Name Type Description
Array planes An array of clipping planes.
Source:

Members

:Number

The bottom clipping plane.
Default Value:
  • undefined

:Number

The distance of the far plane.
Default Value:
  • 500000000.0;

:Number

The left clipping plane.
Default Value:
  • undefined

:Number

The distance of the near plane.
Default Value:
  • 1.0

:Array

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.
Default Value:
  • []
The right clipping plane.
Default Value:
  • undefined

:Number

The top clipping plane.
Default Value:
  • undefined

<static> :Matrix4

The orthographic projection matrix computed from the view frustum.

Methods

Returns a duplicate of a OrthographicFrustum instance.

Parameters:
Name Type Argument Description
result OrthographicFrustum <optional>
 The object onto which to store the result.
Returns:
OrthographicFrustum The modified result parameter or a new PerspectiveFrustum instance if one was not provided.

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.
Throws:
Returns:
CullingVolume A culling volume at the given position and orientation.
Example
// Check if a bounding volume intersects the frustum.
var cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
var intersect = cullingVolume.getVisibility(boundingVolume);

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

Parameters:
Name Type Argument Description
other OrthographicFrustum <optional>
 The right hand side OrthographicFrustum.
Returns:
Boolean true if they are equal, false otherwise.

Returns the pixel's width and height in meters.

Parameters:
Name Type Argument Default Description
drawingBufferDimensions Cartesian2 A Cartesian2 with width and height in the x and y properties, respectively.
distance Number <optional>
 near plane distance The distance to the near plane in meters.
result Cartesian2 <optional>
 The object onto which to store the result.
Throws:
Returns:
Cartesian2 The modified result parameter or a new instance of Cartesian2 with the pixel's width and height in the x and y properties, respectively.
Example
// Example 1
// Get the width and height of a pixel.
var pixelSize = camera.frustum.getPixelSize(new Cartesian2(canvas.clientWidth, canvas.clientHeight));

OrthographicFrustum

new

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.

Example
var maxRadii = ellipsoid.getMaximumRadius();

var frustum = new OrthographicFrustum();
frustum.right = maxRadii * CesiumMath.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;
Source:

Members

:Number

The bottom clipping plane.
Default Value:
  • undefined

:Number

The distance of the far plane.
Default Value:
  • 500000000.0;

:Number

The left clipping plane.
Default Value:
  • undefined

:Number

The distance of the near plane.
Default Value:
  • 1.0

:Array

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.
Default Value:
  • []
The right clipping plane.
Default Value:
  • undefined

:Number

The top clipping plane.
Default Value:
  • undefined

<static> :Matrix4

The orthographic projection matrix computed from the view frustum.

Methods

Returns a duplicate of a OrthographicFrustum instance.

Parameters:
Name Type Argument Description
result OrthographicFrustum <optional>
 The object onto which to store the result.
Returns:
OrthographicFrustum The modified result parameter or a new PerspectiveFrustum instance if one was not provided.

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.
Throws:
Returns:
CullingVolume A culling volume at the given position and orientation.
Example
// Check if a bounding volume intersects the frustum.
var cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
var intersect = cullingVolume.getVisibility(boundingVolume);

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

Parameters:
Name Type Argument Description
other OrthographicFrustum <optional>
 The right hand side OrthographicFrustum.
Returns:
Boolean true if they are equal, false otherwise.

Returns the pixel's width and height in meters.

Parameters:
Name Type Argument Default Description
drawingBufferDimensions Cartesian2 A Cartesian2 with width and height in the x and y properties, respectively.
distance Number <optional>
 near plane distance The distance to the near plane in meters.
result Cartesian2 <optional>
 The object onto which to store the result.
Throws:
Returns:
Cartesian2 The modified result parameter or a new instance of Cartesian2 with the pixel's width and height in the x and y properties, respectively.
Example
// Example 1
// Get the width and height of a pixel.
var pixelSize = camera.frustum.getPixelSize(new Cartesian2(canvas.clientWidth, canvas.clientHeight));