for V_Sim 3.3.1


Table of Contents

I. Core
VisuObject - A general object to store the signals
visu_tools - Basic tools and variables that are used all around the program.
visu_commandLine - All methods needed to parse options from the command line.
visu_basic - Main functions of V_Sim (except graphical ones).
visu_elements - defines methods to create and acccess to VisuElement
visu_nodes - Defines the elementary structure to store informations about an element in a box.
visu_data - Give methods to store and manage data from input file(s).
opengl - This part is responsible for the pseudo3D rendering through OpenGl and gives methods to adapt the view.
visu_rendering - Methods to create and add new rendering methods.
visu_configFile - Defines methods to access (read/write) to config files and to create different entries
visu_extension - All objects drawn by V_Sim are defined in by a OpenGLExtension object
visu_pairs - V_Sim can draw link between nodes. This part defines a pair object and interface to draw pairs.
visu_dump - Some resources to add the ability to export the rendered data to an other format (usually image format).
visu_pickMesure - Some methods to treat a VisuPick informations.
visu_plugins - Introduces the basic handling of plug-ins.
Core tools
toolColor - Simple handling and storage of RGBA colours.
toolConfigFile - Generic read methods of the configuration files are defined here.
toolFileFormat - Describes file format objects (name patterns, description, properties...)
toolFortran - introduces routines to read the binary Fortran data format.
toolMatrix - Defines basic handlings on matrix.
toolOptions - A convienent wrapper around GHashTable that can support types.
toolShade - Shades are color gradients.
Rendering methods
renderingSpin - A module able to represent atoms by their position and spin.
renderingAtomic - A rendering method to draw atoms positioned in a box.
renderingAtomic_d3 - Method to load d3 position file.
renderingAtomic_ascii - Method to load ascii position file.
atomic_xyz - Method to load ascii position file.
OpenGL tools
renderingMode - Controls the way OpenGL renders objects.
light - Controls the use of lights in the rendering window.
text - Enables capabilities to write some text on rendering screen.
view - Defines all necessary informations for the rendering of a view.
interactive - Gives tools to interact with the rendered area.
objectList - Gives storage for ids used by OpenGL lists.
Pairs extensions
cylinder - Gives methods to draw cylinders as OpenGl objects pairing two elements.
wire - Gives methods to draw lines as OpenGl objects pairing two elements.
OpenGL specific extensions
box -
axes -
fogAndBGColor -
Extra functionalities
dataFile - Adds a possibility to colorize nodes depending on data read in an input file.
dataNode - Extends capabilities of node properties.
plane - Adds capabilities to draw and handle planes.
scalarFields - Gives capabilities to load a scalar field.
surfaces - Supports loading of .surf files and drawing of surfaces through OpenGL
pot2surf - Creates surfaces from scalar fields.
OS dependancy and rendering window backend
visu_windowInterface -
visu_actionInterface - Interface for defining actions and events.
visu_OSInterface -
visu_openGL -
Methods to export to other formats
dumpToPsAndPdf -
dumpToTiff -
dumpToGif -
dumpThroughGdkPixbuf -
dumpToAscii -
External include files
externalPairsExtensions -
externalOpenGLExtensions -
externalRenderingMethods -
Plug-ins
nq_basic -
nq_structure -
nq_density -
II. Gtk interface
Main interface
callbacks -
gtk_main -
gtk_observePick -
gtk_about -
gtk_save -
gtk_pairs -
gtk_openGLWidget - defines an OpenGL capable GtkWidget
gtk_renderingWindowWidget -
V_Sim specific widgets
gtk_colorComboBoxWidget -
gtk_numericalEntryWidget -
gtk_dumpDialogWidget -
gtk_toolPanelWidget -
gtk_shadeComboBoxWidget -
Panel add-ons
panelBoxAxes -
panelFogBgColor -
gtkAtomic -
gtkSpin - The gtk interface elements that can interfere with renderingSpin parameters
panelElements -
panelBrowser -
panelPlanes -
panelDataFile -
panelSurfaces - Gtk interface to load isosurfaces.
panelSurfacesTools - Gtk interface to manage isosurfaces
panelMethod -
panelOpenGL -
visuConfig -
gtk_cylinder -
gtk_wire -
Index