Source/Contrib/ComputeBase/Base/OSGComputeCallbackAlgorithm.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGCOMPUTECALLBACKALGORITHM_H_
  40 #define _OSGCOMPUTECALLBACKALGORITHM_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGComputeCallbackAlgorithmBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief ComputeCallbackAlgorithm class. See \ref
  50            PageGroupComputeCallbackAlgorithm for a description.
  51 */
  52
  53 class OSG_CONTRIBCOMPUTEBASE_DLLMAPPING ComputeCallbackAlgorithm :
  54     public ComputeCallbackAlgorithmBase
  55 {
  56   protected:
  57
  58     /*==========================  PUBLIC  =================================*/
  59
  60   public:
  61
  62     typedef ComputeCallbackAlgorithmBase Inherited;
  63     typedef ComputeCallbackAlgorithm     Self;
  64
  65     /*---------------------------------------------------------------------*/
  66     /*! \name                      Sync                                    */
  67     /*! \{                                                                 */
  68
  69     virtual void changed(ConstFieldMaskArg whichField,
  70                          UInt32            origin,
  71                          BitVector         details    );
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name                     Output                                   */
  76     /*! \{                                                                 */
  77
  78     void setCallback(ComputeFunctor func,
  79                      std::string    createSymbol);
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                     Output                                   */
  83     /*! \{                                                                 */
  84
  85     virtual Action::ResultE renderEnter(Action          *pAction );
  86     virtual Action::ResultE renderLeave(Action          *pAction );
  87     virtual void            execute    (HardwareContext *pContext,
  88                                         DrawEnv         *pEnv    );
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                     Output                                   */
  93     /*! \{                                                                 */
  94
  95     virtual void dump(      UInt32     uiIndent = 0,
  96                       const BitVector  bvFlags  = 0) const;
  97
  98     /*! \}                                                                 */
  99     /*=========================  PROTECTED  ===============================*/
 100
 101   protected:
 102
 103     // Variables should all be in CallbackAlgorithmBase.
 104
 105     /*---------------------------------------------------------------------*/
 106     /*! \name                  Constructors                                */
 107     /*! \{                                                                 */
 108
 109     ComputeCallbackAlgorithm(void);
 110     ComputeCallbackAlgorithm(const ComputeCallbackAlgorithm &source);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                   Destructors                                */
 115     /*! \{                                                                 */
 116
 117     virtual ~ComputeCallbackAlgorithm(void);
 118
 119     /*! \}                                                                 */
 120     /*---------------------------------------------------------------------*/
 121     /*! \name                      Init                                    */
 122     /*! \{                                                                 */
 123
 124     static void initMethod(InitPhase ePhase);
 125
 126     /*! \}                                                                 */
 127     /*==========================  PRIVATE  ================================*/
 128
 129   private:
 130
 131     friend class FieldContainer;
 132     friend class ComputeCallbackAlgorithmBase;
 133
 134     // prohibit default functions (move to 'public' if you need one)
 135     void operator =(const ComputeCallbackAlgorithm &source);
 136 };
 137
 138 typedef ComputeCallbackAlgorithm *ComputeCallbackAlgorithmP;
 139
 140 OSG_END_NAMESPACE
 141
 142 #include "OSGComputeCallbackAlgorithmBase.inl"
 143 #include "OSGComputeCallbackAlgorithm.inl"
 144
 145 #endif /* _OSGCOMPUTECALLBACKALGORITHM_H_ */