-// sg_binobj.hxx -- routines to read and write low level flightgear 3d objects
-//
+/**
+ * \file sg_binobj.hxx
+ * Routines to read and write the low level (binary) simgear 3d object format.
+ */
+
// Written by Curtis Olson, started January 2000.
//
// Copyright (C) 2000 Curtis L. Olson - curt@flightgear.org
// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
//
// $Id$
-//
#ifndef _SG_BINOBJ_HXX
#define _SG_BINOBJ_HXX
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
-
#include <plib/sg.h>
#include <simgear/compiler.h>
+/** STL Structure used to store object information */
typedef vector < int_list > group_list;
typedef group_list::iterator group_list_iterator;
typedef group_list::const_iterator const_group_list_iterator;
+/** Magic Number for our file format */
#define SG_FILE_MAGIC_NUMBER ( ('S'<<24) + ('G'<<16) + SG_BINOBJ_VERSION )
+/**
+ * A class to manipulate the simgear 3d object format.
+ * This class provides functionality to both read and write the binary format.
+ *
+ * Here is a really quick overview of the file syntax:
+ *
+ * - scenery-file: magic, nobjects, object+
+ *
+ * - magic: "TG" + version
+ *
+ * - object: obj_typecode, nproperties, nelements, property+, element+
+ *
+ * - element: nbytes, BYTE+
+ *
+ * - property: prop_typecode, nbytes, BYTE+
+ *
+ * - obj_typecode: bounding sphere | vertices | normals | texcoords |
+ * points | triangles | fans | strips
+ *
+ * - prop_typecode: material_name | ???
+ *
+ * - nelements: SHORT (Gives us 65536 which ought to be enough, right?)
+ *
+ * - nproperties: SHORT
+ *
+ * - *_typecode: CHAR
+ *
+ * - nbytes: INTEGER (If we used short here that would mean 65536 bytes = 16384
+ * floats = 5461 vertices which is not enough for future
+ * growth)
+ *
+ * - vertex: FLOAT, FLOAT, FLOAT
+*/
class SGBinObject {
+ unsigned short version;
+
Point3D gbs_center;
float gbs_radius;
point_list wgs84_nodes;
point_list normals;
point_list texcoords;
+ group_list pts_v;
+ string_list pt_materials;
group_list tris_v;
group_list tris_tc;
string_list tri_materials;
public:
+ inline unsigned short get_version() const { return version; }
+
inline Point3D get_gbs_center() const { return gbs_center; }
inline void set_gbs_center( Point3D p ) { gbs_center = p; }
inline point_list get_texcoords() const { return texcoords; }
inline void set_texcoords( point_list t ) { texcoords = t; }
+ inline group_list get_pts_v() const { return pts_v; }
+ inline void set_pts_v( group_list g ) { pts_v = g; }
+ inline string_list get_pt_materials() const { return pt_materials; }
+ inline void set_pt_materials( string_list s ) { pt_materials = s; }
+
inline group_list get_tris_v() const { return tris_v; }
inline void set_tris_v( group_list g ) { tris_v = g; }
inline group_list get_tris_tc() const { return tris_tc; }
inline void set_fans_tc( group_list g ) { fans_tc = g; }
inline string_list get_fan_materials() const { return fan_materials; }
inline void set_fan_materials( string_list s ) { fan_materials = s; }
-};
-
-/*
- scenery-file: magic, nobjects, object+
- magic: "TG" + version
- object: obj_typecode, nproperties, nelements, property+, element+
- element: nbytes, BYTE+
- property: prop_typecode, nbytes, BYTE+
- obj_typecode: bounding sphere | vertices | normals | texcoords | triangles |
- fans | strips
- prop_typecode: material_name | ???
- nelements: SHORT (Gives us 65536 which ought to be enough, right?)
- nproperties: SHORT
- *_typecode: CHAR
- nbytes: INTEGER (If we used short here that would mean 65536 bytes = 16384
- floats = 5461 vertices which is not enough for future
- growth)
- vertex: FLOAT, FLOAT, FLOAT
-*/
+ /**
+ * Read a binary file object and populate the provided structures.
+ * @param file input file name
+ * @return result of read
+ */
+ bool read_bin( const string& file );
+
+ /**
+ * Write out the structures to a binary file. We assume that the
+ * groups come to us sorted by material property. If not, things
+ * don't break, but the result won't be as optimal.
+ * @param base name of output path
+ * @param name name of output file
+ * @param b bucket for object location
+ * @return result of write
+ */
+ bool write_bin( const string& base, const string& name, const SGBucket& b );
+
+ /**
+ * Write out the structures to an ASCII file. We assume that the
+ * groups come to us sorted by material property. If not, things
+ * don't break, but the result won't be as optimal.
+ * @param base name of output path
+ * @param name name of output file
+ * @param b bucket for object location
+ * @return result of write
+ */
+ bool write_ascii( const string& base, const string& name,
+ const SGBucket& b );
+};
-// calculate the bounding sphere. Center is the center of the
-// tile and zero elevation
+/**
+ * \relates SGBinObject
+ * Calculate the bounding sphere of a set of nodes.
+ * Center is the center of the tile and zero elevation.
+ * @param center center of our bounding radius
+ * @param wgs84_nodes list of points in wgs84 coordinates
+ * @return radius
+ */
double sgCalcBoundingRadius( Point3D center, point_list& wgs84_nodes );
-// read a binary file object and populate the provided structures.
-bool sgReadBinObj( const string& file, SGBinObject* obj );
-
-// write out the structures to a binary file. We assume that the
-// groups come to us sorted by material property. If not, things
-// don't break, but the result won't be as optimal.
-bool sgWriteBinObj( const string& base, const string& name, const SGBucket& b,
- const SGBinObject* obj );
-
-// write out the structures to an ASCII file. We assume that the
-// groups come to us sorted by material property. If not, things
-// don't break, but the result won't be as optimal.
-bool sgWriteAsciiObj( const string& base, const string& name, const SGBucket& b,
- SGBinObject* obj );
-
-
#endif // _SG_BINOBJ_HXX
projects / simgear.git / blobdiff