|
1 | | -# VirtualPLantLab v0.0.2 release notes |
| 1 | +# VirtualPLantLab v0.0.7 release notes |
2 | 2 |
|
3 | | -There is no official release for VirtualPlantLab 0.0.1, so the changes below are relative to |
4 | | -the (unregistered) VPL.jl. |
| 3 | +Changes in this version: |
5 | 4 |
|
6 | | -## Changes to API |
| 5 | +- A new `Mesh` object is defined that contains any number of user defined properties per |
| 6 | +triangle. To access `colors` or `materials` one should do `properties(mesh)[:colors]` or |
| 7 | +`properties(mesh)[:materials]` respectively. Note that the assignmet of colors and materials |
| 8 | +through turtle constructors maintains the same API. |
7 | 9 |
|
8 | | -- All exported functions that are not associated to a data type use `snake_case` style, |
9 | | -unless one of the words has a single letter. For example, `loadmesh` becomes `load_mesh` but |
10 | | -`nvertices` remains the same in the API. Similarly, `isRoot` becomes `is_root`. Most of |
11 | | -these changes affect the graph-related and rendering API. Functions associated to datatypes |
12 | | -(i.e., constructors) use `CamelCase` but that was already the case (e.g., `SolidCube!` or |
13 | | -`Scene`) so no changes there!. |
| 10 | +- No `Scene` object exists anymore, a mesh contains all the information needed. The `Scene` |
| 11 | +constructors are now replaced by `Mesh` constructors (i.e., replace `Scene()` with `Mesh()`). |
14 | 12 |
|
15 | | -- The function `feed!` now belongs to PlantGeomTurtle, so to define methods for `feed!` you |
16 | | -should now use `PlantGeomTurtle.feed!` instead of `VPL.Geom.feed!`. |
| 13 | +- The function `add!` has a sligthly different API, check the documentation and examples. |
17 | 14 |
|
18 | | -- The functions `render` and `draw` (and their mutating `!` versions) no longer have a `backend` |
19 | | -argument to set the graphics backend. Instead, the user should import `GLMakie` (for native |
20 | | -backend), `WGLMakie` (for web backend) or `CairoMakie` (for Cairo backend) before any call |
21 | | -to `render` or `draw`. Note that these packages are not installed when installing |
22 | | -VirtualPlantLab.jl, so the user may need to install them. Check the new version of the |
23 | | -tutorials for more information. |
| 15 | +- One can add properties individually to a mesh using the `add_property!` function. This is |
| 16 | + required when meshes are constructed first and then added to a turtle or existing meshes. |
| 17 | + Check the API documentation for details of this function. |
| 18 | + |
| 19 | +- Calls to `geoms()` should also be replaced with `Mesh()` |
| 20 | + |
| 21 | +- When merging multiple meshes you need to ensure that they all have the same properties. |
0 commit comments