3 * Routines to read and write the low level (binary) simgear 3d object format.
6 // Written by Curtis Olson, started January 2000.
8 // Copyright (C) 2000 Curtis L. Olson - http://www.flightgear.org/~curt
10 // This program is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU General Public License as published by
12 // the Free Software Foundation; either version 2 of the License, or
13 // (at your option) any later version.
15 // This program is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
20 // You should have received a copy of the GNU General Public License
21 // along with this program; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #ifndef _SG_BINOBJ_HXX
28 #define _SG_BINOBJ_HXX
30 #include <zlib.h> // for gzFile
32 #include <simgear/compiler.h>
33 #include <simgear/constants.h>
34 #include <simgear/math/sg_types.hxx>
35 #include <simgear/math/SGMath.hxx>
40 /** STL Structure used to store object information */
41 typedef std::vector < int_list > group_list;
42 typedef group_list::iterator group_list_iterator;
43 typedef group_list::const_iterator const_group_list_iterator;
50 * A class to manipulate the simgear 3d object format.
51 * This class provides functionality to both read and write the binary format.
53 * Here is a really quick overview of the file syntax:
55 * - scenery-file: magic, nobjects, object+
57 * - magic: "TG" + version
59 * - object: obj_typecode, nproperties, nelements, property+, element+
61 * - element: nbytes, BYTE+
63 * - property: prop_typecode, nbytes, BYTE+
65 * - obj_typecode: bounding sphere | vertices | normals | texcoords |
66 * points | triangles | fans | strips
68 * - prop_typecode: material_name | ???
70 * - nelements: USHORT (Gives us 65536 which ought to be enough, right?)
72 * - nproperties: USHORT
76 * - nbytes: INTEGER (If we used short here that would mean 65536 bytes = 16384
77 * floats = 5461 vertices which is not enough for future
80 * - vertex: FLOAT, FLOAT, FLOAT
84 unsigned short version;
89 std::vector<SGVec3d> wgs84_nodes; // vertex list
90 std::vector<SGVec4f> colors; // color list
91 std::vector<SGVec3f> normals; // normal list
92 std::vector<SGVec2f> texcoords; // texture coordinate list
94 group_list pts_v; // points vertex index
95 group_list pts_n; // points normal index
96 group_list pts_c; // points color index
97 group_list pts_tc; // points texture coordinate index
98 string_list pt_materials; // points materials
100 group_list tris_v; // triangles vertex index
101 group_list tris_n; // triangles normal index
102 group_list tris_c; // triangles color index
103 group_list tris_tc; // triangles texture coordinate index
104 string_list tri_materials; // triangles materials
106 group_list strips_v; // tristrips vertex index
107 group_list strips_n; // tristrips normal index
108 group_list strips_c; // tristrips color index
109 group_list strips_tc; // tristrips texture coordinate index
110 string_list strip_materials;// tristrips materials
112 group_list fans_v; // fans vertex index
113 group_list fans_n; // fans normal index
114 group_list fans_c; // fans color index
115 group_list fans_tc; // fans texture coordinate index
116 string_list fan_materials; // fans materials
118 void read_properties(gzFile fp, int nproperties);
120 void read_object( gzFile fp,
124 group_list& vertices,
127 group_list& texCoords,
128 string_list& materials);
130 void write_header(gzFile fp, int type, int nProps, int nElements);
131 void write_objects(gzFile fp, int type, const group_list& verts,
132 const group_list& normals, const group_list& colors,
133 const group_list& texCoords, const string_list& materials);
135 unsigned int count_objects(const string_list& materials);
138 inline unsigned short get_version() const { return version; }
140 inline const SGVec3d& get_gbs_center() const { return gbs_center; }
141 inline void set_gbs_center( const SGVec3d& p ) { gbs_center = p; }
143 inline float get_gbs_radius() const { return gbs_radius; }
144 inline void set_gbs_radius( float r ) { gbs_radius = r; }
146 inline const std::vector<SGVec3d>& get_wgs84_nodes() const
147 { return wgs84_nodes; }
148 inline void set_wgs84_nodes( const std::vector<SGVec3d>& n )
151 inline const std::vector<SGVec4f>& get_colors() const { return colors; }
152 inline void set_colors( const std::vector<SGVec4f>& c ) { colors = c; }
154 inline const std::vector<SGVec3f>& get_normals() const { return normals; }
155 inline void set_normals( const std::vector<SGVec3f>& n ) { normals = n; }
157 inline const std::vector<SGVec2f>& get_texcoords() const { return texcoords; }
158 inline void set_texcoords( const std::vector<SGVec2f>& t ) { texcoords = t; }
160 inline const group_list& get_pts_v() const { return pts_v; }
161 inline void set_pts_v( const group_list& g ) { pts_v = g; }
162 inline const group_list& get_pts_n() const { return pts_n; }
163 inline void set_pts_n( const group_list& g ) { pts_n = g; }
164 inline const group_list& get_pts_c() const { return pts_c; }
165 inline void set_pts_c( const group_list& g ) { pts_c = g; }
166 inline const group_list& get_pts_tc() const { return pts_tc; }
167 inline void set_pts_tc( const group_list& g ) { pts_tc = g; }
168 inline const string_list& get_pt_materials() const { return pt_materials; }
169 inline void set_pt_materials( const string_list& s ) { pt_materials = s; }
171 inline const group_list& get_tris_v() const { return tris_v; }
172 inline void set_tris_v( const group_list& g ) { tris_v = g; }
173 inline const group_list& get_tris_n() const { return tris_n; }
174 inline void set_tris_n( const group_list& g ) { tris_n = g; }
175 inline const group_list& get_tris_c() const { return tris_c; }
176 inline void set_tris_c( const group_list& g ) { tris_c = g; }
177 inline const group_list& get_tris_tc() const { return tris_tc; }
178 inline void set_tris_tc( const group_list& g ) { tris_tc = g; }
179 inline const string_list& get_tri_materials() const { return tri_materials; }
180 inline void set_tri_materials( const string_list& s ) { tri_materials = s; }
182 inline const group_list& get_strips_v() const { return strips_v; }
183 inline void set_strips_v( const group_list& g ) { strips_v = g; }
184 inline const group_list& get_strips_n() const { return strips_n; }
185 inline void set_strips_n( const group_list& g ) { strips_n = g; }
186 inline const group_list& get_strips_c() const { return strips_c; }
187 inline void set_strips_c( const group_list& g ) { strips_c = g; }
189 inline const group_list& get_strips_tc() const { return strips_tc; }
190 inline void set_strips_tc( const group_list& g ) { strips_tc = g; }
191 inline const string_list& get_strip_materials() const { return strip_materials; }
192 inline void set_strip_materials( const string_list& s ) { strip_materials = s; }
194 inline const group_list& get_fans_v() const { return fans_v; }
195 inline void set_fans_v( const group_list& g ) { fans_v = g; }
196 inline const group_list& get_fans_n() const { return fans_n; }
197 inline void set_fans_n( const group_list& g ) { fans_n = g; }
198 inline const group_list& get_fans_c() const { return fans_c; }
199 inline void set_fans_c( const group_list& g ) { fans_c = g; }
201 inline const group_list& get_fans_tc() const { return fans_tc; }
202 inline void set_fans_tc( const group_list& g ) { fans_tc = g; }
203 inline const string_list& get_fan_materials() const { return fan_materials; }
204 inline void set_fan_materials( const string_list& s ) { fan_materials = s; }
207 * Read a binary file object and populate the provided structures.
208 * @param file input file name
209 * @return result of read
211 bool read_bin( const std::string& file );
214 * Write out the structures to a binary file. We assume that the
215 * groups come to us sorted by material property. If not, things
216 * don't break, but the result won't be as optimal.
217 * @param base name of output path
218 * @param name name of output file
219 * @param b bucket for object location
220 * @return result of write
222 bool write_bin( const std::string& base, const std::string& name, const SGBucket& b );
225 bool write_bin_file(const SGPath& file);
228 * Write out the structures to an ASCII file. We assume that the
229 * groups come to us sorted by material property. If not, things
230 * don't break, but the result won't be as optimal.
231 * @param base name of output path
232 * @param name name of output file
233 * @param b bucket for object location
234 * @return result of write
236 bool write_ascii( const std::string& base, const std::string& name,
240 #endif // _SG_BINOBJ_HXX