visu_basic

visu_basic — Main functions of V_Sim (except graphical ones).

Functions

Types and Values

Description

There are here the main functions of V_Sim (except for graphical methods) such as open file.

Functions

visu_basic_init ()

void
visu_basic_init (void);

A call to this method is done at startup after having probe the locale of the file system and having initialized the rendering window. It makes the following actions : create the visu object to store the signals, initialize the module part (parameters, and resources), initialize the dump part, the OpenGL part and its extensions, the storage of elements and the 'colorize with data' part.


visu_basic_initConfigFiles ()

void
visu_basic_initConfigFiles (GError **error);

visu_basic_parseConfigFiles ()

gboolean
visu_basic_parseConfigFiles (GError **error);

Parse the parameter and the resource file. Used once at startup.

Parameters

error

location for an error.

 

Returns

a newly allocated GString if some error occured.


visu_basic_showOptionHelp ()

gboolean
visu_basic_showOptionHelp (gboolean force);

Display a small help for some options. The output is different from the -h command line options, here some details about running time options is displayed like the available file format for exportation... If force is TRUE, all possible values are output, otherwise only those relevant to the user provided command line options.

Parameters

force

a boolean.

 

Returns

TRUE if something is displayed.

Since: 3.6


visu_basic_mainExport ()

int
visu_basic_mainExport (void);

This method is called when V_Sim is in export mode from the command line.

Returns

0 if everything is normal, 1 if an error occured.


visu_basic_getPreferedUnit ()

ToolUnits
visu_basic_getPreferedUnit (void);

By setting the prefered unit, when a file is load, V_Sim tries to render it in this prefered unit.

Returns

the prefered unit set by the user (default is TOOL_UNITS_UNDEFINED).

Since: 3.5


visu_basic_setPreferedUnit ()

gboolean
visu_basic_setPreferedUnit (ToolUnits unit);

By setting the prefered unit, when a file is load, V_Sim tries to render it in this prefered unit.

Parameters

unit

a ToolUnits value.

 

Returns

TRUE if the prefered unit is actually changed.

Since: 3.5


visu_basic_setExePath ()

void
visu_basic_setExePath (const gchar *exePath);

This method is used to tell V_Sim where V_Sim is running (usually reading from argv[0]. This makes it possible to relocate everything on the fly. exePath is copied.

Parameters

exePath

a path where the V_Sim executable is running in.

 

Since: 3.6


visu_basic_getDataDir ()

const gchar *
visu_basic_getDataDir (void);

Get the static string where V_Sim looks for its data files.

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getLegalDir ()

const gchar *
visu_basic_getLegalDir (void);

Get the static string where V_Sim looks for its legal files.

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getPixmapsDir ()

const gchar *
visu_basic_getPixmapsDir (void);

Get the static string where V_Sim looks for its pixmap files.

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getIconsDir ()

const gchar *
visu_basic_getIconsDir (void);

Get the static string where V_Sim looks for its icon files.

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getLocalDir ()

const gchar *
visu_basic_getLocalDir (void);

Get the static string where V_Sim looks for its user configuration files.

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getOldLocalDir ()

const gchar *
visu_basic_getOldLocalDir (void);

Get the static string where V_Sim looks for its user configuration files (old location).

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getPluginsDir ()

const gchar *
visu_basic_getPluginsDir (void);

Get the static string where V_Sim looks for its plug-in files.

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getLocaleDir ()

const gchar *
visu_basic_getLocaleDir (void);

Get the static string where V_Sim looks for its localisation files.

Returns

a string owned by V_Sim.

[transfer none]

Since: 3.4


visu_basic_getMainContext ()

GMainContext *
visu_basic_getMainContext (void);

Even without GUI, V_Sim requires to run a main loop. This method is to get the main loop.

Returns

the main loop, as defined in GLib.

[transfer none]

Since: 3.6


visu_basic_freeAll ()

void
visu_basic_freeAll (void);

This routine is called by V_Sim when quiting and it frees the memory used by visu_basic.

Since: 3.5

Types and Values

VISU_VERSION

#define VISU_VERSION       VERSION

The value of current compiled version.


VISU_WEB_SITE

#define VISU_WEB_SITE      "http://inac.cea.fr/L_Sim/V_Sim"

URL where to find info on V_Sim.


V_SIM_DATA_DIR

#define V_SIM_DATA_DIR           visu_basic_getDataDir()

The directory where data files are stored.


V_SIM_LEGAL_DIR

#define V_SIM_LEGAL_DIR          visu_basic_getLegalDir()

The directory where copyright and author files are stored.


V_SIM_PIXMAPS_DIR

#define V_SIM_PIXMAPS_DIR        visu_basic_getPixmapsDir()

The directory where pixmap files are stored.


V_SIM_ICONS_DIR

#define V_SIM_ICONS_DIR          visu_basic_getIconsDir()

The directory where icon files are stored.


V_SIM_LOCAL_CONF_DIR

#define V_SIM_LOCAL_CONF_DIR     visu_basic_getLocalDir()

The directory where user configuration files are stored.


V_SIM_OLD_LOCAL_CONF_DIR

#define V_SIM_OLD_LOCAL_CONF_DIR visu_basic_getOldLocalDir()

Old value of V_SIM_LOCAL_CONF_DIR.


V_SIM_PLUGINS_DIR

#define V_SIM_PLUGINS_DIR        visu_basic_getPluginsDir()

The directory where plugin files are stored.


V_SIM_LOCALE_DIR

#define V_SIM_LOCALE_DIR         visu_basic_getLocaleDir()

The directory where locale files are stored.