VisuNodeMasker

VisuNodeMasker — an interface for objects with masking capabilities on VisuNode.

Functions

Signals

Types and Values

Object Hierarchy

    GInterface
    ╰── VisuNodeMasker

Prerequisites

VisuNodeMasker requires GObject.

Known Implementations

VisuNodeMasker is implemented by VisuBox, VisuColorization, VisuDataColorizerFragment, VisuGlExtMarks and VisuPlaneSet.

Description

Implementers of this interface are objects that can change the visibility of VisuNode through the visu_node_masker_apply() routine. When an implementer has its masking parameters that have changed, it should call visu_node_masker_emitDirty().

Functions

VisuNodeMaskerFunc ()

gboolean
(*VisuNodeMaskerFunc) (const VisuNodeMasker *masker,
                       const VisuNodeValuesIter *at,
                       gpointer data);

Function to decide to hide a node or not.

Parameters

masker

a VisuNodeMasker object ;

 

at

a VisuNodeValuesIter pointer

 

data

some data.

[closure]

Returns

TRUE to hide a node depending on values in at .

Since: 3.8


visu_node_masker_setMaskFunc ()

gboolean
visu_node_masker_setMaskFunc (VisuNodeMasker *masker,
                              VisuNodeMaskerFunc func,
                              gpointer data,
                              GDestroyNotify destroy);

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

Parameters

masker

a VisuNodeMasker object.

 

func

a VisuNodeMaskerFunc object.

[closure data][scope notified][allow-none]

data

some data.

[closure]

destroy

destroy function.

[destroy data]

Returns

TRUE if value is actually changed.

Since: 3.8


visu_node_masker_apply ()

void
visu_node_masker_apply (const VisuNodeMasker *masker,
                        gboolean *redraw,
                        VisuNodeArray *array);

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

Parameters

masker

a VisuNodeMasker object.

 

redraw

a location for a boolean.

[out caller-allocates]

array

a VisuNodeArray object.

 

Since: 3.8


visu_node_masker_emitDirty ()

void
visu_node_masker_emitDirty (VisuNodeMasker *masker);

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

Parameters

masker

a VisuNodeMasker object.

 

Since: 3.8

Types and Values

struct VisuNodeMaskerInterface

struct VisuNodeMaskerInterface {
  GTypeInterface parent;

  gboolean (*set_mask_func)(VisuNodeMasker *masker, VisuNodeMaskerFunc func,
                            gpointer data, GDestroyNotify destroy);
  gboolean (*apply)        (const VisuNodeMasker *masker, VisuNodeArray *array);
};

The different routines common to objects implementing a VisuNodeMasker interface.

Members

GTypeInterface parent;

its parent.

 

set_mask_func ()

a method to specify a custom masking routine.

 

apply ()

a method used to apply a visibility mask on a VisuNodeArray.

 

Since: 3.8


VisuNodeMasker

typedef struct _VisuNodeMasker VisuNodeMasker;

Interface object.

Since: 3.8

Signal Details

The “masking-dirty” signal

void
user_function (VisuNodeMasker *masker,
               gpointer        user_data)

This signal is emitted when some masking parameters changed.

Parameters

masker

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8