VisuNodeArrayRenderer

VisuNodeArrayRenderer — An interface grouping all the VisuElementRenderer used to represent a set of VisuNode.

Functions

Properties

VisuDataColorizer * colorizer Read / Write
VisuNodeArray * data Read / Write
gfloat max-element-size Read
GType * type Read

Signals

Types and Values

Object Hierarchy

    GInterface
    ╰── VisuNodeArrayRenderer

Prerequisites

VisuNodeArrayRenderer requires GObject.

Known Implementations

VisuNodeArrayRenderer is implemented by VisuGlExtNodes.

Description

This interface provides common methods for object displaying VisuData information. In particular, it provides access to all the VisuElementRenderer used to render the nodes and an iterator to run over VisuElementRenderer.

Functions

visu_node_array_renderer_getNodeArray ()

VisuNodeArray *
visu_node_array_renderer_getNodeArray (VisuNodeArrayRenderer *self);

Retrieve the VisuNodeArray represented by self .

Parameters

self

a VisuNodeArrayRenderer object.

 

Returns

the VisuNodeArray represented by element .

[transfer none]

Since: 3.8


visu_node_array_renderer_setNodeArray ()

gboolean
visu_node_array_renderer_setNodeArray (VisuNodeArrayRenderer *self,
                                       VisuNodeArray *array);

Changes the VisuNodeArray that is used as a model for self .

Parameters

self

a VisuNodeArrayRenderer object.

 

array

a VisuNodeArray object.

[allow-none]

Returns

TRUE if value is actually changed.

Since: 3.8


visu_node_array_renderer_get ()

VisuElementRenderer *
visu_node_array_renderer_get (VisuNodeArrayRenderer *node_array,
                              const VisuElement *element);

Retrieve the VisuElementRenderer that is used by node_array to represent element .

Parameters

node_array

a VisuNodeArrayRenderer object.

 

element

a VisuElementRenderer object.

 

Returns

the VisuElementRenderer used for element .

[transfer none]

Since: 3.8


visu_node_array_renderer_getMaxElementSize ()

gfloat
visu_node_array_renderer_getMaxElementSize
                               (VisuNodeArrayRenderer *node_array,
                                guint *n);

Retrieves the maximum rendering size for all VisuElementRenderer used by node_array . n stores on aoutput the number of VisuElementRenderer used by node_array .

Parameters

node_array

a VisuNodeArrayRenderer object.

 

n

a location to store an integer.

[out caller-allocates]

Returns

a positive float value.

Since: 3.8


visu_node_array_renderer_pushColorizer ()

gboolean
visu_node_array_renderer_pushColorizer
                               (VisuNodeArrayRenderer *self,
                                VisuDataColorizer *colorizer);

Changes the VisuDataColorizer of self .

Parameters

self

a VisuNodeArrayRenderer object.

 

colorizer

a VisuDataColorizer object.

 

Returns

TRUE if the value is actually changed.

Since: 3.8


visu_node_array_renderer_removeColorizer ()

gboolean
visu_node_array_renderer_removeColorizer
                               (VisuNodeArrayRenderer *self,
                                VisuDataColorizer *colorizer);

Remove the VisuDataColorizer from the stack of colorizers of self .

Parameters

self

a VisuNodeArrayRenderer object.

 

colorizer

a VisuDataColorizer object.

 

Returns

TRUE if the current colorizer is actually changed.

Since: 3.8


visu_node_array_renderer_getColorizer ()

VisuDataColorizer *
visu_node_array_renderer_getColorizer (VisuNodeArrayRenderer *self);

The renderer self can use a VisuDataColorizer object to modify the pristine color of nodes.

Parameters

self

a VisuNodeArrayRenderer object.

 

Returns

a VisuDataColorizer object, owned by V_Sim.

[transfer none]

Since: 3.8


visu_node_array_renderer_iter_new ()

gboolean
visu_node_array_renderer_iter_new (VisuNodeArrayRenderer *self,
                                   VisuNodeArrayRendererIter *iter,
                                   gboolean physical);

Creates an iterator to run over all VisuElementRenderer of self . The iterator runs only over physical VisuElement when physical is TRUE, see visu_element_getPhysical().

Parameters

self

a VisuNodeArrayRenderer object.

 

iter

a location to an uninitialised VisuNodeArrayRendererIter object.

[out caller-allocates]

physical

a boolean.

 

Returns

TRUE if the iterator is in a valid state.

Since: 3.8


visu_node_array_renderer_iter_next ()

gboolean
visu_node_array_renderer_iter_next (VisuNodeArrayRendererIter *iter);

Iterates to the next VisuElementRenderer object.

Parameters

iter

a VisuNodeArrayRendererIter object.

 

Returns

TRUE if the iterator is still valid.

Since: 3.8

Types and Values

struct VisuNodeArrayRendererInterface

struct VisuNodeArrayRendererInterface {
  GTypeInterface parent;

  VisuNodeArray*       (*getNodeArray)(VisuNodeArrayRenderer *self);
  gboolean             (*setNodeArray)(VisuNodeArrayRenderer *self, VisuNodeArray *array);
  VisuElementRenderer* (*getElement)(VisuNodeArrayRenderer *self, const VisuElement *element);
  gfloat               (*getExtent)(VisuNodeArrayRenderer *self, guint *n);
  gboolean             (*pushColorizer)(VisuNodeArrayRenderer *self, VisuDataColorizer *colorizer);
  gboolean             (*removeColorizer)(VisuNodeArrayRenderer *self, VisuDataColorizer *colorizer);
  VisuDataColorizer *  (*getColorizer)(VisuNodeArrayRenderer *self);
};

Interface for class that can represent VisuNodeArray.

Members

GTypeInterface parent;

its parent.

 

getNodeArray ()

a method to get the VisuNodeArray this renderer is working on.

 

setNodeArray ()

a method to change the VisuNodeArray this renderer is working on.

 

getElement ()

a method to get the VisuElementRenderer of the given VisuElement.

 

getExtent ()

a method to get the maximum element size.

 

pushColorizer ()

a method used to change the current VisuNode colorizer.

 

removeColorizer ()

a method to remove a given colorizer.

 

getColorizer ()

a method used to get the current VisuNode colorizer.

 

Since: 3.8


struct VisuNodeArrayRendererIter

struct VisuNodeArrayRendererIter {
  VisuNodeArrayRenderer *self;
  VisuNodeArrayIter parent;

  VisuElement *element;
  VisuElementRenderer *renderer;
  guint nStoredNodes;
};

An iterator over VisuElementRenderer of self .

Members

VisuNodeArrayRenderer *self;

the VisuNodeArrayRenderer this iterator is working on.

 

VisuNodeArrayIter parent;

the VisuNodeArrayIter this iter is based upon.

 

VisuElement *element;

the current VisuElement.

 

VisuElementRenderer *renderer;

the VisuElementRenderer of element .

 

guint nStoredNodes;

the number of nodes of element .

 

VisuNodeArrayRenderer

typedef struct _VisuNodeArrayRenderer VisuNodeArrayRenderer;

Interface object.

Since: 3.8

Property Details

The “colorizer” property

  “colorizer”                VisuDataColorizer *

current node colorizer.

Flags: Read / Write


The “data” property

  “data”                     VisuNodeArray *

data associated to this renderer.

Flags: Read / Write


The “max-element-size” property

  “max-element-size”         gfloat

maximum size of anyrendered element.

Flags: Read

Allowed values: >= 0

Default value: 1


The “type” property

  “type”                     GType *

type of 'data'.

Flags: Read

Allowed values: VisuDataLoadable

Signal Details

The “element-notify” signal

void
user_function (VisuNodeArrayRenderer *self,
               VisuElementRenderer   *renderer,
               gpointer               user_data)

This signal is emitted each time one of the VisuElementRenderer used to represent the VisuNodeArray is changed.

Parameters

self

the object emitting the signal.

 

renderer

the VisuElementRenderer that has been changed.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8


The “element-size-changed” signal

void
user_function (VisuNodeArrayRenderer *self,
               VisuElementRenderer   *renderer,
               gfloat                 extent,
               gpointer               user_data)

This signal is emitted each time one of the VisuElementRenderer used to represent the VisuNodeArray has changed its size.

Parameters

self

the object emitting the signal.

 

renderer

the VisuElementRenderer that has been changed.

 

extent

the new size.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8


The “nodes” signal

void
user_function (VisuNodeArrayRenderer *self,
               GArray                *nodeIds,
               gpointer               user_data)

This signal is emitted when node rendering properties are changed because of population change, visibility change, position change...

Parameters

self

the object emitting the signal.

 

nodeIds

the id of modified nodes.

[element-type uint]

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8