v_sim.GlExtMaps¶

Subclasses:: v_sim.GlExtMapSet

Methods¶

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

class	`new` (name)
	`add` (map, prec, shade, color, alpha)
	`iter_new` ()
	`remove` (map)
	`removeAll` ()
	`setLineColor` (map, color)
	`setPrecision` (map, prec)
	`setShade` (map, shade)
	`setTransparent` (map, alpha)

Virtual Methods¶

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

	`do_add` (map, prec, shade, color, alpha)
	`do_added` (map)
	`do_removed` (map)

Properties¶

Inherited:: v_sim.GlExt (9)

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`added`	This signal is emitted when map is added to maps.
`removed`	This signal is emitted when map is removed to maps.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.GlExt`	r
priv	`v_sim.GlExtMapsPrivate`	r

Class Details¶

class v_sim.GlExtMaps(**kwargs)¶

Bases:: v_sim.GlExt
Abstract:: No
Structure:: v_sim.GlExtMapsClass

An opaque structure.

New in version 3.7.

classmethod new(name)¶

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

Creates a new v_sim.GlExt to draw maps.

New in version 3.7.

add(map, prec, shade, color, alpha)¶

Parameters:

map (v_sim.Map) – a v_sim.Maps object.
prec (float) – rendering adaptivity level (default is 100).
shade (v_sim.Shade) – a v_sim.Shade object.
color (v_sim.Color or None) – a v_sim.Color object.
alpha (bool) – a boolean.

Returns:

False if surf was already reguistered.

Return type:

bool

Add a new map to the list of drawn maps. If color is None, 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.

New in version 3.7.

iter_new()¶

Returns:: a location to v_sim.GlExtMapsIter.
Return type:: iter: v_sim.GlExtMapsIter

Generate a new iterator to run over v_sim.Map objects stored in self.

New in version 3.8.

remove(map)¶

Parameters:: map (v_sim.Map) – a v_sim.Maps object.
Returns:: True if map was part of drawn maps.
Return type:: bool

Removes map from the list of drawn maps.

New in version 3.7.

removeAll()¶: Removes all the v_sim.Map stored in self.

New in version 3.8.

setLineColor(map, color)¶

Parameters:

map (v_sim.Map) – a v_sim.Map object.
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.GlExtMaps.setShade()).

New in version 3.7.

setPrecision(map, prec)¶

Parameters:

map (v_sim.Map) – a v_sim.Map object.
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.7.

setShade(map, shade)¶

Parameters:

map (v_sim.Map) – a v_sim.Map object.
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.7.

setTransparent(map, alpha)¶

Parameters:

map (v_sim.Map) – a v_sim.Map object.
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.7.

do_add(map, prec, shade, color, alpha) virtual¶

Parameters:

map (v_sim.Map) – a v_sim.Maps object.
prec (float) – rendering adaptivity level (default is 100).
shade (v_sim.Shade) – a v_sim.Shade object.
color (v_sim.Color or None) – a v_sim.Color object.
alpha (bool) – a boolean.

Returns:

False if surf was already reguistered.

Return type:

bool

Add a new map to the list of drawn maps. If color is None, 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.

New in version 3.7.

do_added(map) virtual¶

Parameters:: map (v_sim.Map) –

a method that is called when a v_sim.Map is added to a v_sim.GlExtMaps object.

do_removed(map) virtual¶

Parameters:: map (v_sim.Map) –

a method that is called when a v_sim.Map is removed from a v_sim.GlExtMaps object.

Signal Details¶

v_sim.GlExtMaps.signals.added(gl_ext_maps, map)¶

Signal Name:

added

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

gl_ext_maps (v_sim.GlExtMaps) – The object which received the signal
map (v_sim.Map) – the added v_sim.Map.

This signal is emitted when map is added to maps.

New in version 3.8.

v_sim.GlExtMaps.signals.removed(gl_ext_maps, map)¶

Signal Name:

removed

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

gl_ext_maps (v_sim.GlExtMaps) – The object which received the signal
map (v_sim.Map) – the removed v_sim.Map.

This signal is emitted when map is removed to maps.

New in version 3.8.