Skip to content

Commit b3edd70

Browse files
committed
Update readme.
1 parent e3f9e86 commit b3edd70

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This extension allows to display graphical representation of C++ and C# variable
55

66
![Graphical Debugging](images/graphical_debugging.png)
77

8-
It supports Boost.Geometry and Boost.Polygon models, Boost.Variant, STL/Boost containers of values and points as well as C-style arrays, C# arrays and List. The extension has the following components:
8+
It supports Boost.Geometry and Boost.Polygon models, Boost.Variant, STL/Boost containers of values and points, C-style arrays, C# arrays, List and LinkedList as well as user-defined geometry types. The extension has the following components:
99

1010
* **Debugger visualizers** for Boost.Array, Boost.CircularBuffer, Boost.Container, Boost.Geometry, Boost.MPL, Boost.Polygon, Boost.Tuple and Boost.Variant
1111
* **Geometry Watch** tool window displaying geometries in a common coordinate system, e.g. Boost.Geometry, Boost.Polygon polygons, etc.
@@ -65,23 +65,24 @@ Watch window displaying graphical representation of variables in a single image.
6565

6666
Supported:
6767

68-
* Containers of points
68+
* Containers of points and other geometries
6969
* C-style array
7070
* Pointer to elements with size specifier e.g.: `ptr,5`
7171
* Sequence of containers of point coordinates e.g.: `vec_x;vec_y`
7272
* STL: array, vector, deque, list, set
7373
* Boost.Array: array
7474
* Boost.CircularBuffer: circular_buffer
7575
* Boost.Container: vector, static_vector
76-
* C#: array, List
76+
* C#: array, List, LinkedList
77+
* user-defined containers (see below)
7778
* 2D cartesian geometries
7879
* Boost.Geometry: point, point_xy, box, segment, referring_segment, polygon, multi_point, multi_linestring, multi_polygon, nsphere
7980
* Boost.Polygon: point_data, segment_data, rectangle_data, polygon_data, polygon_with_holes_data
8081
* STL: pair
81-
* user-defined point type
82+
* user-defined geometry types (see below)
8283
* Non-cartesian geometries (spherical_equatorial and geographic)
8384
* Boost.Geometry: point, box, segment, referring_segment, polygon, multi_point, multi_linestring, multi_polygon, nsphere
84-
* Containers of geometries
85+
* Spatial indexes
8586
* Boost.Geometry: rtree (no direct memory access for now, so it may take long time to load)
8687
* Complex numbers
8788
* STL: complex
@@ -110,23 +111,24 @@ Watch window displaying graphical representations of variables in a list. Each v
110111

111112
Supported:
112113

113-
* Containers of values convertible to double and containers of points
114+
* Containers of values convertible to double, points and other geometries
114115
* C-style array
115116
* Pointer to elements with size specifier e.g.: `ptr,5`
116117
* Sequence of containers of point coordinates e.g.: `vec_x;vec_y`
117118
* STL: array, vector, deque, list, set
118119
* Boost.Array: array
119120
* Boost.CircularBuffer: circular_buffer
120121
* Boost.Container: vector, static_vector
121-
* C#: array, List
122+
* C#: array, List, LinkedList
123+
* user-defined containers (see below)
122124
* 2D cartesian geometries
123125
* Boost.Geometry: point, point_xy, box, segment, referring_segment, polygon, multi_point, multi_linestring, multi_polygon, nsphere
124126
* Boost.Polygon: point_data, segment_data, rectangle_data, polygon_data, polygon_with_holes_data
125127
* STL: pair
126-
* user-defined point type
128+
* user-defined geometry types (see below)
127129
* Non-cartesian geometries (spherical_equatorial and geographic)
128130
* Boost.Geometry: point, box, segment, referring_segment, polygon, multi_point, multi_linestring, multi_polygon, nsphere
129-
* Containers of geometries
131+
* Spatial indexes
130132
* Boost.Geometry: rtree (no direct memory access for now, so it may take long time to load)
131133
* Complex numbers
132134
* STL: complex
@@ -164,14 +166,15 @@ Supported containers of values convertible to double and containers of points:
164166
* Boost.Array: array
165167
* Boost.CircularBuffer: circular_buffer
166168
* Boost.Container: vector, static_vector
167-
* C#: array, List
169+
* C#: array, List, LinkedList
170+
* user-defined containers (see below)
168171

169172
where points can be of any supported point type (coordinate system is ignored):
170173

171174
* STL: complex, pair
172175
* Boost.Geometry: point, point_xy
173176
* Boost.Polygon: point_data
174-
* user-defined point type
177+
* user-defined point type (see below)
175178

176179
![Plot Watch](images/plot_watch.png)
177180

@@ -193,6 +196,11 @@ The extension offers support for the following user-defined geometries for both
193196
* Polygon (polygon with holes)
194197
* MultiPolygon
195198

199+
as well as user defined containers for C++ and C# based on:
200+
201+
* Array
202+
* LinkedList (C++ only for now)
203+
196204
They can be defined in XML file similar to *.natvis file. Path to this file can be set in options under **Tools**->**Options**->**Graphical Debugging**->**General**. An example XML file defining C++ types `MyPoint`, `MyRing` and `MyPolygon` in global namespace might look like this:
197205

198206
```
@@ -232,9 +240,9 @@ They can be defined in XML file similar to *.natvis file. Path to this file can
232240
Current limitations:
233241

234242
* only one entry per type
235-
* based on identifier, no template specializations
243+
* based on identifier, no separate entries for template specializations
236244
* no support for user-defined coordinate system, cartesian is used by default
237-
* non-contigeous containers can be used only if this extension natively supports them
245+
* in C# elements stored in containers has to be ValueTypes
238246

239247
See more [examples at GitHub](https://github.com/awulkiew/graphical-debugging/tree/master/examples).
240248

0 commit comments

Comments
 (0)