Class ToneDeltaPair

java.lang.Object

org.glavo.monetfx.internal.dynamiccolor.ToneDeltaPair

public final class ToneDeltaPair
extends Object

Documents a constraint between two DynamicColors, in which their tones must have a certain distance from each other.

Prefer a DynamicColor with a background, this is for special cases when designers want tonal distance, literally contrast, between two colors that don't have a background / foreground relationship or a contrast guarantee.

Constructor Summary

Constructors

Constructor	Description
ToneDeltaPair(DynamicColor roleA, DynamicColor roleB, double delta, TonePolarity polarity, boolean stayTogether)	Documents a constraint in tone distance between two DynamicColors.

Method Summary

Modifier and Type	Method	Description
double	getDelta()
@NotNull TonePolarity	getPolarity()
@NotNull DynamicColor	getRoleA()
@NotNull DynamicColor	getRoleB()
boolean	getStayTogether()

Methods inherited from class java.lang.Object

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

Constructor Details

ToneDeltaPair

public ToneDeltaPair(DynamicColor roleA,
 DynamicColor roleB,
 double delta,
 TonePolarity polarity,
 boolean stayTogether)

Documents a constraint in tone distance between two DynamicColors.

The polarity is an adjective that describes "A", compared to "B".

For instance, ToneDeltaPair(A, B, 15, 'darker', stayTogether) states that A's tone should be at least 15 darker than B's.

'nearer' and 'farther' describes closeness to the surface roles. For instance, ToneDeltaPair(A, B, 10, 'nearer', stayTogether) states that A should be 10 lighter than B in light mode, and 10 darker than B in dark mode.

Parameters:

roleA - The first role in a pair.

roleB - The second role in a pair.

delta - Required difference between tones. Absolute value, negative values have undefined behavior.

polarity - The relative relation between tones of roleA and roleB, as described above.

stayTogether - Whether these two roles should stay on the same side of the "awkward zone" (T50-59). This is necessary for certain cases where one role has two backgrounds.

Method Details

getRoleA

@NotNull
public @NotNull DynamicColor getRoleA()

getRoleB

@NotNull
public @NotNull DynamicColor getRoleB()

getDelta

public double getDelta()

getPolarity

@NotNull
public @NotNull TonePolarity getPolarity()

getStayTogether

public boolean getStayTogether()