Source/System/Action/Base/OSGRenderPartitionBase.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 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 _OSGRENDERPARTITIONBASE_H_
  40 #define _OSGRENDERPARTITIONBASE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 //---------------------------------------------------------------------------
  46 //  Includes
  47 //---------------------------------------------------------------------------
  48
  49 #include "OSGSystemDef.h"
  50 #include "OSGBaseTypes.h"
  51 #include "OSGDrawTask.h"
  52
  53 OSG_BEGIN_NAMESPACE
  54
  55 //---------------------------------------------------------------------------
  56 //  Forward References
  57 //---------------------------------------------------------------------------
  58
  59 class TreeBuilderBase;
  60 class OcclusionCullingTreeBuilder;
  61
  62 //---------------------------------------------------------------------------
  63 //   Types
  64 //---------------------------------------------------------------------------
  65
  66 //---------------------------------------------------------------------------
  67 //  Class
  68 //---------------------------------------------------------------------------
  69
  70 /*! \brief RenderPartition is the core class for keeping track of the actions
  71            necessary to draw a scene.
  72
  73     \ingroup GrpSystemActionBase
  74     \ingroup GrpLibOSGSystem
  75  */
  76
  77 class OSG_SYSTEM_DLLMAPPING RenderPartitionBase : public DrawTask
  78 {
  79   public:
  80
  81     typedef DrawTask Inherited;
  82
  83     //-----------------------------------------------------------------------
  84     //   constants
  85     //-----------------------------------------------------------------------
  86
  87     //-----------------------------------------------------------------------
  88     //   enums
  89     //-----------------------------------------------------------------------
  90
  91     enum CopyOnPush
  92     {
  93         CopyNothing       = 0x0000,
  94
  95         CopyStateOverride = 0x0001,
  96
  97         CopyViewing       = 0x0002,
  98         CopyProjection    = 0x0004,
  99         CopyVisibility    = 0x0008,
 100
 101         CopyTarget        = 0x0010,
 102         CopyWindow        = 0x0020,
 103
 104         CopyViewportSize  = 0x0040,
 105         CopyFrustum       = 0x0080,
 106
 107         CopyNearFar       = 0x0100,
 108
 109         CopyVPCamera      = 0x0200,
 110
 111         CopyMatrix        = 0x0400,
 112
 113         CopyAll           = 0xFFFF
 114     };
 115
 116     enum Mode
 117     {
 118         StateSorting     = 0x0001,
 119         TransformSorting = 0x0002,
 120         SimpleCallback   = 0x0003
 121     };
 122
 123     enum SetupMode
 124     {
 125         EmptySetup      = 0x0000,
 126         ProjectionSetup = 0x0001,
 127         ViewportSetup   = 0x0002,
 128         BackgroundSetup = 0x0004,
 129         FullSetup       = 0x0007
 130     };
 131
 132     enum SetupBit
 133     {
 134         PassiveBit = 0x00010000
 135     };
 136
 137     static const UInt32 Setup   = Inherited::LastType + 1;
 138     static const UInt32 Execute = Inherited::LastType + 2;
 139     static const UInt32 Full    = Inherited::LastType + 3;
 140
 141     //-----------------------------------------------------------------------
 142     //   types
 143     //-----------------------------------------------------------------------
 144
 145     //-----------------------------------------------------------------------
 146     //   class functions
 147     //-----------------------------------------------------------------------
 148
 149     //-----------------------------------------------------------------------
 150     //   class functions
 151     //-----------------------------------------------------------------------
 152
 153     //-----------------------------------------------------------------------
 154     //   instance functions
 155     //-----------------------------------------------------------------------
 156
 157     /*------------------------- your_category -------------------------------*/
 158
 159     void setTaskType(UInt32 uiTaskType);
 160
 161     /*------------------------- assignment ----------------------------------*/
 162
 163     bool getCorrectNegScale(void     ) const;
 164     void setCorrectNegScale(bool bVal);
 165
 166     bool getZWriteTrans    (void     ) const;
 167     void setZWriteTrans    (bool bVal);
 168
 169     /*------------------------- comparison ----------------------------------*/
 170
 171     /*------------------------- comparison ----------------------------------*/
 172
 173   protected:
 174
 175     //-----------------------------------------------------------------------
 176     //   enums
 177     //-----------------------------------------------------------------------
 178
 179     //-----------------------------------------------------------------------
 180     //   types
 181     //-----------------------------------------------------------------------
 182
 183     //-----------------------------------------------------------------------
 184     //   class variables
 185     //-----------------------------------------------------------------------
 186
 187     //-----------------------------------------------------------------------
 188     //   class functions
 189     //-----------------------------------------------------------------------
 190
 191     //-----------------------------------------------------------------------
 192     //   instance variables
 193     //-----------------------------------------------------------------------
 194
 195     // What to do
 196     bool     _bSortTrans;
 197     bool     _bZWriteTrans;
 198     bool     _bCorrectNegScale;
 199     UInt8    _ubState;
 200
 201     // Stat
 202     UInt32   _uiNumMatrixChanges;
 203
 204     //-----------------------------------------------------------------------
 205     //   instance functions
 206     //-----------------------------------------------------------------------
 207
 208     RenderPartitionBase(void);
 209
 210     virtual ~RenderPartitionBase(void);
 211
 212     /*-------------------------- comparison ---------------------------------*/
 213
 214     /*-------------------------- comparison ---------------------------------*/
 215
 216   private:
 217
 218     //-----------------------------------------------------------------------
 219     //   enums
 220     //-----------------------------------------------------------------------
 221
 222     //-----------------------------------------------------------------------
 223     //   types
 224     //-----------------------------------------------------------------------
 225
 226     //-----------------------------------------------------------------------
 227     //   friend classes
 228     //-----------------------------------------------------------------------
 229
 230     friend class TreeBuilderBase;
 231     friend class OcclusionCullingTreeBuilder;
 232
 233     //-----------------------------------------------------------------------
 234     //   friend functions
 235     //-----------------------------------------------------------------------
 236
 237     //-----------------------------------------------------------------------
 238     //   class variables
 239     //-----------------------------------------------------------------------
 240
 241     //-----------------------------------------------------------------------
 242     //   class functions
 243     //-----------------------------------------------------------------------
 244
 245     //-----------------------------------------------------------------------
 246     //   instance variables
 247     //-----------------------------------------------------------------------
 248
 249     //-----------------------------------------------------------------------
 250     //   instance functions
 251     //-----------------------------------------------------------------------
 252
 253     /*!\brief prohibit default function (move to 'public' if needed) */
 254     RenderPartitionBase(const RenderPartitionBase &source);
 255     void operator =(const RenderPartitionBase &source);
 256 };
 257
 258 //---------------------------------------------------------------------------
 259 //   Exported Types
 260 //---------------------------------------------------------------------------
 261
 262 OSG_END_NAMESPACE
 263
 264 #include "OSGRenderPartitionBase.inl"
 265
 266 #endif /* _OSGRENDERPARTITIONBASE_H_ */
 267
 268