Source/Contrib/ComputeBase/Base/OSGComputeAlgorithm.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 _OSGCOMPUTEALGORITHM_H_
  40 #define _OSGCOMPUTEALGORITHM_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include <queue>
  46
  47 #include "OSGComputeAlgorithmBase.h"
  48 #include "OSGAction.h"
  49 #include "OSGDrawTask.h"
  50
  51 OSG_BEGIN_NAMESPACE
  52
  53 class DrawEnv;
  54 class Action;
  55
  56 //! Stage
  57 //! \ingroup GrpSystemNodeCoresMisc
  58
  59 class OSG_CONTRIBCOMPUTEBASE_DLLMAPPING ComputeAlgorithm :
  60     public ComputeAlgorithmBase
  61 {
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                       Sync                                   */
  68     /*! \{                                                                 */
  69
  70     virtual void changed(ConstFieldMaskArg whichField,
  71                          UInt32            origin,
  72                          BitVector         detail);
  73
  74     /*---------------------------------------------------------------------*/
  75     /*! \name                      Execute                                 */
  76     /*! \{                                                                 */
  77
  78     virtual Action::ResultE renderEnter(Action          *pAction ) = 0;
  79     virtual Action::ResultE renderLeave(Action          *pAction ) = 0;
  80     virtual void            execute    (HardwareContext *pContext,
  81                                         DrawEnv         *pEnv    ) = 0;
  82
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                        Dump                                  */
  86     /*! \{                                                                 */
  87
  88     virtual void dump(      UInt32    uiIndent = 0,
  89                       const BitVector bvFlags  = 0) const;
  90
  91     /*! \}                                                                 */
  92     /*=========================  PROTECTED  ===============================*/
  93
  94   protected:
  95
  96     typedef ComputeAlgorithmBase Inherited;
  97
  98     /*---------------------------------------------------------------------*/
  99     /*! \name                   Constructors                               */
 100     /*! \{                                                                 */
 101
 102     ComputeAlgorithm(void);
 103     ComputeAlgorithm(const ComputeAlgorithm &source);
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                   Destructors                                */
 108     /*! \{                                                                 */
 109
 110     virtual ~ComputeAlgorithm(void);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                   Draw                                       */
 115     /*! \{                                                                 */
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                      Init                                    */
 120     /*! \{                                                                 */
 121
 122     static void initMethod(InitPhase ePhase);
 123
 124     /*! \}                                                                 */
 125     /*==========================  PRIVATE  ================================*/
 126
 127   private:
 128
 129     friend class FieldContainer;
 130     friend class ComputeAlgorithmBase;
 131
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                   thread local                               */
 134     /*! \{                                                                 */
 135
 136     /*! \}                                                                 */
 137     /*---------------------------------------------------------------------*/
 138     /*! \name                    load thread                               */
 139     /*! \{                                                                 */
 140
 141     /*! \}                                                                 */
 142     /*---------------------------------------------------------------------*/
 143
 144     /*!\brief prohibit default function (move to 'public' if needed) */
 145     void operator =(const ComputeAlgorithm &source);
 146 };
 147
 148 typedef ComputeAlgorithm *ComputeAlgorithmP;
 149
 150 class OSG_CONTRIBCOMPUTEBASE_DLLMAPPING ComputeAlgorithmDrawTask :
 151     public DrawTask
 152 {
 153     /*==========================  PUBLIC  =================================*/
 154
 155   public:
 156
 157     static const UInt32 Algorithm            = Inherited::LastType + 1;
 158     static const UInt32 AlgorithmWithBarrier = Inherited::LastType + 2;
 159     static const UInt32 LastType             = AlgorithmWithBarrier;
 160
 161     typedef DrawTask Inherited;
 162
 163
 164     /*---------------------------------------------------------------------*/
 165     /*! \name                   Statistic                                  */
 166     /*! \{                                                                 */
 167
 168     ComputeAlgorithmDrawTask(UInt32 uiType);
 169     ComputeAlgorithmDrawTask(ComputeAlgorithmP pAlgorithm, UInt32 uiType);
 170
 171     /*! \}                                                                 */
 172     /*---------------------------------------------------------------------*/
 173     /*! \name                    Access                                    */
 174     /*! \{                                                                 */
 175
 176     virtual void execute(HardwareContext *pContext, DrawEnv *pEnv);
 177
 178     /*! \}                                                                 */
 179     /*---------------------------------------------------------------------*/
 180     /*! \name                    Access                                    */
 181     /*! \{                                                                 */
 182
 183     void activateBarrier(bool              bVal      );
 184     void setAlgorithm   (ComputeAlgorithmP pAlgorithm);
 185
 186     /*! \}                                                                 */
 187     /*---------------------------------------------------------------------*/
 188     /*! \name                    Access                                    */
 189     /*! \{                                                                 */
 190
 191     void waitForBarrier(void);
 192
 193     /*! \}                                                                 */
 194     /*---------------------------------------------------------------------*/
 195     /*! \name                    Access                                    */
 196     /*! \{                                                                 */
 197
 198     /*! \}                                                                 */
 199     /*---------------------------------------------------------------------*/
 200     /*! \name                    Access                                    */
 201     /*! \{                                                                 */
 202
 203     virtual void dump(UInt32 uiIndent);
 204
 205     /*! \}                                                                 */
 206     /*=========================  PROTECTED  ===============================*/
 207
 208   protected:
 209
 210     /*---------------------------------------------------------------------*/
 211     /*! \name                      Member                                  */
 212     /*! \{                                                                 */
 213
 214     ComputeAlgorithmUnrecPtr _pAlgorithm;
 215     BarrierRefPtr            _pBarrier;
 216
 217     /*! \}                                                                 */
 218     /*---------------------------------------------------------------------*/
 219     /*! \name                   Destructor                                 */
 220     /*! \{                                                                 */
 221
 222     virtual ~ComputeAlgorithmDrawTask(void);
 223
 224     /*! \}                                                                 */
 225     /*==========================  PRIVATE  ================================*/
 226
 227   private:
 228
 229     /*! \brief prohibit default function (move to 'public' if needed) */
 230     ComputeAlgorithmDrawTask(const ComputeAlgorithmDrawTask &source);
 231     /*! \brief prohibit default function (move to 'public' if needed) */
 232     void operator =(const ComputeAlgorithmDrawTask &source);
 233 };
 234
 235 typedef RefCountPtr<ComputeAlgorithmDrawTask,
 236                     MemObjRefCountPolicy   > ComputeAlgorithmDrawTaskRefPtr;
 237
 238 OSG_END_NAMESPACE
 239
 240 #include "OSGComputeAlgorithmBase.inl"
 241 #include "OSGComputeAlgorithm.inl"
 242
 243 #endif /* _OSGCOMPUTEALGORITHM_H_ */