Source/System/Action/Base/OSGRenderActionBase.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 _OSGRENDERACTIONBASE_H_
  40 #define _OSGRENDERACTIONBASE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBaseTypes.h"
  46 #include "OSGAction.h"
  47 #include "OSGStatElemTypes.h"
  48 #include "OSGFrustumVolume.h"
  49
  50 #include "OSGMixinHead.h"
  51 #include "OSGDataSlotMixin.h"
  52 #include "OSGDataSlotPool.h"
  53
  54 #include "OSGRenderPartitionBase.h"
  55 #include "OSGRenderPropertiesPool.h"
  56
  57 OSG_BEGIN_NAMESPACE
  58
  59 class DrawEnv;
  60 class Viewarea;
  61 class Camera;
  62 class Background;
  63 class Window;
  64 class StatCollector;
  65 class Material;
  66 class TraversalValidator;
  67
  68 template <class ParentT>
  69 class StageHandlerMixin;
  70
  71 /*! \ingroup GrpSystemActionBase
  72     \ingroup GrpLibOSGSystem
  73     \nohierarchy
  74  */
  75
  76 struct RenderDataSlotDesc
  77 {
  78     typedef Action                   ParentT;
  79     typedef MFUnrecFieldContainerPtr DataStore;
  80
  81     typedef ActionDataSlotPool       DataSlotIdPool;
  82
  83
  84     static void dumpElement(const FieldContainer *pVal)
  85     {
  86         fprintf(stderr, "%p", static_cast<const void *>(pVal));
  87
  88         if(pVal != NULL)
  89         {
  90             fprintf(stderr, " (%s)", pVal->getType().getCName());
  91         }
  92     }
  93 };
  94
  95 /*! \ingroup GrpSystemActionBase
  96  */
  97
  98 typedef DataSlotMixin<
  99             MixinHead <
 100                 RenderDataSlotDesc > > RenderActionBaseParent;
 101
 102
 103
 104 /*! \brief Base class using the render action interface of window
 105     \ingroup GrpSystemActionBase
 106     \ingroup GrpLibOSGSystem
 107  */
 108
 109 class OSG_SYSTEM_DLLMAPPING RenderActionBase : public RenderActionBaseParent
 110 {
 111     /*==========================  PUBLIC  =================================*/
 112
 113   public:
 114
 115     typedef RenderActionBaseParent                     Inherited;
 116     typedef RenderPropertiesPool::Singleton::ValueType RenderPropType;
 117
 118     static StatElemDesc<StatTimeElem> statTravTime;
 119 //    static StatElemDesc<StatIntElem>  statCullTestedNodes;
 120 //    static StatElemDesc<StatIntElem>  statCulledNodes;
 121
 122
 123     /*---------------------------------------------------------------------*/
 124     /*! \name               Rendering Environment                          */
 125     /*! \{                                                                 */
 126
 127     Viewarea   *getViewarea      (void                      ) const;
 128     void        setViewarea      (Viewarea      *pViewarea  );
 129
 130     Node       *getTraversalRoot (void                      ) const;
 131     void        setTraversalRoot (Node          *pTravRoot  );
 132
 133     Camera     *getCamera        (void                      ) const;
 134     void        setCamera        (Camera        *pCamera    );
 135
 136     Background *getBackground    (void                      ) const;
 137     void        setBackground    (Background    *pBackground);
 138
 139     Window     *getWindow        (void                      ) const;
 140     void        setWindow        (Window        *pWindow    );
 141
 142     Material   *getGlobalOverride(void                      ) const;
 143     void        setGlobalOverride(Material      *pMat       );
 144
 145     /*! \}                                                                 */
 146     /*---------------------------------------------------------------------*/
 147     /*! \name                   Statistics                                 */
 148     /*! \{                                                                 */
 149
 150     StatCollector *getStatCollector  (void                ) const;
 151     void           setStatCollector  (StatCollector *pStat);
 152
 153     bool           getResetStatistics(void                ) const;
 154     void           setResetStatistics(bool           value);
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                   Culling                                    */
 159     /*! \{                                                                 */
 160
 161     // control activation of frustum culling
 162     virtual bool getFrustumCulling         (void            ) const;
 163     virtual void setFrustumCulling         (bool val = true );
 164
 165     virtual bool getCorrectTwoSidedLighting(void            ) const;
 166     virtual void setCorrectTwoSidedLighting(bool val = true );
 167
 168     // control drawing of checked volumes
 169     virtual bool getVolumeDrawing          (void            ) const;
 170     virtual void setVolumeDrawing          (bool val = false);
 171
 172     virtual bool getZWriteTrans            (void            ) const;
 173     virtual void setZWriteTrans            (bool val = false);
 174
 175     // control automatic frustum calculation
 176             bool                 getAutoFrustum   (void                ) const;
 177             void                 setAutoFrustum   (bool val = true     );
 178
 179     // control frustum
 180     virtual const FrustumVolume &getFrustum       (void                ) const;
 181     virtual void                 setFrustum       (FrustumVolume &frust);
 182
 183
 184     /*----------- multi-frame buffering / split cull/draw -------------------*/
 185
 186     void setUseGLFinish(bool bVal);
 187     bool getUseGLFinish(void     );
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                   Lights                                     */
 192     /*! \{                                                                 */
 193
 194     virtual Action::ResultE start    (void               );
 195     virtual Action::ResultE stop     (Action::ResultE res);
 196
 197     virtual void            frameInit(void               );
 198
 199     /*! \}                                                                 */
 200     /*---------------------------------------------------------------------*/
 201     /*! \name                   Lights                                     */
 202     /*! \{                                                                 */
 203
 204     TraversalValidator *getTravValidator (void     );
 205     UInt16              getFrameTravCount(void     );
 206
 207     void                setDrawerId      (Int32 iId);
 208     void                setDrawableId    (Int32 iId);
 209
 210     /*! \}                                                                 */
 211     /*---------------------------------------------------------------------*/
 212     /*! \name                   Lights                                     */
 213     /*! \{                                                                 */
 214
 215     RenderPropType getRenderProperties  (void                );
 216     void           setRenderProperties  (RenderPropType oProp);
 217     void           resetRenderProperties(void                );
 218
 219     void           addRenderProperties  (RenderPropType oProp);
 220     void           subRenderProperties  (RenderPropType oProp);
 221
 222
 223     void           setDrawPartPar       (bool           bVal );
 224     bool           getDrawPartPar       (void                );
 225
 226     /*! \}                                                                 */
 227     /*---------------------------------------------------------------------*/
 228     /*! \name                   Lights                                     */
 229     /*! \{                                                                 */
 230
 231     // tmp for testing
 232     virtual Int32 getActivePartitionIdx(void                              )= 0;
 233     virtual Int32 getLastPartitionIdx  (void                              )= 0;
 234
 235     virtual void  readdPartitionByIndex(UInt32                uiPartIdx   )= 0;
 236
 237     /*! \}                                                                 */
 238     /*=========================  PROTECTED  ===============================*/
 239
 240   protected:
 241
 242     template <class ParentT>
 243     friend class StageHandlerMixin;
 244
 245     friend class Viewport;
 246
 247     /*---------------------------------------------------------------------*/
 248     /*! \name                   Constructors                               */
 249     /*! \{                                                                 */
 250
 251     RenderActionBase(void);
 252     RenderActionBase(const RenderActionBase &source);
 253
 254     /*! \}                                                                 */
 255     /*---------------------------------------------------------------------*/
 256     /*! \name                   Destructor                                 */
 257     /*! \{                                                                 */
 258
 259     virtual ~RenderActionBase(void);
 260
 261     /*! \}                                                                 */
 262     /*---------------------------------------------------------------------*/
 263     /*! \name                   Internal updates                           */
 264     /*! \{                                                                 */
 265
 266     // tmp for testing
 267     virtual void  pushPartition        (UInt32                    uiCopyOnPush,
 268                                         RenderPartitionBase::Mode eMode   )= 0;
 269
 270     virtual void  popPartition         (void                              )= 0;
 271
 272     virtual void  beginPartitionGroup  (void                              )= 0;
 273     virtual void  endPartitionGroup    (void                              )= 0;
 274
 275     /*! \}                                                                 */
 276     /*---------------------------------------------------------------------*/
 277     /*! \name                   Internal updates                           */
 278     /*! \{                                                                 */
 279
 280     Int32 getDrawerId  (void);
 281     Int32 getDrawableId(void);
 282
 283     /*! \}                                                                 */
 284     //-----------------------------------------------------------------------
 285     //   instance variables
 286     //-----------------------------------------------------------------------
 287
 288     Camera             *_pCamera;
 289     Background         *_pBackground;
 290     Window             *_pWindow;
 291     Viewarea           *_pViewarea;
 292     Node               *_pTraversalRoot;
 293     Material           *_pGlobalOverride;
 294
 295     StatCollector      *_pStatistics;
 296     TraversalValidator *_pTravValidator;
 297
 298     bool                _bResetStatistics;
 299     bool                _bUseGLFinish;
 300
 301     // frustum culling attributes
 302
 303     bool                _bFrustumCulling;
 304     bool                _bVolumeDrawing;
 305     bool                _bZWriteTrans;
 306     bool                _bAutoFrustum;
 307     bool                _bCorrectTwoSidedLighting;
 308
 309     FrustumVolume       _oFrustum;
 310
 311     UInt16              _uiFrameTravCount;
 312
 313     Int32               _iDrawerId;
 314     Int32               _iDrawableId;
 315
 316     RenderPropType      _oCurrentRenderProp;
 317     bool                _bDrawPartPar;
 318
 319     /*==========================  PRIVATE  ================================*/
 320
 321   private:
 322
 323     /*!\brief prohibit default function (move to 'public' if needed) */
 324     void operator =(const RenderActionBase &source);
 325 };
 326
 327
 328 OSG_END_NAMESPACE
 329
 330 #include "OSGRenderActionBase.inl"
 331
 332 #endif /* _OSGRENDERACTIONBASE_H_ */