Component Prototype

Description

Represent a 3D GUI Button component. This component allows the user to interact with the interface by pressing and releasing it. The output of the button shows the current status of the button ("clicked" or "not clicked"). The two background images are configurable as well as position and dimension of the button.

In-slots

Name

Type

Description

visible***

boolean

The component is shown when true and hidden when false.

transformation***

matrix

This transformation matrix is applied to the component geometry when shown

releaseButton

boolean

Releases the button status.

Out-slots

Name

Type

Description

visible***

boolean

The in-slot is propagated to the out-slot

transformation***

matrix

This transformation matrix corresponds to the output transformation, which combines input transformation with the offset.

clicked

boolean

Reflects the state of the button. True when clicked and false when released.

Properties

Name

Type

Description

iconFileName*

string

The filename of the icon shown for the component in the authoring environment.

offset***

matrix

The offset transformation matrix between the transformation given by the in-slot and the geometry model

size

double

Defines the dimension of the objet (default value, 80.0)

releasedImageFileName

string

Filename of the background image shown when released

toggledImageFileName

string

Filename of the background image shown when toggled

doubleState

boolean

True when the button is a doubleState button