VisuNodeValuesVector

VisuNodeValuesVector — define a VisuNodeValues object to handle vectorial node information.

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuNodeValues
            ╰── VisuNodeValuesFarray
                ╰── VisuNodeValuesVector
                    ├── VisuDataDiff
                    ╰── VisuVibration

Description

Defines a VisuNodeValues object to store a vector information on nodes. One can set and retrieve vector on each node as cartesian (see visu_node_values_vector_setAt() or visu_node_values_vector_getAt() functions) or spherical coordinates (see visu_node_values_vector_setAtSpherical() and visu_node_values_vector_getAtSpherical() functions).

Functions

VisuNodeValuesVectorShift ()

void
(*VisuNodeValuesVectorShift) (const VisuNodeValuesVector *vect,
                              const VisuNode *node,
                              gfloat dxyz[3]);

Prototype of functions used to define a shift between the centre of node and the origin of the stored vector for this node.

Parameters

vect

a VisuNodeValuesVector object.

 

node

a VisuNode pointer:

 

dxyz

a shift in cartesian coordinates.

[array fixed-size=3]

visu_node_values_vector_new ()

VisuNodeValuesVector *
visu_node_values_vector_new (VisuNodeArray *arr,
                             const gchar *label);

Create a new vector field located on nodes.

Parameters

arr

a VisuNodeArray object.

 

label

a translatable label.

 

Returns

a newly created VisuNodeValuesVector object.

[transfer full]

Since: 3.8


visu_node_values_vector_getAt ()

const gfloat *
visu_node_values_vector_getAt (const VisuNodeValuesVector *vect,
                               const VisuNode *node);

Retrieves the vector hosted on node .

Parameters

vect

a VisuNodeValuesVector object.

 

node

a VisuNode object.

 

Returns

the coordinates of vector for node .

[array fixed-size=3][transfer none]

Since: 3.8


visu_node_values_vector_getAtSpherical ()

const gfloat *
visu_node_values_vector_getAtSpherical
                               (const VisuNodeValuesVector *vect,
                                const VisuNode *node);

Retrieves the vector hosted on node in spherical coordinates.

Parameters

vect

a VisuNodeValuesVector object.

 

node

a VisuNode object.

 

Returns

the spherical coordinates.

[array fixed-size=3][allow-none]

Since: 3.8


visu_node_values_vector_getAtIterSpherical ()

const gfloat *
visu_node_values_vector_getAtIterSpherical
                               (const VisuNodeValuesVector *vect,
                                const VisuNodeValuesIter *iter);

Retrieves the vector hosted on iter in spherical coordinates.

Parameters

vect

a VisuNodeValuesVector object.

 

iter

a VisuNodeValuesIter object.

 

Returns

the spherical coordinates.

[array fixed-size=3][allow-none]

Since: 3.8


visu_node_values_vector_getShift ()

void
visu_node_values_vector_getShift (const VisuNodeValuesVector *vect,
                                  const VisuNode *node,
                                  gfloat dxyz[3]);

Get the shift value that is applied to every vector of vect .

Parameters

vect

a VisuNodeValuesVector object.

 

node

a VisuNode pointer.

 

dxyz

a vector location.

[out caller-allocates][array fixed-size=3]

Since: 3.8


visu_node_values_vector_setAt ()

gboolean
visu_node_values_vector_setAt (VisuNodeValuesVector *vect,
                               const VisuNode *node,
                               const gfloat dxyz[3]);

Changes the vector hosted at node for one of coordinates defined by dxyz .

Parameters

vect

a VisuNodeValuesVector object.

 

node

a VisuNode object.

 

dxyz

vector coordinates.

[array fixed-size=3]

Returns

TRUE if vector for node is indeed changed.

Since: 3.8


visu_node_values_vector_setAtSpherical ()

gboolean
visu_node_values_vector_setAtSpherical
                               (VisuNodeValuesVector *vect,
                                const VisuNode *node,
                                const gfloat sph[3]);

Same as visu_node_values_vector_setAt() but using a spherical coordinate description.

Parameters

vect

a VisuNodeValuesVector object.

 

node

a VisuNode object.

 

sph

spherical coordinates.

[array fixed-size=3]

Returns

TRUE if vector for node is indeed changed.

Since: 3.8


visu_node_values_vector_setAtDbl ()

gboolean
visu_node_values_vector_setAtDbl (VisuNodeValuesVector *vect,
                                  const VisuNode *node,
                                  const double dxyz[3]);

Same as visu_node_values_vector_setAt() but for double values.

Parameters

vect

a VisuNodeValuesVector object.

 

node

a VisuNode object.

 

dxyz

vector coordinates.

[array fixed-size=3]

Returns

TRUE if vector for node is indeed changed.

Since: 3.8


visu_node_values_vector_set ()

gboolean
visu_node_values_vector_set (VisuNodeValuesVector *vect,
                             const GArray *data);

Assigns the coordinates stored in data to each nodes in vect .

Parameters

vect

a VisuNodeValuesVector object.

 

data

some vector coordinates.

[element-type float]

Returns

TRUE if data has the same size as vect .

Since: 3.8

Types and Values

struct VisuNodeValuesVector

struct VisuNodeValuesVector;

Common name to refer to a _VisuNodeValuesVector.


struct VisuNodeValuesVectorClass

struct VisuNodeValuesVectorClass {
  VisuNodeValuesFarrayClass parent;

  VisuNodeValuesVectorShift shift;
};

Common name to refer to a _VisuNodeValuesVectorClass.

Members

VisuNodeValuesFarrayClass parent;

private.

 

VisuNodeValuesVectorShift shift;

a routine to add a shift on each node.