Source/System/FileIO/WRL/OSGVRMLWriteAction.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 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 _OSGVRMLWRITEACTION_H_
  40 #define _OSGVRMLWRITEACTION_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 //---------------------------------------------------------------------------
  46 //  Includes
  47 //---------------------------------------------------------------------------
  48
  49 #include <vector>
  50 #include <map>
  51
  52 #include "OSGFileIODef.h"
  53 #include "OSGBaseTypes.h"
  54 #include "OSGAction.h"
  55 #include "OSGGeometry.h"
  56 #include "OSGGroup.h"
  57
  58 OSG_BEGIN_NAMESPACE
  59
  60 //---------------------------------------------------------------------------
  61 //  Forward References
  62 //---------------------------------------------------------------------------
  63
  64 class Node;
  65 class Action;
  66 class Material;
  67
  68 //---------------------------------------------------------------------------
  69 //   Types
  70 //---------------------------------------------------------------------------
  71
  72 //---------------------------------------------------------------------------
  73 //  Class
  74 //---------------------------------------------------------------------------
  75
  76 /*! \brief DrawAction class
  77     \ingroup GrpFileIOWRLObj
  78     \ingroup GrpLibOSGFileIO
  79  */
  80
  81 class OSG_FILEIO_DLLMAPPING VRMLWriteAction : public Action
  82 {
  83   public:
  84
  85     //-----------------------------------------------------------------------
  86     //   enums
  87     //-----------------------------------------------------------------------
  88
  89     enum TraversalMode
  90     {
  91         OSGCollectFC = 0x0001,
  92         OSGWrite     = 0x0002
  93     };
  94
  95     enum WriterOption
  96     {
  97         OSGNoOptions        = 0x0000,
  98         OSGNoIndent         = 0x0001,
  99         OSGNoNormals        = 0x0002,
 100         OSGPixelTextures    = 0x0004
 101     };
 102
 103     //-----------------------------------------------------------------------
 104     //   types
 105     //-----------------------------------------------------------------------
 106
 107     //-----------------------------------------------------------------------
 108     //   class functions
 109     //-----------------------------------------------------------------------
 110
 111     static const char *getClassname(void) { return "VRMLWriteAction"; };
 112
 113     // create a new DrawAction by cloning the prototype
 114     static VRMLWriteAction * create( void );
 115
 116     // prototype access
 117     // after setting the prototype all new DrawActions are clones of it
 118     static void             setPrototype(VRMLWriteAction * proto);
 119     static VRMLWriteAction *getPrototype(void);
 120
 121     //-----------------------------------------------------------------------
 122     //   instance functions
 123     //-----------------------------------------------------------------------
 124
 125     virtual ~VRMLWriteAction(void);
 126
 127     /*------------------------- your_category -------------------------------*/
 128
 129     // default registration. static, so it can be called during static init
 130
 131     static void registerEnterDefault(   const FieldContainerType &type,
 132                                         const Functor            &func);
 133
 134     static void registerLeaveDefault(   const FieldContainerType &type,
 135                                         const Functor            &func);
 136
 137
 138     // rendering state handling
 139
 140     Material      *getMaterial(void) const;
 141     void           setMaterial(Material *material);
 142
 143     FILE          *getFilePtr(void) const;
 144     TraversalMode  getMode   (void) const;
 145
 146     /*------------------------- your_operators ------------------------------*/
 147
 148     bool open (const Char8 *szFilename);
 149     void close(void);
 150
 151     /*------------------------- assignment ----------------------------------*/
 152
 153     void   addOptions(UInt32 uiOptions);
 154     void   subOptions(UInt32 uiOptions);
 155
 156     UInt32 getOptions(void            );
 157
 158     virtual Action::ResultE write(Node *node);
 159
 160     /*------------------------- comparison ----------------------------------*/
 161
 162     bool operator < (const VRMLWriteAction &other) const;
 163
 164     bool operator == (const VRMLWriteAction &other) const;
 165     bool operator != (const VRMLWriteAction &other) const;
 166
 167   protected:
 168
 169     //-----------------------------------------------------------------------
 170     //   enums
 171     //-----------------------------------------------------------------------
 172
 173     //-----------------------------------------------------------------------
 174     //   types
 175     //-----------------------------------------------------------------------
 176
 177     //-----------------------------------------------------------------------
 178     //   class variables
 179     //-----------------------------------------------------------------------
 180
 181     //-----------------------------------------------------------------------
 182     //   class functions
 183     //-----------------------------------------------------------------------
 184
 185     //-----------------------------------------------------------------------
 186     //   instance variables
 187     //-----------------------------------------------------------------------
 188
 189     //-----------------------------------------------------------------------
 190     //   instance functions
 191     //-----------------------------------------------------------------------
 192
 193     // access default functors
 194
 195     virtual std::vector<Functor> *getDefaultEnterFunctors( void );
 196     virtual std::vector<Functor> *getDefaultLeaveFunctors( void );
 197
 198     virtual Action::ResultE apply(std::vector<Node *>::iterator begin,
 199                                   std::vector<Node *>::iterator end);
 200
 201     virtual Action::ResultE apply(Node * const node);
 202
 203   private:
 204
 205     //-----------------------------------------------------------------------
 206     //   enums
 207     //-----------------------------------------------------------------------
 208
 209     //-----------------------------------------------------------------------
 210     //   types
 211     //-----------------------------------------------------------------------
 212
 213     typedef Action Inherited;
 214
 215     /*! \nohierarchy
 216      */
 217     struct ActionInitializer
 218     {
 219         ActionInitializer(void);
 220         ~ActionInitializer(void);
 221     };
 222
 223     /*! \nohierarchy
 224      */
 225     struct FCInfo
 226     {
 227       private:
 228
 229         Int32  _iTimesUsed;
 230         bool   _bOwnName;
 231         Char8 *_szName;
 232         bool   _bWritten;
 233
 234       public:
 235
 236         FCInfo(void);
 237         FCInfo(const FCInfo &source);
 238         ~FCInfo(void);
 239
 240         Char8 mapChar    (      Char8 c);
 241         void  convertName(      Char8 *&szName);
 242
 243         void setName    (const Char8  *szName);
 244         void buildName  (const Char8  *szTypename,
 245                              UInt32  uiContainerId);
 246         void incUse     (void);
 247
 248               UInt32  getUse (void) const;
 249         const Char8  *getName(void) const;
 250
 251         bool  getWritten(void) const;
 252         void  setWritten (void);
 253
 254         // returnvalue required by MS
 255         Int32 clear    (void);
 256
 257       private:
 258
 259         void operator =(const FCInfo &rhs);
 260     };
 261
 262     //-----------------------------------------------------------------------
 263     //   friend classes
 264     //-----------------------------------------------------------------------
 265
 266     friend struct ActionInitializer;
 267
 268     //-----------------------------------------------------------------------
 269     //   friend functions
 270     //-----------------------------------------------------------------------
 271
 272     //-----------------------------------------------------------------------
 273     //   class variables
 274     //-----------------------------------------------------------------------
 275
 276     // the prototype which is copied to create new actions
 277     static VRMLWriteAction * _prototype;
 278
 279     // default functors for instantiation
 280     static std::vector<Functor> *_defaultEnterFunctors;
 281     static std::vector<Functor> *_defaultLeaveFunctors;
 282
 283     static ActionInitializer _actionInitializer;
 284
 285     //-----------------------------------------------------------------------
 286     //   class functions
 287     //-----------------------------------------------------------------------
 288
 289
 290     static Action::ResultE writeGroupEnter(NodeCore * const pGroup,
 291                                            Action *pAction);
 292     static Action::ResultE writeGroupLeave(NodeCore * const pGroup,
 293                                            Action *pAction);
 294
 295     static Action::ResultE writeMatGroupEnter(NodeCore * const pGroup,
 296                                               Action *pAction);
 297     static Action::ResultE writeMatGroupLeave(NodeCore * const pGroup,
 298                                               Action *pAction);
 299
 300     static Action::ResultE writeComponentTransformEnter(NodeCore * const pGroup,
 301                                                         Action *pAction);
 302     static Action::ResultE writeComponentTransformLeave(NodeCore * const pGroup,
 303                                                         Action *pAction);
 304
 305     static Action::ResultE writeTransformEnter(NodeCore * const pGroup,
 306                                                Action *pAction);
 307     static Action::ResultE writeTransformLeave(NodeCore * const pGroup,
 308                                                Action *pAction);
 309
 310     static void writePoints         (      Geometry        *pGeo,
 311                                            FILE            *pFile,
 312                                            VRMLWriteAction *pWriter);
 313     static void writePointSetPoints(      Geometry        *pGeo,
 314                                           FILE            *pFile,
 315                                           VRMLWriteAction *pWriter);
 316     static void writeNormals       (      Geometry        *pGeo,
 317                                           FILE            *pFile,
 318                                           VRMLWriteAction *pWriter);
 319     static void writeColors        (      Geometry        *pGeo,
 320                                           FILE            *pFile,
 321                                           VRMLWriteAction *pWriter);
 322     static void writePointSetColors(      Geometry        *pGeo,
 323                                           FILE            *pFile,
 324                                           VRMLWriteAction *pWriter);
 325     static void writeTexCoords     (      Geometry        *pGeo,
 326                                           FILE            *pFile,
 327                                           VRMLWriteAction *pWriter);
 328
 329     static void writeIndex         (      Geometry        *pGeo,
 330                                           FILE            *pFile,
 331                                           VRMLWriteAction *pWriter);
 332
 333     static void writeLineIndex     (      Geometry        *pGeo,
 334                                           FILE            *pFile,
 335                                           VRMLWriteAction *pWriter);
 336
 337     static void writeMaterial      (      Geometry        *pGeo,
 338                                           FILE            *pFile,
 339                                           VRMLWriteAction *pWriter);
 340
 341     static bool writeGeoCommon     (      Node            *pNode,
 342                                           Geometry        *pGeo,
 343                                           FILE            *pFile,
 344                                           VRMLWriteAction *pWriter,
 345                                     const Char8           *setTypename);
 346
 347     static void writePointSet      (      Node            *pNode,
 348                                           Geometry        *pGeo,
 349                                           FILE            *pFile,
 350                                           VRMLWriteAction *pWriter);
 351
 352     static void writeLineSet       (      Node            *pNode,
 353                                           Geometry        *pGeo,
 354                                           FILE            *pFile,
 355                                           VRMLWriteAction *pWriter,
 356                                           bool             bSinglePrimitiveGeo);
 357
 358     static void writeFaceSet       (      Node            *pNode,
 359                                           Geometry        *pGeo,
 360                                           FILE            *pFile,
 361                                           VRMLWriteAction *pWriter,
 362                                           bool             bSinglePrimitiveGeo);
 363
 364     static Action::ResultE writeGeoEnter(NodeCore * const pGroup, Action *pAction);
 365     static Action::ResultE writeGeoLeave(NodeCore * const pGroup, Action *pAction);
 366
 367     static bool initializeAction(void);
 368     static bool terminateAction (void);
 369
 370     //-----------------------------------------------------------------------
 371     //   instance variables
 372     //-----------------------------------------------------------------------
 373
 374     Material            *_material;
 375
 376     UInt32               _uiIndent;
 377     FILE                *_pFile;
 378
 379     TraversalMode        _eTraversalMode;
 380     bool                 _currentUse;
 381     UInt32               _uiOptions;
 382
 383     //std::vector<FCInfo>  _vFCInfos;
 384     typedef std::map<UInt32, FCInfo *> FCInfosMap;
 385     FCInfosMap _vFCInfos;
 386
 387     // this is a quick hack to get material sharing to work.
 388     // I don't understand the reasoning and design of the FCInfo stuff and
 389     // don't have time to do it right. :( DR 040106
 390     std::vector<FieldContainer *>        _writtenFCs;
 391
 392     UInt32 _nodeCount;
 393     UInt32 _currentNodeCount;
 394
 395     //-----------------------------------------------------------------------
 396     //   instance functions
 397     //-----------------------------------------------------------------------
 398
 399     // prohibit default functions (move to 'public' if you need one)
 400
 401     VRMLWriteAction(void);
 402     VRMLWriteAction(const VRMLWriteAction &source);
 403     VRMLWriteAction& operator =(const VRMLWriteAction &source);
 404
 405     void incIndent  (UInt32 uiDelta);
 406     void decIndent  (UInt32 uiDelta);
 407     void printIndent(void);
 408
 409     void    setCurrentUse  (bool bVal                    );
 410     bool    isCurrentUse   (void                         );
 411
 412     void    addNodeUse     (Node              *pNode     );
 413     void    addContainerUse(FieldContainer    *pContainer);
 414
 415     void    clearInfos     (void);
 416     FCInfo *getInfo        (FieldContainer    *pContainer);
 417
 418     void    updateProgress (void                         );
 419
 420     inline bool        isWritten (FieldContainer *fc);
 421     inline UInt32      getIndex  (FieldContainer *fc);
 422     inline UInt32      setWritten(FieldContainer *fc);
 423 };
 424
 425 OSG_END_NAMESPACE
 426
 427 #include "OSGVRMLWriteAction.inl"
 428
 429 #endif /* _OSGVRMLWRITEACTION_H_ */