v_sim.Element¶

Subclasses:: None

Methods¶

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

class	`getAllElements` ()
class	`lookup` (name)
class	`new` (key)
class	`retrieveFromName` (name)
	`atomic_getFromPool` ()
	`getColorizable` ()
	`getMaskable` ()
	`getName` ()
	`getPhysical` ()
	`getRendered` ()
	`renderer_getFromPool` ()
	`setColorizable` (val)
	`setMaskable` (val)
	`setRendered` (val)
	`spin_getFromPool` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`colorizable`	`bool`	r/w	if element is colorizable
`maskable`	`bool`	r/w	if element is maskable
`rendered`	`bool`	r/w	if element is rendered

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`ElementNew`	A new element is available.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
name	`str`	r
parent	`GObject.Object`	r
physical	`bool`	r
typeNumber	`int`	r

Class Details¶

class v_sim.Element(**kwargs)¶

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

Structure to stores v_sim.Element objects.

classmethod getAllElements()¶

Returns:: the list of all known v_sim.Element.
Return type:: [v_sim.Element]

This method returns a list of all the registered v_sim.Element. The returned list is read-only.

classmethod lookup(name)¶

Parameters:: name (str) – a string.
Returns:: the found v_sim.Element or None.
Return type:: v_sim.Element

Lookup for element name in the base. Do not create it if not found. To do this, use v_sim.Element.retrieveFromName().

New in version 3.6.

classmethod new(key)¶

Parameters:: key (str) – the name of the new element to create.
Returns:: the newly created v_sim.Element or 0 if something goes wrong in the process (if the name already exist for example).
Return type:: v_sim.Element

Allocate a new visuElement with the specified name. Remember that names must be unique since they identify the element.

classmethod retrieveFromName(name)¶

Parameters:

name (str) – a string that identify the v_sim.Element (in UTF8) ;

Returns:

a v_sim.Element associated to this name.

nw:: a location to store a boolean.

Return type:

(v_sim.Element, nw: bool)

Try to find a v_sim.Element already associated to that name or create a new one if none has been found. If nw is not None it is set to False if name was found.

atomic_getFromPool()¶

Returns:: a v_sim.ElementAtomic for self.
Return type:: v_sim.ElementAtomic

Retrieve a v_sim.ElementAtomic representing self. This v_sim.ElementAtomic is unique and its parent properties are bound to the unique v_sim.ElementRenderer for self.

New in version 3.8.

getColorizable()¶

Returns:: True if self is colorizable.
Return type:: bool

Retrieve whether v_sim.Node of type self can be colorized by any v_sim.DataColorizer object.

New in version 3.8.

getMaskable()¶

Returns:: True if self is maskable.
Return type:: bool

Retrieve whether v_sim.Node of type self can be hidden by planes or any v_sim.NodeMasker object.

New in version 3.8.

getName()¶

Returns:: a string owned by V_Sim.
Return type:: str

This routines returns the name of the given self.

New in version 3.7.

getPhysical()¶

Returns:: True if self is indeed physical.
Return type:: bool

This routine gets if self is physical or not. A not physical element can be used for instance to represent specific points…

New in version 3.7.

getRendered()¶

Returns:: True if self is hidden or not.
Return type:: bool

Retrieve wether all v_sim.Node of self are currently hidden or not.

New in version 3.8.

renderer_getFromPool()¶

Returns:: a v_sim.ElementRenderer for self.
Return type:: v_sim.ElementRenderer

Retrieve a v_sim.ElementRenderer representing self. This v_sim.ElementRenderer is unique.

New in version 3.8.

setColorizable(val)¶

Parameters:: val (bool) – a boolean value.
Returns:: True if value is actually changed.
Return type:: bool

Changes if all v_sim.Node of type self can be affected by a v_sim.DataColorizer object.

New in version 3.8.

setMaskable(val)¶

Parameters:: val (bool) – a boolean value.
Returns:: True if value is actually changed.
Return type:: bool

Changes if all v_sim.Node of type self can be affected by a v_sim.NodeMasker object.

New in version 3.8.

setRendered(val)¶

Parameters:: val (bool) – a boolean.
Returns:: True if value is actually changed.
Return type:: bool

Changes if all v_sim.Node of type self are hidden or not.

New in version 3.8.

spin_getFromPool()¶

Returns:: a v_sim.ElementSpin for self.
Return type:: v_sim.ElementSpin

Retrieve a v_sim.ElementSpin representing self. This v_sim.ElementSpin is unique and its parent properties are bound to the unique v_sim.ElementAtomic for self.

New in version 3.8.

Signal Details¶

v_sim.Element.signals.ElementNew(element)¶

Signal Name:: ElementNew
Flags:: RUN_LAST, NO_RECURSE
Parameters:: element (v_sim.Element) – The object which received the signal

A new element is available.

New in version 3.6.

Property Details¶

v_sim.Element.props.colorizable¶

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

if element is colorizable

v_sim.Element.props.maskable¶

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

if element is maskable

v_sim.Element.props.rendered¶

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

if element is rendered