Source/System/FieldContainer/Mixins/OSGTraversalDataHandlerMixin.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *           Copyright (C) 2003 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 _OSGTRAVERSALDATAHANDLERMIXIN_H_
  40 #define _OSGTRAVERSALDATAHANDLERMIXIN_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGTraversalValidationHandlerMixin.h"
  46
  47 #include "OSGTraversalData.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \ingroup GrpSystemFieldContainerMixins
  52     \ingroup GrpLibOSGBase
  53  */
  54
  55 template <class ParentT>
  56 class TraversalDataHandlerMixin  :
  57     public TraversalValidationHandlerMixin<ParentT>
  58 {
  59     /*==========================  PRIVATE  ================================*/
  60
  61   protected:
  62
  63     typedef          TraversalValidationHandlerMixin<ParentT> Inherited;
  64     typedef typename Inherited::DataSlotHandler               DataSlotHandler;
  65
  66     /*==========================  PUBLIC  =================================*/
  67
  68   public:
  69
  70     typedef          TraversalDataHandlerMixin<ParentT>   Self;
  71
  72     typedef typename ParentT::Desc                        Desc;
  73     typedef typename Desc::TypeObject                     TypeObject;
  74
  75     typedef typename Inherited::ValidationStatus          ValidationStatus;
  76
  77     enum GroupMode
  78     {
  79         NoPartitionGroup = 0x0000,
  80         InPartitionGroup = 0x0001,
  81         InPartitionList  = 0x0002
  82     };
  83
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                      dcast                                   */
  86     /*! \{                                                                 */
  87
  88     /*! \}                                                                 */
  89     /*---------------------------------------------------------------------*/
  90     /*! \name        General Fieldcontainer Declaration                    */
  91     /*! \{                                                                 */
  92
  93     /*! \}                                                                 */
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                   Constructors                               */
  96     /*! \{                                                                 */
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                   Destructor                                 */
 101     /*! \{                                                                 */
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                    Helper                                    */
 106     /*! \{                                                                 */
 107
 108     void changed(ConstFieldMaskArg whichField,
 109                  UInt32            origin,
 110                  BitVector         details);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                      Get                                     */
 115     /*! \{                                                                 */
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                      Set                                     */
 120     /*! \{                                                                 */
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                   your_category                              */
 125     /*! \{                                                                 */
 126
 127     /*! \}                                                                 */
 128     /*---------------------------------------------------------------------*/
 129     /*! \name                 Container Access                             */
 130     /*! \{                                                                 */
 131
 132     /*! \}                                                                 */
 133     /*---------------------------------------------------------------------*/
 134     /*! \name                   Binary Access                              */
 135     /*! \{                                                                 */
 136
 137     /*! \}                                                                 */
 138     /*---------------------------------------------------------------------*/
 139     /*! \name                   your_operators                             */
 140     /*! \{                                                                 */
 141
 142     void setData(TraversalData    *pData,
 143                  Int32             iDataSlotId,
 144                  RenderActionBase *pAction    );
 145
 146     /*! \}                                                                 */
 147     /*---------------------------------------------------------------------*/
 148     /*! \name                    Assignment                                */
 149     /*! \{                                                                 */
 150
 151     /*! \}                                                                 */
 152     /*---------------------------------------------------------------------*/
 153     /*! \name                    Comparison                                */
 154     /*! \{                                                                 */
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                        Dump                                  */
 159     /*! \{                                                                 */
 160
 161     virtual void dump(      UInt32    uiIndent = 0,
 162                       const BitVector bvFlags  = 0) const;
 163
 164     /*! \}                                                                 */
 165     /*=========================  PROTECTED  ===============================*/
 166
 167   protected:
 168
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                  Type information                            */
 171     /*! \{                                                                 */
 172
 173     virtual void dataDestroyed(FieldContainer *pCore,
 174                                BitVector       whichField,
 175                                UInt32          origin    );
 176
 177     /*! \}                                                                 */
 178     /*---------------------------------------------------------------------*/
 179     /*! \name                      Fields                                  */
 180     /*! \{                                                                 */
 181
 182     /*! \}                                                                 */
 183     /*---------------------------------------------------------------------*/
 184     /*! \name                      Member                                  */
 185     /*! \{                                                                 */
 186
 187     TraversalDataHandlerMixin(void);
 188     TraversalDataHandlerMixin(const TraversalDataHandlerMixin &source);
 189
 190     virtual ~TraversalDataHandlerMixin(void);
 191
 192     /*! \}                                                                 */
 193     /*---------------------------------------------------------------------*/
 194     /*! \name                      Changed                                 */
 195     /*! \{                                                                 */
 196
 197     /*! \}                                                                 */
 198     /*---------------------------------------------------------------------*/
 199     /*! \name                   MT Destruction                             */
 200     /*! \{                                                                 */
 201
 202     /*! \}                                                                 */
 203     /*---------------------------------------------------------------------*/
 204     /*! \name                       Edit                                   */
 205     /*! \{                                                                 */
 206
 207     /*! \}                                                                 */
 208     /*---------------------------------------------------------------------*/
 209     /*! \name                       Edit                                   */
 210     /*! \{                                                                 */
 211
 212     /*! \}                                                                 */
 213     /*---------------------------------------------------------------------*/
 214     /*! \name                       Sync                                   */
 215     /*! \{                                                                 */
 216
 217     /*! \}                                                                 */
 218     /*==========================  PRIVATE  ================================*/
 219
 220   private:
 221
 222     /*!\brief prohibit default function (move to 'public' if needed) */
 223     void operator =(const TraversalDataHandlerMixin &source);
 224 };
 225
 226 OSG_END_NAMESPACE
 227
 228 #include "OSGTraversalDataHandlerMixin.inl"
 229
 230 #endif /* _OSGTRAVERSALDATAHANDLERMIXIN_H_ */