## box

box —

## Synopsis

    void        boxDraw                         (VisuData *data);
    float       boxGet_blueValue                ();
    float       boxGet_greenValue               ();
    int         boxGet_isOn                     ();
    float       boxGet_lineWidth                ();
    float       boxGet_redValue                 ();
    int         boxSet_RGBValues                (float rgb[3],
                                                 int mask);
    int         boxSet_isOn                     (int value);
    int         boxSet_lineWidth                (float width);

    OpenGLExtension* initExtensionBox           ();

## Description

## Details

### boxDraw ()

    void        boxDraw                         (VisuData *data);

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

`data` : | a VisuData object.

### boxGet_blueValue ()

    float       boxGet_blueValue                ();

Returns : | the blue value of the current box line color.

### boxGet_greenValue ()

    float       boxGet_greenValue               ();

Returns : | the green value of the current box line color.

### boxGet_isOn ()

    int         boxGet_isOn                     ();

Returns : | 1 if a box is drawn, 0 otherwise.

### boxGet_lineWidth ()

    float       boxGet_lineWidth                ();

Returns : | the value of current box line width.

### boxGet_redValue ()

    float       boxGet_redValue                 ();

Returns : | the red value of the current box line color.

### boxSet_RGBValues ()

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

Method used to change the value of the parameter box_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 `boxDraw()` should be called and then 'OpenGLAskForReDraw' signal be emitted.

### boxSet_isOn ()

    int         boxSet_isOn                     (int value);

Method used to change the value of the parameter box_is_on.

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

### boxSet_lineWidth ()

    int         boxSet_lineWidth                (float width);

Method used to change the value of the parameter box_line_width.

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

### initExtensionBox ()

    OpenGLExtension* initExtensionBox           ();

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.