Browse Source

grutil: Change docstring for MeshDrawer link_segment method

In short, this adds notes regarding the manner in which the method makes use of the "frame" and "color" parameters.

Fixes #1560
Closes #1569
Ian Eborn (Thaumaturge) 2 years ago
parent
commit
1c4a91858b
1 changed files with 5 additions and 0 deletions
  1. 5 0
      panda/src/grutil/meshDrawer.cxx

+ 5 - 0
panda/src/grutil/meshDrawer.cxx

@@ -416,6 +416,11 @@ void MeshDrawer::geometry(NodePath draw_node) {
 /**
  * Stars or continues linked segment.  Control position, frame, thickness and
  * color with parameters.  Frame contains u,v,u-size,v-size quadruple.
+ * Note that for the first two calls to this method, the "frame" parameter is
+ * ignored; it first takes effect as of the third call.
+ * Similarly, note that in the second call to this method, the "color" parameter
+ * is ignored; it only has effect in the first call and calls from the third
+ * onwards.
  */
 void MeshDrawer::
 link_segment(const LVector3 &pos, const LVector4 &frame,