v_sim.GlExtMapSet¶

Subclasses:: None

Methods¶

Inherited:: v_sim.GlExtMaps (9), v_sim.GlExt (16), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (name)
	`addFromPlane` (plane)
	`export` (map, filename, format)
	`getLegend` ()
	`getPlane` (map)
	`getPrecision` ()
	`getTransparent` ()
	`setField` (field)
	`setLineColor` (color)
	`setLines` (nLines)
	`setPlane` (map, plane)
	`setPrecision` (prec)
	`setScaling` (scale)
	`setScalingRange` (minMax)
	`setShade` (shade)
	`setTransparent` (alpha)

Virtual Methods¶

Inherited:: v_sim.GlExtMaps (3), v_sim.GlExt (3), GObject.Object (7)

Properties¶

Inherited:: v_sim.GlExt (9)

Name	Type	Flags	Short Description
`field`	`v_sim.ScalarField`	r/w	field storing 3D data
`line-color`	`v_sim.Color`	r/w	colour used to draw isolines
`manual-range`	`GLib.Array`	r/w	manual range values
`manual-range-max`	`float`	r/w	manual range maximum value
`manual-range-min`	`float`	r/w	manual range minimum value
`n-lines`	`int`	r/w	number of lines is the full range
`precision`	`float`	r/w	map degree of adaptability
`scale`	`int`	r/w	scaling method
`shade`	`v_sim.Shade`	r/w	shade used to colourise the map
`transparent`	`bool`	r/w	use alpha channel according to field values
`use-manual-range`	`bool`	r/w	use manual range

Signals¶

Inherited:: v_sim.GlExtMaps (2), GObject.Object (1)

Fields¶

Inherited:: v_sim.GlExtMaps (2), GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.GlExtMaps`	r
priv	`v_sim.GlExtMapSetPrivate`	r

Class Details¶

class v_sim.GlExtMapSet(**kwargs)¶

Bases:: v_sim.GlExtMaps
Abstract:: No
Structure:: v_sim.GlExtMapSetClass

An opaque structure.

New in version 3.8.

classmethod new(name)¶

Parameters:: name (str or None) – the name to give to the extension.
Returns:: a pointer to the v_sim.GlExt it created or None otherwise.
Return type:: v_sim.GlExtMapSet

Creates a new v_sim.GlExt to draw mapSet.

New in version 3.7.

addFromPlane(plane)¶

Parameters:: plane (v_sim.Plane) – a v_sim.Plane object.
Returns:: the corresponding v_sim.Map.
Return type:: v_sim.Map

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

New in version 3.8.

export(map, filename, format)¶

Parameters:

map (v_sim.Map) – a given v_sim.Map object.
filename (str) – a filename.
format (v_sim.MapExportFormat) – a format.

Raises:

GLib.Error

Returns:

True if exportation is successful.

Return type:

bool

Runs v_sim.Map.export() on map with self shade and colour.

New in version 3.8.

getLegend()¶

Returns:: the associated v_sim.GlExtShade legend.
Return type:: v_sim.GlExtShade

Retrieve the associated v_sim.GlExtShade object used to draw the legend.

New in version 3.8.

getPlane(map)¶

Parameters:: map (v_sim.Map) – a v_sim.Map object.
Returns:: the attached v_sim.Plane if any.
Return type:: v_sim.Plane

Retrieve the v_sim.Plane map was build from (if any).

New in version 3.8.

getPrecision()¶

Returns:: the precision value.
Return type:: float

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

New in version 3.8.

getTransparent()¶

Returns:: if map is rendered with transparency or not.
Return type:: bool

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

New in version 3.8.

setField(field)¶

Parameters:: field (v_sim.ScalarField) – a v_sim.ScalarField object.

Associate field to the self.

New in version 3.8.

setLineColor(color)¶

Parameters:: color (v_sim.Color or None) – a v_sim.Color object.
Returns:: True if color of map is changed.
Return type:: bool

Changes the rendered isoline color of map to color. If color is None, then the isolines will be color inversed to the v_sim.Shade of map (see v_sim.GlExtMapSet.setShade()).

New in version 3.8.

setLines(nLines)¶

Parameters:: nLines (int) – a number.
Returns:: True if the number of lines of self is changed.
Return type:: bool

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

New in version 3.8.

setPlane(map, plane)¶

Parameters:

map (v_sim.Map) – a v_sim.Map object.
plane (v_sim.Plane) – a v_sim.Plane object.

Change the plane where map is projected on to plane.

New in version 3.8.

setPrecision(prec)¶

Parameters:: prec (float) – a floating point value (default is 100).
Returns:: True if prec of map is changed.
Return type:: bool

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.

New in version 3.8.

setScaling(scale)¶

Parameters:: scale (v_sim.MatrixScalingFlag) – a v_sim.MatrixScalingFlag scaling method.
Returns:: True if scaling function is changed.
Return type:: bool

Set globally the scaling method for all v_sim.Map in self.

New in version 3.8.

setScalingRange(minMax)¶

Parameters:: minMax ([float] or None) – a range.
Returns:: True if the range is changed of self is changed.
Return type:: bool

Set globally the scaling range for all v_sim.Map in self.

New in version 3.8.

setShade(shade)¶

Parameters:: shade (v_sim.Shade or None) – a v_sim.Shade object.
Returns:: True if shade of map is changed.
Return type:: bool

Changes the v_sim.Shade used to render data variation on the map.

New in version 3.8.

setTransparent(alpha)¶

Parameters:: alpha (bool) – a boolean.
Returns:: True if transparency of map is changed.
Return type:: bool

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.

New in version 3.8.

Property Details¶

v_sim.GlExtMapSet.props.field¶

Name:: field
Type:: v_sim.ScalarField
Default Value:: None
Flags:: READABLE, WRITABLE

field storing 3D data

v_sim.GlExtMapSet.props.line_color¶

Name:: line-color
Type:: v_sim.Color
Default Value:: None
Flags:: READABLE, WRITABLE

colour used to draw isolines

v_sim.GlExtMapSet.props.manual_range¶

Name:: manual-range
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

manual range values

v_sim.GlExtMapSet.props.manual_range_max¶

Name:: manual-range-max
Type:: float
Default Value:: -3.4028234663852886e+38
Flags:: READABLE, WRITABLE

manual range maximum value

v_sim.GlExtMapSet.props.manual_range_min¶

Name:: manual-range-min
Type:: float
Default Value:: -3.4028234663852886e+38
Flags:: READABLE, WRITABLE

manual range minimum value

v_sim.GlExtMapSet.props.n_lines¶

Name:: n-lines
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

number of lines is the full range

v_sim.GlExtMapSet.props.precision¶

Name:: precision
Type:: float
Default Value:: 100.0
Flags:: READABLE, WRITABLE

map degree of adaptability

v_sim.GlExtMapSet.props.scale¶

Name:: scale
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

scaling method

v_sim.GlExtMapSet.props.shade¶

Name:: shade
Type:: v_sim.Shade
Default Value:: None
Flags:: READABLE, WRITABLE

shade used to colourise the map

v_sim.GlExtMapSet.props.transparent¶

Name:: transparent
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

use alpha channel according to field values

v_sim.GlExtMapSet.props.use_manual_range¶

Name:: use-manual-range
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

use manual range