PerspectiveOffCenterFrustum

var frustum = new 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;

Members

bottom :Number

Defines the bottom clipping plane.

Default Value:

• undefined

far :Number

The distance of the far plane.

Default Value:

• 500000000.0

left :Number

Defines the left clipping plane.

Default Value:

• undefined

near :Number

The distance of the near plane.

Default Value:

• 1.0

right :Number

Defines the right clipping plane.

Default Value:

• undefined

top :Number

Defines the top clipping plane.

Default Value:

• undefined

Methods

clone

Returns a duplicate of a PerspectiveOffCenterFrustum instance.

Returns:

PerspectiveOffCenterFrustum A new copy of the PerspectiveOffCenterFrustum instance.

computeCullingVolume

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:

• DeveloperError : position is required.
• DeveloperError : direction is required.
• DeveloperError : up is required.

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);

equals

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

Parameters:

Name	Type	Argument	Description
other	PerspectiveOffCenterFrustum	<optional>	The right hand side PerspectiveOffCenterFrustum.

Returns:

Boolean true if they are equal, false otherwise.

getInfiniteProjectionMatrix

Returns the perspective projection matrix computed from the view frustum with an infinite far plane.

Returns:

Matrix4 The infinite perspective projection matrix.

See:

• PerspectiveOffCenterFrustum#getProjectionMatrix

getPixelSize

Returns the pixel's width and height in meters.

Parameters:

Name	Type	Argument	Default	Description
canvasDimensions	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.

Throws:

• DeveloperError : canvasDimensions is required.
• DeveloperError : canvasDimensions.x must be greater than zero.
• DeveloperError : canvasDimensione.y must be greater than zero.

Returns:

Cartesian2 A 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));

// 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 = primitive.boundingVolume.center.subtract(position);      // vector from camera to a primitive
var toCenterProj = direction.multiplyByScalar(direction.dot(toCenter)); // project vector onto camera direction vector
var distance = toCenterProj.magnitude();
var pixelSize = camera.frustum.getPixelSize(new Cartesian2(canvas.clientWidth, canvas.clientHeight), distance);

getProjectionMatrix

Returns the perspective projection matrix computed from the view frustum.

Returns:

Matrix4 The perspective projection matrix.

See:

• PerspectiveOffCenterFrustum#getInfiniteProjectionMatrix