Target

public final class Target

A class which allows custom selection of colors in a Palette's generation. Instances can be created via the Builder class.

To use the target, use the addTarget API when building a Palette.

Summary

Nested types
public final class Target.Builder

Builder class for generating custom Target instances.

Constants
static final Target

A target which has the characteristics of a muted color which is dark in luminance.
static final Target

A target which has the characteristics of a vibrant color which is dark in luminance.
static final Target

A target which has the characteristics of a muted color which is light in luminance.
static final Target

A target which has the characteristics of a vibrant color which is light in luminance.
static final Target

A target which has the characteristics of a muted color which is neither light or dark.
static final Target

A target which has the characteristics of a vibrant color which is neither light or dark.

Public methods
float

Returns the weight of importance that this target places on a color's lightness within the image.
@FloatRange(from = 0, to = 1) float

The maximum lightness value for this target.
@FloatRange(from = 0, to = 1) float

The maximum saturation value for this target.
@FloatRange(from = 0, to = 1) float

The minimum lightness value for this target.
@FloatRange(from = 0, to = 1) float

The minimum saturation value for this target.
float

Returns the weight of importance that this target places on a color's population within the image.
float

Returns the weight of importance that this target places on a color's saturation within the image.
@FloatRange(from = 0, to = 1) float

The target lightness value for this target.
@FloatRange(from = 0, to = 1) float

The target saturation value for this target.
boolean

Returns whether any color selected for this target is exclusive for this target only.

Constants

DARK_MUTED

Added in 1.0.0
public static final Target DARK_MUTED

A target which has the characteristics of a muted color which is dark in luminance.

DARK_VIBRANT

Added in 1.0.0
public static final Target DARK_VIBRANT

A target which has the characteristics of a vibrant color which is dark in luminance.

LIGHT_MUTED

Added in 1.0.0
public static final Target LIGHT_MUTED

A target which has the characteristics of a muted color which is light in luminance.

LIGHT_VIBRANT

Added in 1.0.0
public static final Target LIGHT_VIBRANT

A target which has the characteristics of a vibrant color which is light in luminance.

MUTED

Added in 1.0.0
public static final Target MUTED

A target which has the characteristics of a muted color which is neither light or dark.

VIBRANT

Added in 1.0.0
public static final Target VIBRANT

A target which has the characteristics of a vibrant color which is neither light or dark.

Public methods

getLightnessWeight

Added in 1.0.0
public float getLightnessWeight()

Returns the weight of importance that this target places on a color's lightness within the image.

The larger the weight, relative to the other weights, the more important that a color being close to the target value has on selection.

See also
getTargetLightness

getMaximumLightness

Added in 1.0.0
public @FloatRange(from = 0, to = 1) float getMaximumLightness()

The maximum lightness value for this target.

getMaximumSaturation

Added in 1.0.0
public @FloatRange(from = 0, to = 1) float getMaximumSaturation()

The maximum saturation value for this target.

getMinimumLightness

Added in 1.0.0
public @FloatRange(from = 0, to = 1) float getMinimumLightness()

The minimum lightness value for this target.

getMinimumSaturation

Added in 1.0.0
public @FloatRange(from = 0, to = 1) float getMinimumSaturation()

The minimum saturation value for this target.

getPopulationWeight

Added in 1.0.0
public float getPopulationWeight()

Returns the weight of importance that this target places on a color's population within the image.

The larger the weight, relative to the other weights, the more important that a color's population being close to the most populous has on selection.

getSaturationWeight

Added in 1.0.0
public float getSaturationWeight()

Returns the weight of importance that this target places on a color's saturation within the image.

The larger the weight, relative to the other weights, the more important that a color being close to the target value has on selection.

See also
getTargetSaturation

getTargetLightness

Added in 1.0.0
public @FloatRange(from = 0, to = 1) float getTargetLightness()

The target lightness value for this target.

getTargetSaturation

Added in 1.0.0
public @FloatRange(from = 0, to = 1) float getTargetSaturation()

The target saturation value for this target.

isExclusive

Added in 1.0.0
public boolean isExclusive()

Returns whether any color selected for this target is exclusive for this target only.

If false, then the color can be selected for other targets.