gtk_curveWidget

gtk_curveWidget — A specialised curve widget to draw distance distribution for pairs.

Functions

Properties

VisuElement * filter Read / Write
gfloat integral-in-range Read
gchar * label Read
gfloat maximum Read / Write
gfloat maximum-highlight Read / Write
gfloat mean-in-range Read
gfloat minimum Read / Write
gfloat minimum-highlight Read / Write
gfloat zoom Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkDrawingArea
                ╰── VisuUiCurveFrame

Implemented Interfaces

VisuUiCurveFrame implements AtkImplementorIface and GtkBuildable.

Description

This is a psecialised widget to display g(r) information.

Functions

visu_ui_curve_frame_new ()

GtkWidget *
visu_ui_curve_frame_new (float distMin,
                         float distMax);

It creates a graph that can display distances distribution for VisuElement pairing. The display span is given by distMin and distMax .

Parameters

distMin

a float.

 

distMax

a float (bigger than distMin ).

 

Returns

a newly craeted VisuUiCurveFrame widget.

Since: 3.6


visu_ui_curve_frame_setModel ()

gboolean
visu_ui_curve_frame_setModel (VisuUiCurveFrame *curve,
                              VisuPairSet *model);

Bind the VisuPairLink of model to curve .

Parameters

curve

a VisuUiCurveFrame object.

 

model

a VisuPairSet object.

 

Returns

TRUE if the value actually changed.

Since: 3.8


visu_ui_curve_frame_setSpan ()

gboolean
visu_ui_curve_frame_setSpan (VisuUiCurveFrame *curve,
                             float span[2]);

Changes the distance range that is displayed on the curve.

Parameters

curve

a VisuUiCurveFrame widget.

 

span

two floats.

 

Returns

TRUE if the distance displayed is actually changed.

Since: 3.6


visu_ui_curve_frame_getSpan ()

void
visu_ui_curve_frame_getSpan (VisuUiCurveFrame *curve,
                             float span[2]);

Retrieves the distances inside which the distribution is displayed.

Parameters

curve

a VisuUiCurveFrame widget.

 

span

a location for two floats.

 

Since: 3.6


visu_ui_curve_frame_setZoomFactor ()

gboolean
visu_ui_curve_frame_setZoomFactor (VisuUiCurveFrame *curve,
                                   float zoom);

Adjusts the zoom factor.

Parameters

curve

a VisuUiCurveFrame widget.

 

zoom

the zoom factor.

 

Returns

TRUE if value is actually changed.

Since: 3.8


visu_ui_curve_frame_setStyle ()

gboolean
visu_ui_curve_frame_setStyle (VisuUiCurveFrame *curve,
                              VisuUiCurveFrameStyle style);

Modify the rendering style of the graph.

Parameters

curve

a VisuUiCurveFrame object.

 

style

a style id.

 

Returns

TRUE if the style is actually changed.

Since: 3.5


visu_ui_curve_frame_setFilter ()

gboolean
visu_ui_curve_frame_setFilter (VisuUiCurveFrame *curve,
                               VisuElement *filter);

Modify the filter used to draw all or single VisuElement distribution.

Parameters

curve

a VisuUiCurveFrame widget.

 

filter

a string.

 

Returns

TRUE if filter is actually changed.

Since: 3.6


visu_ui_curve_frame_setHighlightRange ()

gboolean
visu_ui_curve_frame_setHighlightRange (VisuUiCurveFrame *curve,
                                       float range[2]);

Modify the distance span that is used for highlight rendering and calculation, see visu_ui_curve_frame_getMeanInRange().

Parameters

curve

a VisuUiCurveFrame widget.

 

range

two floats.

 

Returns

TRUE if range is actually changed.

Since: 3.6


visu_ui_curve_frame_getHighlightRange ()

gboolean
visu_ui_curve_frame_getHighlightRange (VisuUiCurveFrame *curve,
                                       float range[2]);

Retrieves the distance span that is used for highlight rendering and calculation, see visu_ui_curve_frame_setHighlightRange().

Parameters

curve

a VisuUiCurveFrame widget.

 

range

a location for two floats.

 

Returns

TRUE if range has been set already.

Since: 3.6

Types and Values

enum VisuUiCurveFrameStyle

Possible styles for the curve rendering, see visu_ui_curve_frame_setStyle().

Members

CURVE_LINEAR

the curve is drawn with lines ;

 

CURVE_BAR

the curve is drawn with bars ;

 

CURVE_GAUSS

the curve is convoluted with gaussians (not implemented yet).

 

VisuUiCurveFrame

typedef struct _VisuUiCurveFrame VisuUiCurveFrame;

An opaque structure defining a VisuUiCurveFrame widget.

Since: 3.6


VisuUiCurveFrameClass

typedef struct _VisuUiCurveFrameClass VisuUiCurveFrameClass;

An opaque structure defining the class of a VisuUiCurveFrame widget.

Since: 3.6

Property Details

The “filter” property

  “filter”                   VisuElement *

filter by element.

Flags: Read / Write


The “integral-in-range” property

  “integral-in-range”        gfloat

integral value in highlight range.

Flags: Read

Allowed values: >= 0

Default value: 0


The “label” property

  “label”                    gchar *

label describing the filter.

Flags: Read

Default value: ""


The “maximum” property

  “maximum”                  gfloat

maximum distance.

Flags: Read / Write

Allowed values: >= 0

Default value: 10


The “maximum-highlight” property

  “maximum-highlight”        gfloat

maximum highlight distance.

Flags: Read / Write

Allowed values: >= 0

Default value: 1


The “mean-in-range” property

  “mean-in-range”            gfloat

mean value in highlight range.

Flags: Read

Allowed values: >= 0

Default value: 0


The “minimum” property

  “minimum”                  gfloat

minimum distance.

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “minimum-highlight” property

  “minimum-highlight”        gfloat

minimum highlight distance.

Flags: Read / Write

Allowed values: >= 0

Default value: 1


The “zoom” property

  “zoom”                     gfloat

zoom factor.

Flags: Read / Write

Allowed values: >= 1

Default value: 5