v_sim.NodeArrayRenderer¶

Implementations:: v_sim.GlExtNodes

Methods¶

	`get` (element)
	`getColorizer` ()
	`getMaxElementSize` ()
	`getNodeArray` ()
	`iter_new` (physical)
	`pushColorizer` (colorizer)
	`removeColorizer` (colorizer)
	`setNodeArray` (array)

Virtual Methods¶

	`do_getColorizer` ()
	`do_getExtent` (n)
	`do_getNodeArray` ()
	`do_pushColorizer` (colorizer)
	`do_removeColorizer` (colorizer)
	`do_setNodeArray` (array)

Properties¶

Name	Type	Flags	Short Description
`colorizer`	`v_sim.DataColorizer`	r/w	current node colorizer.
`data`	`v_sim.NodeArray`	r/w	data associated to this renderer
`max-element-size`	`float`	r	maximum size of anyrendered element
`type`	`GObject.GType`	r	type of ‘data’

Signals¶

Name	Short Description
`element-notify`	This signal is emitted each time one of the `v_sim.ElementRenderer` used to represent the `v_sim.NodeArray` is changed.
`element-size-changed`	This signal is emitted each time one of the `v_sim.ElementRenderer` used to represent the `v_sim.NodeArray` has changed its size.
`nodes`	This signal is emitted when node rendering properties are changed because of population change, visibility change, position change…

Fields¶

None

Class Details¶

class v_sim.NodeArrayRenderer¶

Bases:: GObject.GInterface
Structure:: v_sim.NodeArrayRendererInterface

Interface object.

New in version 3.8.

get(element)¶

Parameters:: element (v_sim.Element) – a v_sim.ElementRenderer object.
Returns:: the v_sim.ElementRenderer used for element.
Return type:: v_sim.ElementRenderer

Retrieve the v_sim.ElementRenderer that is used by self to represent element.

New in version 3.8.

getColorizer()¶

Returns:: a v_sim.DataColorizer object, owned by V_Sim.
Return type:: v_sim.DataColorizer

The renderer self can use a v_sim.DataColorizer object to modify the pristine color of nodes.

New in version 3.8.

getMaxElementSize()¶

Returns:

a positive float value.

n:: a location to store an integer.

Return type:

(float, n: int)

Retrieves the maximum rendering size for all v_sim.ElementRenderer used by self. n stores on aoutput the number of v_sim.ElementRenderer used by self.

New in version 3.8.

getNodeArray()¶

Returns:: the v_sim.NodeArray represented by element.
Return type:: v_sim.NodeArray

Retrieve the v_sim.NodeArray represented by self.

New in version 3.8.

iter_new(physical)¶

Parameters:

physical (bool) – a boolean.

Returns:

True if the iterator is in a valid state.

iter:: a location to an uninitialised v_sim.NodeArrayRendererIter object.

Return type:

(bool, iter: v_sim.NodeArrayRendererIter)

Creates an iterator to run over all v_sim.ElementRenderer of self. The iterator runs only over physical v_sim.Element when physical is True, see v_sim.Element.getPhysical().

New in version 3.8.

pushColorizer(colorizer)¶

Parameters:: colorizer (v_sim.DataColorizer) – a v_sim.DataColorizer object.
Returns:: True if the value is actually changed.
Return type:: bool

Changes the v_sim.DataColorizer of self.

New in version 3.8.

removeColorizer(colorizer)¶

Parameters:: colorizer (v_sim.DataColorizer) – a v_sim.DataColorizer object.
Returns:: True if the current colorizer is actually changed.
Return type:: bool

Remove the v_sim.DataColorizer from the stack of colorizers of self.

New in version 3.8.

setNodeArray(array)¶

Parameters:: array (v_sim.NodeArray or None) – a v_sim.NodeArray object.
Returns:: True if value is actually changed.
Return type:: bool

Changes the v_sim.NodeArray that is used as a model for self.

New in version 3.8.

do_getColorizer() virtual¶

Returns:: a v_sim.DataColorizer object, owned by V_Sim.
Return type:: v_sim.DataColorizer

The renderer self can use a v_sim.DataColorizer object to modify the pristine color of nodes.

New in version 3.8.

do_getExtent(n) virtual¶

Parameters:: n (int) –
Return type:: float

a method to get the maximum element size.

do_getNodeArray() virtual¶

Returns:: the v_sim.NodeArray represented by element.
Return type:: v_sim.NodeArray

Retrieve the v_sim.NodeArray represented by self.

New in version 3.8.

do_pushColorizer(colorizer) virtual¶

Parameters:: colorizer (v_sim.DataColorizer) – a v_sim.DataColorizer object.
Returns:: True if the value is actually changed.
Return type:: bool

Changes the v_sim.DataColorizer of self.

New in version 3.8.

do_removeColorizer(colorizer) virtual¶

Parameters:: colorizer (v_sim.DataColorizer) – a v_sim.DataColorizer object.
Returns:: True if the current colorizer is actually changed.
Return type:: bool

Remove the v_sim.DataColorizer from the stack of colorizers of self.

New in version 3.8.

do_setNodeArray(array) virtual¶

Parameters:: array (v_sim.NodeArray or None) – a v_sim.NodeArray object.
Returns:: True if value is actually changed.
Return type:: bool

Changes the v_sim.NodeArray that is used as a model for self.

New in version 3.8.

Signal Details¶

v_sim.NodeArrayRenderer.signals.element_notify(node_array_renderer, renderer)¶

Signal Name:

element-notify

Flags:

RUN_LAST, NO_RECURSE, DETAILED, NO_HOOKS

Parameters:

node_array_renderer (v_sim.NodeArrayRenderer) – The object which received the signal
renderer (v_sim.ElementRenderer) – the v_sim.ElementRenderer that has been changed.

This signal is emitted each time one of the v_sim.ElementRenderer used to represent the v_sim.NodeArray is changed.

New in version 3.8.

v_sim.NodeArrayRenderer.signals.element_size_changed(node_array_renderer, renderer, extent)¶

Signal Name:

element-size-changed

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

node_array_renderer (v_sim.NodeArrayRenderer) – The object which received the signal
renderer (v_sim.ElementRenderer) – the v_sim.ElementRenderer that has been changed.
extent (float) – the new size.

This signal is emitted each time one of the v_sim.ElementRenderer used to represent the v_sim.NodeArray has changed its size.

New in version 3.8.

v_sim.NodeArrayRenderer.signals.nodes(node_array_renderer, nodeIds)¶

Signal Name:

nodes

Flags:

RUN_LAST, NO_RECURSE, DETAILED, NO_HOOKS

Parameters:

node_array_renderer (v_sim.NodeArrayRenderer) – The object which received the signal
nodeIds ([int]) – the id of modified nodes.

This signal is emitted when node rendering properties are changed because of population change, visibility change, position change…

New in version 3.8.

Property Details¶

v_sim.NodeArrayRenderer.props.colorizer¶

Name:: colorizer
Type:: v_sim.DataColorizer
Default Value:: None
Flags:: READABLE, WRITABLE

current node colorizer.

v_sim.NodeArrayRenderer.props.data¶

Name:: data
Type:: v_sim.NodeArray
Default Value:: None
Flags:: READABLE, WRITABLE

data associated to this renderer

v_sim.NodeArrayRenderer.props.max_element_size¶

Name:: max-element-size
Type:: float
Default Value:: 1.0
Flags:: READABLE

maximum size of anyrendered element

v_sim.NodeArrayRenderer.props.type¶

Name:: type
Type:: GObject.GType
Default Value:: <GType VisuDataLoadable>
Flags:: READABLE

type of ‘data’