Source/Contrib/ComplexSceneManager/Helper/OSGCSMLogger.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGCSMLOGGER_H_
  40 #define _OSGCSMLOGGER_H_
  41
  42 #include "OSGCSMLoggerBase.h"
  43 #include "OSGFileContextHandlerMixin.h"
  44
  45 OSG_BEGIN_NAMESPACE
  46
  47 /*! \brief CSMLogger class. See \ref
  48            PageContribCSMLogger for a description.
  49 */
  50
  51 class OSG_CONTRIBCSM_DLLMAPPING CSMLogger :
  52     public FileContextHandlerMixin<CSMLoggerBase, CSMLogger>
  53 {
  54   protected:
  55
  56     /*==========================  PUBLIC  =================================*/
  57
  58   public:
  59
  60     typedef FileContextHandlerMixin<CSMLoggerBase, CSMLogger> Inherited;
  61     typedef CSMLogger                                         Self;
  62
  63     /*---------------------------------------------------------------------*/
  64     /*! \name                      Sync                                    */
  65     /*! \{                                                                 */
  66
  67     virtual void changed(ConstFieldMaskArg whichField,
  68                          UInt32            origin,
  69                          BitVector         details    );
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                     Output                                   */
  74     /*! \{                                                                 */
  75
  76     virtual void dump(      UInt32     uiIndent = 0,
  77                       const BitVector  bvFlags  = 0) const;
  78
  79     /*! \}                                                                 */
  80     /*=========================  PROTECTED  ===============================*/
  81
  82   protected:
  83
  84     // Variables should all be in CSMLoggerBase.
  85
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                  Constructors                                */
  88     /*! \{                                                                 */
  89
  90     CSMLogger(void);
  91     CSMLogger(const CSMLogger &source);
  92
  93     /*! \}                                                                 */
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                   Destructors                                */
  96     /*! \{                                                                 */
  97
  98     virtual ~CSMLogger(void);
  99
 100     /*! \}                                                                 */
 101     /*---------------------------------------------------------------------*/
 102     /*! \name                      Init                                    */
 103     /*! \{                                                                 */
 104
 105     void postOSGLoading(FileContextAttachment * const pContext);
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                      Init                                    */
 110     /*! \{                                                                 */
 111
 112     void doLog(FieldContainer *pContainer,
 113                BitVector       bvFlags   ,
 114                UInt32          origin    ,
 115                UInt32          uiRefFieldId,
 116                BitVector       uiRefFieldMask);
 117
 118     /*! \}                                                                 */
 119     /*---------------------------------------------------------------------*/
 120     /*! \name                      Init                                    */
 121     /*! \{                                                                 */
 122
 123     static void initMethod(InitPhase ePhase);
 124
 125     /*! \}                                                                 */
 126     /*==========================  PRIVATE  ================================*/
 127
 128   private:
 129
 130     friend class  FieldContainer;
 131     friend class  CSMLoggerBase;
 132     friend class  FileContextHandlerMixin<CSMLoggerBase, CSMLogger>;
 133     friend struct OSGSceneFileType::PostLoadingDispatcher<CSMLogger>;
 134
 135     // prohibit default functions (move to 'public' if you need one)
 136     void operator =(const CSMLogger &source);
 137 };
 138
 139 typedef CSMLogger *CSMLoggerP;
 140
 141 OSG_END_NAMESPACE
 142
 143 #include "OSGCSMLoggerBase.inl"
 144 #include "OSGCSMLogger.inl"
 145
 146 #endif /* _OSGCSMLogger_H_ */