Source/Contrib/ComputeBase/Base/OSGAlgorithmComputeElementData.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 _OSGALGORITHMCOMPUTEELEMENTDATA_H_
  40 #define _OSGALGORITHMCOMPUTEELEMENTDATA_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGAlgorithmComputeElementDataBase.h"
  46 #include "OSGComputeAlgorithm.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class AlgorithmComputeElement;
  51
  52 /*! \brief AlgorithmComputeElementData class. See \ref
  53            PageGroupAlgorithmComputeElementData for a description.
  54
  55     \ingroup GrpEffectsGroupsHDRObj
  56     \ingroup GrpLibOSGEffectsGroups
  57     \includebasedoc
  58  */
  59
  60 class OSG_CONTRIBCOMPUTEBASE_DLLMAPPING AlgorithmComputeElementData :
  61     public AlgorithmComputeElementDataBase
  62 {
  63   protected:
  64
  65     /*==========================  PUBLIC  =================================*/
  66
  67   public:
  68
  69     typedef AlgorithmComputeElementDataBase Inherited;
  70     typedef AlgorithmComputeElementData     Self;
  71
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                      Sync                                    */
  74     /*! \{                                                                 */
  75
  76     virtual void changed(ConstFieldMaskArg whichField,
  77                          UInt32            origin,
  78                          BitVector         detail);
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                     Output                                   */
  83     /*! \{                                                                 */
  84
  85     void setTask(ComputeAlgorithmDrawTask *pTask);
  86
  87     /*! \}                                                                 */
  88     /*---------------------------------------------------------------------*/
  89     /*! \name                     Output                                   */
  90     /*! \{                                                                 */
  91
  92     ComputeAlgorithmDrawTask *getTask(void);
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                     Output                                   */
  97     /*! \{                                                                 */
  98
  99     virtual void dump(      UInt32     uiIndent = 0,
 100                       const BitVector  bvFlags  = 0) const;
 101
 102     /*! \}                                                                 */
 103     /*=========================  PROTECTED  ===============================*/
 104
 105   protected:
 106
 107     // Variables should all be in AlgorithmComputeElementDataBase.
 108
 109     ComputeAlgorithmDrawTaskRefPtr _pTask;
 110
 111     /*---------------------------------------------------------------------*/
 112     /*! \name                  Constructors                                */
 113     /*! \{                                                                 */
 114
 115     AlgorithmComputeElementData(void);
 116     AlgorithmComputeElementData(const AlgorithmComputeElementData &source);
 117
 118     /*! \}                                                                 */
 119     /*---------------------------------------------------------------------*/
 120     /*! \name                   Destructors                                */
 121     /*! \{                                                                 */
 122
 123     virtual ~AlgorithmComputeElementData(void);
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                      Init                                    */
 128     /*! \{                                                                 */
 129
 130 #if 0
 131     virtual void updateData(FieldContainer *pCore,
 132                             BitVector       whichField,
 133                             UInt32          origin    );
 134 #endif
 135
 136     /*! \}                                                                 */
 137     /*---------------------------------------------------------------------*/
 138     /*! \name                       Sync                                   */
 139     /*! \{                                                                 */
 140
 141     virtual void resolveLinks(void);
 142
 143     /*! \}                                                                 */
 144     /*---------------------------------------------------------------------*/
 145     /*! \name                      Init                                    */
 146     /*! \{                                                                 */
 147
 148     static void initMethod(InitPhase ePhase);
 149
 150     /*! \}                                                                 */
 151     /*==========================  PRIVATE  ================================*/
 152
 153   private:
 154
 155     friend class FieldContainer;
 156     friend class AlgorithmComputeElementDataBase;
 157
 158     // prohibit default functions (move to 'public' if you need one)
 159     void operator =(const AlgorithmComputeElementData &source);
 160 };
 161
 162 OSG_END_NAMESPACE
 163
 164 #include "OSGAlgorithmComputeElementDataBase.inl"
 165 #include "OSGAlgorithmComputeElementData.inl"
 166
 167 #endif /* _OSGALGORITHMCOMPUTEELEEDATA_H_ */