PerspectiveOffCenterFrustum

new PerspectiveOffCenterFrustum()

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 frustum = new Cesium.PerspectiveOffCenterFrustum();
frustum.right = 1.0;
frustum.left = -1.0;
frustum.top = 1.0;
frustum.bottom = -1.0;
frustum.near = 1.0;
frustum.far = 2.0;
See:
Source: Scene/PerspectiveOffCenterFrustum.js, line 46

Members

bottom :Number

Defines the bottom clipping plane.
Default Value: undefined
Source: Scene/PerspectiveOffCenterFrustum.js, line 76

far :Number

The distance of the far plane.
Default Value: 500000000.0
Source: Scene/PerspectiveOffCenterFrustum.js, line 92

readonlyinfiniteProjectionMatrix :Matrix4

Gets the perspective projection matrix computed from the view frustum with an infinite far plane.
See:
Source: Scene/PerspectiveOffCenterFrustum.js, line 161

left :Number

Defines the left clipping plane.
Default Value: undefined
Source: Scene/PerspectiveOffCenterFrustum.js, line 52

near :Number

The distance of the near plane.
Default Value: 1.0
Source: Scene/PerspectiveOffCenterFrustum.js, line 84

readonlyprojectionMatrix :Matrix4

Gets the perspective projection matrix computed from the view frustum.
See:
Source: Scene/PerspectiveOffCenterFrustum.js, line 146
Defines the right clipping plane.
Default Value: undefined
Source: Scene/PerspectiveOffCenterFrustum.js, line 60

top :Number

Defines the top clipping plane.
Default Value: undefined
Source: Scene/PerspectiveOffCenterFrustum.js, line 68

Methods

clone(result) → PerspectiveOffCenterFrustum

Returns a duplicate of a PerspectiveOffCenterFrustum instance.
Name Type Description
result PerspectiveOffCenterFrustum optional The object onto which to store the result.
Returns:
The modified result parameter or a new PerspectiveFrustum instance if one was not provided.
Source: Scene/PerspectiveOffCenterFrustum.js, line 447

computeCullingVolume(position, direction, up) → CullingVolume

Creates a culling volume for this frustum.
Name Type Description
position Cartesian3 The eye position.
direction Cartesian3 The view direction.
up Cartesian3 The up direction.
Returns:
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.computeVisibility(boundingVolume);
Source: Scene/PerspectiveOffCenterFrustum.js, line 186

equals(other) → Boolean

Compares the provided PerspectiveOffCenterFrustum componentwise and returns true if they are equal, false otherwise.
Name Type Description
other PerspectiveOffCenterFrustum optional The right hand side PerspectiveOffCenterFrustum.
Returns:
true if they are equal, false otherwise.
Source: Scene/PerspectiveOffCenterFrustum.js, line 477

getPixelDimensions(drawingBufferWidth, drawingBufferHeight, distance, result) → Cartesian2

Returns the pixel's width and height in meters.
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.
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.
Throws:
Examples:
// Example 1
// Get the width and height of a pixel.
var pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 1.0, new Cartesian2());
// Example 2
// Get the width and height of a pixel if the near plane was set to 'distance'.
// For example, get the size of a pixel of an image on a billboard.
var position = camera.position;
var direction = camera.direction;
var toCenter = Cesium.Cartesian3.subtract(primitive.boundingVolume.center, position, new Cesium.Cartesian3());      // vector from camera to a primitive
var toCenterProj = Cesium.Cartesian3.multiplyByScalar(direction, Cesium.Cartesian3.dot(direction, toCenter), new Cesium.Cartesian3()); // project vector onto camera direction vector
var distance = Cesium.Cartesian3.magnitude(toCenterProj);
var pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, distance, new Cartesian2());
Source: Scene/PerspectiveOffCenterFrustum.js, line 409

getPixelSize(drawingBufferDimensions, distance, result) → Cartesian2

Returns the pixel's width and height in meters.
Name Type Default Description
drawingBufferDimensions Cartesian2 A Cartesian2 with width and height in the x and y properties, respectively.
distance Number near plane distance optional The distance to the near plane in meters.
result Cartesian2 optional The object onto which to store the result.
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.
Throws:
  • DeveloperError : drawingBufferDimensions.x must be greater than zero.
  • DeveloperError : drawingBufferDimensions.y must be greater than zero.
Deprecated: true
Examples:
// Example 1
// Get the width and height of a pixel.
var pixelSize = camera.frustum.getPixelSize(new Cesium.Cartesian2(scene.drawingBufferWidth, scene.drawingBufferHeight));
// Example 2
// Get the width and height of a pixel if the near plane was set to 'distance'.
// For example, get the size of a pixel of an image on a billboard.
var position = camera.position;
var direction = camera.direction;
var toCenter = Cesium.Cartesian3.subtract(primitive.boundingVolume.center, position, new Cesium.Cartesian3());      // vector from camera to a primitive
var toCenterProj = Cesium.Cartesian3.multiplyByScalar(direction, Cesium.Cartesian3.dot(direction, toCenter), new Cesium.Cartesian3()); // project vector onto camera direction vector
var distance = Cesium.Cartesian3.magnitude(toCenterProj);
var pixelSize = camera.frustum.getPixelSize(new Cesium.Cartesian2(scene.drawingBufferWidth, scene.drawingBufferHeight), distance);
Source: Scene/PerspectiveOffCenterFrustum.js, line 340