CoppeliaSim 4.3.0 User Manual - CoppeliaSim 4.3.0 使用者手冊

  • Home
    • Site Map
    • reveal
    • blog
  • welcome
  • userInterface
    • pagesAndViews
    • coordinateDialog
    • positionDialog
    • orientationDialog
    • objectMovement
    • positionOrientationTransformation
    • settings
    • shortcuts
  • scenesAndModels
    • scenes
    • models
    • modelDialog
  • environment
    • environmentPropertiesDialog
    • textureDialog
  • entities
    • collections
    • objects
      • sceneObjectPropertiesDialog
      • commonPropertiesDialog
    • collidableObjects
    • measurableObjects
    • detectableObjects
    • viewableObjects
    • convexHull
    • layerSelectionDialog
      • cameras
      • cameraPropertiesDialog
      • lights
      • lightPropertiesDialog
      • shapes
      • shapeReferenceFrames
      • primitiveShapes
      • convexDecomposition
      • shapeProperties
      • shapeDynamicsProperties
      • shapeDynamicEngineProperties
      • geometryDialog
      • shapeEditModes
      • triangleEditMode
      • vertexEditMode
      • edgeEditMode
      • groupedShapeEditMode
      • joints
      • jointModes
      • jointProperties
      • jointDynamicsProperties
      • jointDynamicEngineProperties
      • dummies
      • dummyPropertiesDialog
      • graphs
      • graphPropertiesDialog
      • proximitySensors
      • proximitySensorDescription
      • proximitySensorPropertiesDialog
      • proximitySensorVolumeDialog
      • proximitySensorDetectionParameterDialog
      • visionSensors
      • visionSensorDescription
      • visionSensorPropertiesDialog
      • forceSensors
      • forceSensorPropertiesDialog
      • octrees
      • octreePropertiesDialog
      • pointClouds
      • pointCloudPropertiesDialog
    • paths
  • functionality
    • geometricCalculations
    • collisionDetection
    • distanceCalculation
      • geometricPlugin
      • simGeom API
      • coppeliaGeometricRoutines
      • CoppeliaGeometricRoutinesAPI
    • IGLPluginAPIreference
    • kinematics
    • basicsOnIkGroupsAndIkElements
    • solvingIkAndFk
      • kinematicsPlugin
      • simIKAPI
      • coppeliaKinematicsRoutines
      • CoppeliaKinematicsRoutinesAPI
    • dynamicsModule
    • designingDynamicSimulations
      • dynamicsDialog
      • dynamicsEngineDialog
    • dataVisualizationAndOutput
    • externalFrontEnd
    • dataTransformation
    • meansOfCommunication
      • remoteApiOverview
      • zmqRemoteApiOverview
      • wsRemoteApiOverview
      • rosInterfaces
      • rosInterf
      • ROSPluginAPIreference
      • ros2Interface
      • ROS2PluginAPIreference
    • ZMQPluginAPIreference
    • WSPluginAPIreference
    • pathsAndTrajectories
    • pathAndMotionPlanningModules
    • OMPLPluginAPIreference
    • syntheticVision
    • IMPluginAPIreference
    • simVisionAPI
    • customUIPlugin
    • UIPluginAPIreference
    • simUI-widgets
    • QMLPluginAPIreference
    • importExport
    • xmlFormat
      • urdfPlugin
      • APIFunctions
      • sdfPlugin
      • SDFPluginAPIreference
    • aviRecorder
    • AssimpPluginAPIreference
    • GLTFPluginAPIreference
      • commandLine
      • LuaCmdPluginAPIreference
      • miscellaneousFunctionality
      • SurfRecPluginAPIreference
      • ICPPluginAPIreference
      • SubprocessPluginAPIreference
  • writingCode
    • scripts
      • embeddedScripts
      • simulationScripts
      • mainScript
      • childScripts
      • customizationScripts
      • scriptProperties
      • scriptEditor
    • addOns
    • sandboxScript
    • scriptExecution
    • threadedAndNonThreadedCode
      • callbackFunctions
      • dynCallbackFunctions
      • jointCallbackFunctions
      • contactCallbackFunction
      • visionCallbackFunctions
      • triggerCallbackFunctions
      • userConfigCallbackFunctions
    • luaPythonDifferences
    • luaCrashCourse
    • plugins
    • mainClientApplication
    • accessingSceneObjects
    • explicitHandling
    • apisOverview
      • apiFunctions
      • apiConstants
      • objectParameterIDs
  • simulation
    • simulationPropertiesDialog
  • tutorials
    • bubbleRobTutorial
    • buildingAModelTutorial
    • lineFollowingBubbleRobTutorial
    • inverseKinematicsTutorial
    • externalControllerTutorial
    • pluginTutorial
    • robotLanguageIntegrationTutorial
    • rosTutorial
      • ros1Tutorial
      • ros2Tutorial
    • compilingCoppeliaSim
customUIPlugin << Previous Next >> simUI-widgets

UIPluginAPIreference

UI Plugin API reference

API functions for creating custom user interfaces.

simUI.addCurve
simUI.addCurveTimePoints
simUI.addCurveXYPoints
simUI.addScene3DNode
simUI.addTreeItem
simUI.clearCurve
simUI.clearTable
simUI.clearTree
simUI.collapseAll
simUI.colorDialog
simUI.create
simUI.destroy
simUI.expandAll
simUI.expandToDepth
simUI.fileDialog
simUI.getCheckboxValue
simUI.getColumnCount
simUI.getComboboxItemCount
simUI.getComboboxItemText
simUI.getComboboxItems
simUI.getComboboxSelectedIndex
simUI.getCurrentEditWidget
simUI.getCurrentTab
simUI.getCurveData
simUI.getEditValue
simUI.getItem
simUI.getLabelText
simUI.getPosition
simUI.getRadiobuttonValue
simUI.getRowCount
simUI.getSize
simUI.getSliderValue
simUI.getSpinboxValue
simUI.getTitle
simUI.getWidgetVisibility
simUI.growPlotRanges
simUI.growPlotXRange
simUI.growPlotYRange
simUI.hide
simUI.inputDialog
simUI.insertComboboxItem
simUI.insertTableColumn
simUI.insertTableRow
simUI.isVisible
simUI.msgBox
simUI.removeComboboxItem
simUI.removeCurve
simUI.removeScene3DNode
simUI.removeTableColumn
simUI.removeTableRow
simUI.removeTreeItem
simUI.replot
simUI.rescaleAxes
simUI.rescaleAxesAll
simUI.restoreState
simUI.saveState
simUI.setButtonPressed
simUI.setButtonText
simUI.setCheckboxValue
simUI.setColumnCount
simUI.setColumnHeaderText
simUI.setColumnWidth
simUI.setComboboxItems
simUI.setComboboxSelectedIndex
simUI.setCurrentEditWidget
simUI.setCurrentTab
simUI.setEditValue
simUI.setEnabled
simUI.setImageData
simUI.setItem
simUI.setItemEditable
simUI.setItemImage
simUI.setLabelText
simUI.setLegendVisibility
simUI.setMouseOptions
simUI.setPlotLabels
simUI.setPlotRanges
simUI.setPlotXLabel
simUI.setPlotXRange
simUI.setPlotYLabel
simUI.setPlotYRange
simUI.setPosition
simUI.setProgress
simUI.setRadiobuttonValue
simUI.setRowCount
simUI.setRowHeaderText
simUI.setRowHeight
simUI.setScene3DNodeEnabled
simUI.setScene3DNodeFloatParam
simUI.setScene3DNodeIntParam
simUI.setScene3DNodeParam
simUI.setScene3DNodeStringParam
simUI.setScene3DNodeVector2Param
simUI.setScene3DNodeVector3Param
simUI.setScene3DNodeVector4Param
simUI.setSize
simUI.setSliderValue
simUI.setSpinboxValue
simUI.setStyleSheet
simUI.setTableSelection
simUI.setText
simUI.setTitle
simUI.setTreeSelection
simUI.setUrl
simUI.setWidgetVisibility
simUI.setWindowEnabled
simUI.show
simUI.supportedImageFormats
simUI.svgLoadData
simUI.svgLoadFile
simUI.updateTreeItemParent
simUI.updateTreeItemText

simUI.addCurve
Description Adds a curve to a plot widget.
Lua synopsis simUI.addCurve(string handle, int id, int type, string name, int[3] color, int style, curve_options options)
Lua parameters
handle (string): ui handle
id (int): widget id
type (int): type of the curve. see simUI.curve_type.
name (string): name of the curve
color (table of int, size 3): color of the curve, as RGB values in the 0...255 range
style (int): style of the curve. see simUI.curve_style.
options (curve_options): data structure holding extra options. see curve_options.
Lua return values -
Python synopsis simUI.addCurve(string handle, int id, int type, string name, list color, int style, curve_options options)
See also simUI.curve_type simUI.curve_style curve_options simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.addCurveTimePoints
Description Adds time points to the specified curve of the plot widget.
Lua synopsis simUI.addCurveTimePoints(string handle, int id, string name, double[] x, double[] y)
Lua parameters
handle (string): ui handle
id (int): widget id
name (string): name of the curve
x (table of double): x values
y (table of double): y values
Lua return values -
Python synopsis simUI.addCurveTimePoints(string handle, int id, string name, list x, list y)
See also simUI.addCurve simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.addCurveXYPoints
Description Adds points to the specified curve of the plot widget.
Lua synopsis simUI.addCurveXYPoints(string handle, int id, string name, double[] t, double[] x, double[] y)
Lua parameters
handle (string): ui handle
id (int): widget id
name (string): name of the curve
t (table of double): t values (i.e. the curve parameter, used also to determine how points are connected, according to natural ordering of t)
x (table of double): x values
y (table of double): y values
Lua return values -
Python synopsis simUI.addCurveXYPoints(string handle, int id, string name, list t, list x, list y)
See also simUI.addCurve simUI.addCurveTimePoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.addScene3DNode
Description Add a node in a scene3d widget.
Lua synopsis simUI.addScene3DNode(string handle, int id, int nodeId, int parentNodeId, int type)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
parentNodeId (int): parent node id
type (int): type of the node. see simUI.scene3d_node_type
Lua return values -
Python synopsis simUI.addScene3DNode(string handle, int id, int nodeId, int parentNodeId, int type)
See also simUI.removeScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeFloatParam simUI.setScene3DNodeIntParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector3Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.addTreeItem
Description Add an item to the specified tree widget.
Lua synopsis simUI.addTreeItem(string handle, int id, int item_id, string[] text, int parent_id=0, bool expanded=false, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
item_id (int): item id
text (table of string): item text fields
parent_id (int, default: 0): parent item id (0 means a toplevel item)
expanded (bool, default: false): if true, the item will be in expanded state
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.addTreeItem(string handle, int id, int item_id, list text, int parent_id=0, bool expanded=false, bool suppressEvents=true)
See also simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.clearCurve
Description Clear points of the specified curve of the plot widget.
Lua synopsis simUI.clearCurve(string handle, int id, string name)
Lua parameters
handle (string): ui handle
id (int): widget id
name (string): name of the curve
Lua return values -
Python synopsis simUI.clearCurve(string handle, int id, string name)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.clearTable
Description Clear the specified table widget.
Lua synopsis simUI.clearTable(string handle, int id, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.clearTable(string handle, int id, bool suppressEvents=true)
See also simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.clearTree
Description Clear the specified tree widget.
Lua synopsis simUI.clearTree(string handle, int id, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.clearTree(string handle, int id, bool suppressEvents=true)
See also simUI.addTreeItem simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.collapseAll
Description Collapse all nodes in the specified tree widget.
Lua synopsis simUI.collapseAll(string handle, int id, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.collapseAll(string handle, int id, bool suppressEvents=true)
See also simUI.addTreeItem simUI.clearTree simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.colorDialog
Description Display a color dialog.
Lua synopsis float[3] result=simUI.colorDialog(float[3..4] initColor={1,1,1}, string title="Select color", bool showAlphaChannel=false, bool native=true)
Lua parameters
initColor (table of float, size 3..4, default: {1,1,1}): initial color
title (string, default: "Select color"): the title of the dialog
showAlphaChannel (bool, default: false): allow the user to select the alpha component of a color
native (bool, default: true): use OS-native file dialogs
Lua return values
result (table of float, size 3): result
Python synopsis list result=simUI.colorDialog(list initColor={1,1,1}, string title="Select color", bool showAlphaChannel=false, bool native=true)
See also


simUI.create
Description Create a window.
Lua synopsis string uiHandle=simUI.create(string xml)
Lua parameters
xml (string): xml ui definition (refer to UI plugin XML syntax)
Lua return values
uiHandle (string): a handle to the created UI
Python synopsis string uiHandle=simUI.create(string xml)
See also simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.destroy
Description Destroy a window.
Lua synopsis simUI.destroy(string handle)
Lua parameters
handle (string): ui handle
Lua return values -
Python synopsis simUI.destroy(string handle)
See also simUI.create simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.expandAll
Description Expand all nodes in the specified tree widget.
Lua synopsis simUI.expandAll(string handle, int id, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.expandAll(string handle, int id, bool suppressEvents=true)
See also simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.expandToDepth
Description Expand nodes up to a certain depth in the specified tree widget.
Lua synopsis simUI.expandToDepth(string handle, int id, int depth, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
depth (int): depth
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.expandToDepth(string handle, int id, int depth, bool suppressEvents=true)
See also simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.fileDialog
Description Display a file dialog.
Lua synopsis string[] result=simUI.fileDialog(int type, string title, string startPath, string initName, string extName, string ext, bool native=false)
Lua parameters
type (int): type
title (string): title
startPath (string): start path
initName (string): initial file name
extName (string): the name of the extension
ext (string): the actual extension
native (bool, default: false): use OS-native file dialogs
Lua return values
result (table of string): result
Python synopsis list result=simUI.fileDialog(int type, string title, string startPath, string initName, string extName, string ext, bool native=false)
See also


simUI.getCheckboxValue
Description Get the value of a checkbox widget.
Lua synopsis int value=simUI.getCheckboxValue(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
value (int): value
Python synopsis int value=simUI.getCheckboxValue(string handle, int id)
See also simUI.setCheckboxValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getColumnCount
Description Get the number of columns in the specified table/tree widget.
Lua synopsis int count=simUI.getColumnCount(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
count (int): column count
Python synopsis int count=simUI.getColumnCount(string handle, int id)
See also simUI.clearTable simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getComboboxItemCount
Description Get the number of items in the specified combobox widget.
Lua synopsis int count=simUI.getComboboxItemCount(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
count (int): Item count.
Python synopsis int count=simUI.getComboboxItemCount(string handle, int id)
See also simUI.getComboboxItemText simUI.getComboboxItems simUI.getComboboxSelectedIndex simUI.insertComboboxItem simUI.removeComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getComboboxItemText
Description Get the text of an item in a combobox widget.
Lua synopsis string text=simUI.getComboboxItemText(string handle, int id, int index)
Lua parameters
handle (string): ui handle
id (int): widget id
index (int): Item index.
Lua return values
text (string): Item text.
Python synopsis string text=simUI.getComboboxItemText(string handle, int id, int index)
See also simUI.getComboboxItemCount simUI.getComboboxItems simUI.getComboboxSelectedIndex simUI.insertComboboxItem simUI.removeComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getComboboxItems
Description Get the content of a combobox.
Lua synopsis string[] items=simUI.getComboboxItems(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
items (table of string): Array of items (strings).
Python synopsis list items=simUI.getComboboxItems(string handle, int id)
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxSelectedIndex simUI.insertComboboxItem simUI.removeComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getComboboxSelectedIndex
Description Get the selected item index in a combobox widget.
Lua synopsis int index=simUI.getComboboxSelectedIndex(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
index (int): Index of selected item after inserting all the items.
Python synopsis int index=simUI.getComboboxSelectedIndex(string handle, int id)
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems simUI.insertComboboxItem simUI.removeComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getCurrentEditWidget
Description Get the edit widget with focus and selected text.
Lua synopsis int id=simUI.getCurrentEditWidget(string handle)
Lua parameters
handle (string): ui handle
Lua return values
id (int): widget id of an edit widget, or -1 if no edit widget was focused and had selected text.
Python synopsis int id=simUI.getCurrentEditWidget(string handle)
See also simUI.getEditValue simUI.setCurrentEditWidget simUI.setEditValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getCurrentTab
Description Get the current tab index of a tabs widget.
Lua synopsis int index=simUI.getCurrentTab(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
index (int): index of the tab (zero-based)
Python synopsis int index=simUI.getCurrentTab(string handle, int id)
See also simUI.setCurrentTab simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getCurveData
Description Get the data contained in the specified curve.
Lua synopsis double[] t, double[] x, double[] y=simUI.getCurveData(string handle, int id, string name)
Lua parameters
handle (string): ui handle
id (int): widget id
name (string): name of the curve
Lua return values
t (table of double): t values (if applicable)
x (table of double): x values
y (table of double): y values
Python synopsis list t, list x, list y=simUI.getCurveData(string handle, int id, string name)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getEditValue
Description Get the value of a edit widget.
Lua synopsis string value=simUI.getEditValue(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
value (string): value
Python synopsis string value=simUI.getEditValue(string handle, int id)
See also simUI.getCurrentEditWidget simUI.setCurrentEditWidget simUI.setEditValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getItem
Description Get the table widget item text.
Lua synopsis string text=simUI.getItem(string handle, int id, int row, int column)
Lua parameters
handle (string): ui handle
id (int): widget id
row (int): row index
column (int): column index
Lua return values
text (string): item value
Python synopsis string text=simUI.getItem(string handle, int id, int row, int column)
See also simUI.clearTable simUI.getColumnCount simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getLabelText
Description Get the text of a label widget.
Lua synopsis string text=simUI.getLabelText(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
text (string): text
Python synopsis string text=simUI.getLabelText(string handle, int id)
See also simUI.setLabelText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getPosition
Description Get the position of a UI window.
Lua synopsis int x, int y=simUI.getPosition(string handle)
Lua parameters
handle (string): ui handle
Lua return values
x (int): X position
y (int): Y position
Python synopsis int x, int y=simUI.getPosition(string handle)
See also simUI.create simUI.destroy simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.getRadiobuttonValue
Description Get the value of a radiobutton widget.
Lua synopsis int value=simUI.getRadiobuttonValue(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
value (int): value
Python synopsis int value=simUI.getRadiobuttonValue(string handle, int id)
See also simUI.setRadiobuttonValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getRowCount
Description Get the table widget number of rows.
Lua synopsis int count=simUI.getRowCount(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
count (int): row count
Python synopsis int count=simUI.getRowCount(string handle, int id)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getSize
Description Get the size of a UI window.
Lua synopsis int w, int h=simUI.getSize(string handle)
Lua parameters
handle (string): ui handle
Lua return values
w (int): width
h (int): height
Python synopsis int w, int h=simUI.getSize(string handle)
See also simUI.create simUI.destroy simUI.getPosition simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.getSliderValue
Description Get the value of a slider widget.
Lua synopsis int value=simUI.getSliderValue(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
value (int): value
Python synopsis int value=simUI.getSliderValue(string handle, int id)
See also simUI.setSliderValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getSpinboxValue
Description Get the value of a spinbox widget.
Lua synopsis float value=simUI.getSpinboxValue(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
value (float): value
Python synopsis float value=simUI.getSpinboxValue(string handle, int id)
See also simUI.setSpinboxValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.getTitle
Description Get the title of a UI window.
Lua synopsis string title=simUI.getTitle(string handle)
Lua parameters
handle (string): ui handle
Lua return values
title (string): X position
Python synopsis string title=simUI.getTitle(string handle)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.getWidgetVisibility
Description Get the visibility status of a widget.
Lua synopsis bool visibility=simUI.getWidgetVisibility(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
visibility (bool): true if the window is visible, false otherwise
Python synopsis bool visibility=simUI.getWidgetVisibility(string handle, int id)
See also simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.growPlotRanges
Description Increase the ranges of the plot widget by a fixed amount.
Lua synopsis simUI.growPlotRanges(string handle, int id, double xmin, double xmax, double ymin, double ymax)
Lua parameters
handle (string): ui handle
id (int): widget id
xmin (double): minimum x range
xmax (double): maximum x range
ymin (double): minimum y range
ymax (double): maximum y range
Lua return values -
Python synopsis simUI.growPlotRanges(string handle, int id, double xmin, double xmax, double ymin, double ymax)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.growPlotXRange
Description Increase the X range of the plot widget.
Lua synopsis simUI.growPlotXRange(string handle, int id, double xmin, double xmax)
Lua parameters
handle (string): ui handle
id (int): widget id
xmin (double): minimum x range
xmax (double): maximum x range
Lua return values -
Python synopsis simUI.growPlotXRange(string handle, int id, double xmin, double xmax)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.growPlotYRange
Description Increase the Y range of the plot widget.
Lua synopsis simUI.growPlotYRange(string handle, int id, double ymin, double ymax)
Lua parameters
handle (string): ui handle
id (int): widget id
ymin (double): minimum y range
ymax (double): maximum y range
Lua return values -
Python synopsis simUI.growPlotYRange(string handle, int id, double ymin, double ymax)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.hide
Description Hide the UI window.
Lua synopsis simUI.hide(string handle)
Lua parameters
handle (string): ui handle
Lua return values -
Python synopsis simUI.hide(string handle)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.inputDialog
Description Display an input dialog.
Lua synopsis string result=simUI.inputDialog(string initValue="", string label="Input value:", string title="")
Lua parameters
initValue (string, default: ""): initial value
label (string, default: "Input value:"): label above the input field
title (string, default: ""): title of input dialog
Lua return values
result (string): result
Python synopsis string result=simUI.inputDialog(string initValue="", string label="Input value:", string title="")
See also


simUI.insertComboboxItem
Description Insert an item in a combobox widget.
Lua synopsis simUI.insertComboboxItem(string handle, int id, int index, string text, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
index (int): If the index is equal to or higher than the total number of items, the new item is appended to the list of existing items. If the index is zero or negative, the new item is prepended to the list of existing items.
text (string): Item text.
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.insertComboboxItem(string handle, int id, int index, string text, bool suppressEvents=true)
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems simUI.getComboboxSelectedIndex simUI.removeComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.insertTableColumn
Description insert a column in a table widget
Lua synopsis simUI.insertTableColumn(int ui, int widget, int index)
Lua parameters
ui (int): the ui handle
widget (int): the widget identifier
index (int): the index (0-based) where the new column will appear
Lua return values -
Python synopsis simUI.insertTableColumn(int ui, int widget, int index)
See also


simUI.insertTableRow
Description insert a row in a table widget
Lua synopsis simUI.insertTableRow(int ui, int widget, int index)
Lua parameters
ui (int): the ui handle
widget (int): the widget identifier
index (int): the index (0-based) where the new row will appear
Lua return values -
Python synopsis simUI.insertTableRow(int ui, int widget, int index)
See also


simUI.isVisible
Description Check if the window is visible.
Lua synopsis bool visibility=simUI.isVisible(string handle)
Lua parameters
handle (string): ui handle
Lua return values
visibility (bool): true if the window is visible, false otherwise
Python synopsis bool visibility=simUI.isVisible(string handle)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.msgBox
Description Display a message box.
Lua synopsis int result=simUI.msgBox(int type, int buttons, string title, string message)
Lua parameters
type (int): type
buttons (int): buttons
title (string): title
message (string): message
Lua return values
result (int): result
Python synopsis int result=simUI.msgBox(int type, int buttons, string title, string message)
See also


simUI.removeComboboxItem
Description Remove an item from a combobox widget.
Lua synopsis simUI.removeComboboxItem(string handle, int id, int index, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
index (int): Item index.
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.removeComboboxItem(string handle, int id, int index, bool suppressEvents=true)
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems simUI.getComboboxSelectedIndex simUI.insertComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.removeCurve
Description Remove the specified curve from the plot widget.
Lua synopsis simUI.removeCurve(string handle, int id, string name)
Lua parameters
handle (string): ui handle
id (int): widget id
name (string): name of the curve
Lua return values -
Python synopsis simUI.removeCurve(string handle, int id, string name)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.removeScene3DNode
Description Remove a node in a scene3d widget.
Lua synopsis simUI.removeScene3DNode(string handle, int id, int nodeId)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
Lua return values -
Python synopsis simUI.removeScene3DNode(string handle, int id, int nodeId)
See also simUI.addScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeFloatParam simUI.setScene3DNodeIntParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector3Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.removeTableColumn
Description remove a column from a table widget
Lua synopsis simUI.removeTableColumn(int ui, int widget, int index)
Lua parameters
ui (int): the ui handle
widget (int): the widget identifier
index (int): the column index (0-based) to remove
Lua return values -
Python synopsis simUI.removeTableColumn(int ui, int widget, int index)
See also


simUI.removeTableRow
Description remove a row from a table widget
Lua synopsis simUI.removeTableRow(int ui, int widget, int index)
Lua parameters
ui (int): the ui handle
widget (int): the widget identifier
index (int): the row index (0-based) to remove
Lua return values -
Python synopsis simUI.removeTableRow(int ui, int widget, int index)
See also


simUI.removeTreeItem
Description Remove an item from the specified tree widget.
Lua synopsis simUI.removeTreeItem(string handle, int id, int item_id, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
item_id (int): item id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.removeTreeItem(string handle, int id, int item_id, bool suppressEvents=true)
See also simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.replot
Description Refresh all the plots of a plot widget.
Lua synopsis simUI.replot(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values -
Python synopsis simUI.replot(string handle, int id)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.rescaleAxes
Description Rescales the axes such that the specified curve in the plot is fully visible.
Lua synopsis simUI.rescaleAxes(string handle, int id, string name, bool onlyEnlargeX=false, bool onlyEnlargeY=false)
Lua parameters
handle (string): ui handle
id (int): widget id
name (string): name of the curve
onlyEnlargeX (bool, default: false): makes sure the x ranges are only expanded, never reduced
onlyEnlargeY (bool, default: false): makes sure the x ranges are only expanded, never reduced
Lua return values -
Python synopsis simUI.rescaleAxes(string handle, int id, string name, bool onlyEnlargeX=false, bool onlyEnlargeY=false)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.rescaleAxesAll
Description Rescales the axes such that all curves in the plot are fully visible.
Lua synopsis simUI.rescaleAxesAll(string handle, int id, bool onlyEnlargeX=false, bool onlyEnlargeY=false)
Lua parameters
handle (string): ui handle
id (int): widget id
onlyEnlargeX (bool, default: false): makes sure the x ranges are only expanded, never reduced
onlyEnlargeY (bool, default: false): makes sure the x ranges are only expanded, never reduced
Lua return values -
Python synopsis simUI.rescaleAxesAll(string handle, int id, bool onlyEnlargeX=false, bool onlyEnlargeY=false)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.restoreState
Description Restore a previously saved header state of the specified table/tree widget.
Lua synopsis simUI.restoreState(string handle, int id, string state)
Lua parameters
handle (string): ui handle
id (int): widget id
state (string): a previously saved string representing the state
Lua return values -
Python synopsis simUI.restoreState(string handle, int id, string state)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.saveState
Description Save header state of the specified table/tree widget.
Lua synopsis string state=simUI.saveState(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id
Lua return values
state (string): a string representing the state
Python synopsis string state=simUI.saveState(string handle, int id)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setButtonPressed
Description Set the state of a button.
Lua synopsis simUI.setButtonPressed(string handle, int id, bool pressed)
Lua parameters
handle (string): ui handle
id (int): widget id
pressed (bool): button state
Lua return values -
Python synopsis simUI.setButtonPressed(string handle, int id, bool pressed)
See also simUI.setButtonText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setButtonText
Description Set the text of a button.
Lua synopsis simUI.setButtonText(string handle, int id, string text)
Lua parameters
handle (string): ui handle
id (int): widget id
text (string): button text
Lua return values -
Python synopsis simUI.setButtonText(string handle, int id, string text)
See also simUI.setButtonPressed simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setCheckboxValue
Description Set the value of a checkbox widget.
Lua synopsis simUI.setCheckboxValue(string handle, int id, int value, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
value (int): value
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setCheckboxValue(string handle, int id, int value, bool suppressEvents=true)
See also simUI.getCheckboxValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setColumnCount
Description Resize the specified table/tree widget.
Lua synopsis simUI.setColumnCount(string handle, int id, int count, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
count (int): column count
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setColumnCount(string handle, int id, int count, bool suppressEvents=true)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setColumnHeaderText
Description Set the column header text of the specified table/tree widget.
Lua synopsis simUI.setColumnHeaderText(string handle, int id, int column, string text)
Lua parameters
handle (string): ui handle
id (int): widget id
column (int): column index
text (string): column header text
Lua return values -
Python synopsis simUI.setColumnHeaderText(string handle, int id, int column, string text)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setColumnWidth
Description Resize a column in the specified table/tree widget.
Lua synopsis simUI.setColumnWidth(string handle, int id, int column, int min_size, int max_size)
Lua parameters
handle (string): ui handle
id (int): widget id
column (int): column index
min_size (int): minimum size
max_size (int): maximum size
Lua return values -
Python synopsis simUI.setColumnWidth(string handle, int id, int column, int min_size, int max_size)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setTreeSelection simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setComboboxItems
Description Populate a combobox widget with the specified items, and set the selected item to the specified index.
Lua synopsis simUI.setComboboxItems(string handle, int id, string[] items, int index, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
items (table of string): Array of items (strings).
index (int): Index of selected item after inserting all the items.
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setComboboxItems(string handle, int id, list items, int index, bool suppressEvents=true)
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems simUI.getComboboxSelectedIndex simUI.insertComboboxItem simUI.removeComboboxItem simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setComboboxSelectedIndex
Description Change the selected item index in a combobox widget.
Lua synopsis simUI.setComboboxSelectedIndex(string handle, int id, int index, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
index (int): Index of selected item after inserting all the items.
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setComboboxSelectedIndex(string handle, int id, int index, bool suppressEvents=true)
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems simUI.getComboboxSelectedIndex simUI.insertComboboxItem simUI.removeComboboxItem simUI.setComboboxItems simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setCurrentEditWidget
Description Set the edit widget focus and selected text.
Lua synopsis simUI.setCurrentEditWidget(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): widget id. this value can be -1, in which case the function will do nothing.
Lua return values -
Python synopsis simUI.setCurrentEditWidget(string handle, int id)
See also simUI.getCurrentEditWidget simUI.getEditValue simUI.setEditValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setCurrentTab
Description Set the current tab index in a tabs widget.
Lua synopsis simUI.setCurrentTab(string handle, int id, int index, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
index (int): index of the tab (zero-based)
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setCurrentTab(string handle, int id, int index, bool suppressEvents=true)
See also simUI.getCurrentTab simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setEditValue
Description Set the value of a edit widget.
Lua synopsis simUI.setEditValue(string handle, int id, string value, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
value (string): value
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setEditValue(string handle, int id, string value, bool suppressEvents=true)
See also simUI.getCurrentEditWidget simUI.getEditValue simUI.setCurrentEditWidget simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setEnabled
Description Enable or disable a widget.
Lua synopsis simUI.setEnabled(string handle, int id, bool enabled, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
enabled (bool): enabled
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setEnabled(string handle, int id, bool enabled, bool suppressEvents=true)
See also simUI.getWidgetVisibility simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setImageData
Description Set image content using specified bitmap (RGB888) data.
Lua synopsis simUI.setImageData(string handle, int id, string data, int width, int height)
Lua parameters
handle (string): ui handle
id (int): id of a image widget
data (string): image byte data
width (int): width of the image
height (int): height of the image
Lua return values -
Python synopsis simUI.setImageData(string handle, int id, string data, int width, int height)
See also simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setItem
Description Change item value in the specified table widget.
Lua synopsis simUI.setItem(string handle, int id, int row, int column, string text, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
row (int): row index
column (int): column index
text (string): item value
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setItem(string handle, int id, int row, int column, string text, bool suppressEvents=true)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setItemEditable
Description Change item editable flag in the specified table widget.
Lua synopsis simUI.setItemEditable(string handle, int id, int row, int column, bool editable)
Lua parameters
handle (string): ui handle
id (int): widget id
row (int): row index
column (int): column index
editable (bool): editable flag
Lua return values -
Python synopsis simUI.setItemEditable(string handle, int id, int row, int column, bool editable)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setItemImage
Description Change item image in the specified table widget.
Lua synopsis simUI.setItemImage(string handle, int id, int row, int column, string data, int width, int height, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
row (int): row index
column (int): column index
data (string): image data
width (int): image width
height (int): image height
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setItemImage(string handle, int id, int row, int column, string data, int width, int height, bool suppressEvents=true)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setLabelText
Description Set the text of a label widget.
Lua synopsis simUI.setLabelText(string handle, int id, string text, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
text (string): text
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setLabelText(string handle, int id, string text, bool suppressEvents=true)
See also simUI.getLabelText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setLegendVisibility
Description Set visibility of the plot legend (default is hidden).
Lua synopsis simUI.setLegendVisibility(string handle, int id, bool visible)
Lua parameters
handle (string): ui handle
id (int): widget id
visible (bool): if true, the plot legend will be visible
Lua return values -
Python synopsis simUI.setLegendVisibility(string handle, int id, bool visible)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setMouseOptions
Description Set plot widget options for interacting with mouse.
Lua synopsis simUI.setMouseOptions(string handle, int id, bool panX, bool panY, bool zoomX, bool zoomY)
Lua parameters
handle (string): ui handle
id (int): widget id
panX (bool): if true, panning (by dragging with the mouse) the X axis is allowed
panY (bool): if true, panning (by dragging with the mouse) the Y axis is allowed
zoomX (bool): if true, zooming (by mouse wheel) the X axis is allowed
zoomY (bool): if true, zooming (by mouse wheel) the Y axis is allowed
Lua return values -
Python synopsis simUI.setMouseOptions(string handle, int id, bool panX, bool panY, bool zoomX, bool zoomY)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setPlotLabels
Description Set the labels of the plot widget.
Lua synopsis simUI.setPlotLabels(string handle, int id, string x, string y)
Lua parameters
handle (string): ui handle
id (int): widget id
x (string): x label
y (string): y label
Lua return values -
Python synopsis simUI.setPlotLabels(string handle, int id, string x, string y)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setPlotRanges
Description Set the ranges of the plot widget.
Lua synopsis simUI.setPlotRanges(string handle, int id, double xmin, double xmax, double ymin, double ymax)
Lua parameters
handle (string): ui handle
id (int): widget id
xmin (double): minimum x range
xmax (double): maximum x range
ymin (double): minimum y range
ymax (double): maximum y range
Lua return values -
Python synopsis simUI.setPlotRanges(string handle, int id, double xmin, double xmax, double ymin, double ymax)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setPlotXLabel
Description Set the X label of the plot widget.
Lua synopsis simUI.setPlotXLabel(string handle, int id, string label)
Lua parameters
handle (string): ui handle
id (int): widget id
label (string): x label
Lua return values -
Python synopsis simUI.setPlotXLabel(string handle, int id, string label)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setPlotXRange
Description Set the X range of the plot widget.
Lua synopsis simUI.setPlotXRange(string handle, int id, double xmin, double xmax)
Lua parameters
handle (string): ui handle
id (int): widget id
xmin (double): minimum x range
xmax (double): maximum x range
Lua return values -
Python synopsis simUI.setPlotXRange(string handle, int id, double xmin, double xmax)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setPlotYLabel
Description Set the Y label of the plot widget.
Lua synopsis simUI.setPlotYLabel(string handle, int id, string label)
Lua parameters
handle (string): ui handle
id (int): widget id
label (string): y label
Lua return values -
Python synopsis simUI.setPlotYLabel(string handle, int id, string label)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setPlotYRange
Description Set the Y range of the plot widget.
Lua synopsis simUI.setPlotYRange(string handle, int id, double ymin, double ymax)
Lua parameters
handle (string): ui handle
id (int): widget id
ymin (double): minimum y range
ymax (double): maximum y range
Lua return values -
Python synopsis simUI.setPlotYRange(string handle, int id, double ymin, double ymax)
See also simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setPosition
Description Set the position of a UI window.
Lua synopsis simUI.setPosition(string handle, int x, int y, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
x (int): X position
y (int): Y position
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setPosition(string handle, int x, int y, bool suppressEvents=true)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setSize simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.setProgress
Description Chnge the value of a progressbar widget.
Lua synopsis simUI.setProgress(string handle, int id, int value)
Lua parameters
handle (string): ui handle
id (int): widget id
value (int): value
Lua return values -
Python synopsis simUI.setProgress(string handle, int id, int value)
See also simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setRadiobuttonValue
Description Set the value of a radiobutton widget.
Lua synopsis simUI.setRadiobuttonValue(string handle, int id, int value, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
value (int): value
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setRadiobuttonValue(string handle, int id, int value, bool suppressEvents=true)
See also simUI.getRadiobuttonValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setRowCount
Description Resize the specified table widget.
Lua synopsis simUI.setRowCount(string handle, int id, int count, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
count (int): row count
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setRowCount(string handle, int id, int count, bool suppressEvents=true)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowHeaderText simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setRowHeaderText
Description Set the row header text of the specified table widget.
Lua synopsis simUI.setRowHeaderText(string handle, int id, int row, string text)
Lua parameters
handle (string): ui handle
id (int): widget id
row (int): row index
text (string): row header text
Lua return values -
Python synopsis simUI.setRowHeaderText(string handle, int id, int row, string text)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeight simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setRowHeight
Description Resize a row in the specified table widget.
Lua synopsis simUI.setRowHeight(string handle, int id, int row, int min_size, int max_size)
Lua parameters
handle (string): ui handle
id (int): widget id
row (int): row index
min_size (int): minimum size
max_size (int): maximum size
Lua return values -
Python synopsis simUI.setRowHeight(string handle, int id, int row, int min_size, int max_size)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setTableSelection simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setScene3DNodeEnabled
Description Enable or disable a node in a scene3d widget.
Lua synopsis simUI.setScene3DNodeEnabled(string handle, int id, int nodeId, bool enabled)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
enabled (bool): enabled flag
Lua return values -
Python synopsis simUI.setScene3DNodeEnabled(string handle, int id, int nodeId, bool enabled)
See also simUI.addScene3DNode simUI.removeScene3DNode simUI.setScene3DNodeFloatParam simUI.setScene3DNodeIntParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector3Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setScene3DNodeFloatParam
Description Set node float parameter in a scene3d widget.
Lua synopsis simUI.setScene3DNodeFloatParam(string handle, int id, int nodeId, string paramName, float value)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
value (float): value of parameter
Lua return values -
Python synopsis simUI.setScene3DNodeFloatParam(string handle, int id, int nodeId, string paramName, float value)
See also simUI.addScene3DNode simUI.removeScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeIntParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector3Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setScene3DNodeIntParam
Description Set node int parameter in a scene3d widget.
Lua synopsis simUI.setScene3DNodeIntParam(string handle, int id, int nodeId, string paramName, int value)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
value (int): value of parameter
Lua return values -
Python synopsis simUI.setScene3DNodeIntParam(string handle, int id, int nodeId, string paramName, int value)
See also simUI.addScene3DNode simUI.removeScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeFloatParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector3Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setScene3DNodeParam
Description polymorphic version of the onSetScene3DNodeXXXParam() functions
Lua synopsis simUI.setScene3DNodeParam(int ui, int widget, int nodeId, string paramName, any paramValue)
Lua parameters
ui (int): the ui handle
widget (int): the widget identifier
nodeId (int): the node id
paramName (string): the parameter name
paramValue (any): the parameter value
Lua return values -
Python synopsis simUI.setScene3DNodeParam(int ui, int widget, int nodeId, string paramName, any paramValue)
See also


simUI.setScene3DNodeStringParam
Description Set node string parameter in a scene3d widget.
Lua synopsis simUI.setScene3DNodeStringParam(string handle, int id, int nodeId, string paramName, string value)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
value (string): value of parameter
Lua return values -
Python synopsis simUI.setScene3DNodeStringParam(string handle, int id, int nodeId, string paramName, string value)
See also simUI.addScene3DNode simUI.removeScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeFloatParam simUI.setScene3DNodeIntParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector3Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setScene3DNodeVector2Param
Description Set node vector2 parameter in a scene3d widget.
Lua synopsis simUI.setScene3DNodeVector2Param(string handle, int id, int nodeId, string paramName, float x, float y)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
x (float): value of first component
y (float): value of second component
Lua return values -
Python synopsis simUI.setScene3DNodeVector2Param(string handle, int id, int nodeId, string paramName, float x, float y)
See also simUI.addScene3DNode simUI.removeScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeFloatParam simUI.setScene3DNodeIntParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector3Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setScene3DNodeVector3Param
Description Set node vector3 parameter in a scene3d widget.
Lua synopsis simUI.setScene3DNodeVector3Param(string handle, int id, int nodeId, string paramName, float x, float y, float z)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
x (float): value of first component
y (float): value of second component
z (float): value of third component
Lua return values -
Python synopsis simUI.setScene3DNodeVector3Param(string handle, int id, int nodeId, string paramName, float x, float y, float z)
See also simUI.addScene3DNode simUI.removeScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeFloatParam simUI.setScene3DNodeIntParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector4Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setScene3DNodeVector4Param
Description Set node vector4 parameter in a scene3d widget.
Lua synopsis simUI.setScene3DNodeVector4Param(string handle, int id, int nodeId, string paramName, float x, float y, float z, float w)
Lua parameters
handle (string): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
x (float): value of first component
y (float): value of second component
z (float): value of third component
w (float): value of fourth component
Lua return values -
Python synopsis simUI.setScene3DNodeVector4Param(string handle, int id, int nodeId, string paramName, float x, float y, float z, float w)
See also simUI.addScene3DNode simUI.removeScene3DNode simUI.setScene3DNodeEnabled simUI.setScene3DNodeFloatParam simUI.setScene3DNodeIntParam simUI.setScene3DNodeStringParam simUI.setScene3DNodeVector2Param simUI.setScene3DNodeVector3Param simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setSize
Description Set the size of a UI window.
Lua synopsis simUI.setSize(string handle, int w, int h, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
w (int): width
h (int): height
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setSize(string handle, int w, int h, bool suppressEvents=true)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setTitle simUI.setWindowEnabled simUI.show


simUI.setSliderValue
Description Set the value of a slider widget.
Lua synopsis simUI.setSliderValue(string handle, int id, int value, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
value (int): value
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setSliderValue(string handle, int id, int value, bool suppressEvents=true)
See also simUI.getSliderValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setSpinboxValue
Description Set the value of a spinbox widget.
Lua synopsis simUI.setSpinboxValue(string handle, int id, float value, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
value (float): value
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setSpinboxValue(string handle, int id, float value, bool suppressEvents=true)
See also simUI.getSpinboxValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setStyleSheet
Description Set the stylesheet of a widget.
Lua synopsis simUI.setStyleSheet(string handle, int id, string styleSheet)
Lua parameters
handle (string): ui handle
id (int): widget id
styleSheet (string): stylesheet data
Lua return values -
Python synopsis simUI.setStyleSheet(string handle, int id, string styleSheet)
See also simUI.getWidgetVisibility simUI.setEnabled simUI.setWidgetVisibility


simUI.setTableSelection
Description Set selection in a table widget.
Lua synopsis simUI.setTableSelection(string handle, int id, int row, int column, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
row (int): row index
column (int): column index
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setTableSelection(string handle, int id, int row, int column, bool suppressEvents=true)
See also simUI.clearTable simUI.getColumnCount simUI.getItem simUI.getRowCount simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setItem simUI.setItemEditable simUI.setItemImage simUI.setRowCount simUI.setRowHeaderText simUI.setRowHeight simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setText
Description Set the text in a text-browser widget.
Lua synopsis simUI.setText(string handle, int id, string text, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
text (string): text content
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setText(string handle, int id, string text, bool suppressEvents=true)
See also simUI.setUrl simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setTitle
Description Set the title of a UI window.
Lua synopsis simUI.setTitle(string handle, string title, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
title (string): X position
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setTitle(string handle, string title, bool suppressEvents=true)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setWindowEnabled simUI.show


simUI.setTreeSelection
Description Set selection in a tree widget.
Lua synopsis simUI.setTreeSelection(string handle, int id, int item_id, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
item_id (int): item id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setTreeSelection(string handle, int id, int item_id, bool suppressEvents=true)
See also simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.updateTreeItemParent simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setUrl
Description Load an url in a text-browser widget.
Lua synopsis simUI.setUrl(string handle, int id, string url)
Lua parameters
handle (string): ui handle
id (int): widget id
url (string): url resource
Lua return values -
Python synopsis simUI.setUrl(string handle, int id, string url)
See also simUI.setText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.setWidgetVisibility
Description Hide or show a widget.
Lua synopsis simUI.setWidgetVisibility(string handle, int id, bool visibility)
Lua parameters
handle (string): ui handle
id (int): widget id
visibility (bool): true if the window is visible, false otherwise
Lua return values -
Python synopsis simUI.setWidgetVisibility(string handle, int id, bool visibility)
See also simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet


simUI.setWindowEnabled
Description Enable or disable a UI window.
Lua synopsis simUI.setWindowEnabled(string handle, bool enabled, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
enabled (bool): enabled
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.setWindowEnabled(string handle, bool enabled, bool suppressEvents=true)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.show


simUI.show
Description Show the UI window.
Lua synopsis simUI.show(string handle)
Lua parameters
handle (string): ui handle
Lua return values -
Python synopsis simUI.show(string handle)
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.setWindowEnabled


simUI.supportedImageFormats
Description Return a list of supported image formats
Lua synopsis string[] formatList, string formatListStr=simUI.supportedImageFormats(string separator=nil)
Lua parameters
separator (string, default: nil): if provided, also a string of formats concatenated by separator will be returned
Lua return values
formatList (table of string): list of formats, each item will be the file extension of the format
formatListStr (string): concatenated list of formats, if separator is provided
Python synopsis list formatList, string formatListStr=simUI.supportedImageFormats(string separator=nil)
See also


simUI.svgLoadData
Description Load a SVG document in a SVG widget.
Lua synopsis simUI.svgLoadData(string handle, int id, string data)
Lua parameters
handle (string): ui handle
id (int): widget id
data (string): SVG data (XML) as a string
Lua return values -
Python synopsis simUI.svgLoadData(string handle, int id, string data)
See also simUI.svgLoadFile simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.svgLoadFile
Description Load a SVG file in a SVG widget.
Lua synopsis simUI.svgLoadFile(string handle, int id, string file)
Lua parameters
handle (string): ui handle
id (int): widget id
file (string): file path
Lua return values -
Python synopsis simUI.svgLoadFile(string handle, int id, string file)
See also simUI.svgLoadData simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.updateTreeItemParent
Description Modify the parent of an existing item in the specified tree widget.
Lua synopsis simUI.updateTreeItemParent(string handle, int id, int item_id, int parent_id, bool suppressEvents=true)
Lua parameters
handle (string): ui handle
id (int): widget id
item_id (int): item id
parent_id (int): parent id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
Python synopsis simUI.updateTreeItemParent(string handle, int id, int item_id, int parent_id, bool suppressEvents=true)
See also simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


simUI.updateTreeItemText
Description Modify the text of an existing item in the specified tree widget.
Lua synopsis simUI.updateTreeItemText(string handle, int id, int item_id, string[] text)
Lua parameters
handle (string): ui handle
id (int): widget id
item_id (int): item id
text (table of string): item text fields
Lua return values -
Python synopsis simUI.updateTreeItemText(string handle, int id, int item_id, list text)
See also simUI.addTreeItem simUI.clearTree simUI.collapseAll simUI.expandAll simUI.expandToDepth simUI.getColumnCount simUI.removeTreeItem simUI.restoreState simUI.saveState simUI.setColumnCount simUI.setColumnHeaderText simUI.setColumnWidth simUI.setTreeSelection simUI.updateTreeItemParent simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility



Constants

Constants used in the various functions. Refer to each constant using enumName.constantName, i.e. simUI.curve_type.xy for xy constant in simUI.curve_type enum.


simUI.msgbox_type
info
question
warning
critical

simUI.msgbox_buttons
ok
yesno
yesnocancel
okcancel

simUI.msgbox_result
cancel
no
yes
ok

simUI.filedialog_type
load
load_multiple
save
folder

simUI.curve_type
time: a curve with an X-simple domain, i.e. y = f(x)
xy: a parametric curve, i.e. x = fx(t), y = fy(t)

simUI.curve_style
scatter
line
line_and_scatter
step_left: only available for 'time' curves
step_center: only available for 'time' curves
step_right: only available for 'time' curves
impulse: only available for 'time' curves

simUI.curve_scatter_shape
none
dot
cross
plus
circle
disc
square
diamond
star
triangle
triangle_inverted
cross_square
plus_square
cross_circle
plus_circle
peace

simUI.line_style
solid
dotted
dashed

simUI.scene3d_node_type
entity
transform
camera
camera_controller_first_person
camera_controller_orbit
light_point
light_directional
light_spot
mesh_cuboid
mesh_torus
mesh_cone
mesh_cylinder
mesh_plane
mesh_sphere
mesh
material_phong
material_gooch
material_texture
material_diffuse_map
texture2d
texture_image
object_picker

simUI.mouse
left_button_down: left mouse button pressed
left_button_up: left mouse button released
move: mouse pointer has been moved


Data structures

Data structures are used to pass complex data around. Create data structures in Lua in the form of a map, e.g.: {line_size=3, add_to_legend=false, selectable=true}


curve_options
Description Extra options for the curve creation function simUI.addCurve.
Fields
scatter_shape (int, default: sim_ui_curve_scatter_shape_disc): scatter shape. see simUI.curve_scatter_shape.
scatter_size (int, default: 10): size of the scatter shape
line_size (int, default: 2): size of the line
line_style (int, default: sim_ui_line_style_solid): style of the pen used to draw the line. see simUI.line_style.
add_to_legend (bool, default: true): if false, the curve will not be added to the legend
selectable (bool, default: true): if false, the curve points cannot be selected and will not react to click events
track (bool, default: false): if true, enable the mouse tracker
See also simUI.curve_scatter_shape simUI.addCurve simUI.addCurveTimePoints simUI.addCurveXYPoints simUI.clearCurve simUI.getCurveData simUI.growPlotRanges simUI.growPlotXRange simUI.growPlotYRange simUI.removeCurve simUI.replot simUI.rescaleAxes simUI.rescaleAxesAll simUI.setLegendVisibility simUI.setMouseOptions simUI.setPlotLabels simUI.setPlotRanges simUI.setPlotXLabel simUI.setPlotXRange simUI.setPlotYLabel simUI.setPlotYRange simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility


keyboard_modifiers
Description
Fields
control (bool, default: false):
shift (bool, default: false):
See also



Script functions

Script functions are used to call some lua code from the plugin side (tipically used for event handlers).


onclickCallback
Description Callback for button click event.
Lua synopsis simUI.onclickCallback(string handle, int id)
Lua parameters
handle (string): ui handle
id (int): the ID of the clicked button
Lua return values -
Python synopsis simUI.onclickCallback(string handle, int id)
See also


onLinkActivatedCallback
Description Callback for when a link is clicked.
Lua synopsis simUI.onLinkActivatedCallback(string handle, int id, string link)
Lua parameters
handle (string): ui handle
id (int): the ID of the clicked button
link (string): the href attribute of the activated link
Lua return values -
Python synopsis simUI.onLinkActivatedCallback(string handle, int id, string link)
See also


onchangeIntCallback
Description Callback for widget change event.
Lua synopsis simUI.onchangeIntCallback(string handle, int id, int value)
Lua parameters
handle (string): ui handle
id (int): the ID of the widget
value (int): the new value
Lua return values -
Python synopsis simUI.onchangeIntCallback(string handle, int id, int value)
See also


onchangeDoubleCallback
Description Callback for widget change event.
Lua synopsis simUI.onchangeDoubleCallback(string handle, int id, float value)
Lua parameters
handle (string): ui handle
id (int): the ID of the widget
value (float): the new value
Lua return values -
Python synopsis simUI.onchangeDoubleCallback(string handle, int id, float value)
See also


onchangeStringCallback
Description Callback for widget change event.
Lua synopsis simUI.onchangeStringCallback(string handle, int id, string value)
Lua parameters
handle (string): ui handle
id (int): the ID of the widget
value (string): the new value
Lua return values -
Python synopsis simUI.onchangeStringCallback(string handle, int id, string value)
See also


oneditingfinishedCallback
Description Callback for editing finished event.
Lua synopsis simUI.oneditingfinishedCallback(string handle, int id, string value)
Lua parameters
handle (string): ui handle
id (int): the ID of the widget
value (string): the new value
Lua return values -
Python synopsis simUI.oneditingfinishedCallback(string handle, int id, string value)
See also


oncloseCallback
Description Callback for window close event. It will be called when the user clicks the close button of the window. When an onclose callback is specified, the window will not close automatically when the user clicks the window close button.
Lua synopsis simUI.oncloseCallback(string handle)
Lua parameters
handle (string): the handle of the UI
Lua return values -
Python synopsis simUI.oncloseCallback(string handle)
See also


onPlottableClickCallback
Description Callback for plot widget plottableClick event.
Lua synopsis simUI.onPlottableClickCallback(string handle, int id, string curve, int index, float x, float y)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the plot widget
curve (string): the name of the curve
index (int): the index of the clicked point in the curve
x (float): the x value of the clicked point
y (float): the y value of the clicked point
Lua return values -
Python synopsis simUI.onPlottableClickCallback(string handle, int id, string curve, int index, float x, float y)
See also


onLegendClickCallback
Description Callback for plot widget legendClick event.
Lua synopsis simUI.onLegendClickCallback(string handle, int id, string curve)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the plot widget
curve (string): the name of the curve
Lua return values -
Python synopsis simUI.onLegendClickCallback(string handle, int id, string curve)
See also


onCellActivateCallback
Description Callback for table widget cellActivated event.
Lua synopsis simUI.onCellActivateCallback(string handle, int id, int row, int column, string cellValue)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the plot widget
row (int): the row index (zero based) of the activated cell
column (int): the column index (zero based) of the activated cell
cellValue (string): the value of the cell
Lua return values -
Python synopsis simUI.onCellActivateCallback(string handle, int id, int row, int column, string cellValue)
See also


onTableSelectionChangeCallback
Description Callback for table widget selectionChanged event.
Lua synopsis simUI.onTableSelectionChangeCallback(string handle, int id, int row, int column)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the plot widget
row (int): the row index (zero based) of the activated cell
column (int): the column index (zero based) of the activated cell
Lua return values -
Python synopsis simUI.onTableSelectionChangeCallback(string handle, int id, int row, int column)
See also


onTreeSelectionChangeCallback
Description Callback for tree widget selectionChanged event.
Lua synopsis simUI.onTreeSelectionChangeCallback(string handle, int id, int item_id)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the plot widget
item_id (int): the item id
Lua return values -
Python synopsis simUI.onTreeSelectionChangeCallback(string handle, int id, int item_id)
See also


onMouseEventCallback
Description Callback for a mouse event.
Lua synopsis simUI.onMouseEventCallback(string handle, int id, int type, keyboard_modifiers mods, int x, int y)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the widget
type (int): the mouse event type, one of the values from simUI.mouse
mods (keyboard_modifiers): modifiers. see keyboard_modifiers
x (int): x coordinate of mouse pointer
y (int): y coordinate of mouse pointer
Lua return values -
Python synopsis simUI.onMouseEventCallback(string handle, int id, int type, keyboard_modifiers mods, int x, int y)
See also


onKeyPressCallback
Description Callback called when a key is pressed in a widget.
Lua synopsis simUI.onKeyPressCallback(string handle, int id, int key, string text)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the widget
key (int): the integer value of the key
text (string): a textual representation of the key
Lua return values -
Python synopsis simUI.onKeyPressCallback(string handle, int id, int key, string text)
See also


onScene3DObjectClickCallback
Description Callback called when an object is clicked in a scene3d widget.
Lua synopsis simUI.onScene3DObjectClickCallback(string handle, int id, int nodeId)
Lua parameters
handle (string): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the object-picker
Lua return values -
Python synopsis simUI.onScene3DObjectClickCallback(string handle, int id, int nodeId)
See also

, , , ,
customUIPlugin << Previous Next >> simUI-widgets

Copyright © All rights reserved | This template is made with by Colorlib