Conversation
rdb
left a comment
rdb
left a comment
There was a problem hiding this comment.
There appears to be an extra unnecessary navigation subfolder, the structure is now like programming/navigation/navigation/index.rst, was this intended? I don't think we need to reflect the structure of the libraries here, unless you think we are really going to have a lot of pages. Most importantly, I imagine that to start out we will want a page on building navmeshes and one on using navmeshes and querying them, and further pages explaining more advanced usage.
Please note that the purpose of the manual is to explain concepts and usage patterns, primarily. It is not meant to contain lists of methods. That's what the API documentation is for (which can be linked from here, using :class: directives).
Page names should be lowercase, so bam-serialization.rst
Please follow the style guidelines described in the README.md.
|
|
||
| .. code-block:: cpp | ||
|
|
||
| LPoint3 pos = new LPoint3(0, 1, 5); |
There was a problem hiding this comment.
This is incorrect, and should be: LPoint3 pos(0, 1, 5);
| pathLine.draw_to(path[i]); | ||
| } | ||
|
|
||
| GeomNode *lineNode = pathLine.create(); |
There was a problem hiding this comment.
Use PT(LineSegs) because the result of new is a pointer
Use PT(GeomNode) to avoid a crash here
Use under_score naming of variables in C++ code
Preferred form of for loop:
for (size_t i = 0; i < path.size(); ++i) {|
|
||
| .. code-block:: cpp | ||
|
|
||
| NavMeshBuilder builder = new NavMeshBuilder(); |
|
|
||
| builder.set_actor_climb(1.5); | ||
|
|
||
| You can also get the parameters value as: |
There was a problem hiding this comment.
"the parameter's value"
Also, prefer property interface over getters/setters, if we have a property interface
| plnp.set_pos(10, 20, 0); | ||
| render.set_light(plnp); | ||
|
|
||
| DirectionalLight dlight = new DirectionalLight('dlight'); |
There was a problem hiding this comment.
PT(PointLight)
PT(DirectionalLight)
|
Thanks for your great work on this! I'm going to hold off on merging this for now until (1) the navmesh implementation is merged into the master branch and (2) we've created a new branch on the documentation repo for the 1.11 docs. |
3 participants
No description provided.