Source/System/RenderingBackend/OSGStateSortTreeBuilder.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 _OSGSTATESORTTREEBUILDER_H_
  40 #define _OSGSTATESORTTREEBUILDER_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 //---------------------------------------------------------------------------
  46 //  Includes
  47 //---------------------------------------------------------------------------
  48
  49 #include <map>
  50
  51 #include "OSGHashSorter.h"
  52
  53 #include "OSGTreeBuilderBase.h"
  54
  55 OSG_BEGIN_NAMESPACE
  56
  57 //---------------------------------------------------------------------------
  58 //  Forward References
  59 //---------------------------------------------------------------------------
  60
  61 //---------------------------------------------------------------------------
  62 //   Types
  63 //---------------------------------------------------------------------------
  64
  65 //---------------------------------------------------------------------------
  66 //  Class
  67 //---------------------------------------------------------------------------
  68
  69
  70 /*! \brief StateSortTreeBuilder class
  71     \ingroup GrpSystemRenderingBackendTreeBuild
  72     \ingroup GrpLibOSGSystem
  73  */
  74
  75 class OSG_SYSTEM_DLLMAPPING StateSortTreeBuilder : public TreeBuilderBase
  76 {
  77   public:
  78
  79     //-----------------------------------------------------------------------
  80     //   constants
  81     //-----------------------------------------------------------------------
  82
  83     //-----------------------------------------------------------------------
  84     //   enums
  85     //-----------------------------------------------------------------------
  86
  87     //-----------------------------------------------------------------------
  88     //   types
  89     //-----------------------------------------------------------------------
  90
  91     typedef TreeBuilderBase  Inherited;
  92
  93     //-----------------------------------------------------------------------
  94     //   class functions
  95     //-----------------------------------------------------------------------
  96
  97     //-----------------------------------------------------------------------
  98     //   class functions
  99     //-----------------------------------------------------------------------
 100
 101     //-----------------------------------------------------------------------
 102     //   instance functions
 103     //-----------------------------------------------------------------------
 104
 105              StateSortTreeBuilder(void);
 106     virtual ~StateSortTreeBuilder(void);
 107
 108     /*------------------------- your_category -------------------------------*/
 109
 110     /*------------------------- your_operators ------------------------------*/
 111
 112     /*------------------------- assignment ----------------------------------*/
 113
 114     virtual void setNodePool(RenderTreeNodePool *pNodePool);
 115
 116     /*------------------------- comparison ----------------------------------*/
 117
 118     virtual void reset(void);
 119
 120     /*------------------------- comparison ----------------------------------*/
 121
 122     virtual void add(RenderActionBase    *pAction,
 123                      RenderPartitionBase *pPart,
 124                      DrawFunctor         &drawFunc,
 125                      State               *pState,
 126                      StateOverride       *pStateOverride);
 127
 128     virtual void draw(DrawEnv             &denv,
 129                       RenderPartitionBase *part);
 130
 131     /*-------------------------- comparison ---------------------------------*/
 132
 133     /*-------------------------- comparison ---------------------------------*/
 134
 135   protected:
 136
 137     //-----------------------------------------------------------------------
 138     //   enums
 139     //-----------------------------------------------------------------------
 140
 141     //-----------------------------------------------------------------------
 142     //   types
 143     //-----------------------------------------------------------------------
 144
 145     typedef HashSorter                                    Sorter;
 146
 147     typedef std::map<UInt32 , RenderTreeNode *>           MapSorter;
 148     typedef std::map<UInt32 , RenderTreeNode *>::iterator MapSorterIt;
 149
 150     //-----------------------------------------------------------------------
 151     //   class variables
 152     //-----------------------------------------------------------------------
 153
 154     RenderTreeNode *_pRoot;
 155     Sorter          _oSorter;
 156     MapSorter       _mFallbackSorter;
 157
 158     //-----------------------------------------------------------------------
 159     //   class functions
 160     //-----------------------------------------------------------------------
 161
 162     //-----------------------------------------------------------------------
 163     //   instance variables
 164     //-----------------------------------------------------------------------
 165
 166     //-----------------------------------------------------------------------
 167     //   instance functions
 168     //-----------------------------------------------------------------------
 169
 170   private:
 171
 172     //-----------------------------------------------------------------------
 173     //   enums
 174     //-----------------------------------------------------------------------
 175
 176     //-----------------------------------------------------------------------
 177     //   types
 178     //-----------------------------------------------------------------------
 179
 180     //-----------------------------------------------------------------------
 181     //   friend classes
 182     //-----------------------------------------------------------------------
 183
 184     //-----------------------------------------------------------------------
 185     //   friend functions
 186     //-----------------------------------------------------------------------
 187
 188     //-----------------------------------------------------------------------
 189     //   class variables
 190     //-----------------------------------------------------------------------
 191
 192     //-----------------------------------------------------------------------
 193     //   class functions
 194     //-----------------------------------------------------------------------
 195
 196     //-----------------------------------------------------------------------
 197     //   instance variables
 198     //-----------------------------------------------------------------------
 199
 200     //-----------------------------------------------------------------------
 201     //   instance functions
 202     //-----------------------------------------------------------------------
 203
 204     /*!\brief prohibit default function (move to 'public' if needed) */
 205     StateSortTreeBuilder(const StateSortTreeBuilder &other);
 206     void operator =(const StateSortTreeBuilder &source);
 207 };
 208
 209 //---------------------------------------------------------------------------
 210 //   Exported Types
 211 //---------------------------------------------------------------------------
 212
 213 OSG_END_NAMESPACE
 214
 215 #include "OSGStateSortTreeBuilder.inl"
 216
 217 #endif /* _OSGSTATESORTTREEBUILDER_H_ */
 218
 219