V_Sim API - Reference Manual |
|---|
- I. Core
- VisuObject — A general object to store the signals.
- 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.
- VisuRendering — 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 VisuExtension 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_plugins — Introduces the basic handling of plug-ins.
- Core tools
- toolOptions — A convienent wrapper around GHashTable that can support types.
- toolMatrix — Defines basic handlings on matrix.
- toolConfigFile — Generic read methods of the configuration files are defined here.
- toolFortran — Introduces routines to read the binary Fortran data format.
- toolPhysic — introduce physical values for the chemical species.
- toolColor — Simple handling and storage of RGBA colours.
- toolShade — ToolShades are color gradients.
- toolFileFormat — Describes file format objects (name patterns, description, properties...).
- Rendering methods
- 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.
- renderingSpin — A module able to represent atoms by their position and spin.
- 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 and provides primitive routine for common drawing operations (distances, torus...).
- Pairs extensions
- OpenGL specific extensions
- box — Draw a bounding box around nodes.
- axes — Defines methods to draw axes.
- extInfos — give the capability to draw some information near each node.
- scale — Draw an arrow with a label.
- fogAndBGColor — Handle the background colour and the fog.
- legend — Draw a frame with the representation of each atom species, its name and the number of elements.
- marks — Draw features on nodes, like measurement marks or highlights.
- rings — an extension to highlight closed rings in a structure.
- Extra functionalities
- dataFile — Adds a possibility to colorize nodes depending on data read in an input file.
- dataNode — Extends capabilities of node properties.
- extraNode — add further characteristics to the nodes.
- plane — Adds capabilities to draw and handle planes.
- scalarFields — Gives capabilities to load a scalar field.
- isoline — handle the drawing and the computation of isolines.
- surfaces — Supports loading of .surf files and drawing of surfaces through OpenGL.
- surfaces_points — Define a structure to store a set of triangles defining a surface.
- surfaces_resources — Define the rendering parameters of a surface.
- pot2surf — Creates surfaces from scalar fields.
- geometry — different routines to do high level geometry studies on a box or a set of boxes.
- vibration — Add a support to animate the node positions with a phonon frequency.
- map — Describe how to handle and draw coloured map on a plane from a density field.
- OS dependancy and rendering window backend
- visu_actionInterface — Interface for defining actions and events.
- visu_openGL — Define the OS dependent routines related to OpenGL.
- Methods to export to other formats
- dumpThroughGdkPixbuf — add an export capability into PNG and JPG files.
- dumpToGif — add an export capability into GIF files.
- dumpToAscii — add an export capability of current positions.
- dumpToTiff — add an export capability into TIFF files.
- dumpToXyz — add an export capability of current positions.
- dumpToPsAndPdf — add an export capability into PS and PDF files (encapsulating bitmaps).
- dumpToSVG — add an export capability into SVG files.
- dumpToABINIT — add an export capability of current positions in ABINIT format.
- II. Gtk interface
- Main interface
- visu_gtk — Basic GUI routines, for preview, standard dialogs...
- gtk_main — The command panel definition.
- gtk_interactive — The interactive dialog.
- gtk_pick — The pick and measurement tab in the interactive dialog.
- gtk_move — The move tab in the interactive dialog.
- gtk_about — The about dialog with a readme, the copyright, the author list, the plug-in list and the version notes.
- gtk_save — The load/save dialog for resources and parameters.
- gtk_pairs — The pairs dialog.
- gtk_openGLWidget — defines an OpenGL capable GtkWidget.
- gtk_renderingWindowWidget — Defines a complex widget used to render files and print information.
- V_Sim specific widgets
- gtk_dumpDialogWidget — Defines a widget to export into different file formats.
- gtk_toolPanelWidget — Defines a widget that hold a set of V_Sim panel.
- gtk_numericalEntryWidget — Defines a widget to enter numerical values without any boundary or precision constrains.
-
gtk_valueIOWidget — Defines a specialised
GtkHBox with three button to open, save and save as XML value files. -
gtk_colorComboBoxWidget — Defines a specialised
GtkComboBox to choose stored colours. -
gtk_stippleComboBoxWidget — Defines a specialised
GtkComboBox to choose patterns for lines. - gtk_orientationChooser — Defines a dialog widget to choose the camera position.
-
gtk_shadeComboBoxWidget — Defines a specialised
GtkComboBox to choose pre-built shades. -
gtk_lineObjectWidget — Defines a specialised
GtkHBox to choose all characteristic of lines. -
gtk_elementComboBox — Defines a specialised
GtkComboBox to choose VisuElement. - gtk_curveWidget — A specialised curve widget to draw distance distribution for pairs.
- Panel add-ons
- panelSurfaces — Gtk interface to load isosurfaces.
- panelElements — The tab where VisuElement characteristics can be tuned.
- panelMethod — The tab where drawing method is chosen (atomic or spin).
- panelPlanes — The tab where planes are defined.
- panelBrowser — A tab to view a list of files and quickly change from one to another.
- panelVibration — The tab where phonons are loaded and listed.
- panelDataFile — The tab where to configure the action of an external data file on colourisation of nodes.
- panelMap — The widget to create coloured map.
- panelFogBgColor — The widget to tune the background and the fog.
- panelGeometry — This tab gathers the geometry operation on a VisuData, like periodic translation, physical units, ...
- panelOpenGL — The tab where OpenGL options like lights or quality are setup.
- panelSurfacesTools — Gtk interface to manage isosurfaces.
- panelAxes — The tab where axes, box, scale and legend are setup.
- panelConfig — The tab where miscellaneous options are setup.
- gtkAtomic — The gtk interface elements that are specific to the atomic rendering method.
- gtkSpin — The gtk interface elements that can interfere with renderingSpin parameters.
- gtk_wire — The additional widgets displayed in the pair dialog to handle wire pairs.
- gtk_cylinder — The additional widgets displayed in the pair dialog to handle cylinder pairs.
- III. Additional information
- API Index