org.cesiumjs.cs.core

Class OrthographicOffCenterFrustum

java.lang.Object

org.cesiumjs.cs.core.Frustum

org.cesiumjs.cs.core.OrthographicOffCenterFrustum

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

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.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

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

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

far, near

Constructor Summary

Constructors

Constructor and Description
OrthographicOffCenterFrustum()

Method Summary

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

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

The bottom clipping plane. Default Value: undefined

left

@JsProperty
public double left

The left clipping plane. Default Value: undefined

right

@JsProperty
public double right

The right clipping plane. Default Value: undefined

top

@JsProperty
public double top

The top clipping plane. Default Value: undefined

Constructor Detail

OrthographicOffCenterFrustum

@JsConstructor
public OrthographicOffCenterFrustum()

Method Detail

clone

@JsMethod
public OrthographicOffCenterFrustum clone()

Returns a duplicate of a OrthographicOffCenterFrustum instance.

Overrides:

clone in class Object

Returns:

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

clone

@JsMethod
public OrthographicOffCenterFrustum clone(OrthographicOffCenterFrustum result)

Returns a duplicate of a OrthographicOffCenterFrustum instance.

Parameters:

result - The object onto which to store the result.

Returns:

The modified result parameter or a new OrthographicOffCenterFrustum 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(OrthographicOffCenterFrustum other)

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

Parameters:

other - The right hand side OrthographicOffCenterFrustum.

Returns:

true if they are equal, false otherwise.

equalsEpsilon

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

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

Parameters:

other - The right hand side OrthographicOffCenterFrustum.

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

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

Parameters:

other - The right hand side OrthographicOffCenterFrustum.

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)

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.

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.

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.