Package org.opentrafficsim.base.geometry

Record Class FractionalProjectionHelper.Helper

java.lang.Object
java.lang.Record
org.opentrafficsim.base.geometry.FractionalProjectionHelper.Helper
Record Components:
hasCenter - whether this is a center helper
cx - center x coordinate
cy - center y coordinate
dx - direction x component
dy - direction y component
Enclosing class:
FractionalProjectionHelper
public static record FractionalProjectionHelper.Helper(boolean hasCenter, double cx, double cy, double dx, double dy) extends Record
Value object: per-segment helper, either center or direction.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Helper(boolean hasCenter, double cx, double cy, double dx, double dy)
    Creates an instance of a Helper record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FractionalProjectionHelper.Helper
    center(double cx, double cy)
    Factory for a center-based helper.
    double
    cx()
    Returns the value of the cx record component.
    double
    cy()
    Returns the value of the cy record component.
    static FractionalProjectionHelper.Helper
    direction(double dx, double dy)
    Factory for a direction-based helper.
    double
    dx()
    Returns the value of the dx record component.
    double
    dy()
    Returns the value of the dy record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    hasCenter()
    Returns the value of the hasCenter record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    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

    • Helper

      public Helper(boolean hasCenter, double cx, double cy, double dx, double dy)
      Creates an instance of a Helper record class.
      Parameters:
      hasCenter - the value for the hasCenter record component
      cx - the value for the cx record component
      cy - the value for the cy record component
      dx - the value for the dx record component
      dy - the value for the dy record component

  • Method Details

    • center

      public static FractionalProjectionHelper.Helper center(double cx, double cy)
      Factory for a center-based helper.
      Parameters:
      cx - center x coordinate
      cy - center y coordinate
      Returns:
      center-based helper

    • direction

      public static FractionalProjectionHelper.Helper direction(double dx, double dy)
      Factory for a direction-based helper.
      Parameters:
      dx - direction x component
      dy - direction y component
      Returns:
      direction-based helper

    • 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 '=='.
      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.

    • hasCenter

      public boolean hasCenter()
      Returns the value of the hasCenter record component.
      Returns:
      the value of the hasCenter record component

    • cx

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

    • cy

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

    • dx

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

    • dy

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