org.cesiumjs.cs.core

Class Ray

java.lang.Object

org.cesiumjs.cs.core.Ray

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Cartesian3	direction The direction of the ray.
Cartesian3	origin The origin of the ray.

Constructor Summary

Constructors

Constructor and Description
Ray() Represents a ray that extends infinitely from the provided origin in the provided direction.
Ray(Cartesian3 origin, Cartesian3 direction) Represents a ray that extends infinitely from the provided origin in the provided direction.

Method Summary

Modifier and Type	Method and Description
static Ray	clone(Ray ray) Duplicates a Ray instance.
static Ray	clone(Ray ray, Ray result) Duplicates a Ray instance.
static Cartesian3	getPoint(Ray ray, double t) Computes the point along the ray given by r(t) = o + t*d, where o is the origin of the ray and d is the direction.
static Cartesian3	getPoint(Ray ray, double t, Cartesian3 result) Computes the point along the ray given by r(t) = o + t*d, where o is the origin of the ray and d is the direction.

Methods inherited from class java.lang.Object

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

Field Detail

direction

@JsProperty
public Cartesian3 direction

The direction of the ray.

origin

public Cartesian3 origin

The origin of the ray. Default: Cartesian3.ZERO()

Constructor Detail

Ray

@JsConstructor
public Ray()

Represents a ray that extends infinitely from the provided origin in the provided direction.

Ray

@JsConstructor
public Ray(Cartesian3 origin,
                          Cartesian3 direction)

Represents a ray that extends infinitely from the provided origin in the provided direction.

Parameters:

origin - The origin of the ray. Default: Cartesian3.ZERO()

direction - The direction of the ray. Default: Cartesian3.ZERO()

Method Detail

clone

@JsMethod
public static Ray clone(Ray ray)

Duplicates a Ray instance.

Parameters:

ray - The ray to duplicate.

Returns:

The modified result parameter or a new Ray instance if one was not provided. (Returns undefined if ray is undefined)

clone

@JsMethod
public static Ray clone(Ray ray,
                                  Ray result)

Duplicates a Ray instance.

Parameters:

ray - The ray to duplicate.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new Ray instance if one was not provided. (Returns undefined if ray is undefined)

getPoint

@JsMethod
public static Cartesian3 getPoint(Ray ray,
                                            double t)

Computes the point along the ray given by r(t) = o + t*d, where o is the origin of the ray and d is the direction.

     Example:
     
     //Get the first intersection point of a ray and an ellipsoid.
     var intersection = Cesium.IntersectionTests.rayEllipsoid(ray, ellipsoid);
     Cartesian3 point = Ray.getPoint(ray, intersection.start);
     
 

Parameters:

ray - The ray.

t - A scalar value.

Returns:

The modified result parameter, or a new instance if none was provided.

getPoint

@JsMethod
public static Cartesian3 getPoint(Ray ray,
                                            double t,
                                            Cartesian3 result)

Computes the point along the ray given by r(t) = o + t*d, where o is the origin of the ray and d is the direction.

     Example:
     
     //Get the first intersection point of a ray and an ellipsoid.
     var intersection = Cesium.IntersectionTests.rayEllipsoid(ray, ellipsoid);
     Cartesian3 point = Ray.getPoint(ray, intersection.start);
     
 

Parameters:

ray - The ray.

t - A scalar value.

result - The object in which the result will be stored.

Returns:

The modified result parameter, or a new instance if none was provided.