VisuNodeNeighbours

VisuNodeNeighbours — node neighbours handling.

Functions

Properties

VisuData * data Read / Write / Construct Only
gfloat factor Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuNodeNeighbours

Description

Define an object to store information about neighbours, see visu_node_neighbours_new() and an iterator to run over neighbours.

Functions

visu_node_neighbours_new ()

VisuNodeNeighbours *
visu_node_neighbours_new (VisuData *data);

Create an object to handle a set of neighbours for data .

Parameters

data

a VisuData object.

 

Returns

a newly created VisuNodeNeighbours object.

[transfer full]

Since: 3.8


visu_node_neighbours_getSurfaceAt ()

gboolean
visu_node_neighbours_getSurfaceAt (VisuNodeNeighbours *nei,
                                   guint nodeId,
                                   VisuSurfaceDefinition *def);

Generate a surface definition around atom nodeId .

Parameters

nei

a VisuNodeNeighbours object.

 

nodeId

a node number.

 

def

a place to store points and polys.

[out caller-allocates]

Returns

TRUE if def is generated.

Since: 3.8


visu_node_neighbours_getSurfaceFrom ()

gboolean
visu_node_neighbours_getSurfaceFrom (VisuNodeNeighbours *nei,
                                     guint nodeId,
                                     VisuSurfaceDefinition *def);

Generate a surface definition around atom nodeId and all its neighbours.

Parameters

nei

a VisuNodeNeighbours object.

 

nodeId

a node id.

 

def

a place to store points and polys.

[out caller-allocates]

Returns

TRUE if there is any generated surface.

Since: 3.8


visu_node_neighbours_iter ()

gboolean
visu_node_neighbours_iter (VisuNodeNeighbours *nei,
                           VisuNodeNeighboursIter *iter,
                           guint nodeId);

Initialise iter to iterate over the neighbours of node nodeId .

Parameters

nei

a VisuNodeNeighbours object to iterate on.

 

iter

a VisuNodeNeighboursIter structure.

[out caller-allocates]

nodeId

the node id to obtain neighbours of.

 

Returns

TRUE if the iterator is valid.

Since: 3.8


visu_node_neighbours_iter___iter__ ()

void
visu_node_neighbours_iter___iter__ (const VisuNodeNeighboursIter *iter,
                                    VisuNodeNeighboursIter *out);

Used for Python binding only.

Parameters

iter

a VisuNodeNeighboursIter structure.

 

out

a VisuNodeNeighboursIter structure.

[out caller-allocates]

Since: 3.8


visu_node_neighbours_iter_next ()

gboolean
visu_node_neighbours_iter_next (VisuNodeNeighboursIter *iter);

Look to the next neighbour, see visu_node_neighbours_iter().

Parameters

iter

a VisuNodeNeighboursIter iterator.

 

Returns

TRUE if the iterator is valid.

Since: 3.8

Types and Values

struct VisuNodeNeighbours

struct VisuNodeNeighbours;

Common name to refer to a _VisuNodeNeighbours.


struct VisuNodeNeighboursClass

struct VisuNodeNeighboursClass {
  VisuObjectClass parent;
};

Common name to refer to a _VisuNodeNeighboursClass.

Members

VisuObjectClass parent;

private.

 

struct VisuNodeNeighboursIter

struct VisuNodeNeighboursIter {
  guint index, nnei, neiId;

  /* Private */
  VisuNodeNeighbours *nei;
  guint nodeId;
};

Iterator structure used to span over the neighbours of nodeId .

Members

guint index;

current neighbour index.

 

guint nnei;

number of neighbours.

 

guint neiId;

node id of the current neighbour.

 

VisuNodeNeighbours *nei;

parent VisuNodeNeighbours object.

 

guint nodeId;

node id of the current node.

 

Since: 3.8

Property Details

The “data” property

  “data”                     VisuData *

the Data the neighbours are for.

Flags: Read / Write / Construct Only


The “factor” property

  “factor”                   gfloat

additional percentage on radii.

Flags: Read / Write

Allowed values: [0,1.5]

Default value: 0.2