Record Class Ray

java.lang.Object
java.lang.Record
cz.fidentis.analyst.data.ray.Ray
Record Components:
origin - Ray's origin
direction - Ray's unit direction
length - Ray's length

public record Ray(javax.vecmath.Point3d origin, javax.vecmath.Vector3d direction, double length) extends Record
A ray with origin, unit direction, and length.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Ray(Ray orig)
    Copy constructor.
    Ray(javax.vecmath.Point3d origin, javax.vecmath.Vector3d direction)
    Constructor a standard ray with length 1
    Ray(javax.vecmath.Point3d origin, javax.vecmath.Vector3d direction, double length)
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    javax.vecmath.Vector3d
    Returns the value of the direction record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the ray with inverted direction.
    double
    Returns the value of the length record component.
    javax.vecmath.Point3d
    Returns the value of the origin record component.
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Ray

      public Ray(javax.vecmath.Point3d origin, javax.vecmath.Vector3d direction)
      Constructor a standard ray with length 1
      Parameters:
      origin - Ray's origin
      direction - Ray's unit direction
    • Ray

      public Ray(javax.vecmath.Point3d origin, javax.vecmath.Vector3d direction, double length)
      Constructor.
      Parameters:
      origin - Ray's origin
      direction - Ray's unit direction
      length - Ray's length
    • Ray

      public Ray(Ray orig)
      Copy constructor.
      Parameters:
      orig - Original ray. Must not be null
  • Method Details

    • invert

      public Ray invert()
      Returns the ray with inverted direction.
      Returns:
      the ray with inverted direction.
    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • origin

      public javax.vecmath.Point3d origin()
      Returns the value of the origin record component.
      Returns:
      the value of the origin record component
    • direction

      public javax.vecmath.Vector3d direction()
      Returns the value of the direction record component.
      Returns:
      the value of the direction record component
    • length

      public double length()
      Returns the value of the length record component.
      Returns:
      the value of the length record component