v_sim.GlExtFrame¶

Subclasses:: v_sim.GlExtBoxLegend, v_sim.GlExtLegend, v_sim.GlExtShade

Methods¶

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

	`getPosition` ()
	`getScale` ()
	`setBgRGBA` (rgba, mask)
	`setFontRGB` (rgb, mask)
	`setPadding` (xpad, ypad)
	`setPosition` (xpos, ypos)
	`setRequisition` (width, height)
	`setScale` (scale)
	`setTitle` (title)

Virtual Methods¶

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

	`do_draw` ()
	`do_isValid` ()

Properties¶

Inherited:: v_sim.GlExt (9)

Name	Type	Flags	Short Description
`x-padding`	`float`	r/w	padding along x axis
`x-pos`	`float`	r/w	position along x axis
`y-padding`	`float`	r/w	padding along y axis
`y-pos`	`float`	r/w	position along y axis

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
fontRGB	[`float`]	r
height	`int`	r
parent	`v_sim.GlExt`	r
priv	`v_sim.GlExtFramePrivate`	r
width	`int`	r

Class Details¶

class v_sim.GlExtFrame(**kwargs)¶

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

An opaque structure.

New in version 3.7.

getPosition()¶

Returns:

xpos:: a location to store the x position.
ypos:: a location to store the y position.

Return type:

(xpos: float, ypos: float)

Inquire the position of the representation of the frame.

New in version 3.7.

getScale()¶

Returns:: the scaling factor used to represent frames.
Return type:: float

Frames are rendered with a scaling factor of 1. by default.

New in version 3.7.

setBgRGBA(rgba, mask)¶

Parameters:

rgba ([float]) – a four floats array with values (0 <= values <= 1) for the red, the green, the blue color and the alpha channel. Only values specified by the mask are really relevant.
mask (int) – use v_sim.COLOR_MASK_R, v_sim.COLOR_MASK_G, v_sim.COLOR_MASK_B, v_sim.COLOR_MASK_A or a combinaison to indicate what values in the rgba array must be taken into account.

Returns:

True if value is actually changed.

Return type:

bool

Change the colour to represent the background of the frame.

New in version 3.7.

setFontRGB(rgb, mask)¶

Parameters:

rgb ([float]) – a four floats array with values (0 <= values <= 1) for the red, the green, the blue color. Only values specified by the mask are really relevant.
mask (int) – use v_sim.COLOR_MASK_R, v_sim.COLOR_MASK_G, v_sim.COLOR_MASK_B or a combinaison to indicate what values in the rgb array must be taken into account.

Returns:

True if value is actually changed.

Return type:

bool

Change the colour to represent the font of the frame.

New in version 3.7.

setPadding(xpad, ypad)¶

Parameters:

xpad (float) – the padding along x.
ypad (float) – the padding along y.

Returns:

True if any position is actually changed.

Return type:

bool

Change the padding of the frame representation.

New in version 3.8.

setPosition(xpos, ypos)¶

Parameters:

xpos (float) – the reduced y position (1 to the left).
ypos (float) – the reduced y position (1 to the bottom).

Returns:

True if any position is actually changed.

Return type:

bool

Change the position of the frame representation.

New in version 3.7.

setRequisition(width, height)¶

Parameters:

width (int) – the desired width.
height (int) – the desired height.

Returns:

True if requested size is changed.

Return type:

bool

Set the size of the frame in pixels. Use v_sim.GlExtFrame.setScale() to adjust the size if necessary.

New in version 3.7.

setScale(scale)¶

Parameters:: scale (float) – a positive value.
Returns:: True if value is actually changed.
Return type:: bool

Change the zoom level for the rendering of the legend.

New in version 3.7.

setTitle(title)¶

Parameters:: title (str) – a title.
Returns:: True if title is actually changed.
Return type:: bool

Change the title of the box legend.

New in version 3.7.

do_draw() virtual¶: the draw method for the content of this frame.

do_isValid() virtual¶

Return type:: bool

Property Details¶

v_sim.GlExtFrame.props.x_padding¶

Name:: x-padding
Type:: float
Default Value:: 5.0
Flags:: READABLE, WRITABLE

padding along x axis

v_sim.GlExtFrame.props.x_pos¶

Name:: x-pos
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

position along x axis

v_sim.GlExtFrame.props.y_padding¶

Name:: y-padding
Type:: float
Default Value:: 5.0
Flags:: READABLE, WRITABLE

padding along y axis

v_sim.GlExtFrame.props.y_pos¶

Name:: y-pos
Type:: float
Default Value:: 1.0
Flags:: READABLE, WRITABLE

position along y axis