## axes

axes —

## Synopsis

    void        axesDraw                        (VisuData *dataObj);
    float       axesGet_LineWidth               ();
    int         axesGet_areOn                   ();
    float       axesGet_blueValue               ();
    float       axesGet_greenValue              ();
    float       axesGet_redValue                ();
    int         axesSet_RGBValues               (float rgb[3],
                                                 int mask);
    int         axesSet_areOn                   (int value);
    int         axesSet_lineWidth               (float width);

    OpenGLExtension* initExtensionAxes          ();

## Description

## Details

### axesDraw ()

    void        axesDraw                        (VisuData *dataObj);

This method create a compile list that draw a box for the given `data`.

`dataObj` : | the VisuData object to build axes for.

### axesGet_LineWidth ()

    float       axesGet_LineWidth               ();

Returns : | the value of current axes width.

### axesGet_areOn ()

    int         axesGet_areOn                   ();

Returns : | 1 if axes are drawn, 0 otherwise.

### axesGet_blueValue ()

    float       axesGet_blueValue               ();

Returns : | the blue value of the current background color.

### axesGet_greenValue ()

    float       axesGet_greenValue              ();

Returns : | the green value of the current axes color.

### axesGet_redValue ()

    float       axesGet_redValue                ();

Returns : | the red value of the current scale color.

### axesSet_RGBValues ()

    int         axesSet_RGBValues               (float rgb[3],
                                                 int mask);

Method used to change the value of the parameter axes_color.

`rgb` : | a three 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.
`mask` : | use MASK_RGB_R, MASK_RGB_G, MASK_RGB_B, MASK_RGB_ALL or a combinaison to indicate what values in the rgb array must be taken into account.
Returns : | 1 if `axesDraw()` should be called and then 'OpenGLAskForReDraw' signal be emitted.

### axesSet_areOn ()

    int         axesSet_areOn                   (int value);

Method used to change the value of the parameter axes_are_on.

`value` : | 1 if axes must be drawn, 0 otherwise.
Returns : | 1 if `axesDraw()` should be called. In all cases, 'OpenGLAskForReDraw' signal should then be emitted.

### axesSet_lineWidth ()

    int         axesSet_lineWidth               (float width);

Method used to change the value of the parameter axes_line_width.

`width` : | value of the desired axe width.
Returns : | 1 if `axesDraw()` should be called and then 'OpenGLAskForReDraw' signal be emitted.

### initExtensionAxes ()

    OpenGLExtension* initExtensionAxes          ();

It initialises all variables of the OpenGL extension. It creates all resources and parameters introduced by this extension. This method should be added in the listInitExtensionFunc to be called automatically by the `initOpenGLExtensions()` at V_Sim startup.

Returns : | a pointer to the OpenGLExtension it created or NULL otherwise.