com.wowza.gocoder.sdk.api.graphics

Class WZColor

java.lang.Object

com.wowza.gocoder.sdk.api.graphics.WZColor

All Implemented Interfaces:

Comparable<WZColor>

public class WZColor
extends Object
implements Comparable<WZColor>

An RGBA color representation

Field Summary

Fields

Modifier and Type	Field and Description
float	alpha
static WZColor	BLACK
float	blue
static WZColor	BLUE
static WZColor	CYAN
static WZColor	DARKGREY
float	green
static WZColor	GREEN
static WZColor	GREY
static WZColor	LIGHTGREY
static WZColor	MAGENTA
static WZColor	ORANGE
float	red
static WZColor	RED
static WZColor	WHITE Identifiers for a stndard set of colors
static WZColor	YELLOW

Constructor Summary

Constructors

Constructor and Description
WZColor() Construct a new instance (white by default, fully opaque)
WZColor(float r, float g, float b) Construct a new instance using the specified property values
WZColor(float r, float g, float b, float a) Construct a new instance using the specified property values
WZColor(int r, int g, int b) Construct a new instance using the specified property values
WZColor(int r, int g, int b, int a) Construct a new instance using the specified property values
WZColor(WZColor other) Construct a new instance using the property values from the specified instance

Method Summary

Modifier and Type	Method and Description
int	compareTo(WZColor other) Compare this instance to another
boolean	equals(Object other)
static WZColor	fromPacked(int packedColor) Converts a packed color into a WZColor
static int	packedColor(float r, float g, float b, float a)
void	set(float r, float g, float b) Set the values of this instance using the specified property values
void	set(float r, float g, float b, float a) Set the values of this instance using the specified property values
void	set(int packedColor) Set the values of this instance using the specified packed integer
void	set(WZColor other) Update the property values of this instance with the property values from the specified instance
float[]	toArray()
int	toPacked()
String	toString() Returns a human readable representation
boolean	validate() Validate tje values in this instance
static boolean	validateColor(float r, float g, float b, float a) Validate a set of color values

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WHITE

public static final WZColor WHITE

Identifiers for a stndard set of colors

BLACK

public static final WZColor BLACK

GREY

public static final WZColor GREY

DARKGREY

public static final WZColor DARKGREY

LIGHTGREY

public static final WZColor LIGHTGREY

RED

public static final WZColor RED

GREEN

public static final WZColor GREEN

BLUE

public static final WZColor BLUE

YELLOW

public static final WZColor YELLOW

CYAN

public static final WZColor CYAN

MAGENTA

public static final WZColor MAGENTA

ORANGE

public static final WZColor ORANGE

red

public float red

green

public float green

blue

public float blue

alpha

public float alpha

Constructor Detail

WZColor

public WZColor(float r,
               float g,
               float b,
               float a)

Construct a new instance using the specified property values

Parameters:

r - the red component

g - the green component

b - the blue component

a - the alpha component

WZColor

public WZColor(float r,
               float g,
               float b)

Construct a new instance using the specified property values

Parameters:

r - the red component

g - the green component

b - the blue component

WZColor

public WZColor(int r,
               int g,
               int b,
               int a)

Construct a new instance using the specified property values

Parameters:

r - the red component

g - the green component

b - the blue component

a - the alpha component

WZColor

public WZColor(int r,
               int g,
               int b)

Construct a new instance using the specified property values

Parameters:

r - the red component

g - the green component

b - the blue component

WZColor

public WZColor()

Construct a new instance (white by default, fully opaque)

WZColor

public WZColor(WZColor other)

Construct a new instance using the property values from the specified instance

Parameters:

other - The instance to replicate

Method Detail

packedColor

public static int packedColor(float r,
                              float g,
                              float b,
                              float a)

Parameters:

r - the red component

g - the green component

b - the blue component

a - the alpha component

Returns:

fromPacked

public static WZColor fromPacked(int packedColor)

Converts a packed color into a WZColor

Parameters:

packedColor - the packed color

Returns:

a new WZColor instance

validateColor

public static boolean validateColor(float r,
                                    float g,
                                    float b,
                                    float a)

Validate a set of color values

Parameters:

r - the red component

g - the green component

b - the blue component

a - the alpha component

Returns:

true if each of the values falls in the valid range of 0 to 1

set

public void set(WZColor other)

Update the property values of this instance with the property values from the specified instance

Parameters:

other - The instance with the property values to replicate

set

public void set(float r,
                float g,
                float b,
                float a)

Set the values of this instance using the specified property values

Parameters:

r -

g -

b -

a -

set

public void set(float r,
                float g,
                float b)

Set the values of this instance using the specified property values

Parameters:

r -

g -

b -

set

public void set(int packedColor)

Set the values of this instance using the specified packed integer

Parameters:

packedColor - a packed integer representation whose values to copy

toArray

public float[] toArray()

Returns:

an array of floating point values for this instance

toPacked

public int toPacked()

Returns:

a packed integer representation of this instance

validate

public boolean validate()

Validate tje values in this instance

Returns:

true if each of the values falls in the valid range of 0 to 1

equals

public boolean equals(Object other)

Overrides:

equals in class Object

Returns:

true if this instance is equal to the specified instance

toString

public String toString()

Returns a human readable representation

Overrides:

toString in class Object

Returns:

a string representation of this instance

compareTo

public int compareTo(WZColor other)

Compare this instance to another

Specified by:

compareTo in interface Comparable<WZColor>

Parameters:

other - the instance for comparison

Returns:

0 if equal, -1 is less than the specified instance, 1 if greater