Package com.lightning.northstar.planet.data.orbit

Record Class SimpleOrbitProvider

java.lang.Object
java.lang.Record
com.lightning.northstar.planet.data.orbit.SimpleOrbitProvider
Record Components:
durationDays - how long does it take for the orbit a full circle around the central body
radius - the orbit radius in AU
inclination - the orbit inclination in radians
ascendingNode - the ascending node angle in radians
initialMeanAnomaly - the offset angle at the start of the world (base planets use J2000) in radians
All Implemented Interfaces:
OrbitProvider
@ParametersAreNonnullByDefault public record SimpleOrbitProvider(double durationDays, double radius, double inclination, double ascendingNode, double initialMeanAnomaly) extends Record implements OrbitProvider

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.MapCodec<SimpleOrbitProvider>
    CODEC
     
    static final net.minecraft.resources.ResourceLocation
    TYPE
     

    Fields inherited from interface com.lightning.northstar.planet.data.orbit.OrbitProvider

    REGISTRY

  • Constructor Summary

    Constructors
    Constructor
    Description
    SimpleOrbitProvider(double durationDays, double radius, double inclination, double ascendingNode, double initialMeanAnomaly)
    Creates an instance of a SimpleOrbitProvider record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    approximateRadius()
    Approximate average radius of the orbit, in AU
    double
    ascendingNode()
    Returns the value of the ascendingNode record component.
    org.joml.Vector3d
    calculatePosition(double deltaDays, org.joml.Vector3d dest)
     
    static SimpleOrbitProvider
    create(double durationDays, double radius, double inclinationDeg, double ascendingNodeDeg, double initialMeanAnomalyDeg)
     
    double
    durationDays()
    Returns the value of the durationDays record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    org.joml.Vector3d
    getRotationAxis(org.joml.Vector3d dest)
     
    double
    getVisualAngle(double deltaDays)
    Calculates the visual angle in radians at the given time.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    inclination()
    Returns the value of the inclination record component.
    double
    initialMeanAnomaly()
    Returns the value of the initialMeanAnomaly record component.
    double
    radius()
    Returns the value of the radius record component.
    final String
    toString()
    Returns a string representation of this record class.
    net.minecraft.resources.ResourceLocation
    type()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • TYPE

      public static final net.minecraft.resources.ResourceLocation TYPE

    • CODEC

      public static final com.mojang.serialization.MapCodec<SimpleOrbitProvider> CODEC

  • Constructor Details

    • SimpleOrbitProvider

      public SimpleOrbitProvider(double durationDays, double radius, double inclination, double ascendingNode, double initialMeanAnomaly)
      Creates an instance of a SimpleOrbitProvider record class.
      Parameters:
      durationDays - the value for the durationDays record component
      radius - the value for the radius record component
      inclination - the value for the inclination record component
      ascendingNode - the value for the ascendingNode record component
      initialMeanAnomaly - the value for the initialMeanAnomaly record component

  • Method Details

    • create

      public static SimpleOrbitProvider create(double durationDays, double radius, double inclinationDeg, double ascendingNodeDeg, double initialMeanAnomalyDeg)

    • type

      public net.minecraft.resources.ResourceLocation type()
      Specified by:
      type in interface OrbitProvider

    • approximateRadius

      public double approximateRadius()
      Description copied from interface: OrbitProvider
      Approximate average radius of the orbit, in AU
      Specified by:
      approximateRadius in interface OrbitProvider

    • getVisualAngle

      public double getVisualAngle(double deltaDays)
      Description copied from interface: OrbitProvider
      Calculates the visual angle in radians at the given time. Used for rendering in the orrery.
      Specified by:
      getVisualAngle in interface OrbitProvider

    • getRotationAxis

      public org.joml.Vector3d getRotationAxis(org.joml.Vector3d dest)
      Specified by:
      getRotationAxis in interface OrbitProvider

    • calculatePosition

      public org.joml.Vector3d calculatePosition(double deltaDays, org.joml.Vector3d dest)
      Specified by:
      calculatePosition in interface OrbitProvider

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

    • durationDays

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

    • radius

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

    • inclination

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

    • ascendingNode

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

    • initialMeanAnomaly

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