Browse Source

ogsflib: doxygen update
nvizlib: doxygen page added (just template)


git-svn-id: https://svn.osgeo.org/grass/grass/trunk@32037 15284696-431f-4ddb-bdfa-cd5b030d7da7

Martin Landa 17 years ago
parent
commit
72c6401688
3 changed files with 19 additions and 9 deletions
  1. 1 1
      lib/grasslib.dox
  2. 8 0
      lib/nviz/nvizlib.dox
  3. 10 8
      lib/ogsf/GS2.c

+ 1 - 1
lib/grasslib.dox

@@ -95,7 +95,7 @@ from GRASS 5 Programmer's manual) or are simply undocumented.</I>
 <li>symbol:	Drawing symbols for %point %vector data library - \ref symbol
 <li>vask:	Cursor management library - \ref vask
 <li>%vector:	\ref Vector_Library (GRASS Vector and Direct Graph Library)
-<li>nviz:       Nviz library (used by wxGUI Nviz extension and CLI-based Nviz module)
+<li>nviz:       \ref nvizlib (used by wxGUI Nviz extension and CLI-based Nviz module)
 </ul>
 <!--<li>image3:	extra imagery library (mainly still unused) - \ref image3lib-->
 <!--<li>D:		display library - \ref d_displaylib-->

+ 8 - 0
lib/nviz/nvizlib.dox

@@ -0,0 +1,8 @@
+/*! \page nvizlib GRASS Nviz Library
+
+\section nvizintro Introduction to Nviz Library
+
+This library is build on \ref ogsflib and serves as the interface for
+wxGUI Nviz extension and CLI-based Nviz module.
+
+*/

+ 10 - 8
lib/ogsf/GS2.c

@@ -2382,17 +2382,15 @@ void GS_get_zrange_nz(float *min, float *max)
 }
 
 /*!
-  \brief Set trans ?
+  \brief Set translation (surface position)
 
   \param id surface id
-  \param xtrans,ytrans,ztrans real trans coordinates
+  \param xtrans,ytrans,ztrans translation values
 */
 void GS_set_trans(int id, float xtrans, float ytrans, float ztrans)
 {
     geosurf *gs;
 
-    G_debug(3, "GS_set_trans");
-
     gs = gs_get_surf(id);
 
     if (gs) {
@@ -2401,21 +2399,22 @@ void GS_set_trans(int id, float xtrans, float ytrans, float ztrans)
 	gs->z_trans = ztrans;
     }
 
+    G_debug(3, "GS_set_trans(): id=%d, x=%f, y=%f, z=%f",
+	    id, xtrans, ytrans, ztrans);
+
     return;
 }
 
 /*!
-  \brief Get trans ?
+  \brief Get translation values (surface position)
 
   \param id surface id
-  \param[out] xtrans,ytrans,ztrans real trans coordinates
+  \param[out] xtrans,ytrans,ztrans trans values
 */
 void GS_get_trans(int id, float *xtrans, float *ytrans, float *ztrans)
 {
     geosurf *gs;
 
-    G_debug(3, "GS_get_trans");
-
     gs = gs_get_surf(id);
 
     if (gs) {
@@ -2424,6 +2423,9 @@ void GS_get_trans(int id, float *xtrans, float *ytrans, float *ztrans)
 	*ztrans = gs->z_trans;
     }
 
+    G_debug(3, "GS_get_trans: id=%d, x=%f, y=%f, z=%f",
+	    id, *xtrans, *ytrans, *ztrans);
+
     return;
 }