class Parameter
A native object that represents a GUI parameter.
GUI parameters are defined in a jml file and can be attached to any GUI control. The control is notified about a change of it's parameters and can display or set it's value.
Methods
ClearDirty () | Clears the parameter's dirty state to prevent a value change from updating other controls. |
ClearDirty (NativeControl) | Clear the dirty state, specifying which control is the origin of the action. |
float GetDiscreteSteps () | Returns the parameter's step property, as defined in the jml file where the parameter was defined. |
string GetDisplayFormat () | Returns the parameter's display format string, which is a C-runtime format string used to present the parameter value on the screen. |
string GetDisplayName () | Returns the parameter's display name, which is, a user friendly name that can be displayed in the GUI. |
string GetName () | Returns the parameter's name property as defined in the jml file where this parameter was defined. |
int GetStorageCaps (int) | Returns the parameter's storage capabilities, as defined in the jml file where the parameter was defined. |
string GetType () | Returns the parameter's type. |
string GetUnitString () | Returns the parameter's unit property, as defined in the jml file where the parameter was defined. |
int GetUserIndex (int) | Returns the parameter's user index. |
float GetValueMax () | Gets the maximum value that this parameter will accept. |
float GetValueMin () | Gets the minimum value that this parameter will accept. |
int IsDirty () | Returns true if the parameter's value has been modified. |
SetDirty () | Sets the parameter to dirty state without changing it's value, to force updating all controls that use this parameter. |
SetDirty (NativeControl) | Sets the parameter to dirty, specifying the control which originated the SetDirty() call. |
SetDiscreteSteps (const float) | Sets the parameter's number of discrete steps. |
SetDisplayFormat (const string) | Sets the parameter's display format property. |
SetDisplayName (const string) | Sets the parameter's display name property. |
SetUnitString (const string) | Sets the parameter's unit property. |
SetUserIndex (const int) | Sets the parameter's user index property. |
SetValueRange (const float, const float) | Sets the parameter's value range in natural numbers. |
Properties
float FloatValue () | Returns the parameter's current value as a natural float number. |
FloatValue (const float) | Sets the parameter's value from a natural float number. |
float Normalized () | Returns the parameter's current value as normalized float (range 0.0 ~ 1.0). |
Normalized (const float) | Sets the parameter's value from a normalized float. |
string StringValue () | Returns the parameter's current value as a string. |
StringValue (const string) | Sets the parameter's value from a string. |
Reference
method ClearDirty () |
Clears the parameter's dirty state to prevent a value change from updating other controls. In newer versions of the framework this method is pointless, since all controls attached to a parameter will be notified about a change immediately. There is no scheduling of updates towards controls anymore. |
method ClearDirty (NativeControl) |
Clear the dirty state, specifying which control is the origin of the action. In newer versions of the framework this method is pointless, since all controls attached to a parameter will be notified about a change immediately. There is no scheduling of updates towards controls anymore. |
method float GetDiscreteSteps () |
Returns the parameter's step property, as defined in the jml file where the parameter was defined. |
method string GetDisplayFormat () |
Returns the parameter's display format string, which is a C-runtime format string used to present the parameter value on the screen. If a Scaler is attached to the parameter, it can override the way the parameter value is formatted for display. |
method string GetDisplayName () |
Returns the parameter's display name, which is, a user friendly name that can be displayed in the GUI. |
method string GetName () |
Returns the parameter's name property as defined in the jml file where this parameter was defined. Unlike the display name, this name is kept private (not shown to the user) and used to reference the parameter in scripting or jml node addressing. |
method int GetStorageCaps (int follow) |
Returns the parameter's storage capabilities, as defined in the jml file where the parameter was defined. If follow is true, any links to other parameters are followed and the capabilities of the target parameter is returned instead. |
method string GetType () |
Returns the parameter's type. This can be for example 'float' or 'string'. Float parameters can only store numeric values, string based parameters can store any text. Since the parameter interface is not restricted to these two types, this could return also other types of parameters. |
method string GetUnitString () |
Returns the parameter's unit property, as defined in the jml file where the parameter was defined. |
method int GetUserIndex (int follow) |
Returns the parameter's user index. If follow is true, any links to other parameters are followed and the linked target's index is returned. Otherwise the parameter's own index is returned. |
method float GetValueMax () |
Gets the maximum value that this parameter will accept. This corresponds to the parameter's natural value. The normalized value is always in range 0.0 ~ 1.0. |
method float GetValueMin () |
Gets the minimum value that this parameter will accept. This corresponds to the parameter's natural value. The normalized value is always in range 0.0 ~ 1.0. |
method int IsDirty () |
Returns true if the parameter's value has been modified. In newer versions of the framework this method is pointless, since all controls attached to a parameter will be notified about a change immediately. There is no scheduling of updates towards controls anymore, and the controls decide whether or not they need redrawing due to this parameter change. |
method SetDirty () |
Sets the parameter to dirty state without changing it's value, to force updating all controls that use this parameter. In newer versions of the framework calling this will immediately notify all controls attached to this parameter (they will get a call to Control::ParameterChanged), rather than just setting a dirty state. |
method SetDirty (NativeControl) |
Sets the parameter to dirty, specifying the control which originated the SetDirty() call. The origin will be excluded and not notified about the parameter change. |
method SetDiscreteSteps (const float) |
Sets the parameter's number of discrete steps. |
method SetDisplayFormat (const string) |
Sets the parameter's display format property. |
method SetDisplayName (const string) |
Sets the parameter's display name property. |
method SetUnitString (const string) |
Sets the parameter's unit property. |
method SetUserIndex (const int) |
Sets the parameter's user index property. |
method SetValueRange (const float, const float) |
Sets the parameter's value range in natural numbers. |
accessor float FloatValue () |
Returns the parameter's current value as a natural float number. Natural float numbers are usually the format used to display the value to the user. |
accessor FloatValue (const float) |
Sets the parameter's value from a natural float number. |
accessor float Normalized () |
Returns the parameter's current value as normalized float (range 0.0 ~ 1.0). Normalized float numbers are usually the format in which parameter values are stored, or processed by GUI controls. |
accessor Normalized (const float) |
Sets the parameter's value from a normalized float. |
accessor string StringValue () |
Returns the parameter's current value as a string. If the parameter has a Scaler attached to it, the scaler can define how a string representation of the parameter value is formatted. |
accessor StringValue (const string) |
Sets the parameter's value from a string. |