v_sim.DataColorizer

Subclasses:

v_sim.DataColorizerFragment, v_sim.DataColorizerShaded

Methods

Inherited:

GObject.Object (37), v_sim.Sourceable (8)

Structs:

GObject.ObjectClass (5)

	getActive ()
	getColor (visuData, node)
	getScalingFactor (visuData, node)
	setActive (status)
	setDirty ()

Virtual Methods

Inherited:

GObject.Object (7), v_sim.Sourceable (1)

	do_colorize (rgba, visuData, node)
	do_scale (visuData, node)

Properties

Inherited:

v_sim.Sourceable (2)

Name	Type	Flags	Short Description
active	bool	r/w	active

Signals

Inherited:

GObject.Object (1)

Name	Short Description
dirty	Gets emitted when colorizer characteristics have changed and a redraw is needed.

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	GObject.Object	r

Class Details

class v_sim.DataColorizer(**kwargs)

Bases:

GObject.Object, v_sim.Sourceable

Abstract:

No

Structure:

v_sim.DataColorizerClass

Structure used to define v_sim.DataColorizer objects.

New in version 3.8.

getActive()

Returns:

True if self is active.

Return type:

bool

Retrieve if self is actively changing the v_sim.Node colours.

New in version 3.8.

getColor(visuData, node)

Parameters:

• visuData (v_sim.Data) – a v_sim.Data object.

• node (v_sim.Node) – a v_sim.Node structure.

Returns:

True if self can actually provide a colour for node.

rgba:

a location for store a colour definition.

Return type:

(bool, rgba: [float])

Call the class colorizer function of self to setup a colour in rgba for given node inside visuData. If there is no specific colour for this node and the default element colour should be used instead, this function returns False.

New in version 3.8.

getScalingFactor(visuData, node)

Parameters:

• visuData (v_sim.Data) – a v_sim.Data object.

• node (v_sim.Node) – a v_sim.Node structure.

Returns:

a scaling factor.

Return type:

float

Calls the class scaling function of self to retrieve a scaling factor for node in visuData.

New in version 3.8.

setActive(status)

Parameters:

status (bool) – a boolean.

Returns:

True if the status is actually changed.

Return type:

bool

Changes the active status of self.

New in version 3.8.

setDirty()

Returns:

True if dirty status is actually changed.

Return type:

bool

Notifies when self colorising parameters have been changed.

New in version 3.8.

do_colorize(rgba, visuData, node) virtual

Parameters:

• rgba (float) –

• visuData (v_sim.Data) –

• node (v_sim.Node) –

Return type:

bool

a method to colorize a given node according to a model.

do_scale(visuData, node) virtual

Parameters:

• visuData (v_sim.Data) –

• node (v_sim.Node) –

Return type:

float

a method to scale a given node according to a model.

Signal Details

v_sim.DataColorizer.signals.dirty(data_colorizer)

Signal Name:

dirty

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

data_colorizer (v_sim.DataColorizer) – The object which received the signal

Gets emitted when colorizer characteristics have changed and a redraw is needed.

New in version 3.8.

Property Details

v_sim.DataColorizer.props.active

Name:

active

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

active