org.cesiumjs.cs.scene

Class ClippingPlane

java.lang.Object

org.cesiumjs.cs.core.Plane

org.cesiumjs.cs.scene.ClippingPlane

@JsType(isNative=true,
        namespace="Cesium",
        name="ClippingPlane")
public class ClippingPlane
extends Plane

A Plane in Hessian Normal form to be used with ClippingPlaneCollection. Compatible with mathematics functions in Plane

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	distance The shortest distance from the origin to the plane.
Cartesian3	normal The plane's normal.

Constructor Summary

Constructors

Constructor and Description
ClippingPlane(Cartesian3 normal, double distance) A plane in Hessian Normal Form defined by ax + by + cz + d = 0 where (a, b, c) is the plane's normal, d is the signed distance to the plane, and (x, y, z) is any point on the plane.

Method Summary

Modifier and Type	Method and Description
static ClippingPlane	clone(ClippingPlane clippingPlane) Clones the ClippingPlane without setting its ownership.
static ClippingPlane	clone(ClippingPlane clippingPlane, ClippingPlane result) Clones the ClippingPlane without setting its ownership.
static ClippingPlane	fromPlane(Plane plane) Create a ClippingPlane from a Plane object.
static ClippingPlane	fromPlane(Plane plane, ClippingPlane result) Create a ClippingPlane from a Plane object.

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

clone, clone, equals, fromCartesian4, fromCartesian4, fromPointNormal, fromPointNormal, getPointDistance, ORIGIN_XY_PLANE, ORIGIN_YZ_PLANE, ORIGIN_ZX_PLANE, projectPointOntoPlane, projectPointOntoPlane, transform, transform

Methods inherited from class java.lang.Object

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

Field Detail

distance

@JsProperty
public double distance

The shortest distance from the origin to the plane. The sign of distance determines which side of the plane the origin is on. If distance is positive, the origin is in the half-space in the direction of the normal; if negative, the origin is in the half-space opposite to the normal; if zero, the plane passes through the origin.

normal

@JsProperty
public Cartesian3 normal

The plane's normal.

Constructor Detail

ClippingPlane

public ClippingPlane(Cartesian3 normal,
                     double distance)

A plane in Hessian Normal Form defined by

ax + by + cz + d = 0

where (a, b, c) is the plane's normal, d is the signed distance to the plane, and (x, y, z) is any point on the plane.

Parameters:

normal - The plane's normal (normalized).

distance - The shortest distance from the origin to the plane. The sign of distance determines which side of the plane the origin is on. If distance is positive, the origin is in the half-space in the direction of the normal; if negative, the origin is in the half-space opposite to the normal;

Method Detail

clone

@JsMethod
public static ClippingPlane clone(ClippingPlane clippingPlane)

Clones the ClippingPlane without setting its ownership.

Parameters:

clippingPlane - The ClippingPlane to be cloned

Returns:

a clone of the input ClippingPlane

clone

@JsMethod
public static ClippingPlane clone(ClippingPlane clippingPlane,
                                            ClippingPlane result)

Clones the ClippingPlane without setting its ownership.

Parameters:

clippingPlane - The ClippingPlane to be cloned

result - The object on which to store the cloned parameters.

Returns:

a clone of the input ClippingPlane

fromPlane

@JsMethod
public static ClippingPlane fromPlane(Plane plane)

Create a ClippingPlane from a Plane object.

Parameters:

plane - The plane containing parameters to copy

Returns:

The ClippingPlane generated from the plane's parameters.

fromPlane

@JsMethod
public static ClippingPlane fromPlane(Plane plane,
                                                ClippingPlane result)

Create a ClippingPlane from a Plane object.

Parameters:

plane - The plane containing parameters to copy

result - The object on which to store the result

Returns:

The ClippingPlane generated from the plane's parameters.