Module technology.sola.engine
Package technology.sola.engine.input

Record Class MouseWheelEvent

java.lang.Object
java.lang.Record
technology.sola.engine.input.MouseWheelEvent
Record Components:
isUp - true if the mouse wheel was moved up
isDown - true if the mouse wheel was moved down
isLeft - true if the mouse wheel was moved left
isRight - true if the mouse wheel was moved right
@NullMarked public record MouseWheelEvent(boolean isUp, boolean isDown, boolean isLeft, boolean isRight) extends Record
MouseWheelEvent is an event object containing information about an interaction with the mouse wheel.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final MouseWheelEvent
    NONE
    MouseWheelEvent to represent when no interaction with the mouse wheel has taken place.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MouseWheelEvent(boolean isUp, boolean isDown, boolean isLeft, boolean isRight)
    Creates an instance of a MouseWheelEvent 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.
    boolean
    isDown()
    Returns the value of the isDown record component.
    boolean
    isLeft()
    Returns the value of the isLeft record component.
    boolean
    isRight()
    Returns the value of the isRight record component.
    boolean
    isUp()
    Returns the value of the isUp 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

  • Field Details

    • NONE

      public static final MouseWheelEvent NONE
      MouseWheelEvent to represent when no interaction with the mouse wheel has taken place.

  • Constructor Details

    • MouseWheelEvent

      public MouseWheelEvent(boolean isUp, boolean isDown, boolean isLeft, boolean isRight)
      Creates an instance of a MouseWheelEvent record class.
      Parameters:
      isUp - the value for the isUp record component
      isDown - the value for the isDown record component
      isLeft - the value for the isLeft record component
      isRight - the value for the isRight 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. 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.

    • isUp

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

    • isDown

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

    • isLeft

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

    • isRight

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