![]() |
![]() |
![]() |
V_Sim API - Reference Manual | ![]() |
---|---|---|---|---|
ToolPanel* panelConfigInit (); void panelConfigSet_refreshPeriod (RenderingWindow *window, float val); void panelConfigSet_tabView (gboolean viewed); gdouble panelConfigGet_spinBoundsValue (); void panelConfigSet_automaticRefresh (RenderingWindow *window, int bool); void panelConfigSet_spinBoundsValue (gdouble val);
ToolPanel* panelConfigInit ();
Should be used in the list declared in externalModules.h to be loaded by V_Sim on start-up. This routine will create the ToolPanel where the configuration stuff can be done, such as the auto-reloading.
Returns : | a newly created ToolPanel object. |
void panelConfigSet_refreshPeriod (RenderingWindow *window, float val);
V_Sim can poll the rendered file at periodic intervals. Use this method to tune
the period. See panelConfigSet_automaticRefresh()
to enable this functionality.
window : |
the RenderingWindow to associated the auto refresh ; |
val : |
a floating point value in milliseconds. |
void panelConfigSet_tabView (gboolean viewed);
The note can show its tabs or not. Change this with that method.
viewed : |
a boolean value. |
gdouble panelConfigGet_spinBoundsValue ();
Use this method to retrieve the multiplier factor for spin bounds.
See configPanelSet_spinBoundsValue()
for further details.
Returns : | a floating point value, used as multiplier for spin buttons. |
void panelConfigSet_automaticRefresh (RenderingWindow *window, int bool);
V_Sim can poll the rendered file at periodic intervals to check if the file
has been modified. If true, the file is reloaded. Turn this functionality on or off
with this method. See panelConfigSet_refreshPeriod()
to tune the period of the polling.
window : |
the RenderingWindow to associated the auto refresh ; |
bool : |
a boolean value. |
void panelConfigSet_spinBoundsValue (gdouble val);
Some spins in V_Sim refer to values that depends on the size and the unit of the box. The basic boundings (basic_min and basic_max) of such spins are hard coded, but the used boundings can be changed by changing a parameter (alpha) with a call to this method. The real boundings are then basic_min * alpha and basic_max * alpha. A call to this method is automatically followed by a signal "spinBoundsChanged".
val : |
a floating point value. |