v_sim.ElementRenderer¶

Subclasses:: v_sim.ElementAtomic

Methods¶

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

	`bindToPool` ()
	`copyMaterial` ()
	`featureMaterialCache` ()
	`getColor` ()
	`getColorization` (effect)
	`getConstElement` ()
	`getElement` ()
	`getExtent` ()
	`getGlView` ()
	`getMaterial` ()
	`getVerticeBufferDim` ()
	`getVerticeLayout` (id)
	`setColor` (color)
	`setGlView` (view)
	`setMaterialValue` (value, id)
	`setRGBAValue` (value, id)
	`useDefaultColor` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_getExtent` ()
	`do_getLayout` (id, packing, primitive)

Properties¶

Name	Type	Flags	Short Description
`buffer-dimension`	`int`	r/w/co	number of vertice buffers.
`cache-material`	`bool`	r	can put material in cache.
`color`	`v_sim.Color`	r/w	element color
`element`	`v_sim.Element`	r/w/co	element
`maskable`	`bool`	r/w	if element is maskable
`material`		r/w	element material
`rendered`	`bool`	r/w	if element is rendered

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`size-changed`	Emitted when the size of a element is changed.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class v_sim.ElementRenderer(**kwargs)¶

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

Structure used to define v_sim.ElementRenderer objects.

New in version 3.8.

bindToPool()¶: Bind self to the corresponding v_sim.ElementRenderer of the pool. This allows to have v_sim.Element renderers that follow the same color or maskable properties for instance of a given v_sim.Element.

New in version 3.8.

copyMaterial()¶

Returns:: a location to store the material values.
Return type:: material: float

Copy the #ToolMaterial used by self to represent a v_sim.Element.

New in version 3.9.

featureMaterialCache()¶

Returns:: True if material representation can be stored in a Gl list.
Return type:: bool

Inquires if the given self renderer can use Gl list to store its material representation.

New in version 3.8.

getColor()¶

Returns:: a v_sim.Color or None.
Return type:: v_sim.Color or None

Retrieve the v_sim.Color used by self to represent a v_sim.Element.

New in version 3.8.

getColorization(effect)¶

Parameters:

effect (v_sim.ElementRendererEffects) – a v_sim.ElementRendererEffects value.

Returns:

rgba:: storage for a color.
material:: storage for material data.

Return type:

(rgba: [float], material: [float])

Compute the self color. An additional effect can be added.

New in version 3.9.

getConstElement()¶

Returns:: a const v_sim.Element.
Return type:: v_sim.Element

Retrieve the v_sim.Element represented by self. See v_sim.ElementRenderer.getElement() if the return value should be modified.

New in version 3.8.

getElement()¶

Returns:: the v_sim.Element represented by self.
Return type:: v_sim.Element

Retrieve the v_sim.Element that is represented by self. See v_sim.ElementRenderer.getConstElement() if the returned value should not be modified.

New in version 3.8.

getExtent()¶

Returns:: a positive float value.
Return type:: float

Retrives the radius of a sphere containing the representation of self.

New in version 3.8.

getGlView()¶

Returns:: a const v_sim.GlView object.
Return type:: v_sim.GlView

Retrieves the v_sim.GlView associated to self, see v_sim.ElementRenderer.setGlView().

New in version 3.8.

getMaterial()¶

Returns:: a #ToolMaterial or None.
Return type:: float

Retrieve the #ToolMaterial used by self to represent a v_sim.Element.

New in version 3.8.

getVerticeBufferDim()¶

Returns:: the number of vertice buffers.
Return type:: int

Retrieve the number of vertice buffers used by this renderer to display a node.

New in version 3.9.

getVerticeLayout(id)¶

Parameters:

id (int) – a buffer id.

Returns:

packing:: a location to store the packing.
primitive:: a location to store the drawing primitive.

Return type:

(packing: v_sim.GlExtPackingModels, primitive: v_sim.GlExtPrimitives)

Retrieve data layout and the drawing primitive used by the vertice buffer id.

New in version 3.9.

setColor(color)¶

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

Changes the representation of self to use color.

New in version 3.8.

setGlView(view)¶

Parameters:: view (v_sim.GlView) – a v_sim.GlView object.

Associates view to self, so any changes to the rendering precision happening in view can imply a rebuild of the representation of self.

New in version 3.8.

setMaterialValue(value, id)¶

Parameters:

value (float) – a float in [0;1].
id (v_sim.MaterialIds) – a v_sim.MaterialIds value.

Returns:

True if value is actually changed.

Return type:

bool

Changes the material channel id with value.

New in version 3.8.

setRGBAValue(value, id)¶

Parameters:

value (float) – a float vlaue in [0;1].
id (int) – an value in [0;3].

Returns:

True if value is actually changed.

Return type:

bool

Change one of the RGBA channel of the representation of self.

New in version 3.8.

useDefaultColor()¶

Returns:: True if the colour is actually changed.
Return type:: bool

Use the default colour associated to this element.

New in version 3.9.

do_getExtent() virtual¶

Returns:: a positive float value.
Return type:: float

Retrives the radius of a sphere containing the representation of element.

New in version 3.8.

do_getLayout(id, packing, primitive) virtual¶

Parameters:

id (int) –
packing (v_sim.GlExtPackingModels) –
primitive (v_sim.GlExtPrimitives) –

Signal Details¶

v_sim.ElementRenderer.signals.size_changed(element_renderer, size)¶

Signal Name:

size-changed

Flags:

RUN_LAST, NO_RECURSE

Parameters:

element_renderer (v_sim.ElementRenderer) – The object which received the signal
size (float) – the new size.

Emitted when the size of a element is changed.

New in version 3.8.

Property Details¶

v_sim.ElementRenderer.props.buffer_dimension¶

Name:: buffer-dimension
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

number of vertice buffers.

v_sim.ElementRenderer.props.cache_material¶

Name:: cache-material
Type:: bool
Default Value:: True
Flags:: READABLE

can put material in cache.

v_sim.ElementRenderer.props.color¶

Name:: color
Type:: v_sim.Color
Default Value:: None
Flags:: READABLE, WRITABLE

element color

v_sim.ElementRenderer.props.element¶

Name:: element
Type:: v_sim.Element
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

element

v_sim.ElementRenderer.props.maskable¶

Name:: maskable
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

if element is maskable

v_sim.ElementRenderer.props.material¶

Name:: material
Type:
Default Value:: None
Flags:: READABLE, WRITABLE

element material

v_sim.ElementRenderer.props.rendered¶

Name:: rendered
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

if element is rendered