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