Record Class GuiAnimationTimeline.ViewProgress

java.lang.Object

java.lang.Record

com.render.api.gui.GuiAnimationTimeline.ViewProgress

All Implemented Interfaces:

GuiAnimationTimeline

Enclosing interface:

GuiAnimationTimeline

public static record GuiAnimationTimeline.ViewProgress(GuiComponent<?> target, ScrollContainerComponent viewport, GuiScrollSnapType.Axis axis, GuiViewProgressRange range)
extends Record
implements GuiAnimationTimeline

Nested Class Summary

Nested classes/interfaces inherited from interface GuiAnimationTimeline

GuiAnimationTimeline.GameTime, GuiAnimationTimeline.RealTime, GuiAnimationTimeline.Scroll, GuiAnimationTimeline.ViewProgress

Field Summary

Fields inherited from interface GuiAnimationTimeline

GAME_TIME, REAL_TIME

Constructor Summary

Constructors

Constructor	Description
ViewProgress(GuiComponent<?> target, ScrollContainerComponent viewport, GuiScrollSnapType.Axis axis)
ViewProgress(GuiComponent<?> target, ScrollContainerComponent viewport, GuiScrollSnapType.Axis axis, GuiViewProgressRange range)	Creates an instance of a ViewProgress record class.

Method Summary

Modifier and Type	Method	Description
GuiScrollSnapType.Axis	axis()	Returns the value of the axis record component.
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	progress()	Returns normalized progress, or Float.NaN for clock timelines.
GuiViewProgressRange	range()	Returns the value of the range record component.
GuiComponent<?>	target()	Returns the value of the target record component.
final String	toString()	Returns a string representation of this record class.
ScrollContainerComponent	viewport()	Returns the value of the viewport record component.

Methods inherited from class Object

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

Constructor Details

ViewProgress

public ViewProgress(GuiComponent<?> target,
 ScrollContainerComponent viewport,
 GuiScrollSnapType.Axis axis)

ViewProgress

public ViewProgress(GuiComponent<?> target,
 ScrollContainerComponent viewport,
 GuiScrollSnapType.Axis axis,
 GuiViewProgressRange range)

Creates an instance of a ViewProgress record class.

Parameters:

target - the value for the target record component

viewport - the value for the viewport record component

axis - the value for the axis record component

range - the value for the range record component

Method Details

progress

public float progress()

Description copied from interface: GuiAnimationTimeline

Returns normalized progress, or Float.NaN for clock timelines.

Specified by:

progress in interface GuiAnimationTimeline

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.

target

public GuiComponent<?> target()

Returns the value of the target record component.

Returns:

the value of the target record component

viewport

public ScrollContainerComponent viewport()

Returns the value of the viewport record component.

Returns:

the value of the viewport record component

axis

public GuiScrollSnapType.Axis axis()

Returns the value of the axis record component.

Returns:

the value of the axis record component

range

public GuiViewProgressRange range()

Returns the value of the range record component.

Returns:

the value of the range record component