Record Class GuiClipPath.Circle

java.lang.Object

java.lang.Record

com.render.api.gui.effects.GuiClipPath.Circle

Record Components:

radius - radius relative to the smaller reference-box dimension

centerX - horizontal center relative to the reference box

centerY - vertical center relative to the reference box

referenceBox - box used to resolve the normalized values

All Implemented Interfaces:

GuiClipPath

Enclosing interface:

GuiClipPath

public static record GuiClipPath.Circle(float radius, float centerX, float centerY, GuiClipPath.ReferenceBox referenceBox)
extends Record
implements GuiClipPath

Circle values are normalized to the reference box. A radius of 0.5 reaches half the smaller box dimension.

Nested Class Summary

Nested classes/interfaces inherited from interface GuiClipPath

GuiClipPath.Circle, GuiClipPath.Ellipse, GuiClipPath.Inset, GuiClipPath.Path, GuiClipPath.Point, GuiClipPath.Polygon, GuiClipPath.ReferenceBox

Constructor Summary

Constructors

Constructor	Description
Circle(float radius, float centerX, float centerY, GuiClipPath.ReferenceBox referenceBox)	Creates an instance of a Circle record class.

Method Summary

Modifier and Type	Method	Description
float	centerX()	Returns the value of the centerX record component.
float	centerY()	Returns the value of the centerY record component.
GuiRect	conservativeBounds(GuiRect reference)
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	radius()	Returns the value of the radius record component.
GuiClipPath.ReferenceBox	referenceBox()	Returns the value of the referenceBox 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

Methods inherited from interface GuiClipPath

contains, inputExact, portableExact

Constructor Details

Circle

public Circle(float radius,
 float centerX,
 float centerY,
 GuiClipPath.ReferenceBox referenceBox)

Creates an instance of a Circle record class.

Parameters:

radius - the value for the radius record component

centerX - the value for the centerX record component

centerY - the value for the centerY record component

referenceBox - the value for the referenceBox record component

Method Details

conservativeBounds

public GuiRect conservativeBounds(GuiRect reference)

Specified by:

conservativeBounds in interface GuiClipPath

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.

radius

public float radius()

Returns the value of the radius record component.

Returns:

the value of the radius record component

centerX

public float centerX()

Returns the value of the centerX record component.

Returns:

the value of the centerX record component

centerY

public float centerY()

Returns the value of the centerY record component.

Returns:

the value of the centerY record component

referenceBox

public GuiClipPath.ReferenceBox referenceBox()

Returns the value of the referenceBox record component.

Specified by:

referenceBox in interface GuiClipPath

Returns:

the value of the referenceBox record component