v_sim.GlExtShade

Subclasses:

None

Methods

Inherited:

v_sim.GlExtFrame (9), v_sim.GlExt (60), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (name)
	setMarks (marks)
	setMinMax (minV, maxV)
	setScaling (scaling)
	setShade (shade)

Virtual Methods

Inherited:

v_sim.GlExtFrame (3), v_sim.GlExt (6), GObject.Object (7)

Properties

Inherited:

v_sim.GlExtFrame (7), v_sim.GlExt (11)

Name	Type	Flags	Short Description
range-min-max	GLib.Array	r/w	min / max range to normalise data
shade	v_sim.Shade	r/w	colorization scheme

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	v_sim.GlExtFrame	r
priv	v_sim.GlExtShadePrivate	r

Class Details

class v_sim.GlExtShade(**kwargs)

Bases:

v_sim.GlExtFrame

Abstract:

No

Structure:

v_sim.GlExtShadeClass

An opaque structure.

Added 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_SHADE_ID).

Returns:

a pointer to the v_sim.GlExt it created or None otherwise.

Return type:

v_sim.GlExtShade

Creates a new v_sim.GlExt to draw a shade.

Added in version 3.7.

setMarks(marks)

Parameters:

marks ([float]) – a list of float values in [0;1].

Returns:

True if value is actually changed.

Return type:

bool

The legend can draw additional marks in the shade. Setup these marks with this routine. The first and the last marks of the list will be rendered bigger than the next ones.

Added in version 3.7.

setMinMax(minV, maxV)

Parameters:

• minV (float) – a value.

• maxV (float) – another value.

Returns:

True if value is actually changed.

Return type:

bool

Change the minimum and maximum values used on the legend.

Added in version 3.7.

setScaling(scaling)

Parameters:

scaling (v_sim.MatrixScalingFlag) – a v_sim.MatrixScalingFlag value.

Returns:

True if value is actually changed.

Return type:

bool

Change the scaling variation of the shade between the minimum and the maximum values, see v_sim.GlExtShade.setMinMax().

Added in version 3.7.

setShade(shade)

Parameters:

shade (v_sim.Shade) – the shade to get the color of.

Returns:

True if internal shade is changed.

Return type:

bool

Attach an v_sim.GlView to render to and setup the shade.

Added in version 3.7.

Property Details

v_sim.GlExtShade.props.range_min_max

Name:

range-min-max

Type:

GLib.Array

Default Value:

None

Flags:

READABLE, WRITABLE

min / max range to normalise data

v_sim.GlExtShade.props.shade

Name:

shade

Type:

v_sim.Shade

Default Value:

None

Flags:

READABLE, WRITABLE

colorization scheme