systems.ora.client

Class Halo

java.lang.Object

systems.ora.client.Halo

public class Halo
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private int	appId
private double	brightness
private double	color
private double	complexity
private int	id
private double	size
private double	speed
private double	wobble

Constructor Summary

Constructors

Constructor and Description
Halo(int iAppId) Create an empty halo object.
Halo(int iAppId, double iSize, double iColor, double iComplexity, double iSpeed, double iBrightness, double iWobble) Create a halo object with all settings pre-set.

Method Summary

Modifier and Type	Method and Description
double	getBrightness()
double	getColor()
double	getComplexity()
int	getId()
double	getSize()
double	getSpeed()
double	getWobble()
void	setBrightness(double b)
void	setColor(double c)
void	setComplexity(double c)
void	setId(int haloId)
void	setSize(double s)
void	setSpeed(double s)
void	setWobble(double w)
String	toString() Provides a displayable string of halo information.
private void	validate(double val)

Methods inherited from class java.lang.Object

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

Field Detail

appId

private int appId

id

private int id

size

private double size

complexity

private double complexity

brightness

private double brightness

wobble

private double wobble

color

private double color

speed

private double speed

Constructor Detail

Halo

public Halo(int iAppId)

Create an empty halo object.

Parameters:

iAppId - The appplication id.

Halo

public Halo(int iAppId,
            double iSize,
            double iColor,
            double iComplexity,
            double iSpeed,
            double iBrightness,
            double iWobble)
     throws InvalidParameterException

Create a halo object with all settings pre-set.

Parameters:

iAppId - The applicaation id.

iSize - The size value (0-1)

iColor - The color value (0-1)

iComplexity - The complexity value

iSpeed - The speed value

iBrightness - The brightness value

iWobble - The wobble value

Throws:

InvalidParameterException

Method Detail

toString

public String toString()

Provides a displayable string of halo information.

Overrides:

toString in class Object

getId

public int getId()

Returns:

id

getSize

public double getSize()

Returns:

size value (0-1)

getColor

public double getColor()

Returns:

color value (0-1)

getComplexity

public double getComplexity()

Returns:

complexity value (0-1)

getSpeed

public double getSpeed()

Returns:

speed value (0-1)

getBrightness

public double getBrightness()

Returns:

brightness value (0-1)

getWobble

public double getWobble()

Returns:

wobble value (0-1)

setId

public void setId(int haloId)

Parameters:

haloId - halo id. Changing this will store it under a new id, and is not recommended.

setSize

public void setSize(double s)
             throws InvalidParameterException

Parameters:

s - size value (0-1)

Throws:

InvalidParameterException

setColor

public void setColor(double c)
              throws InvalidParameterException

Parameters:

c - color value (0-1)

Throws:

InvalidParameterException

setComplexity

public void setComplexity(double c)
                   throws InvalidParameterException

Parameters:

c - complexity value (0-1)

Throws:

InvalidParameterException

setSpeed

public void setSpeed(double s)
              throws InvalidParameterException

Parameters:

s - speed value (0-1)

Throws:

InvalidParameterException

setBrightness

public void setBrightness(double b)
                   throws InvalidParameterException

Parameters:

b - brightness value (0-1)

Throws:

InvalidParameterException

setWobble

public void setWobble(double w)
               throws InvalidParameterException

Parameters:

w - wobble value (0-1)

Throws:

InvalidParameterException

validate

private void validate(double val)
               throws InvalidParameterException

Parameters:

val - any value to verify as being within the correct range.

Throws:

InvalidParameterException