Skip to content

Commit b49de37

Browse files
committed
updated README
Signed-off-by: soblin <hilo.soblin@gmail.com>
1 parent 85ba09b commit b49de37

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ descibed in [minimal example](#minimal-example).
5151

5252
## Syntax
5353

54-
The user will need to capsulate *arguments* in `Args(arg1, arg2, ...) == pybind11:tuple` and *keyword arguments* in `Kwargs("k1"_a = v1, "k2"_a = v2, ...) == pybind11::dict`. The returned value is either a `pybind11::object` or a corresponding wrapper class. Please refer to the reference and examples below.
54+
The user will need to capsulate *arguments* in `Args(arg1, arg2, ...) == pybind11:tuple` and *keyword arguments* in `Kwargs("k1"_a = v1, "k2"_a = v2, ...) == pybind11::dict`. The returned value is a wrapper class for pybind. Please refer to the reference and examples below.
5555
- exception: `subplots`, `TBD`s
5656
- conversion: Wrapper class of matplotlibcpp17 like [::container::BarContainer](https://github.com/soblin/matplotlibcpp17/blob/master/include/matplotlibcpp17/container.h) needs to be passed to python interpreter using `unwrap()` method in *args* and *kwargs*.
5757

@@ -180,6 +180,16 @@ From [gallery/images_contours_and_fields/quiver_demo.cpp](https://github.com/sob
180180

181181
![quiver_demo3](./gallery/images/quiver_demo_3.png)
182182

183+
### 3D
184+
185+
To plot 3D graph with `projection = "3d"`, following code is required.
186+
187+
```cpp
188+
#include <matplotlibcpp17/mplot3d.h>
189+
190+
matplotlibcpp17::mplot3d::import();
191+
```
192+
183193
### gif
184194

185195
Currently only `ArtistAnimation` is supported. `FuncAnimation` interface maybe implemented in the future.

include/matplotlibcpp17/cm.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
namespace matplotlibcpp17::cm {
1212

13+
// TODO: more colors
1314
static const char *coolwarm = "coolwarm";
1415
static const char *PuBu_r = "PuBu_r";
1516
static const char *RdYlGn = "RdYlGn";

0 commit comments

Comments
 (0)