v_sim.NodeMasker

Implementations:

v_sim.Box, v_sim.Colorization, v_sim.DataColorizerFragment, v_sim.GlExtMarks, v_sim.PlaneSet

Methods

	apply (array)
	emitDirty ()
	setMaskFunc (func)

Virtual Methods

	do_apply (array)
	do_set_mask_func (func, data)

Properties

None

Signals

Name	Short Description
masking-dirty	This signal is emitted when some masking parameters changed.

Fields

None

Class Details

class v_sim.NodeMasker

Bases:

GObject.GInterface

Structure:

v_sim.NodeMaskerInterface

Interface object.

New in version 3.8.

apply(array)

Parameters:

array (v_sim.NodeArray) – a v_sim.NodeArray object.

Returns:

a location for a boolean

Return type:

redraw: bool

Apply the masking properties of self over array. If any node visibility has changed, redraw is set to True.

New in version 3.8.

emitDirty()

Emits the “masking-dirty” signal. To be used by implementation of this interface to signal that some masking properties have changed.

New in version 3.8.

setMaskFunc(func)

Parameters:

func (v_sim.NodeMaskerFunc or None) – a v_sim.NodeMaskerFunc object.

Returns:

True if value is actually changed.

Return type:

bool

If the implementation provides a user defined masking function, this calls the #VisuNodeMaskerInterface::set_mask_func() routine.

New in version 3.8.

do_apply(array) virtual

Parameters:

array (v_sim.NodeArray) –

Return type:

bool

a method used to apply a visibility mask on a v_sim.NodeArray.

do_set_mask_func(func, data) virtual

Parameters:

• func (v_sim.NodeMaskerFunc) –

• data (object or None) –

Return type:

bool

a method to specify a custom masking routine.

Signal Details

v_sim.NodeMasker.signals.masking_dirty(node_masker)

Signal Name:

masking-dirty

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

node_masker (v_sim.NodeMasker) – The object which received the signal

This signal is emitted when some masking parameters changed.

New in version 3.8.