rubberbox

Scilab Function
Last update : 25/04/2007

rubberbox - Rubberband box for rectangle selection

### Calling Sequence

  `[final_rect,btn]=rubberbox(initial_rect)`
  `[final_rect,btn]=rubberbox()`
  `[final_rect,btn]=rubberbox(edition_mode)`

### Parameters

- `initial_rect` : vector with two or four entries. With four entries it gives the initial rectangle defined by [x_left, y_top, width, height], with two entries width and height are supposed to be 0. coordinates of the upper-left corner of
- `edition_mode` :a boolean, if edition_mode==%t; button press selects the first corner, release selects the opposite corner.if edition_mode==%f, button press or click selects the first corner, a click is requested to select the opposite corner. The default value is edition_mode=%f
- `final_rect` :a rectangle defined by [x_left, y_top, width, height]
- `btn` :an integer, the number of the mouse button clicked

### Description

`rubberbox(initial_rect)` tracks a rubberband box in the current graphic window, following the mouse. When a button is clicked `rubberbox` returns the final rectangles definition in `final_Rect` . If the argument `initial_rect` user has to click to fix the initial corner position.

### Examples

    xsetech(frect=[0,0,100,100])
    [x,y]=xclick();r=rubberbox([x;y;30;10])
    xrect(r)
    r=rubberbox()

### See Also

`xrect` , `xrects` , `xclick` , `xgetmouse` , `dragrect` ,