VisuBoxed

VisuBoxed — Defines a common interface for objects with a VisuBox.

Synopsis

struct              VisuBoxedInterface;
VisuBox *           visu_boxed_getBox                   (VisuBoxed *self);
gboolean            visu_boxed_setBox                   (VisuBoxed *self,
                                                         VisuBoxed *box,
                                                         gboolean update);

Description

Details

struct VisuBoxedInterface

struct VisuBoxedInterface {
  GTypeInterface parent;

  VisuBox* (*get_box) (VisuBoxed *self);
  gboolean (*set_box) (VisuBoxed *self, VisuBox *box, gboolean update);
};

The different routines common to objects implementing a VisuBoxed interface.

GTypeInterface parent;

yet, its parent.

get_box ()

a routine to get a pointer on the VisuBox.

set_box ()

a routine to set a VisuBox to a VisuBoxed object.

Since 3.7


visu_boxed_getBox ()

VisuBox *           visu_boxed_getBox                   (VisuBoxed *self);

Retrieves the VisuBox of self.

self :

a VisuBoxed object.

Returns :

the VisuBox of self. [transfer none]

Since 3.7


visu_boxed_setBox ()

gboolean            visu_boxed_setBox                   (VisuBoxed *self,
                                                         VisuBoxed *box,
                                                         gboolean update);

Attach the VisuBox of box to boxed. If update is TRUE, coordinates inside boxed are updated to fit into the new VisuBox. A reference is taken on the VisuBox of box. This routine emits "setBox" signal if the self has changed its VisuBox.

self :

a VisuBoxed object.

box :

a VisuBoxed object. [transfer none]

update :

a boolean.

Returns :

FALSE boxed was already boxed with the VisuBox of box.

Since 3.7

See Also

VisuBox, VisuData, VisuPlane, VisuSurfaces, VisuScalarField and VisuGlView