panelDataFile

panelDataFile — The tab where to configure the action of an external data file on colourisation of nodes.

Synopsis

VisuUiPanel *       visu_ui_panel_colorization_init     ();
gboolean            visu_ui_panel_colorization_load     (VisuData *visuData,
                                                         const gchar *file,
                                                         gboolean *new);
void                visu_ui_panel_colorization_setManualRange
                                                        (float min,
                                                         float max,
                                                         int column);
gboolean            visu_ui_panel_colorization_setPresetShade
                                                        (ToolShade *shade);
void                visu_ui_panel_colorization_setRangeMode
                                                        (VisuColorizationInputScaleId mode);
void                visu_ui_panel_colorization_setUsed  (gboolean used);
void                visu_ui_panel_colorization_update   (VisuData *visuData);

Description

The widgets are organised in three categories. The first is used to normalised the inputs, see visu_ui_panel_colorization_setManualRange() or visu_ui_panel_colorization_setRangeMode(). The second category is used for colourisation, see visu_ui_panel_colorization_setPresetShade(). Finally the last category is about post-processing.

Details

visu_ui_panel_colorization_init ()

VisuUiPanel *       visu_ui_panel_colorization_init     ();

Should be used in the list declared in externalModules.h to be loaded by V_Sim on start-up. This routine will create the VisuUiPanel where the colouring stuff can be done, such as choosing a colour shade, opening a file, setting boundaries...

Returns :

a newly created VisuUiPanel object.

visu_ui_panel_colorization_load ()

gboolean            visu_ui_panel_colorization_load     (VisuData *visuData,
                                                         const gchar *file,
                                                         gboolean *new);

Read the given data file and associate the values of each column to the node. It does not update the widgets of the panel. This is done to allow to change the values of the colouration before drawing the widgets. See visu_ui_panel_colorization_update() to do it.

visuData :

the VisuData object to associated the data to ;

file :

the file to read ;

new :

return TRUE if the loaded data are associated for the first time to visuData.

Returns :

TRUE if VisuNodeArray::RenderingChanged should be emitted.

visu_ui_panel_colorization_setManualRange ()

void                visu_ui_panel_colorization_setManualRange
                                                        (float min,
                                                         float max,
                                                         int column);

Set the clamping range to [min;max] for column. Column ids range from 0 to (max number of column - 1). Use -3, -2 and -1 for x coordinates, y and z.

min :

a float value.

max :

a float value.

column :

the column to apply the manual range to.

Since 3.7


visu_ui_panel_colorization_setPresetShade ()

gboolean            visu_ui_panel_colorization_setPresetShade
                                                        (ToolShade *shade);

Change the preset shade used to colourise the data.

shade :

a ToolShade object.

Returns :

TRUE if a ToolShade is set.

visu_ui_panel_colorization_setRangeMode ()

void                visu_ui_panel_colorization_setRangeMode
                                                        (VisuColorizationInputScaleId mode);

Set how data are clamp into [0;1].

mode :

auto or manual scaling mode.

Since 3.7


visu_ui_panel_colorization_setUsed ()

void                visu_ui_panel_colorization_setUsed  (gboolean used);

Set if the panel is used or not.

used :

a boolean.

visu_ui_panel_colorization_update ()

void                visu_ui_panel_colorization_update   (VisuData *visuData);

Update the widgets depending on the colouration associated to the given VisuData object.

visuData :

the VisuData object to associated the data to.