X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fmisc%2Ftexcoord.hxx;h=a5c13f707d33e35fe88ffa1a51a742859ca8539f;hb=5bab565cfe4c30d6cf08ecaba50af74d5e4f0c98;hp=50d9945a920a76149edee978f1d6e4871d9778d7;hpb=2ed07850c616705695f2add269d187f981f8d09d;p=simgear.git

diff --git a/simgear/misc/texcoord.hxx b/simgear/misc/texcoord.hxx
index 50d9945a..a5c13f70 100644
--- a/simgear/misc/texcoord.hxx
+++ b/simgear/misc/texcoord.hxx
@@ -1,22 +1,26 @@
-// texcoord.hxx -- routine(s) to handle texture coordinate generation
-//
+/**
+ * \file texcoord.hxx
+ * Routine to handle texture coordinate generation.
+ */
+
 // Written by Curtis Olson, started March 1999.
 //
 // Copyright (C) 1999  Curtis L. Olson  - curt@flightgear.org
 //
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License as
-// published by the Free Software Foundation; either version 2 of the
-// License, or (at your option) any later version.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
 //
-// This program is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-// General Public License for more details.
+// Library General Public License for more details.
 //
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// You should have received a copy of the GNU Library General Public
+// License along with this library; if not, write to the
+// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+// Boston, MA  02111-1307, USA.
 //
 // $Id$
 
@@ -31,12 +35,19 @@
 
 
 #include <simgear/bucket/newbucket.hxx>
-#include <simgear/math/fg_types.hxx>
-
-
-// traverse the specified fan/strip/list of vertices and attempt to
-// calculate "none stretching" texture coordinates
-point_list calc_tex_coords( const FGBucket& b, const point_list& geod_nodes,
+#include <simgear/math/sg_types.hxx>
+
+
+/**
+ * Traverse the specified fan/strip/list of vertices and attempt to
+ * calculate "none stretching" texture coordinates.
+ * @param b the bucket containing the structure
+ * @param geod_nodes vertices in geodetic coordinates
+ * @param fan integer list of indices pointing into the vertex list
+ * @param scale (default = 1.0) scaling factor
+ * @return list of texture coordinates
+ */
+point_list calc_tex_coords( const SGBucket& b, const point_list& geod_nodes,
 			    const int_list& fan, double scale = 1.0 );