vmm3d.core

Class VariableParam

java.lang.Object

vmm3d.core.Parameter

vmm3d.core.RealParam

vmm3d.core.VariableParam

Direct Known Subclasses:

VariableParamAnimateable

public class VariableParam
extends RealParam

A real-valued parameter whose value is also the value of a Variable, as defined in the class Variable. When the value of the parameter is changed, the value of the variable is changed to match, and vice-versa. Parameters of this type are mostly for use in user-defined objects. The name of a VariableParam is shared with the associated variable and therefor should probably be of human-readable form, such as "a" or "b".

Constructor Summary

Constructors

Constructor and Description
VariableParam() Creates a VariableParam that initially has no name and has value and default value equal to 0.
VariableParam(java.lang.String name, double initialValue) Create a VariableParam with a specified name and initial value.
VariableParam(java.lang.String name, java.lang.String value) Create a VariableParam with a specified name and initial value, where the initial value is given as a string.
VariableParam(Variable v) Create a VariableParam that will share the value of the specified variable.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getValueObject() Get the value object of this parameter.
Variable	getVariable() Returns the non-null variable associated with this VariableParam.
void	setName(java.lang.String name) Sets the name of this parameter and of the associated variable.
void	setValueObject(java.lang.Object object) Sets the value of this parameter and of the associated variable.

Methods inherited from class vmm3d.core.RealParam

getDefaultValue, getMaximumValueForInput, getMinimumValueForInput, getValue, reset, setDefaultValue, setMaximumValueForInput, setMinimumValueForInput, setValue, setValueAndDefault

Methods inherited from class vmm3d.core.Parameter

createParameterInput, getDefaultValueAsString, getDefaultValueObject, getHint, getName, getOwner, getTitle, getValueAsString, reset, setDefaultValueFromString, setDefaultValueObject, setOwner, setValueAndDefaultFromString, setValueFromString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableParam

public VariableParam()

Creates a VariableParam that initially has no name and has value and default value equal to 0.

VariableParam

public VariableParam(java.lang.String name,
                     double initialValue)

Create a VariableParam with a specified name and initial value. A variable of the same name is created that will share the value of this parameter. The variable can be retrieved with the getVariable() method.

Parameters:

name - The name of the Parameter, which can be null but ordinarily should not be. The name shoud identify the Parameter uniquely among parameters associated with a given Parameterizeable object. The name is for internal use in VMM. A human-readable name is returned by Parameter.getTitle(). The name also becomes the name of the associated variable.

initialValue - The initial value of the parameter. This also becomes its default value.

VariableParam

public VariableParam(java.lang.String name,
                     java.lang.String value)
              throws java.lang.NumberFormatException

Create a VariableParam with a specified name and initial value, where the initial value is given as a string. A variable of the same name is created that will share the value of this parameter. The variable can be retrieved with the getVariable() method.

Parameters:

name - The name of the Parameter.

value - The initial value of the parameter, given as a constant expression that represents a legal value of type double. If this is not the case, a NumberFormatException is thrown. This also becomes its default value.

Throws:

java.lang.NumberFormatException

VariableParam

public VariableParam(Variable v)

Create a VariableParam that will share the value of the specified variable. The parameter's name and initial value are copied from the variable.

Parameters:

v - the non-null variable that will be associated with the VariableParam

Method Detail

setName

public void setName(java.lang.String name)

Sets the name of this parameter and of the associated variable.

Overrides:

setName in class Parameter

setValueObject

public void setValueObject(java.lang.Object object)

Sets the value of this parameter and of the associated variable.

Overrides:

setValueObject in class Parameter

Parameters:

object - The new value of this parameter. The value is set without checking whether the value is of the correct type for this parameter. A type-cast error might result at some later time. Subclasses might override this method to guarantee that the object is of the correct type.

getValueObject

public java.lang.Object getValueObject()

Get the value object of this parameter. This is overriden here so that when the value object is requested, the value of the associated variable is checked. If the value of the variable is different from the value object, then the value object is first reset to match the variable's value. This makes it possible for the apparent values of the parameter and of the variable to be kept in sync when the variable's value is set using the variable's setVal method.

Overrides:

getValueObject in class Parameter

getVariable

public Variable getVariable()

Returns the non-null variable associated with this VariableParam.