Source/System/FieldContainer/Misc/OSGTraversalData.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 _OSGTRAVERSALDATA_H_
  40 #define _OSGTRAVERSALDATA_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGTraversalDataBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief TraversalData class. See \ref
  50            PageGroupTraversalData for a description.
  51     \ingroup GrpGroupTraversalObj
  52     \ingroup GrpLibOSGGroup
  53     \includebasedoc
  54  */
  55
  56 class OSG_SYSTEM_DLLMAPPING TraversalData : public TraversalDataBase
  57 {
  58   protected:
  59
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     typedef TraversalDataBase Inherited;
  65     typedef TraversalData     Self;
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                     Output                                   */
  69     /*! \{                                                                 */
  70
  71     virtual void copyFrom(TraversalData *pIn);
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name                      Sync                                    */
  76     /*! \{                                                                 */
  77
  78     virtual void changed(ConstFieldMaskArg whichField,
  79                          UInt32            origin,
  80                          BitVector         detail);
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                      Init                                    */
  85     /*! \{                                                                 */
  86
  87     virtual void updateData(FieldContainer *pStageCore,
  88                             BitVector       whichField,
  89                             UInt32          origin    );
  90
  91     /*! \}                                                                 */
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                     Output                                   */
  94     /*! \{                                                                 */
  95
  96     virtual void dump(      UInt32     uiIndent = 0,
  97                       const BitVector  bvFlags  = 0) const;
  98
  99     /*! \}                                                                 */
 100     /*=========================  PROTECTED  ===============================*/
 101
 102   protected:
 103
 104     // Variables should all be in TraversalDataBase.
 105
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                  Constructors                                */
 108     /*! \{                                                                 */
 109
 110     TraversalData(void);
 111     TraversalData(const TraversalData &source);
 112
 113     /*! \}                                                                 */
 114     /*---------------------------------------------------------------------*/
 115     /*! \name                   Destructors                                */
 116     /*! \{                                                                 */
 117
 118     virtual ~TraversalData(void);
 119
 120     /*! \}                                                                 */
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                      Init                                    */
 123     /*! \{                                                                 */
 124
 125     static void initMethod(InitPhase ePhase);
 126
 127     /*! \}                                                                 */
 128     /*==========================  PRIVATE  ================================*/
 129
 130   private:
 131
 132     friend class FieldContainer;
 133     friend class TraversalDataBase;
 134
 135     // prohibit default functions (move to 'public' if you need one)
 136     void operator =(const TraversalData &source);
 137 };
 138
 139 OSG_END_NAMESPACE
 140
 141 #include "OSGTraversalDataBase.inl"
 142 #include "OSGTraversalData.inl"
 143
 144 #endif /* _OSGTRAVERSALDATA_H_ */