1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
# Getting Started
## Install the viewer
the viewer can be installed with:
```bash
conda install -c benensta vibes-bin
```
## Install
Install python api of vibes with:
```bash
# using pip
pip install vibes
# or using conda
conda install -b benensta vibes
```
# Basic usage
## First example
The following example shows how to draw your first figure with vibes:
```python
from vibes import vibes
# initiate the connection with the viewer
vibes.beginDrawing()
# create a new figure
vibes.newFigure("myfig")
# draw a circle at (0,0) with radius 2
vibes.drawCircle(0,0,2)
# end the connection with the viewer
vibes.endDrawing()
```
## Shape
Available shapes are:
+ Arrow
+ AUV
+ Box
+ BoxesUnion
+ Circle
+ Ellipse
+ Line
+ Pie
+ Polygon
+ Ring
+ Vehicle
+ Point
+ Raster (image)
<!--
| drawArrow | drawAUV | drawBox | drawBoxesUnion | drawCircle |
|-------------|----------|-------------|----------------|-------------|
| drawEllipse | drawLine | drawPie | drawPoint | drawPolygon |
| drawRing | drawText | drawVehicle | | |
| | | | | | -->
## Colors
### Basic colors
Color can be set using the **color** keyword with a string like **XXX[YYY]**, where
+ XXX is color of the border (default value is *black*).
+ YYY is the color to fill the shape (default is *transparent*).
Available colors are:
Shortcuts exist for:
+ blue :b
+ red: r
+ yellow: y
+ magenta: m
+ green: g
+ black: k
+ white: w
For instance:
```python
# draw a blue square with a red border
vibes.drawBox(0,1, 0,1, color='red[blue]')
# or
vibes.drawBox(0,1, 0,1, color='r[b]')
```
### Custom colors and transparency
Custom color can be set by passing an RGB string (such as "#112233"), or an RGBA string (such as "#112233ff")
For instance:
```python
vibes.drawBox(0,2, 0,3, color='[#22449977]')
vibes.drawBox(1,5, 2,4, color='[#AAAA2277]')
```
## Figure and view management
### Figures management
+ Create a new figure named *figureName*.
```python
vibes.newFigure('figureName')
```
+ Select *figureName* as the current figure. Drawing operations will then apply to *figureName*.
```python
vibes.selectFigure('figureName')
```
+ Close the figure named *figureName*, or the current figure if no argument is given
```python
vibes.closeFigure('figureName')
```
+ Clears the contents of the figure *figureName*, or the current figure if argument is given
```python
vibes.clearFigure('figureName')
```
+ Save the figure *figureName*, or the current figure if no argument is given as an image.
Available format are: png, jpeg, bmp and svg
```python
vibes.saveImage("myImage.png", figure='figureName')
```
+ Set properties (position,size,viewbox,...) of *figureName*, or of the current figure if argument is given.
```python
# create a dictionnay of promerties
params = { "x": 100, # new x position
"y": 100, # new y positon
"width": 500, # new width
"height": 500, #new height
}
vibes.setFigureProperties(params, figure="myfig")
```
+ Set the size of the figure
```python
vibes.setFigureSize(500,500, figure="myfig")
```
+ Set the position of the figure
```python
vibes.setFigurePos(100,100, figure="myfig")
```
### Axis management
+ Set axes limits to the bounding box of the drawing.
```python
vibes.axisAuto()
```
+ Same as *axisAuto* but with the same ratio on the two axis.
```python
vibes.axisEqual()
```
+ Specify the rectangle to be displayed: Lower-left corner (x_lb, y_lb) and a upper-right corner (x_ub, y_ub).
```python
vibes.axisLimits(x_lb, y_lb, x_ub, y_ub)
```
+ Set axis labels
```python
vibes.axisLabels("xlabel", "ylabel", figure="optional")
```
## Groups
Groups can be created to gather objects which shared common properties (color, ...)
+ Create a new group with the specified *groupName* and parameters.
```python
vibes.newGroup("groupName", params)
vibes.newGroup("groupName", { format:"r[darkblue]"})
```
+ Clear the contents of the group *groupName* in figure *figureName* or the current figure if no argument is given.
```python
vibes.clearGroup("groupName")
```
+ Objects can be added to group by using the keyword *group*
```python
vibes.drawCircle(0,0,3, group="groupName")
```
Example:
```python
vibes.newFigure("myfig")
# Create a new group with specific format.
# Elements of this group are filled in cyan
vibes.newGroup("myGroup", format="r[cyan]")
vibes.drawCircle(0,0,3, group="myGroup")
vibes.drawBox(0,4,-3,3, group="myGroup")
vibes.drawPie( (0,0), (2,4), [30,60], group="myGroup")
```
|
