VisuElementSpin

VisuElementSpin — a class implementing rendering for VisuDataSpin method.

Functions

Properties

gfloat a-axis Read / Write
gfloat b-axis Read / Write
gfloat hat-length Read / Write
gfloat hat-radius Read / Write
gboolean hat-spin-colored Read / Write
gboolean spin-colored Read / Write
guint spin-shape Read / Write
gfloat tail-length Read / Write
gfloat tail-radius Read / Write
gboolean tail-spin-colored Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuElementRenderer
            ╰── VisuElementAtomic
                ╰── VisuElementSpin

Description

This class implements the virtual method of VisuElementRenderer class to display nodes as 1D objects at a given point in a given direction. The specific shape is defined by VisuElementSpinShapeId enumeration. The size and orientation of the 1D object is given per node by a VisuNodeValuesVector property.

visu_element_spin_getFromPool() is a specific function to associate a unique VisuElementSpin to a given VisuElement.

Functions

visu_element_spin_new ()

VisuElementSpin *
visu_element_spin_new (VisuElement *element);

Creates a new VisuElementSpin object to draw element .

Parameters

element

a VisuElement object.

 

Returns

a newly created VisuElementSpin object.

[transfer full]

Since: 3.8


visu_element_spin_getFromPool ()

VisuElementSpin *
visu_element_spin_getFromPool (VisuElement *element);

Retrieve a VisuElementSpin representing element . This VisuElementSpin is unique and its parent properties are bound to the unique VisuElementAtomic for element .

Parameters

element

a VisuElement object.

 

Returns

a VisuElementSpin for element .

[transfer none]

Since: 3.8


visu_element_spin_bindToPool ()

void
visu_element_spin_bindToPool (VisuElementSpin *spin);

Bind all properties of spin to the properties of the VisuElementSpin object from the pool used for the same VisuElement.

Parameters

spin

A VisuElementSpin object.

 

Since: 3.8


visu_element_spin_getShape ()

VisuElementSpinShapeId
visu_element_spin_getShape (const VisuElementSpin *self);

Retrieves the shape of self .

Parameters

self

a VisuElementSpin object.

 

Returns

a VisuElementSpinShapeId value.

Since: 3.8


visu_element_spin_getShapeNames ()

const gchar **
visu_element_spin_getShapeNames (gboolean asLabel);

Get the string defining VisuElementSpinShapeId. If asLabel is TRUE, then the string are translated and stored in UTF8.

Parameters

asLabel

a boolean.

 

Returns

strings representing VisuElementSpinShapeId.

[transfer none][array zero-terminated=1]

Since: 3.8


visu_element_spin_pool_finalize ()

void
visu_element_spin_pool_finalize (void);

Destroy the internal list of known VisuElementSpin objects, see visu_element_spin_getFromPool().

[skip]

Since: 3.8

Types and Values

enum VisuElementSpinShapeId

An identifier for the different shapes to draw elements.

Members

VISU_ELEMENT_SPIN_ARROW_SMOOTH

the shape is smooth and rounded ;

 

VISU_ELEMENT_SPIN_ARROW_SHARP

the shape is built on squares ;

 

VISU_ELEMENT_SPIN_ELLIPSOID

the shape is an ellipsoid ;

 

VISU_ELEMENT_SPIN_TORUS

the shape is a torus (direction of the arrow is normal to the torus plane).

 

VISU_ELEMENT_SPIN_N_SHAPES

private.

 

Property Details

The “a-axis” property

  “a-axis”                   gfloat

A axis length.

Flags: Read / Write

Allowed values: >= 0

Default value: 1.5


The “b-axis” property

  “b-axis”                   gfloat

B axis length.

Flags: Read / Write

Allowed values: >= 0

Default value: 0.6


The “hat-length” property

  “hat-length”               gfloat

hat length.

Flags: Read / Write

Allowed values: >= 0

Default value: 2


The “hat-radius” property

  “hat-radius”               gfloat

hat radius.

Flags: Read / Write

Allowed values: >= 0

Default value: 0.8


The “hat-spin-colored” property

  “hat-spin-colored”         gboolean

hat is colored by spin.

Flags: Read / Write

Default value: FALSE


The “spin-colored” property

  “spin-colored”             gboolean

shape is colored by spin.

Flags: Read / Write

Default value: FALSE


The “spin-shape” property

  “spin-shape”               guint

spin shape.

Flags: Read / Write

Allowed values: <= 3

Default value: 0


The “tail-length” property

  “tail-length”              gfloat

tail length.

Flags: Read / Write

Allowed values: >= 0

Default value: 0.8


The “tail-radius” property

  “tail-radius”              gfloat

tail radius.

Flags: Read / Write

Allowed values: >= 0

Default value: 0.33


The “tail-spin-colored” property

  “tail-spin-colored”        gboolean

tail is colored by spin.

Flags: Read / Write

Default value: FALSE