Class FloatDirection

    • Field Detail

      • ZERO

        public static final FloatDirection ZERO
        Constant with value zero.
    • Constructor Detail

      • FloatDirection

        public FloatDirection​(float value,
                              DirectionUnit unit)
        Construct FloatDirection scalar.
        Parameters:
        value - float; the float value
        unit - DirectionUnit; unit for the float value
      • FloatDirection

        public FloatDirection​(double value,
                              DirectionUnit unit)
        Construct FloatDirection scalar using a double value.
        Parameters:
        value - double; the double value
        unit - DirectionUnit; unit for the resulting float value
      • FloatDirection

        public FloatDirection​(FloatDirection value)
        Construct FloatDirection scalar.
        Parameters:
        value - FloatDirection; Scalar from which to construct this instance
    • Method Detail

      • instantiateAbs

        public final FloatDirection instantiateAbs​(float value,
                                                   DirectionUnit unit)
        Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - float; the float value
        unit - AU; the absolute unit
        Returns:
        A a new absolute instance of the FloatScalar of the right type
      • instantiateRel

        public final FloatAngle instantiateRel​(float value,
                                               AngleUnit unit)
        Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - float; the float value
        unit - RU; the unit
        Returns:
        R a new relative instance of the FloatScalar of the right type
      • instantiateSI

        public static final FloatDirection instantiateSI​(float value)
        Construct FloatDirection scalar.
        Parameters:
        value - float; the float value in BASE units
        Returns:
        FloatDirection; the new scalar with the BASE value
      • interpolate

        public static FloatDirection interpolate​(FloatDirection zero,
                                                 FloatDirection one,
                                                 float ratio)
        Interpolate between two values.
        Parameters:
        zero - FloatDirection; the low value
        one - FloatDirection; the high value
        ratio - float; the ratio between 0 and 1, inclusive
        Returns:
        FloatDirection; a Scalar at the ratio between
      • max

        public static FloatDirection max​(FloatDirection a1,
                                         FloatDirection a2)
        Return the maximum value of two absolute scalars.
        Parameters:
        a1 - FloatDirection; the first scalar
        a2 - FloatDirection; the second scalar
        Returns:
        FloatDirection; the maximum value of two absolute scalars
      • max

        public static FloatDirection max​(FloatDirection a1,
                                         FloatDirection a2,
                                         FloatDirection... an)
        Return the maximum value of more than two absolute scalars.
        Parameters:
        a1 - FloatDirection; the first scalar
        a2 - FloatDirection; the second scalar
        an - FloatDirection...; the other scalars
        Returns:
        FloatDirection; the maximum value of more than two absolute scalars
      • min

        public static FloatDirection min​(FloatDirection a1,
                                         FloatDirection a2)
        Return the minimum value of two absolute scalars.
        Parameters:
        a1 - FloatDirection; the first scalar
        a2 - FloatDirection; the second scalar
        Returns:
        FloatDirection; the minimum value of two absolute scalars
      • min

        public static FloatDirection min​(FloatDirection a1,
                                         FloatDirection a2,
                                         FloatDirection... an)
        Return the minimum value of more than two absolute scalars.
        Parameters:
        a1 - FloatDirection; the first scalar
        a2 - FloatDirection; the second scalar
        an - FloatDirection...; the other scalars
        Returns:
        FloatDirection; the minimum value of more than two absolute scalars
      • valueOf

        public static FloatDirection valueOf​(String text)
        Returns a FloatDirection representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.
        Parameters:
        text - String; the textual representation to parse into a FloatDirection
        Returns:
        FloatDirection; the Scalar representation of the value in its unit
        Throws:
        IllegalArgumentException - when the text cannot be parsed
        NullPointerException - when the text argument is null
      • of

        public static FloatDirection of​(float value,
                                        String unitString)
        Returns a FloatDirection based on a value and the textual representation of the unit, which can be localized.
        Parameters:
        value - double; the value to use
        unitString - String; the textual representation of the unit
        Returns:
        FloatDirection; the Scalar representation of the value in its unit
        Throws:
        IllegalArgumentException - when the unit cannot be parsed or is incorrect
        NullPointerException - when the unitString argument is null