Source/System/Action/RenderAction/OSGRenderPartition.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 _OSGRENDERPARTITION_H_
  40 #define _OSGRENDERPARTITION_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 //---------------------------------------------------------------------------
  46 //  Includes
  47 //---------------------------------------------------------------------------
  48
  49 #include <boost/function.hpp>
  50
  51 #include "OSGRenderPartitionBase.h"
  52 #include "OSGRenderActionFwd.h"
  53 #include "OSGDrawEnv.h"
  54 #include "OSGStatIntElem.h"
  55 #include "OSGFrustumVolume.h"
  56
  57 #include "OSGViewport.h"
  58 #include "OSGBackground.h"
  59 #include "OSGForegroundFields.h"
  60 #include "OSGMaterial.h"
  61 #include "OSGNamedPool.h"
  62 #include "OSGStateOverride.h"
  63
  64 #include <stack>
  65
  66 OSG_BEGIN_NAMESPACE
  67
  68 //---------------------------------------------------------------------------
  69 //  Forward References
  70 //---------------------------------------------------------------------------
  71
  72 class State;
  73 class FrameBufferObject;
  74 class RenderAction;
  75
  76 //---------------------------------------------------------------------------
  77 //   Types
  78 //---------------------------------------------------------------------------
  79
  80 //---------------------------------------------------------------------------
  81 //  Class
  82 //---------------------------------------------------------------------------
  83
  84 /*! \brief RenderPartition is the core class for keeping track of the actions
  85            necessary to draw a scene.
  86
  87     \ingroup GrpSystemRenderAction
  88     \ingroup GrpLibOSGSystem
  89  */
  90
  91 class OSG_SYSTEM_DLLMAPPING RenderPartition : public RenderPartitionBase
  92 {
  93   public:
  94
  95     //-----------------------------------------------------------------------
  96     //   constants
  97     //-----------------------------------------------------------------------
  98
  99     /*! Number of nodes tested for culling */
 100     static StatElemDesc<StatIntElem>  statCullTestedNodes;
 101
 102     /*! Number of nodes culled */
 103     static StatElemDesc<StatIntElem>  statCulledNodes;
 104
 105     //-----------------------------------------------------------------------
 106     //   enums
 107     //-----------------------------------------------------------------------
 108
 109     //-----------------------------------------------------------------------
 110     //   types
 111     //-----------------------------------------------------------------------
 112
 113     /*! MatrixStore is stored internally to keep track of the current matrix.
 114         The UInt32 is used to quickly identify the same matrix without having
 115         to compare actual matrix elements.
 116     */
 117 #ifndef OSG_ENABLE_DOUBLE_MATRIX_STACK
 118     typedef std::pair<UInt32, Matrix>               MatrixStore;
 119     typedef Matrix                                  MatrixT;
 120 #else
 121     typedef std::pair<UInt32, Matrix4d>             MatrixStore;
 122     typedef                   Matrix4d              MatrixT;
 123 #endif
 124
 125     /*! DrawFunctor is the signature for the methods that are called
 126         from within the draw tree
 127     */
 128     typedef DrawEnv::DrawFunctor                    DrawFunctor;
 129
 130     /*! SimpleDrawCallback is the type of functions that are used for simple
 131         partitions (i.e. the ones that only call one function and do not draw
 132         Nodes
 133     */
 134     typedef boost::function<void (DrawEnv *)>       SimpleDrawCallback;
 135
 136     /*! BuildKeyMap is used to index from the material's sortKey to the
 137         StateSorter that keeps the tree for that sort key
 138      */
 139     typedef std::map<Int32, TreeBuilderBase *>      BuildKeyMap;
 140     typedef BuildKeyMap::iterator                   BuildKeyMapIt;
 141     typedef BuildKeyMap::const_iterator             BuildKeyMapConstIt;
 142
 143     /*! VisibilityStack keeps track of the planes of the current frustum that
 144         need to be tested. If a bounding volume is inside all
 145         planes, none need to be tested for its children.
 146     */
 147     typedef std::vector<FrustumVolume::PlaneSet>    VisibilityStack;
 148
 149     /*! OverrideStack keeps track of active StateOverrides during traversal */
 150     typedef std::stack<StateOverride *>             OverrideStack;
 151
 152     /*! MatrixStack keeps track of matrices during traversal */
 153     typedef std::vector<MatrixStore>                MatrixStack;
 154
 155     typedef std::vector<RenderPartition *>          GroupStore;
 156
 157     typedef std::vector<RenderFunctor>              RenderCallbackStore;
 158
 159     //-----------------------------------------------------------------------
 160     //   class functions
 161     //-----------------------------------------------------------------------
 162
 163     //-----------------------------------------------------------------------
 164     //   class functions
 165     //-----------------------------------------------------------------------
 166
 167     //-----------------------------------------------------------------------
 168     //   instance functions
 169     //-----------------------------------------------------------------------
 170
 171     /*------------------------- your_category -------------------------------*/
 172
 173     void setAction         (RenderAction          *pAction         );
 174
 175     void setNodePool       (RenderTreeNodePool    *pNodePool       );
 176     void setStatePool      (StateOverridePool     *pStatePool      );
 177     void setTreeBuilderPool(TreeBuilderPool       *pTreeBuilderPool);
 178     void setStatCollector  (StatCollectorP         pStatCollector  );
 179
 180     /*------------------------- your_operators ------------------------------*/
 181
 182     StatCollectorP getStatCollector(void);
 183
 184     /*------------------------- your_operators ------------------------------*/
 185
 186     void      setWindow        (Window     *pWindow    );
 187     Window   *getWindow        (void                   );
 188
 189     void      setBackground    (Background *pBackground);
 190
 191     void      pushToForegrounds(Foreground *pForeground);
 192     void      clearForegrounds (void                   );
 193
 194     /*------------------------- your_operators ------------------------------*/
 195
 196
 197           void      setupProjection     (const Matrix4f &projection,
 198                                          const Matrix4f &translation);
 199
 200     const Matrix4f &getFullProjection   (      void                 );
 201     const Matrix4f &getProjection       (      void                 );
 202     const Matrix4f &getProjectionTrans  (      void                 );
 203
 204     const Matrix4f &getVPFullProjection (      void                 );
 205     const Matrix4f &getVPProjection     (      void                 );
 206     const Matrix4f &getVPProjectionTrans(      void                 );
 207
 208           void      setupViewing        (const Matrix4f &matrix     );
 209
 210     const Matrix4f &getViewing          (      void                 );
 211     const Matrix4f &getCameraToWorld    (      void                 );
 212     const Matrix4f &getVPViewing        (      void                 );
 213     const Matrix4f &getVPCameraToWorld  (      void                 );
 214
 215     /*------------------------- your_operators ------------------------------*/
 216
 217     void addPartition(RenderPartition *pPart);
 218
 219     /*------------------------- your_operators ------------------------------*/
 220
 221     DrawEnv &getDrawEnv(void);
 222
 223     UInt32   getKeyGen (void) const;
 224
 225     /*------------------------- your_operators ------------------------------*/
 226
 227     void   setNear(Real32 camNear);
 228     void   setFar (Real32 camFar );
 229
 230     Real32 getNear(void          );
 231     Real32 getFar (void          );
 232
 233     /*------------------------- your_operators ------------------------------*/
 234
 235     void  calcFrustum          (void                );
 236
 237     void  setViewportDimension (Int32  iPixelLeft,
 238                                 Int32  iPixelBottom,
 239                                 Int32  iPixelRight,
 240                                 Int32  iPixelTop,
 241                                 bool   bFull        );
 242
 243     void  calcViewportDimension(Real32 rLeft,
 244                                 Real32 rBottom,
 245                                 Real32 rRight,
 246                                 Real32 rTop,
 247
 248                                 UInt16 iTargetWidth,
 249                                 UInt16 iTargetHeight);
 250
 251     Int32 getViewportWidth     (void                );
 252     Int32 getViewportHeight    (void                );
 253
 254
 255     /*------------------------- your_operators ------------------------------*/
 256
 257     void setSetupMode            (UInt32           uiSetupMode   );
 258     void addSetupModeBit         (UInt32           uiSetupModeBit);
 259     void subSetupMode            (UInt32           uiSetupModeBit);
 260
 261     void initFrom                (RenderPartition *pSource,
 262                                   RenderPartition *pInitial,
 263                                   Int32            uiCopyOnPush  );
 264
 265     void initVPMatricesFromCamera(void                           );
 266
 267     void setVPCameraMatrices     (const Matrix  &mFullprojection,
 268                                   const Matrix  &mProjection,
 269                                   const Matrix  &mProjectionTrans,
 270                                   const Matrix  &mViewing,
 271                                   const Matrix  &mToWorld,
 272                                   const Matrix  &mWorldToScreen  );
 273
 274     /*------------------------- your_operators ------------------------------*/
 275
 276     void execute(void);
 277     void disable(void);
 278
 279     /*------------------------- assignment ----------------------------------*/
 280
 281     template<class MatrixType>
 282           void         pushMatrix        (const MatrixType &matrix);
 283           void         popMatrix         (      void              );
 284
 285     const Matrix      &topMatrix         (      void              );
 286
 287     const Matrix      &getModelMatrix    (      void              ) const;
 288
 289     const MatrixT     &getModelViewMatrix(      void              ) const;
 290
 291     const MatrixStore &getMatrixStackTop (      void              ) const;
 292
 293     /*------------------------- comparison ----------------------------------*/
 294
 295     void dropFunctor(DrawFunctor &func,
 296                      State       *pState,
 297                      Int32        uiBuildKey,
 298                      bool         bIgnoreOverrids = false);
 299
 300     void dropFunctor(SimpleDrawCallback &oFunc);
 301
 302     /*------------------------- comparison ----------------------------------*/
 303
 304           void           pushState          (void              );
 305           void           popState           (void              );
 306
 307           void           addOverride        (UInt32      uiSlot,
 308                                              StateChunk *pChunk);
 309
 310           void           subOverride        (UInt32      uiSlot,
 311                                              StateChunk *pChunk);
 312
 313     const StateOverride *getCurrentOverrides(void              ) const;
 314
 315     /*-------------------------- comparison ---------------------------------*/
 316
 317     Int32  allocateLightIndex(void);
 318     void   releaseLightIndex (void);
 319     UInt32 getLightState     (void) const;
 320
 321     /*-------------------------- comparison ---------------------------------*/
 322
 323     void setKeyGen(UInt32 uiKeyGen);
 324
 325     /*-------------------------- comparison ---------------------------------*/
 326
 327     void      overrideMaterial(Material *       pMaterial,
 328                                Node     * const pNode    );
 329
 330     Material *getMaterial     (void                     );
 331
 332     /*-------------------------- comparison ---------------------------------*/
 333
 334     void               setRenderTarget(FrameBufferObject *pTarget);
 335     FrameBufferObject *getRenderTarget(void                      );
 336
 337     void               setDrawBuffer  (GLenum             eBuffer);
 338
 339     /*-------------------------- comparison ---------------------------------*/
 340
 341     // test a single node
 342     bool isVisible      (Node *       pNode);
 343
 344     // visibility levels
 345     bool  pushVisibility(Node * const pNode);
 346     void  popVisibility (void              );
 347
 348     /*-------------------------- comparison ---------------------------------*/
 349
 350     // control activation of frustum culling
 351     bool                 getFrustumCulling(void                ) const;
 352     void                 setFrustumCulling(bool val = true     );
 353
 354     // control drawing of checked volumes
 355     bool                 getVolumeDrawing (void                ) const;
 356     void                 setVolumeDrawing (bool val = false    );
 357
 358     // control frustum
 359     const FrustumVolume &getFrustum       (void                ) const;
 360     void                 setFrustum       (FrustumVolume &frust);
 361
 362     /*-------------------------- comparison ---------------------------------*/
 363
 364     /*-------------------------- comparison ---------------------------------*/
 365
 366     /*-------------------------- comparison ---------------------------------*/
 367
 368     void init(void);
 369     void exit(void);
 370
 371     /*-------------------------- comparison ---------------------------------*/
 372
 373     void addPreRenderCallback (const RenderFunctor &oCallback);
 374     void addPostRenderCallback(const RenderFunctor &oCallback);
 375
 376     /*-------------------------- comparison ---------------------------------*/
 377
 378 #ifdef OSG_DEBUG
 379     void setDebugString(std::string szDebugString);
 380 #endif
 381
 382   protected:
 383
 384     //-----------------------------------------------------------------------
 385     //   enums
 386     //-----------------------------------------------------------------------
 387
 388     //-----------------------------------------------------------------------
 389     //   types
 390     //-----------------------------------------------------------------------
 391
 392     typedef RenderPartitionBase Inherited;
 393
 394     //-----------------------------------------------------------------------
 395     //   class variables
 396     //-----------------------------------------------------------------------
 397
 398     Mode                      _eMode;
 399     UInt32                    _uiSetupMode;
 400     bool                      _bDone;
 401
 402     GroupStore                _vGroupStore;
 403
 404     DrawEnv                   _oDrawEnv;
 405
 406     SimpleDrawCallback        _oSimpleDrawCallback;
 407
 408     Background               *_pBackground;
 409
 410     std::vector<Foreground*>  _vpForegrounds;
 411
 412     // Transform
 413
 414     UInt32                    _uiMatrixId;
 415     mutable bool              _modelMatrixValid;
 416
 417     MatrixStore               _modelViewMatrix;
 418     mutable Matrix            _modelMatrix;
 419
 420     MatrixStack               _modelViewMatrixStack;
 421
 422     // Roots
 423
 424     RenderTreeNodePool       *_pNodePool;
 425
 426     BuildKeyMap               _mMatTrees;
 427     BuildKeyMap               _mTransMatTrees;
 428
 429     // Active Elements
 430
 431     UInt32                    _uiActiveMatrix;
 432
 433     // State
 434
 435     StateOverridePool        *_pStatePool;
 436
 437     OverrideStack             _sStateOverrides;
 438
 439     TreeBuilderPool          *_pTreeBuilderPool;
 440
 441     // State
 442
 443     Int32                     _iNextLightIndex;
 444     UInt32                    _uiLightState;
 445
 446     UInt32                    _uiKeyGen;
 447
 448     // Material Override
 449
 450     Material                 *_pMaterial;
 451     Node                     *_pMaterialNode;
 452     bool                      _addedStateOverride;
 453     // Target
 454
 455     FrameBufferObject        *_pRenderTarget;
 456     GLenum                    _eDrawBuffer;
 457
 458
 459     // Culling
 460
 461     VisibilityStack           _visibilityStack;
 462
 463     bool                      _bFrustumCulling;
 464     bool                      _bVolumeDrawing;
 465     bool                      _bAutoFrustum;
 466     FrustumVolume             _oFrustum;
 467
 468     RenderCallbackStore       _vPreRenderCallbacks;
 469     RenderCallbackStore       _vPostRenderCallbacks;
 470
 471     Node                     *_pNode;
 472
 473 #ifdef OSG_DEBUG
 474      // Debug
 475
 476     std::string               _szDebugString;
 477 #endif
 478
 479     //-----------------------------------------------------------------------
 480     //   class functions
 481     //-----------------------------------------------------------------------
 482
 483     //-----------------------------------------------------------------------
 484     //   instance variables
 485     //-----------------------------------------------------------------------
 486
 487     //-----------------------------------------------------------------------
 488     //   instance functions
 489     //-----------------------------------------------------------------------
 490
 491     RenderPartition(Mode eMode = StateSorting);
 492
 493     virtual ~RenderPartition(void);
 494
 495     /*-------------------------- comparison ---------------------------------*/
 496
 497     void  reset            (Mode  eMode = StateSorting);
 498
 499     void  updateModelMatrix(void                      ) const;
 500
 501     void  setNode          (Node *pNode               );
 502     Node *getNode          (void                      );
 503
 504     /*-------------------------- comparison ---------------------------------*/
 505
 506     bool pushShaderState(State *pState                       );
 507
 508     // Roots
 509     void setupExecution (bool   bUpdateGlobalViewport = false);
 510     void doExecution    (bool   bRestoreViewport      = false);
 511
 512     /*-------------------------- comparison ---------------------------------*/
 513
 514     virtual void execute(HardwareContext *pContext, DrawEnv *pEnv    );
 515     virtual void dump   (UInt32           uiIndent);
 516
 517   private:
 518
 519     //-----------------------------------------------------------------------
 520     //   enums
 521     //-----------------------------------------------------------------------
 522
 523     //-----------------------------------------------------------------------
 524     //   types
 525     //-----------------------------------------------------------------------
 526
 527     //-----------------------------------------------------------------------
 528     //   friend classes
 529     //-----------------------------------------------------------------------
 530
 531     friend class SimplePool<RenderPartition,
 532                             PoolDefaultTag,
 533                             MemObjRefCountPolicy,
 534                             NoLockPolicy        >;
 535
 536     friend class RenderAction;
 537
 538     //-----------------------------------------------------------------------
 539     //   friend functions
 540     //-----------------------------------------------------------------------
 541
 542     //-----------------------------------------------------------------------
 543     //   class variables
 544     //-----------------------------------------------------------------------
 545
 546     //-----------------------------------------------------------------------
 547     //   class functions
 548     //-----------------------------------------------------------------------
 549
 550     //-----------------------------------------------------------------------
 551     //   instance variables
 552     //-----------------------------------------------------------------------
 553
 554     //-----------------------------------------------------------------------
 555     //   instance functions
 556     //-----------------------------------------------------------------------
 557
 558     /*!\brief prohibit default function (move to 'public' if needed) */
 559     RenderPartition(const RenderPartition &source);
 560     void operator =(const RenderPartition &source);
 561 };
 562
 563 //---------------------------------------------------------------------------
 564 //   Exported Types
 565 //---------------------------------------------------------------------------
 566
 567 OSG_END_NAMESPACE
 568
 569 #include "OSGRenderPartition.inl"
 570
 571 #endif /* _OSGRENDERPARTITION_H_ */
 572
 573