VisuGlNodeScene

VisuGlNodeScene — Defines a storage object to handle all VisuGlExt used to render nodes and associated data.

Functions

VisuGlNodeScene * visu_gl_node_scene_new ()
gboolean visu_gl_node_scene_applyCLI ()
gboolean visu_gl_node_scene_dump ()
gboolean visu_gl_node_scene_setData ()
gboolean visu_gl_node_scene_loadData ()
VisuData * visu_gl_node_scene_getData ()
gboolean visu_gl_node_scene_setColorization ()
VisuColorization * visu_gl_node_scene_getColorization ()
gboolean visu_gl_node_scene_setColorizationPolicy ()
VisuDataColorizerFragment * visu_gl_node_scene_getFragmentColorizer ()
VisuGlView * visu_gl_node_scene_getGlView ()
void visu_gl_node_scene_setGlCamera ()
VisuGlExtNodes * visu_gl_node_scene_getNodes ()
VisuGlExtPairs * visu_gl_node_scene_getPairs ()
VisuGlExtAxes * visu_gl_node_scene_getAxes ()
VisuGlExtBox * visu_gl_node_scene_getBox ()
VisuGlExtBoxLegend * visu_gl_node_scene_getBoxLegend ()
VisuGlExtLegend * visu_gl_node_scene_getLegend ()
VisuGlExtBg * visu_gl_node_scene_getBgImage ()
VisuGlExtScale * visu_gl_node_scene_getScales ()
VisuGlExtForces * visu_gl_node_scene_getForces ()
VisuGlExtVibrations * visu_gl_node_scene_getVibrations ()
VisuGlExtShade * visu_gl_node_scene_getColorizationLegend ()
VisuGlExtGeodiff * visu_gl_node_scene_getGeometryDifferences ()
VisuGlExtPlanes * visu_gl_node_scene_addPlanes ()
VisuGlExtSurfaces * visu_gl_node_scene_addSurfaces ()
VisuGlExtMapSet * visu_gl_node_scene_addMaps ()
VisuGlExtMarks * visu_gl_node_scene_getMarks ()
gboolean visu_gl_node_scene_setMarksFromFile ()
gboolean visu_gl_node_scene_marksToFile ()
gboolean visu_gl_node_scene_getMarkActive ()
gboolean visu_gl_node_scene_setMark ()
VisuDataColorizerFragment * visu_gl_node_scene_colorizeShell ()
VisuDataColorizerFragment * visu_gl_node_scene_colorizeFragments ()
void visu_gl_node_scene_removeMarks ()
VisuGlExtInfos * visu_gl_node_scene_getInfos ()
gboolean visu_gl_node_scene_setDiffFromLoadable ()
void visu_gl_node_scene_setDiffFromData ()
void visu_gl_node_scene_clearPaths ()
gboolean visu_gl_node_scene_parsePathsFromXML ()
gboolean visu_gl_node_scene_exportPathsToXML ()
gboolean visu_gl_node_scene_addMasker ()
gboolean visu_gl_node_scene_removeMasker ()
gboolean visu_gl_node_scene_addMover ()
gboolean visu_gl_node_scene_removeMover ()
void visu_gl_node_scene_setDefault ()
VisuGlNodeScene * visu_gl_node_scene_getDefault ()

Properties

gboolean axes-from-box Read / Write
gchar * colorization-file-extension Read / Write
guint colorization-policy Read / Write
VisuData * data Read / Write
gboolean geometry-differences Read / Write
gboolean loading Read
gchar * loading-message Read
gboolean path-active Read / Write / Construct
guint path-length Read
ToolShade * path-shade Read / Write
gboolean record-path Read / Write / Construct
gboolean reorder-reference Read / Write / Construct
VisuDataColorizerFragment * shell-colorizer Read
VisuGlView * view Read

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuGl
            ╰── VisuGlExtSet
                ╰── VisuGlNodeScene

Implemented Interfaces

VisuGlNodeScene implements VisuBoxed.

Description

Functions

visu_gl_node_scene_new ()

VisuGlNodeScene *
visu_gl_node_scene_new ();

Create an object to handle a set of VisuGlExt objects and draw them together.

Returns

a newly created VisuGlNodeScene object.

[transfer full]

Since: 3.8


visu_gl_node_scene_applyCLI ()

gboolean
visu_gl_node_scene_applyCLI (VisuGlNodeScene *scene,
                             GError **error);

Call all the get methods on the command line options to tune the given data .

Parameters

scene

a VisuGlNodeScene object to apply the options on ;

 

error

a location for error report.

 

Returns

TRUE if complete without error.


visu_gl_node_scene_dump ()

gboolean
visu_gl_node_scene_dump (VisuGlNodeScene *scene,
                         VisuDump *format,
                         const char *fileName,
                         guint width,
                         guint height,
                         ToolVoidDataFunc functionWait,
                         gpointer data,
                         GError **error);

Call this method to dump the given scene to a file.

Parameters

scene

a valid VisuGlNodeScene object ;

 

format

a VisuDump object, corresponding to the write method ;

 

fileName

a string that defined the file to write to ;.

[type filename]

width

an integer, or 0 for current ;

 

height

an integer, or 0 for current ;

 

functionWait

a method to call periodically during the dump ;.

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

data

some pointer on object to be passed to the wait function.

[closure]

error

a location to store some error (not NULL) ;

 

Returns

TRUE if everything went right.


visu_gl_node_scene_setData ()

gboolean
visu_gl_node_scene_setData (VisuGlNodeScene *scene,
                            VisuData *data);

Apply the given view on all VisuGlExt objects stored in set .

Parameters

scene

a VisuGlNodeScene object.

 

data

a VisuData object.

 

Returns

TRUE if the view actually change.

Since: 3.8


visu_gl_node_scene_loadData ()

gboolean
visu_gl_node_scene_loadData (VisuGlNodeScene *scene,
                             VisuDataLoadable *loadable,
                             guint iSet,
                             GCancellable *cancel,
                             GError **error);

A convenience function that tries to load loadable , see visu_data_loadable_load(). On success, loadable is associated to scene , see visu_gl_node_scene_setData().

Parameters

scene

a VisuGlNodeScene object.

 

loadable

a VisuDataLoadable object.

 

iSet

an id.

 

cancel

a cancellable.

[allow-none]

error

an error location.

 

Returns

TRUE on success.

Since: 3.8


visu_gl_node_scene_getData ()

VisuData *
visu_gl_node_scene_getData (VisuGlNodeScene *scene);

Retrives the VisuData represented by VisuGlNodeScene.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuData object.

[transfer none]

Since: 3.8


visu_gl_node_scene_setColorization ()

gboolean
visu_gl_node_scene_setColorization (VisuGlNodeScene *scene,
                                    VisuColorization *dt);

Associates dt with scene to colorize nodes.

Parameters

scene

a VisuGlNodeScene object.

 

dt

a VisuColorization object.

[allow-none]

Returns

TRUE if value is actually changed.

Since: 3.8


visu_gl_node_scene_getColorization ()

VisuColorization *
visu_gl_node_scene_getColorization (VisuGlNodeScene *scene);

The attached VisuColorization object, if any.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuColorization object, or NULL.

[transfer none]

Since: 3.8


visu_gl_node_scene_setColorizationPolicy ()

gboolean
visu_gl_node_scene_setColorizationPolicy
                               (VisuGlNodeScene *scene,
                                VisuGlNodeSceneColorizationPolicies policy);

Specifies how the colorization should be modified when a new VisuData is associated to scene .

Parameters

scene

a VisuGlNodeScene object.

 

policy

a VisuGlNodeSceneColorizationPolicies value.

 

Returns

TRUE if value is actually changed.

Since: 3.8


visu_gl_node_scene_getFragmentColorizer ()

VisuDataColorizerFragment *
visu_gl_node_scene_getFragmentColorizer
                               (VisuGlNodeScene *scene);

Retrieves the default fragment colorizer object of scene .

Parameters

scene

a VisuGlNodeScene object.

 

Returns

the default VisuDataColorizerFragment.

[transfer none]

Since: 3.8


visu_gl_node_scene_getGlView ()

VisuGlView *
visu_gl_node_scene_getGlView (VisuGlNodeScene *scene);

Retrieves the VisuGlView used by scene to render nodes.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlView object.

[transfer none]

Since: 3.8


visu_gl_node_scene_setGlCamera ()

void
visu_gl_node_scene_setGlCamera (VisuGlNodeScene *scene,
                                VisuGlCamera *camera);

A convenience function to change the view all at once with animations.

Parameters

scene

a VisuGlNodeScene object.

 

camera

a VisuGlCamera object.

 

Returns

TRUE if camera is actually changed.

Since: 3.8


visu_gl_node_scene_getNodes ()

VisuGlExtNodes *
visu_gl_node_scene_getNodes (VisuGlNodeScene *scene);

Retrieve the VisuGlExtNodes object used by scene to render nodes.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtNodes object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getPairs ()

VisuGlExtPairs *
visu_gl_node_scene_getPairs (VisuGlNodeScene *scene);

Retrieve the VisuGlExtPairs object used by scene to render pairs.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtPairs object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getAxes ()

VisuGlExtAxes *
visu_gl_node_scene_getAxes (VisuGlNodeScene *scene);

Retrieve the VisuGlExtAxes object used by scene to render axes.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtAxes object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getBox ()

VisuGlExtBox *
visu_gl_node_scene_getBox (VisuGlNodeScene *scene);

Retrieve the VisuGlExtBox object used by scene to render the box.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtBox object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getBoxLegend ()

VisuGlExtBoxLegend *
visu_gl_node_scene_getBoxLegend (VisuGlNodeScene *scene);

Retrieve the VisuGlExtBoxLegend object used by scene to render the lgened of the box.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtBoxLegend object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getLegend ()

VisuGlExtLegend *
visu_gl_node_scene_getLegend (VisuGlNodeScene *scene);

Retrieve the VisuGlExtLegend object used by scene to render the node legend.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtLegend object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getBgImage ()

VisuGlExtBg *
visu_gl_node_scene_getBgImage (VisuGlNodeScene *scene);

Retrieve the VisuGlExtBg object used by scene to render images on the background.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtBg object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getScales ()

VisuGlExtScale *
visu_gl_node_scene_getScales (VisuGlNodeScene *scene);

Retrieve the VisuGlExtScale object used by scene to render scales.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtScale object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getForces ()

VisuGlExtForces *
visu_gl_node_scene_getForces (VisuGlNodeScene *scene);

Retrieve the VisuGlExtForces object used by scene to render forces.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtForces object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getVibrations ()

VisuGlExtVibrations *
visu_gl_node_scene_getVibrations (VisuGlNodeScene *scene);

Retrieves the associated VisuGlExtVibrations used to represent periodic displacements of nodes.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

the attached VisuGlExtVibrations, owned by V_Sim.

[transfer none]

Since: 3.8


visu_gl_node_scene_getColorizationLegend ()

VisuGlExtShade *
visu_gl_node_scene_getColorizationLegend
                               (VisuGlNodeScene *scene);

Retrieve the VisuGlExtShade object, used to represent the color variation of an attached VisuColorization object. The returned object is created if none already exists.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtShade.

[transfer none]

Since: 3.8


visu_gl_node_scene_getGeometryDifferences ()

VisuGlExtGeodiff *
visu_gl_node_scene_getGeometryDifferences
                               (VisuGlNodeScene *scene);

Retrieve the VisuGlExtGeodiff used to draw geometry differences.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtGeodiff object.

[transfer none]

Since: 3.8


visu_gl_node_scene_addPlanes ()

VisuGlExtPlanes *
visu_gl_node_scene_addPlanes (VisuGlNodeScene *scene);

Add or retrieve the VisuGlExtPlanes object used by scene to render planes.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtPlanes object.

[transfer none]

Since: 3.8


visu_gl_node_scene_addSurfaces ()

VisuGlExtSurfaces *
visu_gl_node_scene_addSurfaces (VisuGlNodeScene *scene);

Add or retrieve the VisuGlExtSurfaces object used by scene to render surfaces.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtSurfaces object.

[transfer none]

Since: 3.8


visu_gl_node_scene_addMaps ()

VisuGlExtMapSet *
visu_gl_node_scene_addMaps (VisuGlNodeScene *scene,
                            VisuGlExtShade **mapLegend);

Add or retrieve the VisuGlExtMapSet object used by scene to render maps.

Parameters

scene

a VisuGlNodeScene object.

 

mapLegend

a pointer to retrieve the associated VisuGlExtShade legend of the coloured map.

[out][transfer none]

Returns

a VisuGlExtMapSet object.

[transfer none]

Since: 3.8


visu_gl_node_scene_getMarks ()

VisuGlExtMarks *
visu_gl_node_scene_getMarks (VisuGlNodeScene *scene);

Retrieve the VisuGlExtMarks object used by scene to render marks.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtMarks object.

[transfer none]

Since: 3.8


visu_gl_node_scene_setMarksFromFile ()

gboolean
visu_gl_node_scene_setMarksFromFile (VisuGlNodeScene *scene,
                                     const gchar *filename,
                                     GError **error);

Try to parse filename and put marks on nodes of scene accordingly.

Parameters

scene

a VisuGlNodeScene object.

 

filename

a filename

 

error

an error location.

 

Returns

TRUE on success.

Since: 3.8


visu_gl_node_scene_marksToFile ()

gboolean
visu_gl_node_scene_marksToFile (VisuGlNodeScene *scene,
                                const gchar *filename,
                                GError **error);

Export the current selection and marks into filename .

Parameters

scene

a VisuGlNodeScene object.

 

filename

a path.

 

error

a error location.

 

Returns

FALSE if an error occured.

Since: 3.8


visu_gl_node_scene_getMarkActive ()

gboolean
visu_gl_node_scene_getMarkActive (const VisuGlNodeScene *scene,
                                  guint nodeId);

Tests if nodeId from scene has some marks on it.

Parameters

scene

a VisuGlNodeScene obejct.

 

nodeId

a node id.

 

Returns

TRUE if nodeId has some marks on it.

Since: 3.8


visu_gl_node_scene_setMark ()

gboolean
visu_gl_node_scene_setMark (VisuGlNodeScene *scene,
                            guint nodeId,
                            gboolean status);

Display or removes marks on nodeId , depending on status .

Parameters

scene

a VisuGlNodeScene object.

 

nodeId

a node id.

 

status

a boolean.

 

Returns

TRUE if nodeId mark status changed.

Since: 3.8


visu_gl_node_scene_colorizeShell ()

VisuDataColorizerFragment *
visu_gl_node_scene_colorizeShell (VisuGlNodeScene *scene,
                                  gint nodeId);

Apply colorization depending on neighbouring shell of nodeId .

Parameters

scene

a VisuGlNodeScene object.

 

nodeId

a node id.

 

Returns

the VisuDataColorizerFragment used for the colorization.

[transfer none]

Since: 3.8


visu_gl_node_scene_colorizeFragments ()

VisuDataColorizerFragment *
visu_gl_node_scene_colorizeFragments (VisuGlNodeScene *scene);

Apply colorization depending on fragments if they are defined.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

the associated VisuDataColorizerFragment object.

[transfer none]

Since: 3.8


visu_gl_node_scene_removeMarks ()

void
visu_gl_node_scene_removeMarks (VisuGlNodeScene *scene);

Remove all marks on scene .

Parameters

scene

a VisuGlNodeScene object.

 

Since: 3.8


visu_gl_node_scene_getInfos ()

VisuGlExtInfos *
visu_gl_node_scene_getInfos (VisuGlNodeScene *scene);

Retrieves the VisuGlExtInfos object used by scene to display info on nodes.

Parameters

scene

a VisuGlNodeScene object.

 

Returns

a VisuGlExtInfos object.

[transfer none]

Since: 3.8


visu_gl_node_scene_setDiffFromLoadable ()

gboolean
visu_gl_node_scene_setDiffFromLoadable
                               (VisuGlNodeScene *scene,
                                VisuDataLoadable *ref,
                                GError **error);

Same as visu_gl_node_scene_setDiffFromData(), but load first ref before doing the difference.

Parameters

scene

a VisuGlNodeScene object.

 

ref

a VisuData object.

 

error

an error location.

 

Returns

TRUE on success.

Since: 3.8


visu_gl_node_scene_setDiffFromData ()

void
visu_gl_node_scene_setDiffFromData (VisuGlNodeScene *scene,
                                    const VisuData *dataRef);

Creates a VisuDataDiff from the current VisuData and dataRef . If the scene is in recording mode (see "record-path" property), the difference is appended to the current path.

Parameters

scene

a VisuGlNodeScene object.

 

dataRef

a VisuData object.

 

Since: 3.8


visu_gl_node_scene_clearPaths ()

void
visu_gl_node_scene_clearPaths (VisuGlNodeScene *scene);

Remove any VisuPaths from scene .

Parameters

scene

a VisuGlNodeScene object.

 

Since: 3.8


visu_gl_node_scene_parsePathsFromXML ()

gboolean
visu_gl_node_scene_parsePathsFromXML (VisuGlNodeScene *scene,
                                      const gchar *filename,
                                      GError **error);

Try to parse filename to load some VisuPaths into scene .

Parameters

scene

a VisuGlNodeScene object.

 

filename

a filename.

 

error

an error location.

 

Returns

TRUE on success.

Since: 3.8


visu_gl_node_scene_exportPathsToXML ()

gboolean
visu_gl_node_scene_exportPathsToXML (VisuGlNodeScene *scene,
                                     const gchar *filename,
                                     GError **error);

If scene has some VisuPaths, it exports them to an XML file defined by filename .

Parameters

scene

a VisuGlNodeScene object.

 

filename

a filename.

 

error

an error location.

 

Returns

TRUE on success.

Since: 3.8


visu_gl_node_scene_addMasker ()

gboolean
visu_gl_node_scene_addMasker (VisuGlNodeScene *scene,
                              VisuNodeMasker *masker);

Add masker to scene , so when masker is modified, VisuNode of scene are hidden accordingly.

Parameters

scene

a VisuGlNodeScene object.

 

masker

a VisuNodeMasker object.

 

Returns

FALSE if masker already exists.

Since: 3.8


visu_gl_node_scene_removeMasker ()

gboolean
visu_gl_node_scene_removeMasker (VisuGlNodeScene *scene,
                                 VisuNodeMasker *masker);

Remove masker from the list of objects that may hide nodes in scene .

Parameters

scene

a VisuGlNodeScene object.

 

masker

a VisuNodeMasker object.

 

Returns

TRUE on successful removal.

Since: 3.8


visu_gl_node_scene_addMover ()

gboolean
visu_gl_node_scene_addMover (VisuGlNodeScene *scene,
                             VisuNodeMover *mover);

Add mover to scene .

Parameters

scene

a VisuGlNodeScene object.

 

mover

a VisuNodeMover object.

 

Returns

FALSE if mover already exists.

Since: 3.8


visu_gl_node_scene_removeMover ()

gboolean
visu_gl_node_scene_removeMover (VisuGlNodeScene *scene,
                                VisuNodeMover *mover);

Remove mover from the list of objects that may move nodes in scene .

Parameters

scene

a VisuGlNodeScene object.

 

mover

a VisuNodeMover object.

 

Returns

TRUE on successful removal.

Since: 3.8


visu_gl_node_scene_setDefault ()

void
visu_gl_node_scene_setDefault (VisuGlNodeScene *scene);

Parameters

scene

a VisuGlNodeScene object.

[transfer none][allow none]

Since: 3.8


visu_gl_node_scene_getDefault ()

VisuGlNodeScene *
visu_gl_node_scene_getDefault (void);

Returns

a VisuGlNodeScene object or NULL.

[transfer none]

Since: 3.8

Types and Values

enum VisuGlNodeSceneColorizationPolicies

The different policies to apply when a new VisuData is associated to a VisuGlNodeScene object.

Members

COLORIZATION_POLICY_NONE

no policy.

 

COLORIZATION_POLICY_FROM_FILE

try to load colourisation data from file matching file name.

 

COLORIZATION_POLICY_FROM_PREVIOUS

copy previous colourisation data to new VisuData.

 

Since: 3.8


struct VisuGlNodeScene

struct VisuGlNodeScene;

Common name to refer to a _VisuGlNodeScene.


struct VisuGlNodeSceneClass

struct VisuGlNodeSceneClass {
  VisuGlExtSetClass parent;
};

Common name to refer to a _VisuGlNodeSceneClass.

Members

VisuGlExtSetClass parent;

private.

 

Property Details

The “axes-from-box” property

  “axes-from-box”            gboolean

axes follow the data super-cell.

Flags: Read / Write

Default value: FALSE


The “colorization-file-extension” property

  “colorization-file-extension” gchar *

extension used to discover colourisation file.

Flags: Read / Write

Default value: ".dat"


The “colorization-policy” property

  “colorization-policy”      guint

colorization load policy.

Flags: Read / Write

Allowed values: <= 2

Default value: 2


The “data” property

  “data”                     VisuData *

storing data for nodes.

Flags: Read / Write


The “geometry-differences” property

  “geometry-differences”     gboolean

display arrows to represent differences.

Flags: Read / Write

Default value: FALSE


The “loading” property

  “loading”                  gboolean

flag indicating that data are loading.

Flags: Read

Default value: FALSE


The “loading-message” property

  “loading-message”          gchar *

message when loading.

Flags: Read

Default value: ""


The “path-active” property

  “path-active”              gboolean

display stored paths.

Flags: Read / Write / Construct

Default value: FALSE


The “path-length” property

  “path-length”              guint

store the path length.

Flags: Read

Default value: 0


The “path-shade” property

  “path-shade”               ToolShade *

store the path shade.

Flags: Read / Write


The “record-path” property

  “record-path”              gboolean

save differences between data.

Flags: Read / Write / Construct

Default value: FALSE


The “reorder-reference” property

  “reorder-reference”        gboolean

reorder reference data before comparing.

Flags: Read / Write / Construct

Default value: FALSE


The “shell-colorizer” property

  “shell-colorizer”          VisuDataColorizerFragment *

used to colorize neighbouring shells.

Flags: Read


The “view” property

  “view”                     VisuGlView *

storing the view to represent the data.

Flags: Read