VisuGlExtMaps

VisuGlExtMaps — Defines methods to draw maps.

Functions

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuGlExt
            ╰── VisuGlExtMaps
                ╰── VisuGlExtMapSet

Description

Maps are coloured representation of a VisuScalarField on a VisuPlane.

Functions

visu_gl_ext_maps_new ()

VisuGlExtMaps *
visu_gl_ext_maps_new (const gchar *name);

Creates a new VisuGlExt to draw maps.

Parameters

name

the name to give to the extension (default is VISU_GL_EXT_MAPS_ID).

[allow-none]

Returns

a pointer to the VisuGlExt it created or NULL otherwise.

Since: 3.7


visu_gl_ext_maps_add ()

gboolean
visu_gl_ext_maps_add (VisuGlExtMaps *maps,
                      VisuMap *map,
                      float prec,
                      ToolShade *shade,
                      const ToolColor *color,
                      gboolean alpha);

Add a new map to the list of drawn maps. If color is NULL, then iso-lines will be drawn in inverse color. If alpha is TRUE, the map will be rendered with alpha blending when values go to zero.

Parameters

maps

a VisuGlExtMaps object.

 

map

a VisuMaps object.

[transfer full]

prec

rendering adaptivity level (default is 100).

 

shade

a ToolShade object.

[transfer full]

color

a ToolColor object.

[transfer full][allow-none]

alpha

a boolean.

 

Returns

FALSE if surf was already reguistered.

Since: 3.7


visu_gl_ext_maps_remove ()

gboolean
visu_gl_ext_maps_remove (VisuGlExtMaps *maps,
                         VisuMap *map);

Removes map from the list of drawn maps.

Parameters

maps

a VisuGlExtMaps object.

 

map

a VisuMaps object.

 

Returns

TRUE if map was part of drawn maps.

Since: 3.7


visu_gl_ext_maps_removeAll ()

void
visu_gl_ext_maps_removeAll (VisuGlExtMaps *maps);

Removes all the VisuMap stored in maps .

Parameters

maps

a VisuGlExtMaps object.

 

Since: 3.8


visu_gl_ext_maps_setPrecision ()

gboolean
visu_gl_ext_maps_setPrecision (VisuGlExtMaps *maps,
                               VisuMap *map,
                               float prec);

Changes the adaptative mesh of map . At a value of 200, there is no adaptivity and all triangles are rendered. At a level of 100, a variation of less than 3% on neighbouring triangles make them merged.

Parameters

maps

a VisuGlExtMaps object.

 

map

a VisuMap object.

 

prec

a floating point value (default is 100).

 

Returns

TRUE if prec of map is changed.

Since: 3.7


visu_gl_ext_maps_setShade ()

gboolean
visu_gl_ext_maps_setShade (VisuGlExtMaps *maps,
                           VisuMap *map,
                           ToolShade *shade);

Changes the ToolShade used to render data variation on the map .

Parameters

maps

a VisuGlExtMaps object.

 

map

a VisuMap object.

 

shade

a ToolShade object.

[allow-none][transfer full]

Returns

TRUE if shade of map is changed.

Since: 3.7


visu_gl_ext_maps_setLineColor ()

gboolean
visu_gl_ext_maps_setLineColor (VisuGlExtMaps *maps,
                               VisuMap *map,
                               const ToolColor *color);

Changes the rendered isoline color of map to color . If color is NULL, then the isolines will be color inversed to the ToolShade of map (see visu_gl_ext_maps_setShade()).

Parameters

maps

a VisuGlExtMaps object.

 

map

a VisuMap object.

 

color

a ToolColor object.

[allow-none][transfer full]

Returns

TRUE if color of map is changed.

Since: 3.7


visu_gl_ext_maps_setTransparent ()

gboolean
visu_gl_ext_maps_setTransparent (VisuGlExtMaps *maps,
                                 VisuMap *map,
                                 gboolean alpha);

Sets if map is rendered with transparency or not. If alpha is TRUE, the lower the rendered value is, the more transparent the colour will be.

Parameters

maps

a VisuGlExtMaps object.

 

map

a VisuMap object.

 

alpha

a boolean.

 

Returns

TRUE if transparency of map is changed.

Since: 3.7


visu_gl_ext_maps_iter_new ()

void
visu_gl_ext_maps_iter_new (VisuGlExtMaps *maps,
                           VisuGlExtMapsIter *iter);

Generate a new iterator to run over VisuMap objects stored in maps .

Parameters

maps

a VisuGlExtMaps object.

 

iter

a location to VisuGlExtMapsIter.

[out caller-allocates]

Since: 3.8


visu_gl_ext_maps_iter_next ()

void
visu_gl_ext_maps_iter_next (VisuGlExtMapsIter *iter);

Go to the next VisuMap in iter .

Parameters

iter

a VisuGlExtMapsIter iterator.

 

Since: 3.8

Types and Values

VISU_GL_EXT_MAPS_ID

#define VISU_GL_EXT_MAPS_ID "Maps"

The id used to identify this extension, see visu_gl_ext_rebuild() for instance.


struct VisuGlExtMapsIter

struct VisuGlExtMapsIter {
  VisuGlExtMaps *maps;
  gboolean valid;
  VisuMap *map;
};

Structure to iterate over VisuMap objects stored in a VisuGlExtMaps object.

Members

VisuGlExtMaps *maps;

the VisuGlExtMaps object the iterator iters on.

 

gboolean valid;

if the iterator is in a valid state.

 

VisuMap *map;

the current VisuMap object the iterator is on.

 

Since: 3.8

Signal Details

The “added” signal

void
user_function (VisuGlExtMaps *maps,
               VisuMap       *map,
               gpointer       user_data)

This signal is emitted when map is added to maps .

Parameters

maps

the object emitting the signal.

 

map

the added VisuMap.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8


The “removed” signal

void
user_function (VisuGlExtMaps *maps,
               VisuMap       *map,
               gpointer       user_data)

This signal is emitted when map is removed to maps .

Parameters

maps

the object emitting the signal.

 

map

the removed VisuMap.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8