com.wowza.gocoder.sdk.api.graphics

Class WOWZColor

java.lang.Object

com.wowza.gocoder.sdk.api.graphics.WOWZColor

All Implemented Interfaces:

java.lang.Comparable<WOWZColor>

public class WOWZColor
extends java.lang.Object
implements java.lang.Comparable<WOWZColor>

An RGBA color representation.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
WOWZColor() Creates and initializes a white, fully opaque instance.
WOWZColor(float r, float g, float b) Creates and initializes an instance using the specified property values.
WOWZColor(float r, float g, float b, float a) Creates and initializes an instance using the specified property values.
WOWZColor(int r, int g, int b) Creates and initializes an instance using the specified property values.
WOWZColor(int r, int g, int b, int a) Creates and initializes an instance using the specified property values.
WOWZColor(WOWZColor other) Creates and initializes an instance using the property values from the specified instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(WOWZColor other) Compares this instance to another.
boolean	equals(java.lang.Object other)
static WOWZColor	fromPacked(int packedColor) Converts a packed color into a WOWZColor.
static int	packedColor(float r, float g, float b, float a)
void	set(float r, float g, float b) Sets the values of this instance using the specified property values.
void	set(float r, float g, float b, float a) Sets the values of this instance using the specified property values.
void	set(int packedColor) Sets the values of this instance using the specified packed integer.
void	set(WOWZColor other) Updates the property values of this instance with the property values from the specified instance.
float[]	toArray()
int	toPacked()
java.lang.String	toString() Gets a human-readable representation.
boolean	validate() Validates the values in this instance.
static boolean	validateColor(float r, float g, float b, float a) Validates 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 WOWZColor WHITE

Identifiers for a standard set of colors.

BLACK

public static final WOWZColor BLACK

GREY

public static final WOWZColor GREY

DARKGREY

public static final WOWZColor DARKGREY

LIGHTGREY

public static final WOWZColor LIGHTGREY

RED

public static final WOWZColor RED

GREEN

public static final WOWZColor GREEN

BLUE

public static final WOWZColor BLUE

YELLOW

public static final WOWZColor YELLOW

CYAN

public static final WOWZColor CYAN

MAGENTA

public static final WOWZColor MAGENTA

ORANGE

public static final WOWZColor ORANGE

red

public float red

green

public float green

blue

public float blue

alpha

public float alpha

Constructor Detail

WOWZColor

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

Creates and initializes an instance using the specified property values.

Parameters:

r - The red component.

g - The green component.

b - The blue component.

a - The alpha component.

WOWZColor

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

Creates and initializes an instance using the specified property values.

Parameters:

r - The red component.

g - The green component.

b - The blue component.

WOWZColor

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

Creates and initializes an instance using the specified property values.

Parameters:

r - The red component.

g - The green component.

b - The blue component.

a - The alpha component.

WOWZColor

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

Creates and initializes an instance using the specified property values.

Parameters:

r - The red component.

g - The green component.

b - The blue component.

WOWZColor

public WOWZColor()

Creates and initializes a white, fully opaque instance.

WOWZColor

public WOWZColor(WOWZColor other)

Creates and initializes an instance using the property values from the specified instance.

Parameters:

other - The instance to use.

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 WOWZColor fromPacked(int packedColor)

Converts a packed color into a WOWZColor.

Parameters:

packedColor - The packed color.

Returns:

A new WOWZColor instance.

validateColor

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

Validates 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(WOWZColor other)

Updates the property values of this instance with the property values from the specified instance.

Parameters:

other - The instance with the property values to use.

set

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

Sets the values of this instance using the specified property values.

Parameters:

r - The red component.

g - The green component.

b - The blue component.

a - The alpha component.

set

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

Sets the values of this instance using the specified property values.

Parameters:

r - The red component.

g - The green component.

b - The blue component.

set

public void set(int packedColor)

Sets 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()

Validates the values in this instance.

Returns:

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

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

Returns:

True if this instance equals the specified instance.

toString

public java.lang.String toString()

Gets a human-readable representation.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this instance.

compareTo

public int compareTo(WOWZColor other)

Compares this instance to another.

Specified by:

compareTo in interface java.lang.Comparable<WOWZColor>

Parameters:

other - The instance for comparison.

Returns:

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