Package dev.prozilla.pine.common.math.dimension

Class Dimension.Clamp

java.lang.Object

dev.prozilla.pine.common.math.dimension.DimensionBase

dev.prozilla.pine.common.math.dimension.Dimension.Clamp

All Implemented Interfaces:

Cloneable<DimensionBase>, Printable

Enclosing class:

Dimension

public static class Dimension.Clamp
extends DimensionBase

Field Summary

Fields inherited from class dev.prozilla.pine.common.math.dimension.DimensionBase

computedValue, DEFAULT_DIRTY

Constructor Summary

Constructors

Constructor	Description
Clamp(DimensionBase dimension, DimensionBase dimensionMin, DimensionBase dimensionMax)	Creates a function that returns the value of a dimension, clamped between the values of two dimensions.

Method Summary

Modifier and Type	Method	Description
Dimension.Clamp	clone()	Returns a clone of this dimension.
boolean	equals(DimensionBase dimensionBase)	Checks whether this dimension is equal to a given dimension.
boolean	equals(DimensionBase dimension, DimensionBase dimensionMin, DimensionBase dimensionMax)
boolean	isDirty(Node node, boolean isHorizontal)	Checks whether this dimension has been modified since the last calculation.
protected float	recompute(Node node, boolean isHorizontal)	Recalculates the value of this dimension when it has been marked as dirty.
@NotNull String	toString()	Returns the string representation of this dimension.

Methods inherited from class dev.prozilla.pine.common.math.dimension.DimensionBase

compute, equals, getUnit, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Constructor Details

Clamp

public Clamp(DimensionBase dimension,
 DimensionBase dimensionMin,
 DimensionBase dimensionMax)

Creates a function that returns the value of a dimension, clamped between the values of two dimensions.

Method Details

isDirty

public boolean isDirty(Node node,
 boolean isHorizontal)

Description copied from class: DimensionBase

Checks whether this dimension has been modified since the last calculation.

Overrides:

isDirty in class DimensionBase

Returns:

True if this dimension has been modified.

recompute

protected float recompute(Node node,
 boolean isHorizontal)

Description copied from class: DimensionBase

Recalculates the value of this dimension when it has been marked as dirty.

Specified by:

recompute in class DimensionBase

Parameters:

node - UI element, serving as the context of this dimension.

Returns:

The computed value of this dimension in pixels.

clone

public Dimension.Clamp clone()

Description copied from class: DimensionBase

Returns a clone of this dimension.

Specified by:

clone in interface Cloneable<DimensionBase>

Specified by:

clone in class DimensionBase

Returns:

New dimension instance

equals

public boolean equals(DimensionBase dimensionBase)

Description copied from class: DimensionBase

Checks whether this dimension is equal to a given dimension.

Specified by:

equals in interface Cloneable<DimensionBase>

Specified by:

equals in class DimensionBase

Parameters:

dimensionBase - Other dimension

Returns:

true if both objects are equal.

equals

public boolean equals(DimensionBase dimension,
 DimensionBase dimensionMin,
 DimensionBase dimensionMax)

toString

@NotNull
public @NotNull String toString()

Description copied from class: DimensionBase

Returns the string representation of this dimension.

Specified by:

toString in interface Printable

Specified by:

toString in class DimensionBase

Returns:

String representation of this object.