kinetic.util
Class EffectParameter

java.lang.Object
  |
  +--kinetic.util.EffectParameter

Direct Known Subclasses:

EffectParameter.Boolean, EffectParameter.BoundedDouble, EffectParameter.BoundedInteger, EffectParameter.Double, EffectParameter.EnumeratedString, EffectParameter.Integer, EffectParameter.Percentage, EffectParameter.String, EffectParameter.ZeroToOne

public abstract class EffectParameter

extends java.lang.Object

base class for effect paramter types

Nested Class Summary

static class	EffectParameter.Boolean Boolean Parameter Class
static class	EffectParameter.BoundedDouble Bounded Double Parameter Class
static class	EffectParameter.BoundedInteger Bounded Integer Parameter Class
static class	EffectParameter.Double Unbouned Double Parameter Type Class
static class	EffectParameter.EnumeratedString Enumerated String Parameter Class
static class	EffectParameter.Integer Unbounded Integer Parameter Class
static class	EffectParameter.Percentage Bounded [0.0-100.0] Double Parameter Class
static class	EffectParameter.String Unrestricted String Parameter Class
static class	EffectParameter.ZeroToOne Bounded [0.0-1.0] Double Parameter Class

Field Summary

java.lang.Object	currentValue current value of the effect parameter
java.lang.Object	defaultValue default value of the effect parameter
java.lang.String	name name of this Effect Parameter
int	type used to indicate what variable this parameter uses
static int	TYPE_BOOLEAN Boolean Type
static int	TYPE_BOUNDED_DOUBLE Generic bounded double type
static int	TYPE_BOUNDED_INTEGER Generic bounded interger type
static int	TYPE_DOUBLE Double type
static int	TYPE_ENUMERATED_STRING enumerated string type
static int	TYPE_INTEGER Integer Type
static int	TYPE_PERCENTAGE Double type bounded between 0 and 100
static int	TYPE_STRING String Type
static int	TYPE_UNKNOWN Unknown type
static int	TYPE_ZERO_TO_ONE Double value bounded between 0 and 1

Constructor Summary

EffectParameter(java.lang.String n, int t, java.lang.Object d, java.lang.Object c)
Creates a new instance of EffectParameter

Method Summary

java.lang.Object	getCurrentObject() gets the current value object for this parameter
java.lang.Object	getDefaultObject() return the default value object
java.lang.String	getName() get the name of this parameter
int	getType() get the value type integer for this parameter
void	setCurrentObject(java.lang.Object v) sets the current value object for this parameter
void	setDefaultObject(java.lang.Object v) sets the default value object for this parameter
void	setName(java.lang.String n) sets the name of this parameter
void	setType(int t) sets the value type integer for this parameter

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

name of this Effect Parameter

type

public int type

used to indicate what variable this parameter uses

defaultValue

public java.lang.Object defaultValue

default value of the effect parameter

currentValue

public java.lang.Object currentValue

current value of the effect parameter

TYPE_UNKNOWN

public static final int TYPE_UNKNOWN

Unknown type

See Also:

Constant Field Values

TYPE_DOUBLE

public static final int TYPE_DOUBLE

Double type

See Also:

Constant Field Values

TYPE_INTEGER

public static final int TYPE_INTEGER

Integer Type

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

String Type

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

Boolean Type

See Also:

Constant Field Values

TYPE_ZERO_TO_ONE

public static final int TYPE_ZERO_TO_ONE

Double value bounded between 0 and 1

See Also:

Constant Field Values

TYPE_PERCENTAGE

public static final int TYPE_PERCENTAGE

Double type bounded between 0 and 100

See Also:

Constant Field Values

TYPE_BOUNDED_DOUBLE

public static final int TYPE_BOUNDED_DOUBLE

Generic bounded double type

See Also:

Constant Field Values

TYPE_BOUNDED_INTEGER

public static final int TYPE_BOUNDED_INTEGER

Generic bounded interger type

See Also:

Constant Field Values

TYPE_ENUMERATED_STRING

public static final int TYPE_ENUMERATED_STRING

enumerated string type

See Also:

Constant Field Values

Constructor Detail

EffectParameter

public EffectParameter(java.lang.String n,
                       int t,
                       java.lang.Object d,
                       java.lang.Object c)

Creates a new instance of EffectParameter

Parameters:

n - name for this effect parameter

t - integer indicating the variable type of this effect parameter

d - object representing the default value for this parameter

c - object representing the current value for this parameter

Method Detail

getDefaultObject

public java.lang.Object getDefaultObject()

return the default value object

Returns:

default value object for this parameter

setDefaultObject

public void setDefaultObject(java.lang.Object v)

sets the default value object for this parameter

Parameters:

v - default value object for this parameter

getCurrentObject

public java.lang.Object getCurrentObject()

gets the current value object for this parameter

Returns:

current value object

setCurrentObject

public void setCurrentObject(java.lang.Object v)

sets the current value object for this parameter

Parameters:

v - a new value object

getType

public int getType()

get the value type integer for this parameter

Returns:

type integer

setType

public void setType(int t)

sets the value type integer for this parameter

Parameters:

t - new type integer

getName

public java.lang.String getName()

get the name of this parameter

Returns:

the name of this parameter

setName

public void setName(java.lang.String n)

sets the name of this parameter

Parameters:

n - new name