v_sim.PairLinkRenderer¶

Subclasses:: v_sim.PairCylinderRenderer, v_sim.PairWireRenderer

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`draw` (iter)
	`emitDirty` ()
	`setGlView` (view)
	`start` (data, ele1, ele2, colorizer)
	`stop` (data)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_draw` (iter)
	`do_set_view` (view)
	`do_start` (data, ele1, ele2, colorizer)
	`do_stop` (data)

Properties¶

Name	Type	Flags	Short Description
`description`	`str`	r/w/co	description of this renderer
`id`	`str`	r/w/co	id defining this renderer
`label`	`str`	r/w/co	label of this renderer

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`dirty`	Gets emitted when some rendering parameter of renderer has been changed.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class v_sim.PairLinkRenderer(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: v_sim.PairLinkRendererClass

An opaque structure.

draw(iter)¶

Parameters:: iter (v_sim.PairLinkIter) – a v_sim.PairLinkIter object.

Calls the draw() method of self for the current pair defined by iter.

New in version 3.8.

emitDirty()¶: Emits the “dirty” signal of self.

New in version 3.8.

setGlView(view)¶

Parameters:: view (v_sim.GlView) – a v_sim.GlView object.
Returns:: True if value is actually cahnged.
Return type:: bool

If self class has a #VisuPairLinkRenderer::set_view() method, it binds view to self.

New in version 3.8.

start(data, ele1, ele2, colorizer)¶

Parameters:

data (v_sim.PairLink) – a v_sim.PairLink object.
ele1 (v_sim.ElementRenderer) – a v_sim.ElementRenderer object.
ele2 (v_sim.ElementRenderer) – a v_sim.ElementRenderer object.
colorizer (v_sim.DataColorizer) – a v_sim.DataColorizer object.

Calls the start() method of self class. This method is actually called each time a different data pair is drawn.

New in version 3.8.

stop(data)¶

Parameters:: data (v_sim.PairLink) – a v_sim.PairLink object.

Calls the stop() method of self class. It is actually called each time a different data pair is finished.

New in version 3.8.

do_draw(iter) virtual¶

Parameters:: iter (v_sim.PairLinkIter) – a v_sim.PairLinkIter object.

Calls the draw() method of renderer for the current pair defined by iter.

New in version 3.8.

do_set_view(view) virtual¶

Parameters:: view (v_sim.GlView) –
Return type:: bool

a routine called to set a different v_sim.GlView object.

do_start(data, ele1, ele2, colorizer) virtual¶

Parameters:

data (v_sim.PairLink) – a v_sim.PairLink object.
ele1 (v_sim.ElementRenderer) – a v_sim.ElementRenderer object.
ele2 (v_sim.ElementRenderer) – a v_sim.ElementRenderer object.
colorizer (v_sim.DataColorizer) – a v_sim.DataColorizer object.

Calls the start() method of renderer class. This method is actually called each time a different data pair is drawn.

New in version 3.8.

do_stop(data) virtual¶

Parameters:: data (v_sim.PairLink) – a v_sim.PairLink object.

Calls the stop() method of renderer class. It is actually called each time a different data pair is finished.

New in version 3.8.

Signal Details¶

v_sim.PairLinkRenderer.signals.dirty(pair_link_renderer)¶

Signal Name:: dirty
Flags:: RUN_LAST, NO_RECURSE
Parameters:: pair_link_renderer (v_sim.PairLinkRenderer) – The object which received the signal

Gets emitted when some rendering parameter of renderer has been changed.

New in version 3.8.

Property Details¶

v_sim.PairLinkRenderer.props.description¶

Name:: description
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

description of this renderer

v_sim.PairLinkRenderer.props.id¶

Name:: id
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

id defining this renderer

v_sim.PairLinkRenderer.props.label¶

Name:: label
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

label of this renderer