Rayd (sim-math 1.6.0 API)

java.lang.Object
- com.simsilica.mathd.Rayd

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Rayd
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
A mathematical "ray" consisting of an origin point and a direction.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Rayd()` Provided only for certain types of serialization that require no-arg constructors.
	`Rayd(com.jme3.math.Ray ray)` Creates a double-precision ray with the same double versions of origin and direction from the supplied single precision Ray.
	`Rayd(Vec3d origin, Vec3d direction)` Creates a double-precision ray with the specified origin and direction.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rayd`	`clone()` Creates a deep clone of this Ray that has its own origin and direction.
`double`	`distanceSq(Vec3d point, double limit)` Returns the squared-distance from the specified point to this ray, where the ray length is limited to the specified limit.
`boolean`	`equals(java.lang.Object o)`
`Vec3d`	`getClosestPoint(Vec3d point, double limit, Vec3d target)` Returns the point on this ray that is closest to the specified point, clamped to the origin and the specified limit value.
`Vec3d`	`getDirection()`
`Vec3d`	`getOrigin()`
`int`	`hashCode()`
`double`	`intersectSphere(double limit, Vec3d center, double radius, boolean outsideOnly)` Returns the distance along this ray of the nearest intersection to the specified sphere or -1 if the ray and sphere do not intersect.
`boolean`	`isSimilar(Rayd other, double epsilon)` Returns true if this Quatd is similar to the specified Quatd within some value of epsilon.
`Vec3d`	`project(double distance, Vec3d target)` Returns the point along the ray at the specified distance.
`Rayd`	`set(com.jme3.math.Ray r)`
`Rayd`	`set(Rayd r)`
`Rayd`	`set(Vec3d origin, Vec3d direction)`
`void`	`setDirection(Vec3d direction)`
`void`	`setOrigin(Vec3d origin)`
`com.jme3.math.Ray`	`toRay()` Returns a single-precision version of this ray.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Rayd
```
protected Rayd()
```
    Provided only for certain types of serialization that require no-arg constructors.
  - Rayd
```
public Rayd(Vec3d origin,
            Vec3d direction)
```
    Creates a double-precision ray with the specified origin and direction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if origin or direction are null or direction is non-unit in length.
  - Rayd
```
public Rayd(com.jme3.math.Ray ray)
```
    Creates a double-precision ray with the same double versions of origin and direction from the supplied single precision Ray.
- Method Detail
  - setOrigin
```
public final void setOrigin(Vec3d origin)
```
  - getOrigin
```
public final Vec3d getOrigin()
```
  - setDirection
```
public final void setDirection(Vec3d direction)
```
  - getDirection
```
public final Vec3d getDirection()
```
  - set
```
public final Rayd set(Vec3d origin,
                      Vec3d direction)
```
  - set
```
public final Rayd set(Rayd r)
```
  - set
```
public final Rayd set(com.jme3.math.Ray r)
```
  - clone
```
public final Rayd clone()
```
    Creates a deep clone of this Ray that has its own origin and direction.
    
    Overrides:
    
    clone in class java.lang.Object
  - toRay
```
public com.jme3.math.Ray toRay()
```
    Returns a single-precision version of this ray.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - isSimilar
```
public boolean isSimilar(Rayd other,
                         double epsilon)
```
    Returns true if this Quatd is similar to the specified Quatd within some value of epsilon.
  - project
```
public Vec3d project(double distance,
                     Vec3d target)
```
    Returns the point along the ray at the specified distance. No checking is done to ensure that distance is positive so negative values will return values 'behind' the origin.
  - getClosestPoint
```
public Vec3d getClosestPoint(Vec3d point,
                             double limit,
                             Vec3d target)
```
    Returns the point on this ray that is closest to the specified point, clamped to the origin and the specified limit value. If limit is less than or equal to zero then it is ignored as if it were infinity. Stores the result in target, creating it if null.
  - distanceSq
```
public double distanceSq(Vec3d point,
                         double limit)
```
    Returns the squared-distance from the specified point to this ray, where the ray length is limited to the specified limit. If limit is less than or equal to zero then it is ignored as if it were infinity.
  - intersectSphere
```
public double intersectSphere(double limit,
                              Vec3d center,
                              double radius,
                              boolean outsideOnly)
```
    Returns the distance along this ray of the nearest intersection to the specified sphere or -1 if the ray and sphere do not intersect. 'limit' can optionally limit the length of the Ray if set to a value greater than 0. If 'outsideOnly' is true then cases where the ray origin is inside the sphere are rejected.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Rayd

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rayd

Rayd

Rayd

Method Detail

setOrigin

getOrigin

setDirection

getDirection

set

set

set

clone

toRay

hashCode

equals

isSimilar

project

getClosestPoint

distanceSq

intersectSphere

toString