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

Class Dimension

java.lang.Object

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

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

All Implemented Interfaces:

Cloneable<DimensionBase>, Printable

public class Dimension
extends DimensionBase

Dimension of a UI element, defined by the combination of a value and a unit or by a function that computes the value of a dimension. The dimension system is based on the CSS length data type, and has similar features and conventions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dimension.Add
static class	Dimension.Clamp
static class	Dimension.If
static class	Dimension.Max
static class	Dimension.Min
static class	Dimension.Multiply

Field Summary

Fields

Modifier and Type	Field	Description
protected float	currentFactor
static final Unit	DEFAULT_UNIT
static final int	DEFAULT_VALUE
protected boolean	isDirty
protected Unit	unit
protected int	value

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

computedValue, DEFAULT_DIRTY

Constructor Summary

Constructors

Constructor	Description
Dimension()
Dimension(int value)
Dimension(int value, Unit unit)

Method Summary

Modifier and Type	Method	Description
static Dimension.Add	add(DimensionBase... dimensions)	Creates a dimension based on the sum of the values of two or more dimensions.
static Dimension	auto()	Creates a dimension that automatically computes, regardless of its value.
static <D extends DimensionBase> D	chainDimensions(BiFunction<DimensionBase,DimensionBase,D> constructor, DimensionBase[] dimensions)	Helper method to chain dimensions based on the given constructor.
static Dimension.Clamp	clamp(DimensionBase dimension, DimensionBase dimensionMin, DimensionBase dimensionMax)	Creates a dimension based on the lowest value of two dimensions.
Dimension	clone()	Returns a clone of this dimension.
boolean	equals(DimensionBase dimensionBase)	Checks whether this dimension is equal to a given dimension.
protected float	getFactor(RectTransform context, boolean isHorizontal)	Returns the factor based on this dimension's unit and a given context element.
Unit	getUnit()
boolean	isDirty(RectTransform context, boolean isHorizontal)	Checks whether this dimension has been modified since the last calculation.
static boolean	isValid(String input)
static Dimension.Max	max(DimensionBase... dimensions)	Creates a dimension based on the highest value of two or more dimensions.
static Dimension.Min	min(DimensionBase... dimensions)	Creates a dimension based on the lowest value of two or more dimensions.
static Dimension.Multiply	multiply(DimensionBase... dimensions)	Creates a dimension based on the product of the values of two or more dimensions.
static Dimension	parentSize()
static DimensionBase	parse(String input)	Parses a string into a dimension instance.
static Dimension.If	predicate(boolean predicate, DimensionBase dimensionTrue, DimensionBase dimensionFalse)	Creates a dimension based on a predicate.
protected int	recompute(RectTransform context, boolean isHorizontal)	Computes the value of this dimension by multiplying the original value with a factor based on the unit.
void	set(int value, Unit unit)
void	setUnit(Unit unit)
void	setValue(int value)
String	toString()	Returns the string representation of this dimension.
static Dimension	viewportHeight()	Creates a dimension based on the viewport height.
static Dimension	viewportWidth()	Creates a dimension based on the viewport width.
static Dimension	zero()	Creates a dimension with value 0.

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

compute, equals, 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

Field Details

value

protected int value

unit

protected Unit unit

isDirty

protected boolean isDirty

currentFactor

protected float currentFactor

DEFAULT_VALUE

public static final int DEFAULT_VALUE

See Also:

• Constant Field Values

DEFAULT_UNIT

public static final Unit DEFAULT_UNIT

Constructor Details

Dimension

public Dimension()

Dimension

public Dimension(int value)

Dimension

public Dimension(int value,
 Unit unit)

Method Details

recompute

protected int recompute(RectTransform context,
 boolean isHorizontal)

Computes the value of this dimension by multiplying the original value with a factor based on the unit.

Specified by:

recompute in class DimensionBase

Parameters:

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

Returns:

The computed value of this dimension in pixels.

isDirty

public boolean isDirty(RectTransform context,
 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.

getUnit

public Unit getUnit()

Overrides:

getUnit in class DimensionBase

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.

toString

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

getFactor

protected float getFactor(RectTransform context,
 boolean isHorizontal)

Returns the factor based on this dimension's unit and a given context element.

set

public void set(int value,
 Unit unit)

setValue

public void setValue(int value)

setUnit

public void setUnit(Unit unit)

clone

public Dimension 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

isValid

public static boolean isValid(String input)

parse

public static DimensionBase parse(String input)
                           throws IllegalArgumentException,
InvalidStringException

Parses a string into a dimension instance.

Parameters:

input - Input string

Returns:

New dimension with based on input string

Throws:

IllegalArgumentException - When input is not a valid dimension string

InvalidStringException

zero

public static Dimension zero()

Creates a dimension with value 0.

auto

public static Dimension auto()

Creates a dimension that automatically computes, regardless of its value.

viewportWidth

public static Dimension viewportWidth()

Creates a dimension based on the viewport width.

viewportHeight

public static Dimension viewportHeight()

Creates a dimension based on the viewport height.

parentSize

public static Dimension parentSize()

max

public static Dimension.Max max(DimensionBase... dimensions)
                         throws InvalidArrayException

Creates a dimension based on the highest value of two or more dimensions.

Throws:

InvalidArrayException

min

public static Dimension.Min min(DimensionBase... dimensions)
                         throws InvalidArrayException

Creates a dimension based on the lowest value of two or more dimensions.

Throws:

InvalidArrayException

clamp

public static Dimension.Clamp clamp(DimensionBase dimension,
 DimensionBase dimensionMin,
 DimensionBase dimensionMax)

Creates a dimension based on the lowest value of two dimensions.

predicate

public static Dimension.If predicate(boolean predicate,
 DimensionBase dimensionTrue,
 DimensionBase dimensionFalse)

Creates a dimension based on a predicate.

add

public static Dimension.Add add(DimensionBase... dimensions)
                         throws InvalidArrayException

Creates a dimension based on the sum of the values of two or more dimensions.

Throws:

InvalidArrayException

multiply

public static Dimension.Multiply multiply(DimensionBase... dimensions)
                                   throws InvalidArrayException

Creates a dimension based on the product of the values of two or more dimensions.

Throws:

InvalidArrayException

chainDimensions

public static <D extends DimensionBase> D chainDimensions(BiFunction<DimensionBase,DimensionBase,D> constructor,
 DimensionBase[] dimensions)
                                                   throws InvalidArrayException

Helper method to chain dimensions based on the given constructor.

Type Parameters:

D - The type of the chain dimension

Parameters:

constructor - A constructor that creates a part of the dimension chain

dimensions - The dimensions to create a chain of

Returns:

The chain of dimensions

Throws:

InvalidArrayException - If less than two dimensions are passed