VisuMethodSpin

VisuMethodSpin — a class defining how a set of spin should be rendered.

Functions

Properties

gfloat cone-omega Read / Write
gfloat cone-phi Read / Write
gfloat cone-theta Read / Write
guint hiding-mode Read / Write
guint modulus-scaling Read / Write
gboolean use-atomic Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuMethodSpin

Description

Defines global properties for the rendering of spin data, like should atomic rendering be used in addition? How to orientate the colourisation cone?

Functions

visu_method_spin_new ()

VisuMethodSpin *
visu_method_spin_new (void);

Creates a VisuMethodSpin object.

Returns

a newly allocated VisuMethodSpin object.

Since: 3.8


visu_method_spin_getDefault ()

VisuMethodSpin *
visu_method_spin_getDefault (void);

Access the default spin method object.

Returns

the default spin method object.

[transfer none]

Since: 3.8


visu_method_spin_getSpinVector ()

const gfloat *
visu_method_spin_getSpinVector (const VisuMethodSpin *method,
                                const VisuDataSpin *dataSpin,
                                const VisuNode *node,
                                gfloat *ratio,
                                gfloat rgb[3],
                                gboolean *withAtomic);

Retrieves the spin of node in spherical coordinates. According to rendering policy from method , ratio , rgb and withAtomic will be set to their respective values. If no spin should be rendered for node , NULL is returned.

Parameters

method

a VisuMethodSpin object.

 

dataSpin

a VisuDataSpin object.

 

node

a VisuNode from dataSpin .

 

ratio

the ratio to apply when drawing the spin.

[out]

rgb

a location to store the colour.

[out]

withAtomic

a location to store if atomic rendering is required.

[out]

Returns

three floats representing the spin.

Since: 3.8

Types and Values

struct VisuMethodSpin

struct VisuMethodSpin;

Structure used to define VisuMethodSpin objects.

Since: 3.8


struct VisuMethodSpinClass

struct VisuMethodSpinClass {
  VisuObjectClass parent;
};

A short way to identify _VisuMethodSpinClass structure.

Members

VisuObjectClass parent;

the parent class.

 

enum VisuMethodSpinDrawingPolicy

Different policy to render the spin when the modulus is null. This policy is applied for all VisuElement.

Members

VISU_METHOD_SPIN_ALWAYS

Arrows are drawn whatever the modulus value.

 

VISU_METHOD_SPIN_HIDE_NULL

Spin with a null modulus are hidden.

 

VISU_METHOD_SPIN_ATOMIC_NULL

Follow atomic method for null modulus.

 

VISU_METHOD_SPIN_N_MODES

a flag to count the number of modes.

 

enum VisuMethodSpinModulusPolicy

Different policy to render the spin depending on the modulus.

Members

VISU_METHOD_SPIN_CONSTANT

arrows have all the same size, whatever the modulus value.

 

VISU_METHOD_SPIN_PER_TYPE

arrows are scaled per node type.

 

VISU_METHOD_SPIN_GLOBAL

arrows are scaled globaly.

 

VISU_METHOD_SPIN_N_MODULUS_MODES

a flag to count the number of modes.

 

Property Details

The “cone-omega” property

  “cone-omega”               gfloat

The omega angle to orientate the colourisation cone.

Flags: Read / Write

Allowed values: [0,360]

Default value: 0


The “cone-phi” property

  “cone-phi”                 gfloat

The phi angle to orientate the colourisation cone.

Flags: Read / Write

Allowed values: [0,360]

Default value: 0


The “cone-theta” property

  “cone-theta”               gfloat

The theta angle to orientate the colourisation cone.

Flags: Read / Write

Allowed values: [0,180]

Default value: 0


The “hiding-mode” property

  “hiding-mode”              guint

The hiding policy for spin with a null modulus.

Flags: Read / Write

Allowed values: <= 3

Default value: 0


The “modulus-scaling” property

  “modulus-scaling”          guint

The scaling policy based on modulus value.

Flags: Read / Write

Allowed values: <= 3

Default value: 0


The “use-atomic” property

  “use-atomic”               gboolean

If atomic rendering is used in addition to spin rendering.

Flags: Read / Write

Default value: FALSE