v_sim.GlExtPairs¶

Subclasses:: None

Methods¶

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

class	`new` (name)
	`getAllLinkRenderer` ()
	`getDataRenderer` ()
	`getLinkRenderer` (data)
	`getSet` ()
	`renderAsSticks` ()
	`setData` (data)
	`setDataRenderer` (renderer)
	`setLinkRenderer` (data, renderer)

Virtual Methods¶

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

Properties¶

Inherited:: v_sim.GlExt (11)

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`renderer-changed`	Gets emitted when the renderer used for link is changed.

Fields¶

Inherited:: GObject.Object (1)

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

Class Details¶

class v_sim.GlExtPairs(**kwargs)¶

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

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_PAIRS_ID).
Returns:: a pointer to the v_sim.GlExt it created or None otherwise.
Return type:: v_sim.GlExtPairs

Creates a new v_sim.GlExt to draw a pairs.

Added in version 3.7.

getAllLinkRenderer()¶

Returns:: a list of all the known v_sim.PairLinkRenderer. This list should be considered read-only.
Return type:: [v_sim.PairLinkRenderer]

Useful to know all v_sim.PairLinkRenderer used by self.

Added in version 3.8.

getDataRenderer()¶

Returns:: the v_sim.NodeArrayRenderer this self is using the rendering properties from.
Return type:: v_sim.NodeArrayRenderer

Retrieve the v_sim.NodeArrayRenderer this self is using the rendering properties from.

Added in version 3.8.

getLinkRenderer(data)¶

Parameters:: data (v_sim.PairLink) – a v_sim.PairLink object.
Returns:: a drawing method.
Return type:: v_sim.PairLinkRenderer

Get the drawing method of a pair.

Added in version 3.6.

getSet()¶

Returns:: the v_sim.PairSet this self is based on.
Return type:: v_sim.PairSet

Retrieve the v_sim.PairSet this self is based on.

Added in version 3.8.

renderAsSticks()¶: Setup all links to be rendered as sticks following the element colours. The hanges are applied for all already existing links, but not to newly created ones. Make self active if not already.

Added in version 3.9.

setData(data)¶

Parameters:: data (v_sim.Data) – the nodes to get the population of.
Returns:: True if data is actually changed.
Return type:: bool

Attach a v_sim.Data to render to and setup the pairs to get the node population also.

Added in version 3.7.

setDataRenderer(renderer)¶

Parameters:: renderer (v_sim.NodeArrayRenderer) – a v_sim.NodeArrayRenderer object.
Returns:: True if value is actually changed.
Return type:: bool

Specify the renderer that may be used to draw pairs in the same colour and material than elements.

Added in version 3.8.

setLinkRenderer(data, renderer)¶

Parameters:

data (v_sim.PairLink) – a v_sim.PairLink object.
renderer (v_sim.PairLinkRenderer) – a v_sim.PairLinkRenderer object.

Returns:

True if drawing method is changed.

Return type:

bool

Set the drawing method of a pair.

Added in version 3.6.

Signal Details¶

v_sim.GlExtPairs.signals.renderer_changed(gl_ext_pairs, link)¶

Signal Name:

renderer-changed

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

gl_ext_pairs (v_sim.GlExtPairs) – The object which received the signal
link (v_sim.PairLink) – the v_sim.PairLink which is changed.

Gets emitted when the renderer used for link is changed.

Added in version 3.8.