org.cesiumjs.cs.core

Class PerspectiveFrustum

java.lang.Object

org.cesiumjs.cs.core.Frustum

org.cesiumjs.cs.core.PerspectiveFrustum

@JsType(isNative=true,
        namespace="Cesium",
        name="PerspectiveFrustum")
public class PerspectiveFrustum
extends Frustum

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	aspectRatio The aspect ratio of the frustum's width to it's height.
double	fov The angle of the field of view (FOV), in radians.
double	xOffset Offsets the frustum in the x direction.
double	yOffset Offsets the frustum in the y direction.

Fields inherited from class org.cesiumjs.cs.core.Frustum

far, near

Constructor Summary

Constructors

Constructor and Description
PerspectiveFrustum() The viewing frustum is defined by 6 planes.

Method Summary

Modifier and Type	Method and Description
PerspectiveFrustum	clone() Returns a duplicate of a PerspectiveFrustum instance.
PerspectiveFrustum	clone(PerspectiveFrustum result) Returns a duplicate of a PerspectiveFrustum instance.
CullingVolume	computeCullingVolume(Cartesian3 position, Cartesian3 direction, Cartesian3 up) Creates a culling volume for this frustum.
boolean	equals(PerspectiveFrustum other) Compares the provided PerspectiveFrustum componentwise and returns true if they are equal, false otherwise.
boolean	equalsEpsilon(PerspectiveFrustum other, double relativeEpsilon) Compares the provided PerspectiveFrustum componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
boolean	equalsEpsilon(PerspectiveFrustum other, double relativeEpsilon, double absoluteEpsilon) Compares the provided PerspectiveFrustum componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
double	fovy() Gets the angle of the vertical field of view, in radians.
Cartesian2	getPixelDimensions(double drawingBufferWidth, double drawingBufferHeight, double distance, Cartesian2 result) Returns the pixel's width and height in meters.
Matrix4	infiniteProjectionMatrix() The perspective projection matrix computed from the view frustum with an infinite far plane.

Methods inherited from class org.cesiumjs.cs.core.Frustum

projectionMatrix

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

aspectRatio

@JsProperty
public double aspectRatio

The aspect ratio of the frustum's width to it's height. Default: undefined

fov

@JsProperty
public double fov

The angle of the field of view (FOV), in radians. This angle will be used as the horizontal FOV if the width is greater than the height, otherwise it will be the vertical FOV. Default: undefined

xOffset

@JsProperty
public double xOffset

Offsets the frustum in the x direction. Default: 0.0

yOffset

@JsProperty
public double yOffset

Offsets the frustum in the y direction. Default: 0.0

Constructor Detail

PerspectiveFrustum

@JsConstructor
public PerspectiveFrustum()

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:
     
     PerspectiveFrustum frustum = new PerspectiveFrustum();
     frustum.aspectRatio = canvas.clientWidth / canvas.clientHeight;
     frustum.fov = Math.PI_OVER_THREE;
     frustum.near = 1.0;
     frustum.far = 2.0;
     
 

See Also:

PerspectiveOffCenterFrustum

Method Detail

fovy

@JsProperty(name="fovy")
public double fovy()

Gets the angle of the vertical field of view, in radians. Default: undefined

infiniteProjectionMatrix

@JsProperty(name="infiniteProjectionMatrix")
public Matrix4 infiniteProjectionMatrix()

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

See Also:

Frustum.projectionMatrix()

clone

@JsMethod
public PerspectiveFrustum clone()

Returns a duplicate of a PerspectiveFrustum instance.

Overrides:

clone in class Object

Returns:

The modified result parameter or a new PerspectiveFrustum instance if one was not provided.

clone

@JsMethod
public PerspectiveFrustum clone(PerspectiveFrustum result)

Returns a duplicate of a PerspectiveFrustum instance.

Parameters:

result - The object onto which to store the result.

Returns:

The modified result parameter or a new PerspectiveFrustum instance if one was not provided.

computeCullingVolume

@JsMethod
public CullingVolume computeCullingVolume(Cartesian3 position,
                                                    Cartesian3 direction,
                                                    Cartesian3 up)

Creates a culling volume for this frustum.

     Example:
     
     // Check if a bounding volume intersects the frustum.
     CullingVolume cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
     Cartesian3 intersect = cullingVolume.computeVisibility(boundingVolume);
     
 

Parameters:

position - The eye position.

direction - The view direction.

up - The up direction.

Returns:

A culling volume at the given position and orientation.

equals

@JsMethod
public boolean equals(PerspectiveFrustum other)

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

Parameters:

other - The right hand side PerspectiveFrustum.

Returns:

true if they are equal, false otherwise.

equalsEpsilon

@JsMethod
public boolean equalsEpsilon(PerspectiveFrustum other,
                                       double relativeEpsilon)

Compares the provided PerspectiveFrustum componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

Parameters:

other - The right hand side PerspectiveFrustum.

relativeEpsilon - The relative epsilon tolerance to use for equality testing.

Returns:

true if this and other are within the provided epsilon, false otherwise.

equalsEpsilon

@JsMethod
public boolean equalsEpsilon(PerspectiveFrustum other,
                                       double relativeEpsilon,
                                       double absoluteEpsilon)

Compares the provided PerspectiveFrustum componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.

Parameters:

other - The right hand side PerspectiveFrustum.

relativeEpsilon - The relative epsilon tolerance to use for equality testing.

absoluteEpsilon - The absolute epsilon tolerance to use for equality testing.

Returns:

true if this and other are within the provided epsilon, false otherwise.

getPixelDimensions

@JsMethod
public Cartesian2 getPixelDimensions(double drawingBufferWidth,
                                               double drawingBufferHeight,
                                               double distance,
                                               Cartesian2 result)

Returns the pixel's width and height in meters.

Parameters:

drawingBufferWidth - The width of the drawing buffer.

drawingBufferHeight - The height of the drawing buffer.

distance - The distance to the near plane in meters.

result - 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.