Regular API function

remote API equivalent: simxLoadUI
RosPlugin API equivalent: simRosLoadUI

Description Loads a previously saved OpenGl-based custom UI file (*.ttb-files). See also simSaveUI, simLoadModel, simLoadScene, and simSetBoolParameter with sim_boolparam_scene_and_model_load_messages. When interacting with a UI from an add-on, you might have to add the property flag sim_ui_property_pauseactive to the UI, in order to also have it respond while simulation is paused.
C synopsis simInt simLoadUI(const simChar* filename,int maxCount,int* uiHandles)
C parameters
filename: UI filename. The filename extension is required ("ttb")
maxCount: the maximum number of items that the uiHandles pointer can hold
uiHandles: a pointer to integer values that will receive the handles of the loaded UIs (a single UI file can hold an unlimited number of UI elements)
C return value
-1 if operation was not successful, otherwise the number of UI elements loaded.
Lua synopsis table handles=simLoadUI(string filename)
Lua parameters
Same as C-function
Lua return values
handles: a table containing the handles of all loaded UI elements, or nil in case of an error

All regular API functions on one page