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

Class DimensionComparator

java.lang.Object

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

dev.prozilla.pine.common.math.dimension.DimensionComparator

All Implemented Interfaces:

Cloneable<DimensionBase>, Printable

Direct Known Subclasses:

Dimension.Add, Dimension.If, Dimension.Max, Dimension.Min, Dimension.Mix, Dimension.Multiply, Dimension.Subtract

public abstract class DimensionComparator
extends DimensionBase

Abstract class for a function that compares two dimensions.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DimensionBase	dimensionA
protected final DimensionBase	dimensionB
protected boolean	isDirty

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

computedValue, DEFAULT_DIRTY

Constructor Summary

Constructors

Constructor	Description
DimensionComparator(DimensionBase dimensionA, DimensionBase dimensionB)

Method Summary

Modifier and Type	Method	Description
protected abstract float	compare(float valueA, float valueB)	Compares the values of both dimensions stored in this comparator.
boolean	equals(DimensionBase dimensionBase)	Checks whether this dimension is equal to a given dimension.
boolean	has(DimensionBase dimension)
boolean	isDirty(Node node, boolean isHorizontal)	Checks whether this dimension has been modified since the last calculation.
protected final float	recompute(Node node, boolean isHorizontal)	Recalculates the value of this dimension when it has been marked as dirty.

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

clone, compute, equals, getUnit, hashCode, toString

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

Field Details

dimensionA

protected final DimensionBase dimensionA

dimensionB

protected final DimensionBase dimensionB

isDirty

protected boolean isDirty

Constructor Details

DimensionComparator

public DimensionComparator(DimensionBase dimensionA,
 DimensionBase dimensionB)

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 final 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.

has

public boolean has(DimensionBase dimension)

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.

compare

protected abstract float compare(float valueA,
 float valueB)

Compares the values of both dimensions stored in this comparator.

Returns:

The result of this comparator function.