A checkbutton item is used to place a press button on the rollout that has two states, on and off, just like a check box. The user can click to successively switch between states. The syntax is:
checkbutton <name> [ <caption> ] [ highlightColor:<color> ] \
[ toolTip:<string> ] \
[ checked:<boolean> ] \
[ images:<image_spec_array> ]
The default alignment of checkbutton items is #center.
Example
checkbutton setup "Setup" checked:true tooltip:"Opens setup panels"
on setup changed state do
if state == on
then openRollout setup_pan
else closeRollout setup_pan
Parameters
checked:
Initial state of the check button, defaults to off.
highlightColor:
The background color of the check button in its pressed (or on) state, defaults to a light-gray wash in keeping with 3ds max user-interface conventions.
toolTip:
Provides text for a tooltip for the check button; no tooltip if unsupplied.
images:
An image-specification array for providing bitmap images for the check button. If this is specified, the <label> is ignored and the contents of the check button are replaced with the bitmaps. The form is:
images:#(<image>, <maskImage>, <count_integer>, \
<enabled_out_image_index>, <enabled_in_image_index>, \
<disabled_out_image_index>, <disabled_in_image_index>)
where <image> and <maskImage> can be either a bitmap file-name string or a MAXScript bitmap value. <count_integer> specifies the number of sub-images in the bitmaps, and the image_index values specify which sub-image in the bitmaps is to be used for each of the four check button states. For example:
bm1 = render camera:$cam01 outputSize:[80,60]
...
checkbutton foo images:#(bm1, undefined, 1, 1, 1, 1, 1)
would use a rendering as the check button image, and
checkbutton decay images:#("dcybtns.bmp", "dcymask.bmp", 6, 1, 4, 1, 4)
would use sub-images 1 and 4 of bitmaps dcybtns.bmp and dcymask.bmp for the out and in states of the check button, respectively.
See also Image Buttons.
Properties
<checkbutton>.checked Boolean
The state of the check button, on (true) or off (false).
<checkbutton>.state Boolean
Synonym for .checked
<checkbutton>.images Array
Sets the image-specification array for the check button. For example:
-- re-render, update button
bm1 = render()
foo.images = #(bm1, undefined, 1, 1, 1, 1, 1)
This property is write-only.
Events
on <checkbutton> changed <arg> do <expr>
Called when the user clicks the check button to change its state; the <arg> argument contains the new state of the check button, on (true) or off (false).
See also
Rollout User-Interface Items Common Properties