CustomUI Plugin API reference
API functions for creating custom user interfaces.
simExtCustomUI_addCurve
simExtCustomUI_addCurveTimePoints
simExtCustomUI_addCurveXYPoints
simExtCustomUI_clearCurve
simExtCustomUI_create
simExtCustomUI_destroy
simExtCustomUI_getCheckboxValue
simExtCustomUI_getComboboxItemCount
simExtCustomUI_getComboboxItemText
simExtCustomUI_getComboboxItems
simExtCustomUI_getCurrentEditWidget
simExtCustomUI_getCurrentTab
simExtCustomUI_getCurveData
simExtCustomUI_getEditValue
simExtCustomUI_getLabelText
simExtCustomUI_getPosition
simExtCustomUI_getRadiobuttonValue
simExtCustomUI_getSize
simExtCustomUI_getSliderValue
simExtCustomUI_getSpinboxValue
simExtCustomUI_getTitle
simExtCustomUI_getWidgetVisibility
Description
|
Get the visibility status of a widget. |
Lua synopsis |
bool visibility=simExtCustomUI_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
|
simExtCustomUI_setEnabled simExtCustomUI_setWidgetVisibility
|
simExtCustomUI_growPlotRanges
simExtCustomUI_growPlotXRange
simExtCustomUI_growPlotYRange
simExtCustomUI_hide
simExtCustomUI_insertComboboxItem
simExtCustomUI_isVisible
simExtCustomUI_removeComboboxItem
simExtCustomUI_removeCurve
simExtCustomUI_replot
simExtCustomUI_rescaleAxes
simExtCustomUI_rescaleAxesAll
simExtCustomUI_setCheckboxValue
simExtCustomUI_setComboboxItems
simExtCustomUI_setComboboxSelectedIndex
simExtCustomUI_setCurrentEditWidget
simExtCustomUI_setCurrentTab
simExtCustomUI_setEditValue
simExtCustomUI_setEnabled
Description
|
Enable or disable a widget. |
Lua synopsis |
simExtCustomUI_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
|
simExtCustomUI_getWidgetVisibility simExtCustomUI_setWidgetVisibility
|
simExtCustomUI_setImageData
simExtCustomUI_setLabelText
simExtCustomUI_setLegendVisibility
simExtCustomUI_setMouseOptions
simExtCustomUI_setPlotLabels
simExtCustomUI_setPlotRanges
simExtCustomUI_setPlotXLabel
simExtCustomUI_setPlotXRange
simExtCustomUI_setPlotYLabel
simExtCustomUI_setPlotYRange
simExtCustomUI_setPosition
simExtCustomUI_setRadiobuttonValue
simExtCustomUI_setSize
simExtCustomUI_setSliderValue
simExtCustomUI_setSpinboxValue
simExtCustomUI_setTitle
simExtCustomUI_setWidgetVisibility
Description
|
Hide or show a widget. |
Lua synopsis |
simExtCustomUI_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
|
simExtCustomUI_getWidgetVisibility simExtCustomUI_setEnabled
|
simExtCustomUI_show
Constants
curve_type
sim_customui_curve_type_time: a curve with an X-simple domain, i.e. y = f(x)
sim_customui_curve_type_xy: a parametric curve, i.e. x = fx(t), y = fy(t)
|
curve_style
sim_customui_curve_style_scatter
sim_customui_curve_style_line
sim_customui_curve_style_line_and_scatter
sim_customui_curve_style_step_left: only available for 'time' curves
sim_customui_curve_style_step_center: only available for 'time' curves
sim_customui_curve_style_step_right: only available for 'time' curves
sim_customui_curve_style_impulse: only available for 'time' curves
|
curve_scatter_shape
sim_customui_curve_scatter_shape_none
sim_customui_curve_scatter_shape_dot
sim_customui_curve_scatter_shape_cross
sim_customui_curve_scatter_shape_plus
sim_customui_curve_scatter_shape_circle
sim_customui_curve_scatter_shape_disc
sim_customui_curve_scatter_shape_square
sim_customui_curve_scatter_shape_diamond
sim_customui_curve_scatter_shape_star
sim_customui_curve_scatter_shape_triangle
sim_customui_curve_scatter_shape_triangle_inverted
sim_customui_curve_scatter_shape_cross_square
sim_customui_curve_scatter_shape_plus_square
sim_customui_curve_scatter_shape_cross_circle
sim_customui_curve_scatter_shape_plus_circle
sim_customui_curve_scatter_shape_peace
|
line_style
sim_customui_line_style_solid
sim_customui_line_style_dotted
sim_customui_line_style_dashed
|
Data structures
curve_options
Description
|
Extra options for the curve creation function simExtCustomUI_addCurve. Create this data structure in the form of a hash table, e.g.: {line_size=3, add_to_legend=false, selectable=true}
|
Fields |
scatter_shape (int, default: sim_customui_curve_scatter_shape_disc): scatter shape. see 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_customui_line_style_solid): style of the pen used to draw the line. see 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
|
curve_scatter_shape simExtCustomUI_addCurve simExtCustomUI_addCurveTimePoints simExtCustomUI_addCurveXYPoints simExtCustomUI_clearCurve simExtCustomUI_getCurveData simExtCustomUI_growPlotRanges simExtCustomUI_growPlotXRange simExtCustomUI_growPlotYRange simExtCustomUI_removeCurve simExtCustomUI_replot simExtCustomUI_rescaleAxes simExtCustomUI_rescaleAxesAll simExtCustomUI_setLegendVisibility simExtCustomUI_setMouseOptions simExtCustomUI_setPlotLabels simExtCustomUI_setPlotRanges simExtCustomUI_setPlotXLabel simExtCustomUI_setPlotXRange simExtCustomUI_setPlotYLabel simExtCustomUI_setPlotYRange simExtCustomUI_getWidgetVisibility simExtCustomUI_setEnabled simExtCustomUI_setWidgetVisibility
|
|