VisuGlExtLined

VisuGlExtLined — Defines a common interface for VisuGlExt objects with line characteristics.

Functions

Properties

ToolColor * color Read / Write
guint stipple Read / Write
gfloat width Read / Write

Types and Values

Object Hierarchy

    GInterface
    ╰── VisuGlExtLined

Prerequisites

VisuGlExtLined requires GObject.

Known Implementations

VisuGlExtLined is implemented by VisuGlExtAxes, VisuGlExtBox and VisuGlExtScale.

Description

Functions

visu_gl_ext_lined_getWidth ()

gfloat
visu_gl_ext_lined_getWidth (const VisuGlExtLined *self);

Read the line width used to draw lines.

Parameters

self

the VisuGlExtLined object to inquire.

 

Returns

the value of current line width.

Since: 3.8


visu_gl_ext_lined_getStipple ()

guint16
visu_gl_ext_lined_getStipple (const VisuGlExtLined *self);

Read the line pattern used to draw lines.

Parameters

self

the VisuGlExtLined object to inquire.

 

Returns

the value of current line pattern.

Since: 3.8


visu_gl_ext_lined_getRGBA ()

gfloat *
visu_gl_ext_lined_getRGBA (const VisuGlExtLined *self);

Read all the colour components of the line (in [0;1]).

Parameters

self

the VisuGlExtLined object to inquire.

 

Returns

four RGB values, private from V_Sim, read only.

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

Since: 3.8


visu_gl_ext_lined_setWidth ()

gboolean
visu_gl_ext_lined_setWidth (VisuGlExtLined *self,
                            gfloat value);

Method used to change the value of the line width.

Parameters

self

the VisuGlExtLined object to modify.

 

value

value of the desired line width.

 

Returns

TRUE if modified.

Since: 3.8


visu_gl_ext_lined_setStipple ()

gboolean
visu_gl_ext_lined_setStipple (VisuGlExtLined *self,
                              guint16 value);

Method used to change the value of the line stipple.

Parameters

self

the VisuGlExtLined object to modify.

 

value

value of the desired pattern.

 

Returns

TRUE if modified.

Since: 3.8


visu_gl_ext_lined_setRGBA ()

gboolean
visu_gl_ext_lined_setRGBA (VisuGlExtLined *self,
                           gfloat values[4],
                           gint mask);

Method used to change the value of the color used to draw the line.

Parameters

self

the VisuGlExtLined object to modify.

 

values

a four floats array with values (0 <= values <= 1) for the red, the green and the blue color. Only values specified by the mask are really relevant.

[array fixed-size=4]

mask

use TOOL_COLOR_MASK_R, TOOL_COLOR_MASK_G, TOOL_COLOR_MASK_B, TOOL_COLOR_MASK_A or a combinaison to indicate what values in the rgb array must be taken into account.

 

Returns

TRUE if modified.

Since: 3.8

Types and Values

struct VisuGlExtLinedInterface

struct VisuGlExtLinedInterface {
  GTypeInterface parent;

  gfloat  (*get_width)   (const VisuGlExtLined *self);
  guint16 (*get_stipple) (const VisuGlExtLined *self);
  gfloat* (*get_rgba)    (const VisuGlExtLined *self);

  gboolean (*set_width)   (VisuGlExtLined *self, gfloat value);
  gboolean (*set_stipple) (VisuGlExtLined *self, guint16 value);
  gboolean (*set_rgba)    (VisuGlExtLined *self, gfloat values[4], gint mask);
};

The different routines common to objects implementing a VisuGlExtLined interface.

Members

GTypeInterface parent;

yet, its parent.

 

get_width ()

a routine to get line width.

 

get_stipple ()

a routine to get line stipple.

 

get_rgba ()

a routine to get line color.

 

set_width ()

a routine to set line width.

 

set_stipple ()

a routine to set line stipple.

 

set_rgba ()

a routine to set line color.

 

Since: 3.8


VisuGlExtLined

typedef struct _VisuGlExtLined VisuGlExtLined;

Interface object.

Since: 3.8

Property Details

The “color” property

  “color”                    ToolColor *

rendering color.

Flags: Read / Write


The “stipple” property

  “stipple”                  guint

rendering line stipple pattern.

Flags: Read / Write

Allowed values: <= 65535

Default value: 65535


The “width” property

  “width”                    gfloat

rendering line width.

Flags: Read / Write

Allowed values: [0,10]

Default value: 1

See Also

VisuGlExtAxes, VisuGlExtScale or VisuGlExtBox