Record Class GuiViewTransition.Snapshot

java.lang.Object

java.lang.Record

com.render.api.gui.GuiViewTransition.Snapshot

Record Components:

name - source or explicit transition name

bounds - captured design-space bounds

phase - old/new phase

explicitlyNamed - whether GuiComponent.viewTransitionName(String) supplied the name; false can still represent automatic ID pairing

Enclosing class:

GuiViewTransition

public static record GuiViewTransition.Snapshot(String name, GuiRect bounds, GuiViewTransition.SnapshotPhase phase, boolean explicitlyNamed)
extends Record

Inspectable snapshot metadata.

Constructor Summary

Constructors

Constructor	Description
Snapshot(String name, GuiRect bounds, GuiViewTransition.SnapshotPhase phase, boolean explicitlyNamed)	Creates an instance of a Snapshot record class.

Method Summary

Modifier and Type	Method	Description
GuiRect	bounds()	Returns the value of the bounds record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	explicitlyNamed()	Returns the value of the explicitlyNamed record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
GuiViewTransition.SnapshotPhase	phase()	Returns the value of the phase record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Snapshot

public Snapshot(String name,
 GuiRect bounds,
 GuiViewTransition.SnapshotPhase phase,
 boolean explicitlyNamed)

Creates an instance of a Snapshot record class.

Parameters:

name - the value for the name record component

bounds - the value for the bounds record component

phase - the value for the phase record component

explicitlyNamed - the value for the explicitlyNamed 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 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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

bounds

public GuiRect bounds()

Returns the value of the bounds record component.

Returns:

the value of the bounds record component

phase

public GuiViewTransition.SnapshotPhase phase()

Returns the value of the phase record component.

Returns:

the value of the phase record component

explicitlyNamed

public boolean explicitlyNamed()

Returns the value of the explicitlyNamed record component.

Returns:

the value of the explicitlyNamed record component