VisuGlExtMapSet

VisuGlExtMapSet — Defines methods to draw maps that share a same VisuScalarField.

Functions

Properties

VisuScalarField * field Read / Write
ToolColor * line-color Read / Write
GArray * manual-range Read / Write
gfloat manual-range-max Read / Write
gfloat manual-range-min Read / Write
guint n-lines Read / Write
gfloat precision Read / Write
guint scale Read / Write
ToolShade * shade Read / Write
gboolean transparent Read / Write
gboolean use-manual-range Read / Write

Object Hierarchy

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

Description

Maps are coloured representation of a VisuScalarField on a VisuPlane.

Functions

visu_gl_ext_map_set_new ()

VisuGlExtMapSet *
visu_gl_ext_map_set_new (const gchar *name);

Creates a new VisuGlExt to draw mapSet.

Parameters

name

the name to give to the extension.

[allow-none]

Returns

a pointer to the VisuGlExt it created or NULL otherwise.

Since: 3.7


visu_gl_ext_map_set_getLegend ()

VisuGlExtShade *
visu_gl_ext_map_set_getLegend (VisuGlExtMapSet *mapSet);

Retrieve the associated VisuGlExtShade object used to draw the legend.

Parameters

mapSet

a VisuGlExtMapSet object.

 

Returns

the associated VisuGlExtShade legend.

[transfer none]

Since: 3.8


visu_gl_ext_map_set_setField ()

void
visu_gl_ext_map_set_setField (VisuGlExtMapSet *mapSet,
                              VisuScalarField *field);

Associate field to the mapSet .

Parameters

mapSet

a VisuGlExtMapSet object.

 

field

a VisuScalarField object.

[transfer none]

Since: 3.8


visu_gl_ext_map_set_addFromPlane ()

VisuMap *
visu_gl_ext_map_set_addFromPlane (VisuGlExtMapSet *mapSet,
                                  VisuPlane *plane);

Add a new map to the list of drawn mapSet. If color is NULL, then iso-lines will be drawn in inverse color.

Parameters

mapSet

a VisuGlExtMapSet object.

 

plane

a VisuPlane object.

[transfer none]

Returns

the corresponding VisuMap.

[transfer none]

Since: 3.8


visu_gl_ext_map_set_setPlane ()

void
visu_gl_ext_map_set_setPlane (VisuGlExtMapSet *mapSet,
                              VisuMap *map,
                              VisuPlane *plane);

Change the plane where map is projected on to plane .

Parameters

mapSet

a VisuGlExtMapSet object.

 

map

a VisuMap object.

 

plane

a VisuPlane object.

 

Since: 3.8


visu_gl_ext_map_set_getPlane ()

VisuPlane *
visu_gl_ext_map_set_getPlane (VisuGlExtMapSet *mapSet,
                              VisuMap *map);

Retrieve the VisuPlane map was build from (if any).

Parameters

mapSet

a VisuGlExtMapSet object.

 

map

a VisuMap object.

 

Returns

the attached VisuPlane if any.

[transfer none]

Since: 3.8


visu_gl_ext_map_set_setPrecision ()

gboolean
visu_gl_ext_map_set_setPrecision (VisuGlExtMapSet *mapSet,
                                  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

mapSet

a VisuGlExtMapSet object.

 

prec

a floating point value (default is 100).

 

Returns

TRUE if prec of map is changed.

Since: 3.8


visu_gl_ext_map_set_setShade ()

gboolean
visu_gl_ext_map_set_setShade (VisuGlExtMapSet *mapSet,
                              ToolShade *shade);

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

Parameters

mapSet

a VisuGlExtMapSet object.

 

shade

a ToolShade object.

[allow-none][transfer full]

Returns

TRUE if shade of map is changed.

Since: 3.8


visu_gl_ext_map_set_setLineColor ()

gboolean
visu_gl_ext_map_set_setLineColor (VisuGlExtMapSet *mapSet,
                                  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_map_set_setShade()).

Parameters

mapSet

a VisuGlExtMapSet object.

 

color

a ToolColor object.

[allow-none][transfer full]

Returns

TRUE if color of map is changed.

Since: 3.8


visu_gl_ext_map_set_setTransparent ()

gboolean
visu_gl_ext_map_set_setTransparent (VisuGlExtMapSet *mapSet,
                                    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

mapSet

a VisuGlExtMapSet object.

 

alpha

a boolean.

 

Returns

TRUE if transparency of map is changed.

Since: 3.8


visu_gl_ext_map_set_getPrecision ()

float
visu_gl_ext_map_set_getPrecision (const VisuGlExtMapSet *mapSet);

Return the rendering adaptability of map , or the general adaptability value if map is NULL.

Parameters

mapSet

a VisuGlExtMapSet object.

 

Returns

the precision value.

Since: 3.8


visu_gl_ext_map_set_getTransparent ()

gboolean
visu_gl_ext_map_set_getTransparent (const VisuGlExtMapSet *mapSet);

Return if field values are also used for alpha channel for map , or the general setting if map is NULL.

Parameters

mapSet

a VisuGlExtMapSet object.

 

Returns

if map is rendered with transparency or not.

Since: 3.8


visu_gl_ext_map_set_setLines ()

gboolean
visu_gl_ext_map_set_setLines (VisuGlExtMapSet *mapSet,
                              guint nLines);

Set the number of iso-lines that are computed for each VisuMap in mapSet . Contrary to visu_map_setLines(), this routine set the same number of lines for every VisuMap and use the same bounds for all.

Parameters

mapSet

a VisuGlExtMapSet object.

 

nLines

a number.

 

Returns

TRUE if the number of lines of mapSet is changed.

Since: 3.8


visu_gl_ext_map_set_setScaling ()

gboolean
visu_gl_ext_map_set_setScaling (VisuGlExtMapSet *mapSet,
                                ToolMatrixScalingFlag scale);

Set globally the scaling method for all VisuMap in mapSet .

Parameters

mapSet

a VisuGlExtMapSet object.

 

scale

a ToolMatrixScalingFlag scaling method.

 

Returns

TRUE if scaling function is changed.

Since: 3.8


visu_gl_ext_map_set_setScalingRange ()

gboolean
visu_gl_ext_map_set_setScalingRange (VisuGlExtMapSet *mapSet,
                                     const float minMax[2]);

Set globally the scaling range for all VisuMap in mapSet .

Parameters

mapSet

a VisuGlExtMapSet object.

 

minMax

a range.

[array fixed-size=2][allow-none]

Returns

TRUE if the range is changed of mapSet is changed.

Since: 3.8


visu_gl_ext_map_set_export ()

gboolean
visu_gl_ext_map_set_export (VisuGlExtMapSet *mapSet,
                            VisuMap *map,
                            const gchar *filename,
                            VisuMapExportFormat format,
                            GError **error);

Runs visu_map_export() on map with mapSet shade and colour.

Parameters

mapSet

a VisuGlExtMapSet object.

 

map

a given VisuMap object.

 

filename

a filename.

 

format

a format.

 

error

an error location.

 

Returns

TRUE if exportation is successful.

Since: 3.8

Types and Values

Property Details

The “field” property

  “field”                    VisuScalarField *

field storing 3D data.

Flags: Read / Write


The “line-color” property

  “line-color”               ToolColor *

colour used to draw isolines.

Flags: Read / Write


The “manual-range” property

  “manual-range”             GArray *

manual range values.

Flags: Read / Write


The “manual-range-max” property

  “manual-range-max”         gfloat

manual range maximum value.

Flags: Read / Write

Default value: -3.40282e+38


The “manual-range-min” property

  “manual-range-min”         gfloat

manual range minimum value.

Flags: Read / Write

Default value: -3.40282e+38


The “n-lines” property

  “n-lines”                  guint

number of lines is the full range.

Flags: Read / Write

Default value: 0


The “precision” property

  “precision”                gfloat

map degree of adaptability.

Flags: Read / Write

Allowed values: [10,200]

Default value: 100


The “scale” property

  “scale”                    guint

scaling method.

Flags: Read / Write

Allowed values: <= 2

Default value: 0


The “shade” property

  “shade”                    ToolShade *

shade used to colourise the map.

Flags: Read / Write


The “transparent” property

  “transparent”              gboolean

use alpha channel according to field values.

Flags: Read / Write

Default value: FALSE


The “use-manual-range” property

  “use-manual-range”         gboolean

use manual range.

Flags: Read / Write

Default value: FALSE