main.cesium.Ray.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)
package cesium
/**
* Represents a ray that extends infinitely from the provided origin in the provided direction.
* @see Online Documentation
*
* @constructor
* @property [origin] The origin of the ray.
* Default value - [Cartesian3.ZERO]
* @property [direction] The direction of the ray.
* Default value - [Cartesian3.ZERO]
* @see Online Documentation
*/
@JsName("\$cesium__Ray")
external class Ray(
var origin: Cartesian3 = definedExternally,
var direction: Cartesian3 = definedExternally,
) {
companion object {
/**
* Duplicates a Ray instance.
* @param [ray] The ray to duplicate.
* @param [result] The object onto which to store the result.
* @return The modified result parameter or a new Ray instance if one was not provided. (Returns undefined if ray is undefined)
* @see Online Documentation
*/
fun clone(
ray: Ray,
result: Ray? = definedExternally,
): Ray
/**
* 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.
* ```
* //Get the first intersection point of a ray and an ellipsoid.
* var intersection = IntersectionTests.rayEllipsoid(ray, ellipsoid);
* var point = Ray.getPoint(ray, intersection.start);
* ```
* @param [ray] The ray.
* @param [t] A scalar value.
* @param [result] The object in which the result will be stored.
* @return The modified result parameter, or a new instance if none was provided.
* @see Online Documentation
*/
fun getPoint(
ray: Ray,
t: Double,
result: Cartesian3? = definedExternally,
): Cartesian3
}
}