Source/System/FileIO/OpenFlight/OSGOFPrimaryRecords.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *                Copyright (C) 2011 by the OpenSG Forum                     *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGOFPRIMARYRECORDS_H_
  40 #define _OSGOFPRIMARYRECORDS_H_
  41
  42 #include "OSGFileIODef.h"
  43 #include "OSGOFRecords.h"
  44
  45 OSG_BEGIN_NAMESPACE
  46
  47 //---------------------------------------------------------------------------
  48 //  Class
  49 //---------------------------------------------------------------------------
  50
  51 /*! \ingroup GrpFileIOOpenFlight
  52     \nohierarchy
  53  */
  54
  55 class OSG_FILEIO_DLLMAPPING OFHeaderRecord : public OFPrimaryRecord
  56 {
  57  protected:
  58     typedef OFPrimaryRecord Inherited;
  59
  60     /*---------------------------------------------------------------------*/
  61
  62              OFHeaderRecord(const OFRecordHeader &oHeader,
  63                                   OFDatabase     &oDB    );
  64     virtual ~OFHeaderRecord(void                         );
  65
  66   public:
  67
  68     static const UInt16 OpCode = 1;
  69
  70     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
  71                                            OFDatabase     &oDB     );
  72
  73     /*---------------------------------------------------------------------*/
  74
  75     virtual bool           read         (std::istream &is    );
  76     virtual NodeTransitPtr convertToNode(void                );
  77     virtual bool           addChild     (OFRecord     *pChild);
  78
  79     /*---------------------------------------------------------------------*/
  80
  81     virtual UInt16 getOpCode(void) const;
  82
  83     /*---------------------------------------------------------------------*/
  84
  85     virtual void dump(UInt32 uiIndent) const;
  86
  87     /*---------------------------------------------------------------------*/
  88 };
  89
  90 /*! \ingroup GrpFileIOOpenFlight
  91  */
  92 typedef RefCountPtr<OFHeaderRecord,
  93                     MemObjRefCountPolicy> OFHeaderRecordRCPtr;
  94
  95
  96 //---------------------------------------------------------------------------
  97 //  Class
  98 //---------------------------------------------------------------------------
  99
 100 /*! \ingroup GrpFileIOOpenFlight
 101     \nohierarchy
 102  */
 103
 104 class OSG_FILEIO_DLLMAPPING OFGroupRecord : public OFPrimaryRecord
 105 {
 106   protected:
 107
 108     /*---------------------------------------------------------------------*/
 109
 110     typedef OFPrimaryRecord Inherited;
 111
 112     /*---------------------------------------------------------------------*/
 113
 114     static OFRecordFactoryBase::RegisterRecord _regHelper;
 115
 116     Char8  szASCIIId[8];    //  4  8  7 char ascii id, 0 terminates
 117
 118     /*---------------------------------------------------------------------*/
 119
 120              OFGroupRecord(const OFRecordHeader &oHeader,
 121                                  OFDatabase     &oDB     );
 122     virtual ~OFGroupRecord(void                          );
 123
 124   public:
 125
 126     /*---------------------------------------------------------------------*/
 127
 128     static const UInt16 OpCode = 2;
 129
 130     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 131                                            OFDatabase     &oDB     );
 132
 133     /*---------------------------------------------------------------------*/
 134
 135     virtual bool           read         (std::istream &is);
 136     virtual NodeTransitPtr convertToNode(void            );
 137
 138     /*---------------------------------------------------------------------*/
 139
 140     virtual UInt16 getOpCode(void) const;
 141
 142     /*---------------------------------------------------------------------*/
 143
 144     virtual void dump(UInt32 uiIndent) const;
 145
 146     NodeTransitPtr convertAncillaryChildren(Node *pNode);
 147 };
 148
 149 //---------------------------------------------------------------------------
 150 //  Class
 151 //---------------------------------------------------------------------------
 152
 153 /*! \ingroup GrpFileIOOpenFlight
 154  */
 155 class OFFaceRecord;
 156 /*! \ingroup GrpFileIOOpenFlight
 157  */
 158 typedef RefCountPtr<OFFaceRecord, MemObjRefCountPolicy> OFFaceRecordRCPtr;
 159
 160 /*! \ingroup GrpFileIOOpenFlight
 161  */
 162 class OFMeshRecord;
 163 /*! \ingroup GrpFileIOOpenFlight
 164  */
 165 typedef RefCountPtr<OFMeshRecord, MemObjRefCountPolicy> OFMeshRecordRCPtr;
 166
 167 /*! \ingroup GrpFileIOOpenFlight
 168     \nohierarchy
 169  */
 170
 171 class OSG_FILEIO_DLLMAPPING OFObjectRecord : public OFPrimaryRecord
 172 {
 173   protected:
 174
 175     /*---------------------------------------------------------------------*/
 176
 177     typedef OFPrimaryRecord Inherited;
 178
 179     typedef std::vector<OFFaceRecordRCPtr> FaceStore;
 180     typedef std::vector<OFMeshRecordRCPtr> MeshStore;
 181
 182     static OFRecordFactoryBase::RegisterRecord _regHelper;
 183
 184     /*---------------------------------------------------------------------*/
 185
 186              OFObjectRecord(const OFRecordHeader &oHeader,
 187                                   OFDatabase     &oDB     );
 188     virtual ~OFObjectRecord(void                          );
 189
 190     Char8  szASCIIId[8];   //  4  8  7 char ASCII ID, 0 terminates
 191     Int32  flags;          // 12  4  flags
 192     Int16  relPriority;    // 16  2  relative priority
 193     UInt16 transparency;   // 18  2  transparency
 194     Int16  specialEffect1; // 20  2  specialEffect ID 1, application defined
 195     Int16  specialEffect2; // 22  2  specialEffect ID 2, application defined
 196     Int16  significance;   // 24  2  significance
 197     Int16  reserved;       // 26  2  reserved
 198
 199     FaceStore _vFaces;
 200     MeshStore _vMeshes;
 201
 202   public:
 203
 204     static const UInt16 OpCode = 4;
 205
 206     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 207                                            OFDatabase     &oDB     );
 208
 209     /*---------------------------------------------------------------------*/
 210
 211     virtual bool           read         (std::istream &is    );
 212     virtual NodeTransitPtr convertToNode(void                );
 213     virtual bool           addChild     (OFRecord     *pChild);
 214
 215     /*---------------------------------------------------------------------*/
 216
 217     virtual UInt16 getOpCode(void) const;
 218
 219     /*---------------------------------------------------------------------*/
 220
 221     virtual void dump(UInt32 uiIndent) const;
 222
 223     /*---------------------------------------------------------------------*/
 224
 225     void groupFaces(std::vector< std::vector<OFFaceRecord *> > &vFaceGroups);
 226
 227     NodeTransitPtr convertFaceGroup(std::vector<OFFaceRecord *> &vFaceGroup);
 228
 229     NodeTransitPtr convertGeometry (void);
 230
 231     NodeTransitPtr convertAncillaryChildren(Node *pNode);
 232 };
 233
 234 //---------------------------------------------------------------------------
 235 //  Forward declarations
 236 //---------------------------------------------------------------------------
 237
 238 /*! \ingroup GrpFileIOOpenFlight
 239  */
 240 class OFMeshPrimitiveRecord;
 241 /*! \ingroup GrpFileIOOpenFlight
 242  */
 243 typedef RefCountPtr<OFMeshPrimitiveRecord,
 244                     MemObjRefCountPolicy  > OFMeshPrimitiveRecordRCPtr;
 245
 246 //---------------------------------------------------------------------------
 247 //  Class
 248 //---------------------------------------------------------------------------
 249
 250 /*! \ingroup GrpFileIOOpenFlight
 251     \nohierarchy
 252  */
 253
 254 class OSG_FILEIO_DLLMAPPING OFLocalVertexPoolRecord : public OFPrimaryRecord
 255 {
 256   protected:
 257     typedef OFPrimaryRecord Inherited;
 258
 259     static OFRecordFactoryBase::RegisterRecord _regHelper;
 260
 261     /*---------------------------------------------------------------------*/
 262
 263     UInt32  uiNumVerts;         //  4 4 Number of vertices - number of vertices in the local vertex pool
 264     UInt32  uiAttribMask;       //  8 4 Attribute mask - Bit mask indicating what kind of vertex infor-
 265                                 //      mation is specified for each vertex in the local vertex pool. Bits
 266                                 //      are ordered from left to right as follows:
 267                                 // Bit #    Description
 268                                 //   0     Has Position - if set, data for each vertex in will include
 269                                 //         x, y, and z coordinates (3 doubles)
 270                                 //   1     Has Color Index - if set, data for each vertex will in-
 271                                 //         clude a color value that specifies a color table index as
 272                                 //         well as an alpha value
 273                                 //   2     Has RGBA Color - if set, data for each vertex will in-
 274                                 //         clude a color value that is a packed RGBA color value
 275                                 //         Note: Bits 1and 2 are mutually exclusive - a vertex can have ei-
 276                                 //         ther color index or RGB color value or neither, but not both.
 277                                 //   3     Has Normal - if set, data for each vertex will include a
 278                                 //         normal (3 floats)
 279                                 //   4     Has Base UV - if set, data for each vertex will include
 280                                 //         uv texture coordinates for the base texture (2 floats)
 281                                 //   5     Has UV Layer 1 - if set, data for each vertex will include
 282                                 //         uv texture coordinates for layer 1 (2 floats)
 283                                 //   6     Has UV Layer 2 - if set, data for each vertex will include
 284                                 //         uv texture coordinates for layer 2 (2 floats)
 285                                 //   7     Has UV Layer 3 - if set, data for each vertex will include
 286                                 //         uv texture coordinates for layer 3 (2 floats)
 287                                 //   8     Has UV Layer 4 - if set, data for each vertex will include
 288                                 //         uv texture coordinates for layer 4 (2 floats)
 289                                 //   9     Has UV Layer 5 - if set, data for each vertex will include
 290                                 //         uv texture coordinates for layer 5 (2 floats)
 291                                 //  10     Has UV Layer 6 - if set, data for each vertex will include
 292                                 //         uv texture coordinates for layer 6 (2 floats)
 293                                 //  11     Has UV Layer 7 - if set, data for each vertex will include
 294                                 //         uv texture coordinates for layer 7 (2 floats)
 295                                 //  12-31  Spare
 296     //      The following fields (if they are present according to uiAttribMask)
 297     //      are repeated uiNumVerts times
 298     // Double       Varies 8*3 CoordinateN - Coordinate of vertex N (x, y, z) - present if At-
 299     //                         tribute mask includes Has Position.
 300     // Unsigned Int Varies 4   colorN - Color for vertex N - present if Attribute mask includes
 301     //                         Has Color Index or Has RGBA Color.
 302     //                         If Has Color Index, lower 3 bytes specify color table index,
 303     //                         upper 1 byte is Alpha.
 304     //                         If Has RGBA Color, 4 bytes specify (a, b, g, r) values.
 305     // Float        Varies 4*3 normalN - Normal for vertex N (i, j, k) - present if Attribute mask
 306     //                         includes Has Normal.
 307     // Float        Varies 4*2 uvBaseN - Texture coordinates (u, v) for base texture layer of
 308     //                         vertex N - present if Attribute mask includes Has Base UV.
 309     // Float        Varies 4*2 uv1N - Texture coordinates (u, v) for layer 1 of vertex N -
 310     //                         present if Attribute mask includes Has UV Layer 1.
 311     // Float        Varies 4*2 uv2N - Texture coordinates (u, v) for layer 2 of vertex N -
 312     //                         present if Attribute mask includes Has UV Layer 2.
 313     // Float        Varies 4*2 uv3N - Texture coordinates (u, v) for layer 3 of vertex N -
 314     //                         present if Attribute mask includes Has UV Layer 3.
 315     // Float        Varies 4*2 uv4N - Texture coordinates (u, v) for layer 4 of vertex N -
 316     //                         present if Attribute mask includes Has UV Layer 4.
 317     // Float        Varies 4*2 uv5N - Texture coordinates (u, v) for layer 5 of vertex N -
 318     //                         present if Attribute mask includes Has UV Layer 5.
 319     // Float        Varies 4*2 uv6N - Texture coordinates (u, v) for layer 6 of vertex N -
 320     //                         present if Attribute mask includes Has UV Layer 6.
 321     // Float        Varies 4*2 uv7N - Texture coordinates (u, v) for layer 7 of vertex N -
 322     //                         present if Attribute mask includes Has UV Layer 7.
 323
 324     GeoPnt3dPropertyUnrecPtr                _pPositions;
 325     GeoColor4ubPropertyUnrecPtr             _pColors;
 326     GeoVec3fPropertyUnrecPtr                _pNormals;
 327     GeoVec2fPropertyUnrecPtr                _texCoords[8];
 328
 329     std::vector<OFMeshPrimitiveRecordRCPtr> _vTriStrips;
 330     std::vector<OFMeshPrimitiveRecordRCPtr> _vTriFans;
 331     std::vector<OFMeshPrimitiveRecordRCPtr> _vQuadStrips;
 332     std::vector<OFMeshPrimitiveRecordRCPtr> _vPolygons;
 333
 334     /*---------------------------------------------------------------------*/
 335
 336              OFLocalVertexPoolRecord(const OFRecordHeader &oHeader,
 337                                            OFDatabase     &oDB    );
 338     virtual ~OFLocalVertexPoolRecord(void                         );
 339
 340   public:
 341     typedef TransitPtr <OFLocalVertexPoolRecord >   ObjTransitPtr;
 342     typedef RefCountPtr<OFLocalVertexPoolRecord,
 343                         MemObjRefCountPolicy    >   ObjRCPtr;
 344
 345     static const UInt16 OpCode = 85;
 346
 347     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 348                                            OFDatabase     &oDB    );
 349
 350     static const UInt32 AMHasPosition;
 351     static const UInt32 AMHasColorIndex;
 352     static const UInt32 AMHasColorValue;
 353     static const UInt32 AMHasNormal;
 354     static const UInt32 AMHasTexCoords[8];
 355
 356     /*---------------------------------------------------------------------*/
 357
 358     virtual bool read        (std::istream &is      );
 359     virtual bool readContinue(std::istream &is,
 360                               UInt16        uiLength);
 361     virtual bool addChild    (OFRecord     *pChild  );
 362
 363     /*---------------------------------------------------------------------*/
 364
 365     virtual UInt16 getOpCode(void) const;
 366
 367     /*---------------------------------------------------------------------*/
 368
 369     virtual void dump(UInt32 uiIndent) const;
 370
 371     /*---------------------------------------------------------------------*/
 372
 373     virtual void convertPrimitives(Geometry *pGeo);
 374
 375     GeoPnt3dProperty    *getPositions(void      ) const;
 376     GeoColor4ubProperty *getColors   (void      ) const;
 377     GeoVec3fProperty    *getNormals  (void      ) const;
 378     GeoVec2fProperty    *getTexCoords(UInt32 idx) const;
 379 };
 380
 381 /*! \ingroup GrpFileIOOpenFlight
 382  */
 383 typedef OFLocalVertexPoolRecord::ObjTransitPtr OFLocalVertexPoolRecordTransitPtr;
 384 /*! \ingroup GrpFileIOOpenFlight
 385  */
 386 typedef OFLocalVertexPoolRecord::ObjRCPtr      OFLocalVertexPoolRecordRCPtr;
 387
 388 //---------------------------------------------------------------------------
 389 //  Class
 390 //---------------------------------------------------------------------------
 391
 392 /*! \ingroup GrpFileIOOpenFlight
 393     \nohierarchy
 394  */
 395
 396 class OSG_FILEIO_DLLMAPPING OFMeshPrimitiveRecord : public OFPrimaryRecord
 397 {
 398   public:
 399     typedef std::vector<UInt32> IndexStore;
 400
 401   protected:
 402     typedef OFPrimaryRecord  Inherited;
 403
 404     static OFRecordFactoryBase::RegisterRecord _regHelper;
 405
 406     /*---------------------------------------------------------------------*/
 407
 408     Int16 uiPrimType;        //  4 2 Primitive Type - specifies how the vertices
 409                              //      of the primitive are interpreted
 410                              //       1 = Triangle Strip
 411                              //       2 = Triangle Fan
 412                              //       3 = Quadrilateral Strip
 413                              //       4 = Indexed Polygon
 414     UInt16 uiIndexSize;      //  6 2 Index Size - specifies the length (in bytes)
 415                              //      of each of the vertex indices that follow -
 416                              //      will be either 1, 2, or 4
 417     UInt32 uiVertexCount;    //  8 4 Vertex Count- number of vertices contained
 418                              //      in this primitive.
 419
 420     IndexStore _vIndices;
 421
 422     /*---------------------------------------------------------------------*/
 423
 424     friend class OFLocalVertexPoolRecord;
 425
 426     /*---------------------------------------------------------------------*/
 427
 428              OFMeshPrimitiveRecord(const OFRecordHeader &oHeader,
 429                                          OFDatabase     &oDB    );
 430     virtual ~OFMeshPrimitiveRecord(void                         );
 431
 432   public:
 433     typedef TransitPtr <OFMeshPrimitiveRecord >   ObjTransitPtr;
 434     typedef RefCountPtr<OFMeshPrimitiveRecord,
 435                         MemObjRefCountPolicy  >   ObjRCPtr;
 436
 437     static const UInt16 OpCode = 86;
 438
 439     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 440                                            OFDatabase     &oDB     );
 441
 442     static const UInt16 PTTriStrip  = 1;
 443     static const UInt16 PTTriFan    = 2;
 444     static const UInt16 PTQuadStrip = 3;
 445     static const UInt16 PTPolygon   = 4;
 446
 447     /*---------------------------------------------------------------------*/
 448
 449     virtual bool read        (std::istream &is      );
 450     virtual bool readContinue(std::istream &is,
 451                               UInt16        uiLength);
 452
 453     /*---------------------------------------------------------------------*/
 454
 455     virtual UInt16 getOpCode(void) const;
 456
 457     /*---------------------------------------------------------------------*/
 458
 459     virtual void dump(UInt32 uiIndent) const;
 460
 461     /*---------------------------------------------------------------------*/
 462
 463           IndexStore &editIndices(void);
 464     const IndexStore &getIndices (void) const;
 465 };
 466
 467 /*! \ingroup GrpFileIOOpenFlight
 468  */
 469 typedef OFMeshPrimitiveRecord::ObjTransitPtr OFMeshPrimitiveRecordTransitPtr;
 470 /*! \ingroup GrpFileIOOpenFlight
 471  */
 472 typedef OFMeshPrimitiveRecord::ObjRCPtr      OFMeshPrimitiveRecordRCPtr;
 473
 474 //---------------------------------------------------------------------------
 475 //  Class
 476 //---------------------------------------------------------------------------
 477
 478 /*! \ingroup GrpFileIOOpenFlight
 479     \nohierarchy
 480  */
 481
 482 class OSG_FILEIO_DLLMAPPING OFMeshRecord : public OFPrimaryRecord
 483 {
 484   protected:
 485     typedef OFPrimaryRecord Inherited;
 486
 487     static OFRecordFactoryBase::RegisterRecord _regHelper;
 488
 489     /*---------------------------------------------------------------------*/
 490
 491     Char8  szASCIIId[8];        //   4 8 7 char ASCII ID; 0 terminates
 492     Int32  iPad1;               //  12 4 Reserved
 493     Int32  iIRColorCode;        //  16 4 IR color code
 494     Int16  iRelPrio;            //  20 2 Relative priority
 495     Int8   iDrawType;           //  22 1 Draw type
 496                                 //        0 = Draw solid with backface culling
 497                                 //            (front side only)
 498                                 //        1 = Draw solid, no backface culling
 499                                 //            (both sides visible)
 500                                 //        2 = Draw wireframe and close
 501                                 //        3 = Draw wireframe
 502                                 //        4 = Surround with wireframe in alternate color
 503                                 //        8 = Omnidirectional light
 504                                 //        9 = Unidirectional light
 505                                 //       10 = Bidirectional light
 506     Int8   iTextureWhite;       //  23 1 Texture white = if TRUE, draw textured face white
 507     UInt16 uiColorNameIdx;      //  24 2 Color name index
 508     UInt16 uiAltColorNameIdx;   //  26 2 Alternate color name index
 509     Int8   iPad2;               //  28 1 Reserved
 510     Int8   iTemplate;           //  29 1 Template (billboard)
 511                                 //        0 = Fixed, no alpha blending
 512                                 //        1 = Fixed, alpha blending
 513                                 //        2 = Axial rotate with alpha blending
 514                                 //        4 = Point rotate with alpha blending
 515     Int16  iDetailTexIdx;       //  30 2 Detail texture pattern index, -1 if none
 516     Int16  iTexIdx;             //  32 2 Texture pattern index, -1 if none
 517     Int16  iMatIdx;             //  34 2 Material index, -1 if none
 518     Int16  iSurfMatCode;        //  36 2 Surface material code (for DFAD)
 519     Int16  iFeatureId;          //  38 2 Feature ID (for DFAD)
 520     Int32  iIRMatCode;          //  40 4 IR material code
 521     UInt16 uiTransparency;      //  44 2 Transparency
 522                                 //            0 = Opaque
 523                                 //        65535 = Totally clear
 524     UInt8  uiLODGenControl;     //  46 1 LOD generation control
 525     UInt8  uiLineStyle;         //  47 1 Line style index
 526     Int32  iFlags;              //  48 4 Flags (bits from left to right)
 527                                 //        0 = Terrain
 528                                 //        1 = No color
 529                                 //        2 = No alternate color
 530                                 //        3 = Packed color
 531                                 //        4 = Terrain culture cutout (footprint)
 532                                 //        5 = Hidden, not drawn
 533                                 //        6 = Roofline
 534                                 //        7-31 = Spare
 535     UInt8  uiLightMode;         //  52 1 Light mode
 536                                 //        0 = Use mesh color, not illuminated (Flat)
 537                                 //        1 = Use vertex colors, not illuminated (Gouraud)
 538                                 //        2 = Use mesh color and vertex normals (Lit)
 539                                 //        3 = Use vertex colors and vertex normals
 540                                 //            (Lit, Gouraud)
 541     Char8  szPad3[7];           //  53 7 Reserved
 542     UInt32 uiPackedPrimCol;     //  60 4 Packed color, primary (a, b, g, r)
 543                                 //       only b, g, r used
 544     UInt32 uiPackedAltCol;      //  64 4 Packed color, alternate (a, b, g, r)
 545                                 //       only b, g, r used
 546     Int16  iTexMapIdx;          //  68 2 Texture mapping index, -1 if none
 547     Int16  iPad4;               //  70 2 Reserved
 548     Int32  uiPrimColIdx;        //  72 4 Primary color index, -1 if none
 549     Int32  uiAltColIdx;         //  76 4 Alternate color index, -1 if none
 550     Int16  iPad5;               //  80 2 Reserved
 551     Int16  iShaderIdx;          //  82 2 Shader index, -1 if none
 552
 553     OFLocalVertexPoolRecordRCPtr _pVertexPool;
 554
 555     /*---------------------------------------------------------------------*/
 556
 557              OFMeshRecord(const OFRecordHeader &oHeader,
 558                                 OFDatabase     &oDB    );
 559     virtual ~OFMeshRecord(void                         );
 560
 561   public:
 562     typedef TransitPtr <OFMeshRecord        >   ObjTransitPtr;
 563     typedef RefCountPtr<OFMeshRecord,
 564                         MemObjRefCountPolicy>   ObjRCPtr;
 565
 566     static const UInt16 OpCode = 84;
 567
 568     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 569                                            OFDatabase     &oDB    );
 570
 571     /*---------------------------------------------------------------------*/
 572
 573     virtual bool           read         (std::istream &is    );
 574     virtual NodeTransitPtr convertToNode(void                );
 575     virtual bool           addChild     (OFRecord     *pChild);
 576
 577     /*---------------------------------------------------------------------*/
 578
 579     virtual UInt16 getOpCode(void) const;
 580
 581     /*---------------------------------------------------------------------*/
 582
 583     virtual void dump(UInt32 uiIndent) const;
 584 };
 585
 586 /*! \ingroup GrpFileIOOpenFlight
 587  */
 588 typedef OFMeshRecord::ObjTransitPtr OFMeshRecordTransitPtr;
 589 /*! \ingroup GrpFileIOOpenFlight
 590  */
 591 typedef OFMeshRecord::ObjRCPtr      OFMeshRecordRCPtr;
 592
 593 //---------------------------------------------------------------------------
 594 //  Class
 595 //---------------------------------------------------------------------------
 596
 597 class OFVertexListRecord;
 598
 599 typedef RefCountPtr<OFVertexListRecord,
 600                     MemObjRefCountPolicy> OFVertexListRecordRCPtr;
 601
 602 /*! \ingroup GrpFileIOOpenFlight
 603     \nohierarchy
 604  */
 605
 606 class OSG_FILEIO_DLLMAPPING OFFaceRecord : public OFPrimaryRecord
 607 {
 608   protected:
 609
 610     /*---------------------------------------------------------------------*/
 611
 612     typedef OFPrimaryRecord Inherited;
 613
 614     /*---------------------------------------------------------------------*/
 615
 616     static OFRecordFactoryBase::RegisterRecord _regHelper;
 617
 618     /*---------------------------------------------------------------------*/
 619
 620     Char8  szASCIIId[8];      // 4  8 7 char ASCII ID; 0 terminates
 621     Int32  iIRColorCode;      // 12 4 IR color code
 622     Int16  iRelPrio;          // 16 2 Relative priority
 623     Int8   iDrawType;         // 18 1 Draw type
 624                               // 0 = Draw solid with backface culling
 625                               // (front side only)
 626                               // 1 = Draw solid, no backface culling
 627                               // (both sides visible)
 628                               // 2 = Draw wireframe and close
 629                               // 3 = Draw wireframe
 630                               // 4 = Surround with wireframe in alternate color
 631                               // 8 = Omnidirectional light
 632                               // 9 = Unidirectional light
 633                               // 10 = Bidirectional light
 634     Int8   iTextureWhite;     // 19 1 Texture white =
 635                               // if TRUE, draw textured face white
 636     UInt16 uiColorNameIdx;    // 20 2 Color name index
 637     UInt16 uiAltColorNameIdx; // 22 2 Alternate color name index
 638     Int8   iPad1;           //       24 1 Reserved
 639     Int8   iTemplate;       // 25 1 Template (billboard)
 640                             // 0 = Fixed, no alpha blending
 641                             // 1 = Fixed, alpha blending
 642                             // 2 = Axial rotate with alpha blending
 643                             // 4 = Point rotate with alpha blending
 644     Int16  iDetailTexIdx;   // 26 2 Detail texture pattern index, -1 if none
 645     Int16  iTexIdx;         // 28 2 Texture pattern index, -1 if none
 646     Int16  iMatIdx;         // 30 2 Material index, -1 if none
 647     Int16  iSurfMatCode;    // 32 2 Surface material code (for DFAD)
 648     Int16  iFeatureId;      // 34 2 Feature ID (for DFAD)
 649     Int32  iIRMatCode;      // 36 4 IR material code
 650     UInt16 uiTransparency;  // 40 2 Transparency
 651                             // 0 = Opaque
 652                             // 65535 = Totally clear
 653     UInt8  uiLODGenControl; // 42 1 LOD generation control
 654     UInt8  uiLineStyle;     // 43 1 Line style index
 655     Int32  iFlags;          //         44 4 Flags (bits from left to right)
 656                             // 0 = Terrain
 657                             // 1 = No color
 658                             // 2 = No alternate color
 659                             // 3 = Packed color
 660                             // 4 = Terrain culture cutout (footprint)
 661                             // 5 = Hidden, not drawn
 662                             // 6 = Roofline
 663                             // 7-31 = Spare
 664     UInt8  uiLightMode;     // 48 1 Light mode
 665                             // 0 = Use face color, not illuminated     (Flat)
 666                             // 1 = Use vertex colors, not illuminated  (Gouraud)
 667                             // 2 = Use face color and vertex normals   (Lit)
 668                             // 3 = Use vertex colors and vertex normals(Lit
 669                             //                                          Gouraud)
 670     Char8  szPad2[7];       // 49 7 Reserved
 671     UInt32 uiPackedPrimCol; // 56 4 Packed color, primary (a, b, g, r) -
 672                             // only b, g, r used
 673     UInt32 uiPackedAltCol;  // 60 4 Packed color, alternate (a, b, g, r) -
 674                             // only b, g, r used
 675     Int16  iTexMapIdx;      // 64 2 Texture mapping index, -1 if none
 676     Int16  iPad3;           // 66 2 Reserved
 677     Int32  uiPrimColIdx;    // 68 4 Primary color index, -1 if none
 678     Int32  uiAltColIdx;     // 72 4 Alternate color index, -1 if none
 679     Int16  iPad4;           // 76 2 Reserved
 680     Int16  iShaderIdx;      // 78 2 Shader index, -1 if none
 681
 682     /*---------------------------------------------------------------------*/
 683
 684     OFVertexListRecordRCPtr _pVList;
 685
 686     /*---------------------------------------------------------------------*/
 687
 688              OFFaceRecord(const OFRecordHeader &oHeader,
 689                                 OFDatabase     &oDB    );
 690     virtual ~OFFaceRecord(void                         );
 691
 692   public:
 693
 694     static const UInt16 OpCode = 5;
 695
 696     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 697                                            OFDatabase     &oDB    );
 698
 699     /*---------------------------------------------------------------------*/
 700
 701     virtual bool read    (std::istream &is    );
 702     virtual bool addChild(OFRecord     *pChild);
 703
 704     /*---------------------------------------------------------------------*/
 705
 706     virtual UInt16 getOpCode(void) const;
 707
 708     /*---------------------------------------------------------------------*/
 709
 710     virtual void dump(UInt32 uiIndent) const;
 711
 712     /*---------------------------------------------------------------------*/
 713
 714     bool operator ==(const OFFaceRecord &rhs) const;
 715
 716     /*---------------------------------------------------------------------*/
 717
 718     OFVertexListRecord *getVertexList  (void);
 719     Int8                getDrawType    (void) const;
 720     Int8                getTextureWhite(void) const;
 721     Int16               getTexIdx      (void) const;
 722     Int16               getMatIdx      (void) const;
 723     UInt16              getTransparency(void) const;
 724     Int32               getFlags       (void) const;
 725     UInt8               getLightMode   (void) const;
 726     Color4f             getPrimColor   (void) const;
 727     Color4f             getAltColor    (void) const;
 728 };
 729
 730 /*! \ingroup GrpFileIOOpenFlight
 731  */
 732 typedef RefCountPtr<OFFaceRecord, MemObjRefCountPolicy> OFFaceRecordRCPtr;
 733
 734 //---------------------------------------------------------------------------
 735 //  Class
 736 //---------------------------------------------------------------------------
 737
 738 /*! \ingroup GrpFileIOOpenFlight
 739     \nohierarchy
 740  */
 741
 742 class OSG_FILEIO_DLLMAPPING OFVertexListRecord : public OFPrimaryRecord
 743 {
 744   protected:
 745
 746     /*---------------------------------------------------------------------*/
 747
 748     typedef OFPrimaryRecord Inherited;
 749
 750     /*---------------------------------------------------------------------*/
 751
 752     static OFRecordFactoryBase::RegisterRecord _regHelper;
 753
 754     /*---------------------------------------------------------------------*/
 755
 756     std::vector<Int32> _vIndices;
 757
 758     /*---------------------------------------------------------------------*/
 759
 760              OFVertexListRecord(const OFRecordHeader &oHeader,
 761                                       OFDatabase     &oDB    );
 762     virtual ~OFVertexListRecord(void                         );
 763
 764   public:
 765
 766     static const UInt16 OpCode = 72;
 767
 768     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 769                                            OFDatabase     &oDB    );
 770
 771     /*---------------------------------------------------------------------*/
 772
 773     virtual bool read(std::istream &is);
 774
 775     /*---------------------------------------------------------------------*/
 776
 777     virtual UInt16 getOpCode(void) const;
 778
 779     /*---------------------------------------------------------------------*/
 780
 781     const std::vector<Int32> &getIndices(void);
 782 };
 783
 784 //---------------------------------------------------------------------------
 785 //  Class
 786 //---------------------------------------------------------------------------
 787
 788 /*! \ingroup GrpFileIOOpenFlight
 789     \nohierarchy
 790  */
 791
 792 class OSG_FILEIO_DLLMAPPING OFLODRecord : public OFPrimaryRecord
 793 {
 794   protected:
 795
 796     /*---------------------------------------------------------------------*/
 797
 798     typedef OFPrimaryRecord Inherited;
 799
 800     /*---------------------------------------------------------------------*/
 801
 802     static OFRecordFactoryBase::RegisterRecord _regHelper;
 803
 804     /*---------------------------------------------------------------------*/
 805
 806     Char8  szASCIIId[8]; // 4  8 7 char ASCII ID; 0 terminates
 807     Int32  iPad1;        // 12 4 Reserved
 808     Real64 rSwitchIn;    // 16 8 Switch-in distance
 809     Real64 rSwitchOut;   // 24 8 Switch-out distance
 810     Int16  iSpecialEff1; // 32 2 Special effect ID1 - application defined
 811     Int16  iSpecialEff2; // 34 2 Special effect ID2 - application defined
 812     Int32  iFlags;       // 36 4 Flags (bits, from left to right)
 813                          // 0 = Use previous slant range
 814                          // 1 = Reserved
 815                          // 2 = Freeze center (don't recalculate)
 816                          // 3-31 = Spare
 817     Real64 rCenterX;     // 40 8 Center coordinate x of LOD
 818     Real64 rCenterY;     // 48 8 Center coordinate y of LOD
 819     Real64 rCenterZ;     // 56 8 Center coordinate z of LOD
 820     Real64 rTransRange;  // 64 8 Transition range
 821     Real64 rSigSize;     // 72 8 Significant size
 822
 823     /*---------------------------------------------------------------------*/
 824
 825              OFLODRecord(const OFRecordHeader &oHeader,
 826                                OFDatabase     &oDB    );
 827     virtual ~OFLODRecord(void                         );
 828
 829   public:
 830
 831     static const UInt16 OpCode = 73;
 832
 833     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 834                                            OFDatabase     &oDB    );
 835
 836     /*---------------------------------------------------------------------*/
 837
 838     virtual bool           read         (std::istream &is);
 839     virtual NodeTransitPtr convertToNode(void            );
 840
 841     /*---------------------------------------------------------------------*/
 842
 843     virtual UInt16 getOpCode(void) const;
 844
 845     /*---------------------------------------------------------------------*/
 846
 847     virtual void dump(UInt32 uiIndent) const;
 848
 849     /*---------------------------------------------------------------------*/
 850
 851     Real64 getSwitchIn (void);
 852     Real64 getSwitchOut(void);
 853
 854     Pnt3f  getCenter   (void);
 855
 856     NodeTransitPtr convertAncillaryChildren(Node *pNode);
 857 };
 858
 859 //---------------------------------------------------------------------------
 860 //  Class
 861 //---------------------------------------------------------------------------
 862
 863 /*! \ingroup GrpFileIOOpenFlight
 864     \nohierarchy
 865  */
 866
 867 class OSG_FILEIO_DLLMAPPING OFSwitchRecord : public OFPrimaryRecord
 868 {
 869   protected:
 870
 871     /*---------------------------------------------------------------------*/
 872
 873     typedef OFPrimaryRecord Inherited;
 874
 875     static OFRecordFactoryBase::RegisterRecord _regHelper;
 876
 877     /*---------------------------------------------------------------------*/
 878
 879     typedef std::vector< std::vector<UInt32> > MaskStore;
 880
 881     /*---------------------------------------------------------------------*/
 882
 883     Char8 szASCIIID[8]; // 4  8 7 char ASCII ID; 0 terminates
 884     Int32 szPad1;       // 12 4 Reserved
 885     Int32 iCurrMask;    // 16 4 Current mask
 886     Int32 iNumMask;     // 20 4 Number of masks
 887     Int32 iMaskWords;   // 24 4 Number of words per mask -
 888                         // the number of 32 bit words
 889                         // required for each mask, calculated as follows:
 890                         // (number of children / 32) + X
 891                         // where X equals:
 892                         // 0 if (number of children modulo 32) is zero
 893                         // 1 if (number of children modulo 32) is nonzero
 894     MaskStore vMask;    // Unsigned Int 28 Variable Mask words.
 895                         // The length (in bytes) can be calculated as follows:
 896                         // Number of words per mask * Number of masks * 4 bytes
 897
 898     /*---------------------------------------------------------------------*/
 899
 900              OFSwitchRecord(const OFRecordHeader &oHeader,
 901                                   OFDatabase     &oDB    );
 902     virtual ~OFSwitchRecord(void                         );
 903
 904   public:
 905
 906     static const UInt16 OpCode = 96;
 907
 908     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 909                                            OFDatabase     &oDB    );
 910
 911     /*---------------------------------------------------------------------*/
 912
 913     virtual bool           read         (std::istream &is);
 914     virtual NodeTransitPtr convertToNode(void            );
 915
 916     /*---------------------------------------------------------------------*/
 917
 918     virtual UInt16 getOpCode(void) const;
 919
 920     /*---------------------------------------------------------------------*/
 921
 922     virtual void dump(UInt32 uiIndent) const;
 923
 924     NodeTransitPtr convertAncillaryChildren(Node *pNode);
 925 };
 926
 927 //---------------------------------------------------------------------------
 928 //  Class
 929 //---------------------------------------------------------------------------
 930
 931 /*! \ingroup GrpFileIOOpenFlight
 932     \nohierarchy
 933  */
 934
 935 class OSG_FILEIO_DLLMAPPING OFExternalReferenceRecord : public OFPrimaryRecord
 936 {
 937   protected:
 938
 939     typedef OFPrimaryRecord Inherited;
 940
 941     static OFRecordFactoryBase::RegisterRecord _regHelper;
 942
 943     /*---------------------------------------------------------------------*/
 944
 945     Char8 szFilename[200]; // 4   200 199-char ASCII path; 0 terminates
 946                            // Format of this string is: filename<node name>
 947                            // if <node name> absent, references entire file
 948     Int32 iPad1;           // 204 4   Reserved
 949     Int32 iFlags;          // 208 4   Flags (bits, from left to right)
 950                            // 0 = Color palette override
 951                            // 1 = Material palette override
 952                            // 2 = Texture and texture mapping palette override
 953                            // 3 = Line style palette override
 954                            // 4 = Sound palette override
 955                            // 5 = Light source palette override
 956                            // 6 = Light point palette override
 957                            // 7 = Shader palette override
 958                            // 8-31 = Spare
 959     Int16 iViewAsBBox;     // 212 2   View as bounding box
 960                            // 0 = View external reference normally
 961                            // 1 = View external reference as bounding box
 962     Int16 iPad2;           // 214 2   Reserved
 963
 964     /*---------------------------------------------------------------------*/
 965
 966              OFExternalReferenceRecord(const OFRecordHeader &oHeader,
 967                                              OFDatabase     &oDB    );
 968     virtual ~OFExternalReferenceRecord(void                         );
 969
 970   public:
 971
 972     static const UInt16 OpCode = 63;
 973
 974     static OFRecordTransitPtr create(const OFRecordHeader &oHeader,
 975                                            OFDatabase     &oDB    );
 976
 977     /*---------------------------------------------------------------------*/
 978
 979     virtual bool           read         (std::istream &is);
 980     virtual NodeTransitPtr convertToNode(void            );
 981
 982     /*---------------------------------------------------------------------*/
 983
 984     virtual UInt16 getOpCode(void) const;
 985
 986     /*---------------------------------------------------------------------*/
 987
 988     virtual void dump(UInt32 uiIndent) const;
 989
 990     NodeTransitPtr convertAncillaryChildren(Node *pNode);
 991 };
 992
 993 OSG_END_NAMESPACE
 994
 995 #endif /* _OSGOFPRIMARYRECORDS_H_ */
 996