geometry

geometry — different routines to do high level geometry studies on a box or a set of boxes.

Functions

Object Hierarchy

    GBoxed
    ╰── VisuPaths

Description

The first possibility of the geometry section is to make a two by two difference node position difference between two VisuData objects. The VisuNode positions are compared (number to number and not closed equivalent to closed equivalent) and stored for visualisation. The visualisation is done through small arrows position on the currently visualised file.

Functions

visu_paths_new ()

VisuPaths *
visu_paths_new (float translation[3]);

Create a new VisuPaths object.

Parameters

translation

the current box translation (cartesian).

[in][array fixed-size=3]

Returns

the newly create object VisuPaths, to be freed with visu_paths_free().

Since: 3.6


visu_paths_ref ()

VisuPaths *
visu_paths_ref (VisuPaths *paths);

Increase the ref counter.

Parameters

paths

a VisuPaths object.

 

Returns

itself.

Since: 3.7


visu_paths_unref ()

void
visu_paths_unref (VisuPaths *paths);

Decrease the ref counter, free all memory if counter reachs zero.

Parameters

paths

a VisuPaths object.

 

Since: 3.7


visu_paths_free ()

void
visu_paths_free (VisuPaths *paths);

Free a set of paths.

Parameters

paths

a VisuPaths object.

 

Since: 3.6


visu_paths_empty ()

void
visu_paths_empty (VisuPaths *paths);

Reinitialise internal values of a given paths .

Parameters

paths

a VisuPaths object.

 

Since: 3.6


visu_paths_addFromDiff ()

gboolean
visu_paths_addFromDiff (VisuPaths *paths,
                        VisuDataDiff *data,
                        gdouble energy);

This routine read the geometry difference hold in data and add a new step in the set of paths. If new paths are created, one should call visu_paths_setTranslation() to be sure that all paths are moved inside the box.

Parameters

data

a VisuData object with a geometry difference (see visu_geodiff_new()).

 

paths

the set of paths to extend.

 

energy

the current total energy, if any, otherwise use G_MAXFLOAT.

 

Returns

TRUE if new paths have been added.

Since: 3.6


visu_paths_addNodeStep ()

gboolean
visu_paths_addNodeStep (VisuPaths *paths,
                        guint time,
                        guint nodeId,
                        float xyz[3],
                        float dxyz[3],
                        float energy);

This routine expand the path for the given nodeId at position xyz of dxyz . The energy value will be used only if visu_paths_setToolShade() is used with a non NULL ToolShade. In that case the energy value will be used to colourise the provided path.

Parameters

paths

a set of paths.

 

time

the flag that give the number of expansion to update.

 

nodeId

the node to expand the path of.

 

xyz

the current position of the path.

 

dxyz

the variation in the path.

 

energy

the energy of the system.

 

Returns

TRUE if a new path is started.

Since: 3.6


visu_paths_pinPositions ()

void
visu_paths_pinPositions (VisuPaths *paths,
                         VisuData *data);

Use the current positions of data to extend paths .

Parameters

paths

a VisuPaths object.

 

data

a VisuData object.

 

Since: 3.6


visu_paths_draw ()

void
visu_paths_draw (VisuPaths *paths,
                 float pathWidth);

OpenGL calls to create the paths.

Parameters

paths

a set of paths.

 

pathWidth

the width for the drawn path

 

Since: 3.6


visu_paths_constrainInBox ()

void
visu_paths_constrainInBox (VisuPaths *paths,
                           VisuData *data);

Modify the corrdinates of the path nodes to contraint them in a box (when applying translations for instance).

Parameters

paths

a VisuPaths object.

 

data

a VisuData object.

 

Since: 3.6


visu_paths_exportXMLFile ()

gboolean
visu_paths_exportXMLFile (const VisuPaths *paths,
                          const gchar *filename,
                          GError **error);

Write an XML file with the description of the given paths .

Parameters

paths

a VisuPaths object.

 

filename

a location on disk.

 

error

a pointer on an error.

 

Returns

TRUE if no error.

Since: 3.6


visu_paths_parseFromXML ()

gboolean
visu_paths_parseFromXML (const gchar *filename,
                         VisuPaths *paths,
                         GError **error);

Read an XML containing a description of paths . paths is newly created on success and should be freed with visu_paths_free().

Parameters

filename

a location on disk.

 

paths

a VisuPaths object.

 

error

a pointer on an error.

 

Returns

TRUE on success.

Since: 3.6


visu_paths_setTranslation ()

void
visu_paths_setTranslation (VisuPaths *paths,
                           float cartCoord[3]);

Change the translation of the path, stored in cartesian coordinates.

Parameters

paths

a VisuPaths object.

 

cartCoord

three floats.

 

Since: 3.6


visu_paths_setToolShade ()

gboolean
visu_paths_setToolShade (VisuPaths *paths,
                         const ToolShade *shade);

Set the colourisation scheme for the path.

Parameters

paths

a VisuPaths object.

 

shade

a ToolShade object.

 

Returns

TRUE is the scheme is changed.

Since: 3.6


visu_paths_getToolShade ()

const ToolShade *
visu_paths_getToolShade (const VisuPaths *paths);

The paths are drawn with a colourisation scheme.

Parameters

paths

a VisuPaths object.

 

Returns

the ToolShade used by the paths .

Since: 3.6


visu_paths_getLength ()

guint
visu_paths_getLength (VisuPaths *paths);

Get the number of steps stored in a VisuPaths.

Parameters

paths

a VisuPaths object.

 

Returns

the number of steps.

Since: 3.6

Types and Values