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

Record Class FixedOrbitProvider

java.lang.Object
java.lang.Record
com.lightning.northstar.planet.data.orbit.FixedOrbitProvider
All Implemented Interfaces:
OrbitProvider
@ParametersAreNonnullByDefault public record FixedOrbitProvider(org.joml.Vector3f position) extends Record implements OrbitProvider

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.MapCodec<FixedOrbitProvider>
    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
    FixedOrbitProvider(org.joml.Vector3f position)
    Creates an instance of a FixedOrbitProvider record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    approximateRadius()
    Approximate average radius of the orbit, in AU
    org.joml.Vector3d
    calculatePosition(double deltaDays, org.joml.Vector3d dest)
     
    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.
    org.joml.Vector3f
    position()
    Returns the value of the position 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<FixedOrbitProvider> CODEC

  • Constructor Details

    • FixedOrbitProvider

      public FixedOrbitProvider(org.joml.Vector3f position)
      Creates an instance of a FixedOrbitProvider record class.
      Parameters:
      position - the value for the position record component

  • Method Details

    • type

      public net.minecraft.resources.ResourceLocation type()
      Specified by:
      type 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

    • approximateRadius

      public double approximateRadius()
      Description copied from interface: OrbitProvider
      Approximate average radius of the orbit, in AU
      Specified by:
      approximateRadius 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 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.

    • position

      public org.joml.Vector3f position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component