Module technology.sola.engine
Package technology.sola.engine.graphics.components

Record Class LightFlicker

java.lang.Object
java.lang.Record
technology.sola.engine.graphics.components.LightFlicker
Record Components:
min - minimum light intensity between 0 and 1
max - maximum light intensity between 0 and 1
rate - the rate which flickering happens between 0 and 1
smoothingFunction - function applied to smooth current intensity and next intensity value
@NullMarked public record LightFlicker(float min, float max, float rate, LightFlicker.FlickerSmoothing smoothingFunction) extends Record
LightFlicker

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    LightFlicker.FlickerSmoothing
    Defines the API for the function called to smooth the transition between the current and next light intensity values.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LightFlicker(float min, float max)
    Creates a LightFlicker instance with a low flicker rate and a running average smoothing function.
    LightFlicker(float min, float max, float rate, LightFlicker.FlickerSmoothing smoothingFunction)
    Creates an instance of a LightFlicker record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    float
    max()
    Returns the value of the max record component.
    float
    min()
    Returns the value of the min record component.
    float
    rate()
    Returns the value of the rate record component.
    LightFlicker.FlickerSmoothing
    smoothingFunction()
    Returns the value of the smoothingFunction record component.
    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

    • LightFlicker

      public LightFlicker(float min, float max)
      Creates a LightFlicker instance with a low flicker rate and a running average smoothing function.
      Parameters:
      min - minimum light intensity between 0 and 1
      max - maximum light intensity between 0 and 1

    • LightFlicker

      public LightFlicker(float min, float max, float rate, LightFlicker.FlickerSmoothing smoothingFunction)
      Creates an instance of a LightFlicker record class.
      Parameters:
      min - the value for the min record component
      max - the value for the max record component
      rate - the value for the rate record component
      smoothingFunction - the value for the smoothingFunction 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • min

      public float min()
      Returns the value of the min record component.
      Returns:
      the value of the min record component

    • max

      public float max()
      Returns the value of the max record component.
      Returns:
      the value of the max record component

    • rate

      public float rate()
      Returns the value of the rate record component.
      Returns:
      the value of the rate record component

    • smoothingFunction

      public LightFlicker.FlickerSmoothing smoothingFunction()
      Returns the value of the smoothingFunction record component.
      Returns:
      the value of the smoothingFunction record component