agi.foundation.cesium

(agi.foundation.cesium-2024r3.jar)

Enum CesiumColorBlendMode

java.lang.Object

java.lang.Enum<CesiumColorBlendMode>

agi.foundation.cesium.CesiumColorBlendMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CesiumColorBlendMode>

public enum CesiumColorBlendMode
extends Enum<CesiumColorBlendMode>
implements Enumeration

The mode to use when blending between a target color and an entity's source color.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGHLIGHT Multiplies the source color by the target color.
MIX Blends the source color and target color together.
REPLACE Replaces the source color with the target color.

Method Summary

Modifier and Type	Method and Description
static CesiumColorBlendMode	getDefault() Get the enum constant that is considered to be the default.
static CesiumColorBlendMode	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static CesiumColorBlendMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CesiumColorBlendMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HIGHLIGHT

public static final CesiumColorBlendMode HIGHLIGHT

Multiplies the source color by the target color.

REPLACE

public static final CesiumColorBlendMode REPLACE

Replaces the source color with the target color.

MIX

public static final CesiumColorBlendMode MIX

Blends the source color and target color together.

Method Detail

values

public static CesiumColorBlendMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CesiumColorBlendMode c : CesiumColorBlendMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CesiumColorBlendMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static CesiumColorBlendMode getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static CesiumColorBlendMode getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.