Numeric Controls

There are three kinds of numeric controls available:

Numeric Edit Box with Slider—standard XSI numeric parameter control.

RGB Color Control—standard XSI color parameter control without the alpha channel.

RGBA Color Control—standard XSI color parameter control including the alpha channel.

The user can change the values that appear in these controls directly, but they can also be changed dynamically through Logic (see Dynamically Changing Custom Properties).

Numeric Edit Box with Slider

 

Standard numeric controls display a numeric edit box and optional slider along with an optional animation divot and an optional label. They are associated to an underlying parameter of any numeric type.

 

To provide a valid value range for your slider, use the Parameter.Min and Parameter.Max properties when you create the parameter.

You create them using the PPGLayout.AddItem method (the siControlNumber is the default for numeric parameters).

 

To get a sense of the full range of configuring numbers in the layout, check out the Number Control example for the PPGLayout object.

The following item attributes are available:

Available on all Controls also as a property on the PPGItem object:

Common to many Controls:

Specific to the Standard Numeric control:

siUILabel

siUIItems

siUIType

siUIWidthPercentage

siUILabelPercentage

siUILabelMinPixels

siUINoLabel

siUIValueOnly

siUIContinue

siUICX

siUICY

siUISyncSlider

siUILogarithmic

siUIDecimals

siUINoSlider

siUIThumbWheel

siUITreadmill

RGB Color Control

 

RGB Color controls display a preview pane, the RGB/HLS/HSV toggle button, a numerical edit box and a color slider along with an optional animation divot and an optional label. They are associated to three underlying Float or Double parameters.

 

To provide a valid value range for your slider, use the Parameter.Min and Parameter.Max properties when you create each parameter.

You create them using the PPGLayout.AddColor method (RGB is the default for type of color control).

 

You can also use the PPGLayout.AddItem method with the siControlRGB control type enum, but the PPGLayout.AddColor method is a little more convenient.

The following item attributes are available:

Available on all Controls also as a property on the PPGItem object:

Common to many Controls:

siUILabel

siUIItems

siUIType

siUIWidthPercentage

siUILabelPercentage

siUILabelMinPixels

siUINoLabel

siUIValueOnly

siUIContinue

RGBA Color Control

 

RGBA Color controls display a preview pane, the RGB/HLS/HSV toggle button, a numerical edit box and a color slider along with an optional animation divot and an optional label. They are associated to four underlying Float or Double parameters.

 

To provide a valid value range for your slider, use the Parameter.Min and Parameter.Max properties when you create each parameter.

You create them using the PPGLayout.AddColor method with the Alpha parameter set to true.

 

You can also use the PPGLayout.AddItem method with the siControlRGBA control type enum, but the PPGLayout.AddColor method is a little more convenient.

The following item attributes are available:

Available on all Controls also as a property on the PPGItem object:

Common to many Controls:

siUILabel

siUIItems

siUIType

siUIWidthPercentage

siUILabelPercentage

siUILabelMinPixels

siUINoLabel

siUIValueOnly

siUIContinue



SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index