org.cesiumjs.cs.core

Class PerspectiveOffCenterFrustum

java.lang.Object

org.cesiumjs.cs.core.Frustum

org.cesiumjs.cs.core.PerspectiveOffCenterFrustum

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	bottom Defines the bottom clipping plane.
double	left Defines the left clipping plane.
double	right Defines the right clipping plane.
double	top Defines the top clipping plane.

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

far, near

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PerspectiveOffCenterFrustum	clone() Returns a duplicate of a PerspectiveOffCenterFrustum instance.
PerspectiveOffCenterFrustum	clone(PerspectiveOffCenterFrustum result) Returns a duplicate of a PerspectiveOffCenterFrustum instance.
CullingVolume	computeCullingVolume(Cartesian3 position, Cartesian3 direction, Cartesian3 up) Creates a culling volume for this frustum.
boolean	equals(PerspectiveOffCenterFrustum other) Compares the provided PerspectiveOffCenterFrustum componentwise and returns true if they are equal, false otherwise.
boolean	equalsEpsilon(PerspectiveOffCenterFrustum other, double relativeEpsilon) Compares the provided PerspectiveOffCenterFrustum componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
boolean	equalsEpsilon(PerspectiveOffCenterFrustum other, double relativeEpsilon, double absoluteEpsilon) Compares the provided PerspectiveOffCenterFrustum componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
Cartesian2	getPixelDimensions(double drawingBufferWidth, double drawingBufferHeight, double distance, Cartesian2 result) Returns the pixel's width and height in meters.
Matrix4	infiniteProjectionMatrix() Gets 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

bottom

@JsProperty
public double bottom

Defines the bottom clipping plane. Default: undefined

left

@JsProperty
public double left

Defines the left clipping plane. Default: undefined

right

@JsProperty
public double right

Defines the right clipping plane. Default: undefined

top

@JsProperty
public double top

Defines the top clipping plane. Default: undefined

Constructor Detail

PerspectiveOffCenterFrustum

@JsConstructor
public 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.

See Also:

PerspectiveFrustum

Method Detail

infiniteProjectionMatrix

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

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

See Also:

Frustum.projectionMatrix()

clone

@JsMethod
public PerspectiveOffCenterFrustum clone()

Returns a duplicate of a PerspectiveOffCenterFrustum instance.

Overrides:

clone in class Object

Returns:

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

clone

@JsMethod
public PerspectiveOffCenterFrustum clone(PerspectiveOffCenterFrustum result)

Returns a duplicate of a PerspectiveOffCenterFrustum 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.

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(PerspectiveOffCenterFrustum other)

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

Parameters:

other - The right hand side PerspectiveOffCenterFrustum.

Returns:

true if they are equal, false otherwise.

equalsEpsilon

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

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

Parameters:

other - The right hand side PerspectiveOffCenterFrustum.

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(PerspectiveOffCenterFrustum other,
                                       double relativeEpsilon,
                                       double absoluteEpsilon)

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

Parameters:

other - The right hand side PerspectiveOffCenterFrustum.

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.