Plane (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.core.Plane

Direct Known Subclasses:: ClippingPlane

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

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.

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
`Plane(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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Plane`	`clone(Plane plane)` Duplicates a Plane instance.
`static Plane`	`clone(Plane plane, Plane result)` Duplicates a Plane instance.
`static Plane`	`equals(Plane left, Plane right)` Compares the provided Planes by normal and distance and returns true if they are equal, false otherwise.
`static Plane`	`fromCartesian4(Cartesian4 coefficients)` Creates a plane from the general equation
`static Plane`	`fromCartesian4(Cartesian4 coefficients, Plane result)` Creates a plane from the general equation
`static Plane`	`fromPointNormal(Cartesian3 point, Cartesian3 normal)` Creates a plane from a normal and a point on the plane.
`static Plane`	`fromPointNormal(Cartesian3 point, Cartesian3 normal, Plane result)` Creates a plane from a normal and a point on the plane.
`static double`	`getPointDistance(Plane plane, Cartesian3 point)` Computes the signed shortest distance of a point to a plane.
`static Plane`	`ORIGIN_XY_PLANE()` A constant initialized to the XY plane passing through the origin, with normal in positive Z.
`static Plane`	`ORIGIN_YZ_PLANE()` A constant initialized to the YZ plane passing through the origin, with normal in positive X.
`static Plane`	`ORIGIN_ZX_PLANE()` A constant initialized to the ZX plane passing through the origin, with normal in positive Y.
`static Cartesian3`	`projectPointOntoPlane(Plane plane, Cartesian3 point)` Projects a point onto the plane.
`static Cartesian3`	`projectPointOntoPlane(Plane plane, Cartesian3 point, Cartesian3 result)` Projects a point onto the plane.
`static Plane`	`transform(Plane plane, Matrix4 transform)` Transforms the plane by the given transformation matrix.
`static Plane`	`transform(Plane plane, Matrix4 transform, Plane result)` Transforms the plane by the given transformation matrix.

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
  - Plane
```
@JsConstructor
public Plane(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; if zero, the plane passes through the origin.
- Method Detail
  - ORIGIN_XY_PLANE
```
@JsProperty(name="ORIGIN_XY_PLANE")
public static Plane ORIGIN_XY_PLANE()
```
    A constant initialized to the XY plane passing through the origin, with normal in positive Z.
  - ORIGIN_YZ_PLANE
```
@JsProperty(name="ORIGIN_YZ_PLANE")
public static Plane ORIGIN_YZ_PLANE()
```
    A constant initialized to the YZ plane passing through the origin, with normal in positive X.
  - ORIGIN_ZX_PLANE
```
@JsProperty(name="ORIGIN_ZX_PLANE")
public static Plane ORIGIN_ZX_PLANE()
```
    A constant initialized to the ZX plane passing through the origin, with normal in positive Y.
  - clone
```
@JsMethod
public static Plane clone(Plane plane)
```
    Duplicates a Plane instance.
    
    Parameters:
    
    plane - The plane to duplicate.
    
    Returns:
    
    The modified result parameter or a new Plane instance if one was not provided.
  - clone
```
@JsMethod
public static Plane clone(Plane plane,
                                    Plane result)
```
    Duplicates a Plane instance.
    
    Parameters:
    
    plane - The plane to duplicate.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The modified result parameter or a new Plane instance if one was not provided.
  - equals
```
@JsMethod
public static Plane equals(Plane left,
                                     Plane right)
```
    Compares the provided Planes by normal and distance and returns true if they are equal, false otherwise.
    
    Parameters:
    
    left - The first plane.
    
    right - The second plane.
    
    Returns:
    
    true if left and right are equal, false otherwise.
  - fromCartesian4
```
@JsMethod
public static Plane fromCartesian4(Cartesian4 coefficients)
```
    Creates a plane from the general equation
    
    Parameters:
    
    coefficients - The plane's normal (normalized).
    
    Returns:
    
    A new plane instance or the modified result parameter.
  - fromCartesian4
```
@JsMethod
public static Plane fromCartesian4(Cartesian4 coefficients,
                                             Plane result)
```
    Creates a plane from the general equation
    
    Parameters:
    
    coefficients - The plane's normal (normalized).
    
    result - The object onto which to store the result.
    
    Returns:
    
    A new plane instance or the modified result parameter.
  - fromPointNormal
```
@JsMethod
public static Plane fromPointNormal(Cartesian3 point,
                                              Cartesian3 normal)
```
    Creates a plane from a normal and a point on the plane.
```
     Example:
     
     Cartesian3 point = Cartesian3.fromDegrees(-72.0, 40.0);
     Cartesian3 normal = ellipsoid.geodeticSurfaceNormal(point);
     Plane tangentPlane = Plane.fromPointNormal(point, normal);
     
 
```
    Parameters:
    
    point - The point on the plane.
    
    normal - The plane's normal (normalized).
    
    Returns:
    
    A new plane instance or the modified result parameter.
  - fromPointNormal
```
@JsMethod
public static Plane fromPointNormal(Cartesian3 point,
                                              Cartesian3 normal,
                                              Plane result)
```
    Creates a plane from a normal and a point on the plane.
```
     Example:
     
     Cartesian3 point = Cartesian3.fromDegrees(-72.0, 40.0);
     Cartesian3 normal = ellipsoid.geodeticSurfaceNormal(point);
     Plane tangentPlane = Plane.fromPointNormal(point, normal);
     
 
```
    Parameters:
    
    point - The point on the plane.
    
    normal - The plane's normal (normalized).
    
    result - The object onto which to store the result.
    
    Returns:
    
    A new plane instance or the modified result parameter.
  - getPointDistance
```
@JsMethod
public static double getPointDistance(Plane plane,
                                                Cartesian3 point)
```
    Computes the signed shortest distance of a point to a plane. The sign of the distance determines which side of the plane the point is on. If the distance is positive, the point is in the half-space in the direction of the normal; if negative, the point is in the half-space opposite to the normal; if zero, the plane passes through the point.
    
    Parameters:
    
    plane - The plane.
    
    point - The point.
    
    Returns:
    
    The signed shortest distance of the point to the plane.
  - projectPointOntoPlane
```
@JsMethod
public static Cartesian3 projectPointOntoPlane(Plane plane,
                                                         Cartesian3 point)
```
    Projects a point onto the plane.
    
    Parameters:
    
    plane - The plane to project the point onto
    
    point - The point to project onto the plane
    
    Returns:
    
    The result point.
  - projectPointOntoPlane
```
@JsMethod
public static Cartesian3 projectPointOntoPlane(Plane plane,
                                                         Cartesian3 point,
                                                         Cartesian3 result)
```
    Projects a point onto the plane.
    
    Parameters:
    
    plane - The plane to project the point onto
    
    point - The point to project onto the plane
    
    result - The result point. If undefined, a new Cartesian3 will be created.
    
    Returns:
    
    The result point.
  - transform
```
@JsMethod
public static Plane transform(Plane plane,
                                        Matrix4 transform)
```
    Transforms the plane by the given transformation matrix.
    
    Parameters:
    
    plane - The plane.
    
    transform - The transformation matrix.
    
    Returns:
    
    The plane transformed by the given transformation matrix.
  - transform
```
@JsMethod
public static Plane transform(Plane plane,
                                        Matrix4 transform,
                                        Plane result)
```
    Transforms the plane by the given transformation matrix.
    
    Parameters:
    
    plane - The plane.
    
    transform - The transformation matrix.
    
    result - The object into which to store the result.
    
    Returns:
    
    The plane transformed by the given transformation matrix.

Class Plane

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

distance

normal

Constructor Detail

Plane

Method Detail

ORIGIN_XY_PLANE

ORIGIN_YZ_PLANE

ORIGIN_ZX_PLANE

clone

clone

equals

fromCartesian4

fromCartesian4

fromPointNormal

fromPointNormal

getPointDistance

projectPointOntoPlane

projectPointOntoPlane

transform

transform