Update the code a bit more, add a function to retreive the last error string and...

[simgear.git] / simgear / misc / texcoord.hxx

diff --git a/simgear/misc/texcoord.hxx b/simgear/misc/texcoord.hxx
index 955679df8001e290dc30d29b41e9926681c01019..0600b3c3bc6d4ec56dec41fb867c5796f8ee8007 100644 (file)
--- a/simgear/misc/texcoord.hxx
+++ b/simgear/misc/texcoord.hxx
@@ -1,8 +1,11 @@
-// 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
+// Copyright (C) 1999  Curtis L. Olson  - http://www.flightgear.org/~curt
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -35,9 +38,16 @@
 #include <simgear/math/sg_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,
+/**
+ * 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 sgCalcTexCoords( const SGBucket& b, const point_list& geod_nodes,
                            const int_list& fan, double scale = 1.0 );