org.cesiumjs.cs.core

Class OrthographicFrustum

java.lang.Object

org.cesiumjs.cs.core.Frustum

org.cesiumjs.cs.core.OrthographicFrustum

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

Author:

Serge Silaev aka iSergio

Field Summary

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

far, near

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OrthographicFrustum	clone() OrthographicFrustum
OrthographicFrustum	clone(OrthographicFrustum result) OrthographicFrustum
CullingVolume	computeCullingVolume(Cartesian3 position, Cartesian3 direction, Cartesian3 up) Creates a culling volume for this frustum.
boolean	equals(OrthographicFrustum other) Compares the provided OrthographicFrustum componentwise and returns true if they are equal, false otherwise.
boolean	equalsEpsilon(OrthographicFrustum other, double relativeEpsilon) Compares the provided OrthographicFrustum componentwise and returns true if they pass an absolute or relative tolerance test, false otherwise.
boolean	equalsEpsilon(OrthographicFrustum other, double relativeEpsilon, double absoluteEpsilon) Compares the provided OrthographicFrustum 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.

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

Constructor Detail

OrthographicFrustum

@JsConstructor
public OrthographicFrustum()

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.

Method Detail

clone

@JsMethod
public OrthographicFrustum clone()

OrthographicFrustum

Overrides:

clone in class Object

Returns:

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

clone

@JsMethod
public OrthographicFrustum clone(OrthographicFrustum result)

OrthographicFrustum

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

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

Parameters:

other - The right hand side OrthographicFrustum.

Returns:

true if they are equal, false otherwise.

equalsEpsilon

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

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

Parameters:

other - The right hand side OrthographicFrustum.

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

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

Parameters:

other - The right hand side OrthographicFrustum.

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.