GuiSwatchButtonCtrl
A button that is used to represent color; often used in correlation with a color picker.
Public Attributes
LinearColorF
The foreground color of GuiSwatchButtonCtrl.
string
The bitmap used for the transparent grid.
Public Functions
void
setColor(string newColor)
Set the color of the swatch control.
Detailed Description
A button that is used to represent color; often used in correlation with a color picker.
A swatch button is a push button that uses its color field to designate the color drawn over an image, on top of a button.
The color itself is a float value stored inside the GuiSwatchButtonCtrl::color field. The texture path that represents the image underlying the color is stored inside the GuiSwatchButtonCtrl::gridBitmap field. The default value assigned toGuiSwatchButtonCtrl::color is "1 1 1 1"( White ). The default/fallback image assigned to GuiSwatchButtonCtrl::gridBitmap is "tools/gui/images/transp_grid".
// Create a GuiSwatchButtonCtrl that calls randomFunction with its current color when clicked %swatchButton = new GuiSwatchButtonCtrl() { profile = "GuiInspectorSwatchButtonProfile"; command = "randomFunction( $ThisControl.color );"; };
Public Attributes
LinearColorF color
The foreground color of GuiSwatchButtonCtrl.
string gridBitmap
The bitmap used for the transparent grid.
Public Functions
setColor(string newColor)
Set the color of the swatch control.
Parameters:
| newColor | The new color string given to the swatch control in float format "r g b a". |
note:It's also important to note that when setColor is called causes the control's altCommand field to be executed.