Source/System/FieldContainer/Mixins/OSGTraversalValidationHandlerMixin.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 _OSGTRAVERSALVALIDATIONHANDLERMIXIN_H_
  40 #define _OSGTRAVERSALVALIDATIONHANDLERMIXIN_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGOSGAnyFields.h"
  46
  47 #include <boost/bind.hpp>
  48
  49 #include "OSGWindow.h"
  50 #include "OSGTraversalValidator.h"
  51 #include "OSGRenderActionBase.h"
  52 #include "OSGViewarea.h"
  53
  54 OSG_BEGIN_NAMESPACE
  55
  56 /*! \ingroup GrpSystemFieldContainerMixins
  57     \ingroup GrpLibOSGSystem
  58  */
  59 template <class ParentT>
  60 class TraversalValidationHandlerMixin  : public ParentT
  61 {
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     typedef          TraversalValidationHandlerMixin<ParentT> Self;
  67
  68     typedef typename ParentT::Desc                            Desc;
  69     typedef typename Desc::TypeObject                         TypeObject;
  70
  71     /*==========================  PRIVATE  ================================*/
  72
  73   protected:
  74
  75     typedef ParentT                                  Inherited;
  76     typedef typename Desc::DataSlotHandler           DataSlotHandler;
  77     typedef typename DataSlotHandler::DataSlotIdPool DataSlotIdPool;
  78     typedef typename Desc::ElementIdPool             ElementIdPool;
  79
  80     /*==========================  PUBLIC  =================================*/
  81
  82   public:
  83
  84     typedef TraversalValidator::ValidationStatus  ValidationStatus;
  85
  86     enum UpdateMode
  87     {
  88         PerWindow    = 0x0001,
  89         PerViewport  = 0x0002,
  90         PerTraversal = 0x0003,
  91
  92         PerVisit     = 0x0004,
  93
  94         OnRequest    = 0x0005
  95     };
  96
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                      dcast                                   */
  99     /*! \{                                                                 */
 100
 101     OSG_RC_FIRST_FIELD_DECL(UpdateMode                   );
 102
 103     OSG_RC_FIELD_DECL      (RequestRun,        UpdateMode);
 104     OSG_RC_FIELD_DECL      (DestroyedFunctors, RequestRun);
 105     OSG_RC_LAST_FIELD_DECL (DestroyedFunctors            );
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name        General Fieldcontainer Declaration                    */
 110     /*! \{                                                                 */
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                   Constructors                               */
 115     /*! \{                                                                 */
 116
 117     void   addDestroyedFunctor     (ChangedFunctor    func,
 118                                     std::string       createSymbol);
 119
 120     template<class FunctorT>
 121     void   subDestroyedFunctor     (FunctorT          func        );
 122
 123     template<class FunctorT>
 124     bool   hasDestroyedFunctor     (FunctorT          func        );
 125
 126     void   clearDestroyedFunctors  (void                          );
 127
 128     template<class DataSlotHandlerT>
 129     void   clearDestroyedFunctorFor(DataSlotHandlerT  *pHandler    );
 130
 131     /*! \}                                                                 */
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                   Destructor                                 */
 134     /*! \{                                                                 */
 135
 136     bool requestRun(void);
 137
 138     /*! \}                                                                 */
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                    Helper                                    */
 141     /*! \{                                                                 */
 142
 143     void changed(ConstFieldMaskArg whichField,
 144                  UInt32            origin,
 145                  BitVector         details);
 146
 147     /*! \}                                                                 */
 148     /*---------------------------------------------------------------------*/
 149     /*! \name                      Get                                     */
 150     /*! \{                                                                 */
 151
 152     /*! \}                                                                 */
 153     /*---------------------------------------------------------------------*/
 154     /*! \name                      Set                                     */
 155     /*! \{                                                                 */
 156
 157     /*! \}                                                                 */
 158     /*---------------------------------------------------------------------*/
 159     /*! \name                   your_category                              */
 160     /*! \{                                                                 */
 161
 162           void      setUpdateMode   (UpdateMode eMode);
 163           UInt32    getUpdateMode   (void            ) const;
 164
 165           SFUInt32 *editSFUpdateMode(void            );
 166     const SFUInt32 *getSFUpdateMode (void            ) const;
 167
 168     /*! \}                                                                 */
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                 Container Access                             */
 171     /*! \{                                                                 */
 172
 173     /*! \}                                                                 */
 174     /*---------------------------------------------------------------------*/
 175     /*! \name                   Binary Access                              */
 176     /*! \{                                                                 */
 177
 178     virtual SizeT  getBinSize (ConstFieldMaskArg   whichField);
 179     virtual void   copyToBin  (BinaryDataHandler  &pMem,
 180                                ConstFieldMaskArg   whichField);
 181     virtual void   copyFromBin(BinaryDataHandler  &pMem,
 182                                ConstFieldMaskArg   whichField);
 183
 184     /*! \}                                                                 */
 185     /*---------------------------------------------------------------------*/
 186     /*! \name                   your_operators                             */
 187     /*! \{                                                                 */
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                    Assignment                                */
 192     /*! \{                                                                 */
 193
 194     /*! \}                                                                 */
 195     /*---------------------------------------------------------------------*/
 196     /*! \name                    Comparison                                */
 197     /*! \{                                                                 */
 198
 199     /*! \}                                                                 */
 200     /*---------------------------------------------------------------------*/
 201     /*! \name                        Dump                                  */
 202     /*! \{                                                                 */
 203
 204     virtual void dump(      UInt32    uiIndent = 0,
 205                       const BitVector bvFlags  = 0) const;
 206
 207     /*! \}                                                                 */
 208     /*=========================  PROTECTED  ===============================*/
 209
 210   protected:
 211
 212     Int32  _iDataSlotId;
 213     Int32  _iElementId;
 214
 215     /*---------------------------------------------------------------------*/
 216     /*! \name                  Type information                            */
 217     /*! \{                                                                 */
 218
 219     ValidationStatus validate(RenderActionBase *pAction);
 220
 221     /*! \}                                                                 */
 222     /*---------------------------------------------------------------------*/
 223     /*! \name                      Fields                                  */
 224     /*! \{                                                                 */
 225
 226     SFUInt32                 _sfUpdateMode;
 227     SFOSGAny                 _sfRequestRun;
 228     MFChangedFunctorCallback _mfDestroyedFunctors;
 229
 230     /*! \}                                                                 */
 231     /*---------------------------------------------------------------------*/
 232     /*! \name                      Member                                  */
 233     /*! \{                                                                 */
 234
 235     TraversalValidationHandlerMixin(void);
 236     TraversalValidationHandlerMixin(const Self &source);
 237
 238     virtual ~TraversalValidationHandlerMixin(void);
 239
 240     /*! \}                                                                 */
 241     /*---------------------------------------------------------------------*/
 242     /*! \name                      Changed                                 */
 243     /*! \{                                                                 */
 244
 245     static void classDescInserter(TypeObject &oType);
 246
 247     /*! \}                                                                 */
 248     /*---------------------------------------------------------------------*/
 249     /*! \name                   MT Destruction                             */
 250     /*! \{                                                                 */
 251
 252 #ifdef OSG_MT_CPTR_ASPECT
 253     void execSync  (      Self              *pFrom,
 254                           ConstFieldMaskArg  whichField,
 255                           AspectOffsetStore &oOffsets,
 256                           ConstFieldMaskArg  syncMode  ,
 257                     const UInt32             uiSyncInfo);
 258 #endif
 259
 260
 261     /*! \}                                                                 */
 262     /*---------------------------------------------------------------------*/
 263     /*! \name                       Edit                                   */
 264     /*! \{                                                                 */
 265
 266     /*! \}                                                                 */
 267     /*---------------------------------------------------------------------*/
 268     /*! \name                       Edit                                   */
 269     /*! \{                                                                 */
 270
 271     EditFieldHandlePtr editHandleUpdateMode       (void);
 272     GetFieldHandlePtr  getHandleUpdateMode        (void) const;
 273
 274     GetFieldHandlePtr  getHandleRequestRun        (void) const;
 275
 276     GetFieldHandlePtr  getHandleDestroyedFunctors (void) const;
 277     EditFieldHandlePtr editHandleDestroyedFunctors(void);
 278
 279     /*! \}                                                                 */
 280     /*---------------------------------------------------------------------*/
 281     /*! \name                       Sync                                   */
 282     /*! \{                                                                 */
 283
 284             void onCreateAspect (const Self   *createAspect,
 285                                  const Self   *source      = NULL);
 286
 287             void onCreate       (const Self   *source      = NULL);
 288
 289     virtual void onDestroy      (      UInt32  uiContainerId     );
 290
 291     virtual void onDestroyAspect(      UInt32  uiContainerId,
 292                                        UInt32  uiAspect          );
 293
 294     /*! \}                                                                 */
 295     /*==========================  PRIVATE  ================================*/
 296
 297   private:
 298
 299     /*!\brief prohibit default function (move to 'public' if needed) */
 300     void operator =(const TraversalValidationHandlerMixin &source);
 301 };
 302
 303 OSG_END_NAMESPACE
 304
 305 #include "OSGTraversalValidationHandlerMixin.inl"
 306
 307 #endif /* _OSGTRAVERSALVALIDATIONHANDLERMIXIN_H_ */