Module simpa.core
Package simpa.core.api

Record Class TangentVector3D

java.lang.Object
java.lang.Record
simpa.core.api.TangentVector3D
public record TangentVector3D(org.apache.commons.math3.geometry.euclidean.threed.Vector3D location, org.apache.commons.math3.geometry.euclidean.threed.Vector3D direction) extends Record
Object representing vector that is tangent to a curve or surface at a given point.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TangentVector3D(org.apache.commons.math3.geometry.euclidean.threed.Vector3D location, org.apache.commons.math3.geometry.euclidean.threed.Vector3D direction)
    Creates an instance of a TangentVector3D record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.commons.math3.geometry.euclidean.threed.Vector3D
    direction()
    Returns the value of the direction record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    org.apache.commons.math3.geometry.euclidean.threed.Vector3D
    location()
    Returns the value of the location record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TangentVector3D

      public TangentVector3D(org.apache.commons.math3.geometry.euclidean.threed.Vector3D location, org.apache.commons.math3.geometry.euclidean.threed.Vector3D direction)
      Creates an instance of a TangentVector3D record class.
      Parameters:
      location - the value for the location record component
      direction - the value for the direction record component

  • Method Details

    • toString

      public final 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • location

      public org.apache.commons.math3.geometry.euclidean.threed.Vector3D location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component

    • direction

      public org.apache.commons.math3.geometry.euclidean.threed.Vector3D direction()
      Returns the value of the direction record component.
      Returns:
      the value of the direction record component