Record Class GuiCaretAnimation

java.lang.Object

java.lang.Record

com.render.api.gui.GuiCaretAnimation

Record Components:

periodSeconds - complete blink period, or zero for a steady caret

visibleFraction - visible portion of each period

phaseSeconds - phase offset

public record GuiCaretAnimation(double periodSeconds, float visibleFraction, double phaseSeconds)
extends Record

Reusable caret visibility animation.

Field Summary

Fields

Modifier and Type	Field	Description
static final GuiCaretAnimation	BLINK
static final GuiCaretAnimation	STEADY

Constructor Summary

Constructors

Constructor	Description
GuiCaretAnimation(double periodSeconds, float visibleFraction, double phaseSeconds)	Creates an instance of a GuiCaretAnimation 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.
double	periodSeconds()	Returns the value of the periodSeconds record component.
double	phaseSeconds()	Returns the value of the phaseSeconds record component.
final String	toString()	Returns a string representation of this record class.
boolean	visibleAt(double timeSeconds)	Samples caret visibility.
float	visibleFraction()	Returns the value of the visibleFraction record component.

Methods inherited from class Object

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

Field Details

STEADY

public static final GuiCaretAnimation STEADY

BLINK

public static final GuiCaretAnimation BLINK

Constructor Details

GuiCaretAnimation

public GuiCaretAnimation(double periodSeconds,
 float visibleFraction,
 double phaseSeconds)

Creates an instance of a GuiCaretAnimation record class.

Parameters:

periodSeconds - the value for the periodSeconds record component

visibleFraction - the value for the visibleFraction record component

phaseSeconds - the value for the phaseSeconds record component

Method Details

visibleAt

public boolean visibleAt(double timeSeconds)

Samples caret visibility.

Parameters:

timeSeconds - animation time

Returns:

whether the caret is visible

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 the compare method from their corresponding wrapper classes.

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.

periodSeconds

public double periodSeconds()

Returns the value of the periodSeconds record component.

Returns:

the value of the periodSeconds record component

visibleFraction

public float visibleFraction()

Returns the value of the visibleFraction record component.

Returns:

the value of the visibleFraction record component

phaseSeconds

public double phaseSeconds()

Returns the value of the phaseSeconds record component.

Returns:

the value of the phaseSeconds record component