Regular API function

simGetUIEventButton
remote API equivalent: simxGetUIEventButton
RosPlugin API equivalent: simRosGetUIEventButton

Description Gets the button handle and some auxiliary values of the last occurred event in that OpenGl-based custom UI. The function will then clear the event. When an OpenGl-based custom UI button is pressed, a slider is moved or an edit box is changed, an event is registered and stored in the OpenGl-based custom UI. See also the sim_message_ui_button_state_change message.
C synopsis simInt simGetUIEventButton(simInt uiHandle,simInt* auxiliaryValues)
C parameters
uiHandle: OpenGl-based custom UI handle
auxiliaryValues: 2 values (can be NULL).
value1: the button property
value2: for sliders: slider state (0-1000), for stay down buttons: down state (0 or 1), for up/down event buttons: up/down events (0 or 1)
C return value
button handle or -1 if no event occurred or if operation was not successful
Lua synopsis number buttonHandle, table_2 auxiliaryValues=simGetUIEventButton(number uiHandle)
Lua parameters
uiHandle: OpenGl-based custom UI handle
Lua return values
buttonHandle: button handle or -1 if no event occurred or if operation was not successful
auxiliaryValues: 2 values. Same as for the C-function. See also the boolean operators in Lua.

All regular API functions on one page