CustomUI Plugin API reference

API functions for creating custom user interfaces.

simUI.addConnection

Description Remove a node in a dataflow widget.
Lua synopsis simUI.addConnection(int handle, int id, int srcNodeId, int srcOutlet, int dstNodeId, int dstInlet)
Lua parameters
handle (int): ui handle
id (int): widget id
srcNodeId (int): source node id
srcOutlet (int): source outlet index (zero based)
dstNodeId (int): destination node id
dstInlet (int): destination inlet index (zero based)
Lua return values -
See also simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.addCurve

Description Adds a curve to a plot widget.
Lua synopsis simUI.addCurve(int handle, int id, int type, string name, table color, int style, curve_options options)
Lua parameters
handle (int): 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): 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 -
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(int handle, int id, string name, table x, table y)
Lua parameters
handle (int): 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 -
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(int handle, int id, string name, table t, table x, table y)
Lua parameters
handle (int): 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 -
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.addNode

Description Add a node to a dataflow widget.
Lua synopsis int nodeId=simUI.addNode(int handle, int id, int x, int y, string text, int inlets, int outlets)
Lua parameters
handle (int): ui handle
id (int): widget id
x (int): x position
y (int): y position
text (string): object text
inlets (int): number of inlets
outlets (int): number of outlets
Lua return values
nodeId (int): node id
See also simUI.addConnection simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.addScene3DNode

Description Add a node in a scene3d widget.
Lua synopsis simUI.addScene3DNode(int handle, int id, int nodeId, int parentNodeId, int type)
Lua parameters
handle (int): 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 -
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(int handle, int id, int item_id, table text, int parent_id=0, bool expanded=false, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, string name)
Lua parameters
handle (int): ui handle
id (int): widget id
name (string): name of the curve
Lua return values -
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(int handle, int id, bool suppressEvents=true)
Lua parameters
handle (int): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
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(int handle, int id, bool suppressEvents=true)
Lua parameters
handle (int): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
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(int handle, int id, bool suppressEvents=true)
Lua parameters
handle (int): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
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.create

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

simUI.destroy

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

simUI.expandAll

Description Expand all nodes in the specified tree widget.
Lua synopsis simUI.expandAll(int handle, int id, bool suppressEvents=true)
Lua parameters
handle (int): ui handle
id (int): widget id
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
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(int handle, int id, int depth, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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.getCheckboxValue

Description Get the value of a checkbox widget.
Lua synopsis int value=simUI.getCheckboxValue(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
value (int): value
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
count (int): column count
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
count (int): Item count.
See also simUI.getComboboxItemText simUI.getComboboxItems 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(int handle, int id, int index)
Lua parameters
handle (int): ui handle
id (int): widget id
index (int): Item index.
Lua return values
text (string): Item text.
See also simUI.getComboboxItemCount simUI.getComboboxItems 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 table items=simUI.getComboboxItems(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
items (table of string): Array of items (strings).
See also simUI.getComboboxItemCount simUI.getComboboxItemText 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(int handle)
Lua parameters
handle (int): 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.
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
index (int): index of the tab (zero-based)
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 table t, table x, table y=simUI.getCurveData(int handle, int id, string name)
Lua parameters
handle (int): 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
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
value (string): value
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(int handle, int id, int row, int column)
Lua parameters
handle (int): ui handle
id (int): widget id
row (int): row index
column (int): column index
Lua return values
text (string): item value
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
text (string): text
See also simUI.setLabelText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.getNodeInletCount

Description Get the inlet count of a node in a dataflow widget.
Lua synopsis int count=simUI.getNodeInletCount(int handle, int id, int nodeId)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
Lua return values
count (int): inlet count
See also simUI.addConnection simUI.addNode simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.getNodeOutletCount

Description Get the inlet count of a node in a dataflow widget.
Lua synopsis int count=simUI.getNodeOutletCount(int handle, int id, int nodeId)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
Lua return values
count (int): inlet count
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.getNodePos

Description Get the position of a node in a dataflow widget.
Lua synopsis int x, int y=simUI.getNodePos(int handle, int id, int nodeId)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
Lua return values
x (int): x position
y (int): y position
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.getNodeText

Description Get the text of a node in a dataflow widget.
Lua synopsis string text=simUI.getNodeText(int handle, int id, int nodeId)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
Lua return values
text (string): node text
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid 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(int handle)
Lua parameters
handle (int): ui handle
Lua return values
x (int): X position
y (int): Y position
See also simUI.create simUI.destroy simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.show

simUI.getRadiobuttonValue

Description Get the value of a radiobutton widget.
Lua synopsis int value=simUI.getRadiobuttonValue(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
value (int): value
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
count (int): row count
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(int handle)
Lua parameters
handle (int): ui handle
Lua return values
w (int): width
h (int): height
See also simUI.create simUI.destroy simUI.getPosition simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.show

simUI.getSliderValue

Description Get the value of a slider widget.
Lua synopsis int value=simUI.getSliderValue(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
value (int): value
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
value (float): value
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(int handle)
Lua parameters
handle (int): ui handle
Lua return values
title (string): X position
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.show

simUI.getWidgetVisibility

Description Get the visibility status of a widget.
Lua synopsis bool visibility=simUI.getWidgetVisibility(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
visibility (bool): true if the window is visible, false otherwise
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(int handle, int id, double xmin, double xmax, double ymin, double ymax)
Lua parameters
handle (int): 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 -
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(int handle, int id, double xmin, double xmax)
Lua parameters
handle (int): ui handle
id (int): widget id
xmin (double): minimum x range
xmax (double): maximum x range
Lua return values -
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(int handle, int id, double ymin, double ymax)
Lua parameters
handle (int): ui handle
id (int): widget id
ymin (double): minimum y range
ymax (double): maximum y range
Lua return values -
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(int handle)
Lua parameters
handle (int): ui handle
Lua return values -
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.isVisible simUI.setPosition simUI.setSize simUI.setTitle simUI.show

simUI.insertComboboxItem

Description Insert an item in a combobox widget.
Lua synopsis simUI.insertComboboxItem(int handle, int id, int index, string text, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems simUI.removeComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.isNodeValid

Description Get the validity flag of a node in a dataflow widget.
Lua synopsis bool valid=simUI.isNodeValid(int handle, int id, int nodeId)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
Lua return values
valid (bool): validity flag
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.isVisible

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

simUI.removeComboboxItem

Description Remove an item from a combobox widget.
Lua synopsis simUI.removeComboboxItem(int handle, int id, int index, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems simUI.insertComboboxItem simUI.setComboboxItems simUI.setComboboxSelectedIndex simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.removeConnection

Description Remove a node in a dataflow widget.
Lua synopsis simUI.removeConnection(int handle, int id, int srcNodeId, int srcOutlet, int dstNodeId, int dstInlet)
Lua parameters
handle (int): ui handle
id (int): widget id
srcNodeId (int): source node id
srcOutlet (int): source outlet index (zero based)
dstNodeId (int): destination node id
dstInlet (int): destination inlet index (zero based)
Lua return values -
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.removeCurve

Description Remove the specified curve from the plot widget.
Lua synopsis simUI.removeCurve(int handle, int id, string name)
Lua parameters
handle (int): ui handle
id (int): widget id
name (string): name of the curve
Lua return values -
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.removeNode

Description Remove a node from a dataflow widget.
Lua synopsis simUI.removeNode(int handle, int id, int nodeId)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
Lua return values -
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.removeScene3DNode

Description Remove a node in a scene3d widget.
Lua synopsis simUI.removeScene3DNode(int handle, int id, int nodeId)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
Lua return values -
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.removeTreeItem

Description Remove an item from the specified tree widget.
Lua synopsis simUI.removeTreeItem(int handle, int id, int item_id, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values -
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(int handle, int id, string name, bool onlyEnlargeX=false, bool onlyEnlargeY=false)
Lua parameters
handle (int): 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 -
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(int handle, int id, bool onlyEnlargeX=false, bool onlyEnlargeY=false)
Lua parameters
handle (int): 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 -
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(int handle, int id, string state)
Lua parameters
handle (int): ui handle
id (int): widget id
state (string): a previously saved string representing the state
Lua return values -
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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id
Lua return values
state (string): a string representing the state
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(int handle, int id, bool pressed)
Lua parameters
handle (int): ui handle
id (int): widget id
pressed (bool): button state
Lua return values -
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(int handle, int id, string text)
Lua parameters
handle (int): ui handle
id (int): widget id
text (string): button text
Lua return values -
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(int handle, int id, int value, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, int count, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, int column, string text)
Lua parameters
handle (int): ui handle
id (int): widget id
column (int): column index
text (string): column header text
Lua return values -
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(int handle, int id, int column, int min_size, int max_size)
Lua parameters
handle (int): ui handle
id (int): widget id
column (int): column index
min_size (int): minimum size
max_size (int): maximum size
Lua return values -
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(int handle, int id, table items, int index, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems 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(int handle, int id, int index, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.getComboboxItemCount simUI.getComboboxItemText simUI.getComboboxItems 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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): widget id. this value can be -1, in which case the function will do nothing.
Lua return values -
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(int handle, int id, int index, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, string value, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, bool enabled, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.getWidgetVisibility simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setImageData

Description Set image content using specified bitmap (RGB888) data.
Lua synopsis simUI.setImageData(int handle, int id, string data, int width, int height)
Lua parameters
handle (int): 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 -
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(int handle, int id, int row, int column, string text, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, int row, int column, bool editable)
Lua parameters
handle (int): ui handle
id (int): widget id
row (int): row index
column (int): column index
editable (bool): editable flag
Lua return values -
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(int handle, int id, int row, int column, string data, int width, int height, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, string text, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, bool visible)
Lua parameters
handle (int): ui handle
id (int): widget id
visible (bool): if true, the plot legend will be visible
Lua return values -
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(int handle, int id, bool panX, bool panY, bool zoomX, bool zoomY)
Lua parameters
handle (int): 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 -
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.setNodeInletCount

Description Set the inlet count of a node in a dataflow widget.
Lua synopsis simUI.setNodeInletCount(int handle, int id, int nodeId, int count)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
count (int): inlet count
Lua return values -
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setNodeOutletCount

Description Set the inlet count of a node in a dataflow widget.
Lua synopsis simUI.setNodeOutletCount(int handle, int id, int nodeId, int count)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
count (int): inlet count
Lua return values -
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodePos simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setNodePos

Description Set the position of a node in a dataflow widget.
Lua synopsis simUI.setNodePos(int handle, int id, int nodeId, int x, int y)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
x (int): x position
y (int): y position
Lua return values -
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodeText simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setNodeText

Description Set the text of a node in a dataflow widget.
Lua synopsis simUI.setNodeText(int handle, int id, int nodeId, string text)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
text (string): node text
Lua return values -
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeValid simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setNodeValid

Description Set the validity flag of a node in a dataflow widget.
Lua synopsis simUI.setNodeValid(int handle, int id, int nodeId, bool valid)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
valid (bool): validity flag
Lua return values -
See also simUI.addConnection simUI.addNode simUI.getNodeInletCount simUI.getNodeOutletCount simUI.getNodePos simUI.getNodeText simUI.isNodeValid simUI.removeConnection simUI.removeNode simUI.setNodeInletCount simUI.setNodeOutletCount simUI.setNodePos simUI.setNodeText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setPlotLabels

Description Set the labels of the plot widget.
Lua synopsis simUI.setPlotLabels(int handle, int id, string x, string y)
Lua parameters
handle (int): ui handle
id (int): widget id
x (string): x label
y (string): y label
Lua return values -
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(int handle, int id, double xmin, double xmax, double ymin, double ymax)
Lua parameters
handle (int): 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 -
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(int handle, int id, string label)
Lua parameters
handle (int): ui handle
id (int): widget id
label (string): x label
Lua return values -
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(int handle, int id, double xmin, double xmax)
Lua parameters
handle (int): ui handle
id (int): widget id
xmin (double): minimum x range
xmax (double): maximum x range
Lua return values -
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(int handle, int id, string label)
Lua parameters
handle (int): ui handle
id (int): widget id
label (string): y label
Lua return values -
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(int handle, int id, double ymin, double ymax)
Lua parameters
handle (int): ui handle
id (int): widget id
ymin (double): minimum y range
ymax (double): maximum y range
Lua return values -
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(int handle, int x, int y, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setSize simUI.setTitle simUI.show

simUI.setProgress

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

simUI.setRadiobuttonValue

Description Set the value of a radiobutton widget.
Lua synopsis simUI.setRadiobuttonValue(int handle, int id, int value, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.getRadiobuttonValue simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setRowCount

Description Resize the specified table widget.
Lua synopsis simUI.setRowCount(int handle, int id, int count, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, int row, string text)
Lua parameters
handle (int): ui handle
id (int): widget id
row (int): row index
text (string): row header text
Lua return values -
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(int handle, int id, int row, int min_size, int max_size)
Lua parameters
handle (int): ui handle
id (int): widget id
row (int): row index
min_size (int): minimum size
max_size (int): maximum size
Lua return values -
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(int handle, int id, int nodeId, bool enabled)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
enabled (bool): enabled flag
Lua return values -
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(int handle, int id, int nodeId, string paramName, float value)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
value (float): value of parameter
Lua return values -
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(int handle, int id, int nodeId, string paramName, int value)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
value (int): value of parameter
Lua return values -
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.setScene3DNodeStringParam

Description Set node string parameter in a scene3d widget.
Lua synopsis simUI.setScene3DNodeStringParam(int handle, int id, int nodeId, string paramName, string value)
Lua parameters
handle (int): ui handle
id (int): widget id
nodeId (int): node id
paramName (string): name of parameter
value (string): value of parameter
Lua return values -
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(int handle, int id, int nodeId, string paramName, float x, float y)
Lua parameters
handle (int): 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 -
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(int handle, int id, int nodeId, string paramName, float x, float y, float z)
Lua parameters
handle (int): 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 -
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(int handle, int id, int nodeId, string paramName, float x, float y, float z, float w)
Lua parameters
handle (int): 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 -
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(int handle, int w, int h, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setTitle simUI.show

simUI.setSliderValue

Description Set the value of a slider widget.
Lua synopsis simUI.setSliderValue(int handle, int id, int value, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, float value, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, string styleSheet)
Lua parameters
handle (int): ui handle
id (int): widget id
styleSheet (string): stylesheet data
Lua return values -
See also simUI.getWidgetVisibility simUI.setEnabled simUI.setWidgetVisibility

simUI.setTableSelection

Description Set selection in a table widget.
Lua synopsis simUI.setTableSelection(int handle, int id, int row, int column, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, string text, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, string title, bool suppressEvents=true)
Lua parameters
handle (int): ui handle
title (string): X position
suppressEvents (bool, default: true): if true, no event will be generated from this call
Lua return values -
See also simUI.create simUI.destroy simUI.getPosition simUI.getSize simUI.getTitle simUI.hide simUI.isVisible simUI.setPosition simUI.setSize simUI.show

simUI.setTreeSelection

Description Set selection in a tree widget.
Lua synopsis simUI.setTreeSelection(int handle, int id, int item_id, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, string url)
Lua parameters
handle (int): ui handle
id (int): widget id
url (string): url resource
Lua return values -
See also simUI.setText simUI.getWidgetVisibility simUI.setEnabled simUI.setStyleSheet simUI.setWidgetVisibility

simUI.setWidgetVisibility

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

simUI.show

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

simUI.updateTreeItemParent

Description Modify the parent of an existing item in the specified tree widget.
Lua synopsis simUI.updateTreeItemParent(int handle, int id, int item_id, int parent_id, bool suppressEvents=true)
Lua parameters
handle (int): 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 -
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(int handle, int id, int item_id, table text)
Lua parameters
handle (int): ui handle
id (int): widget id
item_id (int): item id
text (table of string): item text fields
Lua return values -
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.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 hash table, 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(int handle, int id)
Lua parameters
handle (int): ui handle
id (int): the ID of the clicked button
Lua return values -
See also

onLinkActivatedCallback

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

onchangeIntCallback

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

onchangeDoubleCallback

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

onchangeStringCallback

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

oneditingfinishedCallback

Description Callback for editing finished event.
Lua synopsis simUI.oneditingfinishedCallback(int handle, int id, string value)
Lua parameters
handle (int): ui handle
id (int): the ID of the widget
value (string): the new value
Lua return values -
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(int handle)
Lua parameters
handle (int): the handle of the UI
Lua return values -
See also

onPlottableClickCallback

Description Callback for plot widget plottableClick event.
Lua synopsis simUI.onPlottableClickCallback(int handle, int id, string curve, int index, float x, float y)
Lua parameters
handle (int): 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 -
See also

onLegendClickCallback

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

onCellActivateCallback

Description Callback for table widget cellActivated event.
Lua synopsis simUI.onCellActivateCallback(int handle, int id, int row, int column, string cellValue)
Lua parameters
handle (int): 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 -
See also

onTableSelectionChangeCallback

Description Callback for table widget selectionChanged event.
Lua synopsis simUI.onTableSelectionChangeCallback(int handle, int id, int row, int column)
Lua parameters
handle (int): 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 -
See also

onTreeSelectionChangeCallback

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

onMouseEventCallback

Description Callback for a mouse event.
Lua synopsis simUI.onMouseEventCallback(int handle, int id, int type, keyboard_modifiers mods, int x, int y)
Lua parameters
handle (int): 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 -
See also

onNodeAddedCallback

Description Callback called when a node is added to a dataflow widget.
Lua synopsis simUI.onNodeAddedCallback(int handle, int id, int nodeId, int x, int y, string text, int inlets, int outlets)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the node
x (int): x coordinate of the node
y (int): y coordinate of the node
text (string): node text
inlets (int): node inlet count
outlets (int): node outlet count
Lua return values -
See also

onNodeRemovedCallback

Description Callback called when a node is removed from a dataflow widget.
Lua synopsis simUI.onNodeRemovedCallback(int handle, int id, int nodeId)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the node
Lua return values -
See also

onNodeValidChangedCallback

Description Callback called when the validity of a node is changed in a dataflow widget.
Lua synopsis simUI.onNodeValidChangedCallback(int handle, int id, int nodeId, bool valid)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the node
valid (bool): the validity of the node
Lua return values -
See also

onNodePosChangedCallback

Description Callback called when the position of a node is changed in a dataflow widget.
Lua synopsis simUI.onNodePosChangedCallback(int handle, int id, int nodeId, int x, int y)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the node
x (int): the x coordinate of the node
y (int): the y coordinate of the node
Lua return values -
See also

onNodeTextChangedCallback

Description Callback called when the text of a node is changed in a dataflow widget.
Lua synopsis simUI.onNodeTextChangedCallback(int handle, int id, int nodeId, string text)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the node
text (string): the text of the node
Lua return values -
See also

onNodeInletCountChangedCallback

Description Callback called when the inlet count of a node is changed in a dataflow widget.
Lua synopsis simUI.onNodeInletCountChangedCallback(int handle, int id, int nodeId, int count)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the node
count (int): the inlet count of the node
Lua return values -
See also

onNodeOutletCountChangedCallback

Description Callback called when the outlet count of a node is changed in a dataflow widget.
Lua synopsis simUI.onNodeOutletCountChangedCallback(int handle, int id, int nodeId, int count)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
nodeId (int): the ID of the node
count (int): the outlet count of the node
Lua return values -
See also

onConnectionAddedCallback

Description Callback called when a connection is created in a dataflow widget.
Lua synopsis simUI.onConnectionAddedCallback(int handle, int id, int srcNodeId, int srcOutlet, int dstNodeId, int dstInlet)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
srcNodeId (int): the ID of source the node
srcOutlet (int): the index (zero-based) of the source node outlet
dstNodeId (int): the ID of the destination node
dstInlet (int): the index (zero-based) of the destination node inlet
Lua return values -
See also

onConnectionRemovedCallback

Description Callback called when a connection is removed in a dataflow widget.
Lua synopsis simUI.onConnectionRemovedCallback(int handle, int id, int srcNodeId, int srcOutlet, int dstNodeId, int dstInlet)
Lua parameters
handle (int): the handle of the UI
id (int): the ID of the widget
srcNodeId (int): the ID of source the node
srcOutlet (int): the index (zero-based) of the source node outlet
dstNodeId (int): the ID of the destination node
dstInlet (int): the index (zero-based) of the destination node inlet
Lua return values -
See also

onKeyPressCallback

Description Callback called when a key is pressed in a widget.
Lua synopsis simUI.onKeyPressCallback(int handle, int id, int key, string text)
Lua parameters
handle (int): 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 -
See also

onScene3DObjectClickCallback

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