Class SceneGraphPath

java.lang.Object

com.thecsdev.commonmc.api.client.gui.util.SceneGraphPath

@Environment(CLIENT)
public final class SceneGraphPath
extends Object

Represents a path in the scene graph from a parent TElement down to a child TElement, via all intermediate elements.

Each segment in the path specifies the expected Class type of the child TElement at that segment, as well as the expected index of that child within its parent segment.

Constructor Summary

Constructors

Constructor	Description
SceneGraphPath(@NotNull Class<? extends TElement> child, int childIndex, @Nullable SceneGraphPath path)	Creates a new SceneGraphPath segment instance.

Method Summary

Modifier and Type	Method	Description
@NotNull Class<? extends TElement>	getChild()	Returns the expected Class of the child TElement at this path segment.
int	getChildIndex()	Returns the expected index of the child TElement within its parent at this path segment.
@Nullable SceneGraphPath	getNext()	Returns the next segment in this scene graph path, or null if this is the last segment.
static final @Nullable SceneGraphPath	of(@NotNull TElement from, @Nullable TElement to)	Creates a SceneGraphPath that navigates from a given parent TElement down to a specified child TElement.
final @Nullable TElement	resolve(@NotNull TElement from)	Resolves this SceneGraphPath starting from a given TElement, returning the final TElement at the end of the path, if found.
static final @Nullable TElement	resolve(@NotNull TElement from, @NotNull SceneGraphPath path)	Resolves a SceneGraphPath starting from a given TElement, returning the final TElement at the end of the path, if found.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SceneGraphPath

public SceneGraphPath(@NotNull
 @NotNull Class<? extends TElement> child,
 int childIndex,
 @Nullable
 @Nullable SceneGraphPath path)
               throws NullPointerException

Creates a new SceneGraphPath segment instance.

Parameters:

child - The expected Class type of the child TElement at this segment.

childIndex - The expected index of the child TElement within its parent at this segment.

path - The next segment in the scene graph path, or null if this is the last segment.

Throws:

NullPointerException - If child is null.

Method Details

getChild

@NotNull
public @NotNull Class<? extends TElement> getChild()

Returns the expected Class of the child TElement at this path segment.

getChildIndex

public int getChildIndex()

Returns the expected index of the child TElement within its parent at this path segment.

getNext

@Nullable
public @Nullable SceneGraphPath getNext()

Returns the next segment in this scene graph path, or null if this is the last segment.

resolve

@Nullable
public final @Nullable TElement resolve(@NotNull
 @NotNull TElement from)
                                 throws NullPointerException

Resolves this SceneGraphPath starting from a given TElement, returning the final TElement at the end of the path, if found.

Parameters:

from - The TElement from which to start resolving the path.

Returns:

The resolved TElement, or null if the path could not be fully resolved.

Throws:

NullPointerException - If the argument is null.

of

@Nullable
public static final @Nullable SceneGraphPath of(@NotNull
 @NotNull TElement from,
 @Nullable
 @Nullable TElement to)

Creates a SceneGraphPath that navigates from a given parent TElement down to a specified child TElement.

Parameters:

from - The parent TElement from which to navigate.

to - The child TElement to which to navigate.

Returns:

The SceneGraphPath from from to to, or null if from is the same as to, or if to is not a descendant of from.

Throws:

NullPointerException - If an argument is null.

resolve

@Nullable
public static final @Nullable TElement resolve(@NotNull
 @NotNull TElement from,
 @NotNull
 @NotNull SceneGraphPath path)
                                        throws NullPointerException

Resolves a SceneGraphPath starting from a given TElement, returning the final TElement at the end of the path, if found.

Parameters:

from - The TElement from which to start resolving the path.

path - The SceneGraphPath to resolve.

Returns:

The resolved TElement, or null if the path could not be fully resolved.

Throws:

NullPointerException - If an argument is null.