Button

A button item is used to place a press button on the rollout which the user can click, typically to have some task performed. The syntax is:

button <name> [ <caption> ] [ images:<image_spec_array> ] \

              [ toolTip:<string> ]

The default alignment of button items is #center.

Example

button clone "Create Clones"

on clone pressed do ...

Parameters

images:

An image-specification array for providing bitmap images for the button. If this is specified, the <label> is ignored and the contents of the 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 button states. For example:

bm1 = render camera:$cam01 outputSize:[80,60].

...

button foo images:#(bm1, undefined, 1, 1, 1, 1, 1)

would use the rendered image as the button image, and

button 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 button, respectively.

See also Image Buttons.

toolTip:

Provides text for a tooltip for the button; no tooltip if unsupplied.

Properties

<button>.images              Array

Sets the image-specification array for the 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 <button> pressed do <expr>

Called when the user clicks the button.

See also