Source/System/State/Shader/Chunks/OSGShaderProgramVariableChunk.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 _OSGSHADERPROGRAMVARIABLECHUNK_H_
  40 #define _OSGSHADERPROGRAMVARIABLECHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGShaderProgramVariableChunkBase.h"
  46 #include "OSGShaderProgramVariables.h"
  47 #include "OSGLockPolicies.h"
  48 #include "OSGSimpleReusePool.h"
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 /*! \brief ShaderProgramVariableChunk class. See \ref
  53            PageStateShaderProgramVariableChunk for a description.
  54     \ingroup GrpSystemShaderChunks
  55     \ingroup GrpLibOSGSystem
  56     \includebasedoc
  57  */
  58
  59 class OSG_SYSTEM_DLLMAPPING ShaderProgramVariableChunk :
  60     public ShaderProgramVariableChunkBase
  61 {
  62   protected:
  63
  64     /*==========================  PUBLIC  =================================*/
  65
  66   public:
  67
  68     typedef ShaderProgramVariableChunkBase Inherited;
  69     typedef ShaderProgramVariableChunk     Self;
  70
  71     struct VariableIdPoolTag;
  72
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                 Chunk Class Access                           */
  75     /*! \{                                                                 */
  76
  77     virtual const StateChunkClass *getClass(void) const;
  78
  79     /*! \}                                                                 */
  80     /*---------------------------------------------------------------------*/
  81     /*! \name              Static Chunk Class Access                       */
  82     /*! \{                                                                 */
  83
  84     static       UInt32           getStaticClassId(void);
  85     static const StateChunkClass *getStaticClass  (void);
  86
  87     /*! \}                                                                 */
  88     /*---------------------------------------------------------------------*/
  89     /*! \name                    Chunk Id                                  */
  90     /*! \{                                                                 */
  91
  92     virtual UInt16 getChunkId(void);
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                      Sync                                    */
  97     /*! \{                                                                 */
  98
  99     virtual void changed(ConstFieldMaskArg whichField,
 100                          UInt32            origin,
 101                          BitVector         details    );
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                     Output                                   */
 106     /*! \{                                                                 */
 107
 108     UInt16 getVariableId(void);
 109
 110     /*! \}                                                                 */
 111     /*---------------------------------------------------------------------*/
 112     /*! \name                     Output                                   */
 113     /*! \{                                                                 */
 114     template<class ValueT>
 115     bool addUniformVariable    (const Char8 *name, const ValueT &value);
 116
 117     template<class ValueT>
 118     bool updateUniformVariable (const Char8 *name, const ValueT &value);
 119
 120     template<class ValueT>
 121     bool getUniformVariable    (const Char8 *name,       ValueT &value);
 122
 123     bool subUniformVariable    (const Char8 *name                     );
 124     void clearUniformVariables (      void                            );
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name                     Output                                   */
 129     /*! \{                                                                 */
 130     bool addUniformBlock        (const Char8 *name, UInt32  value);
 131     bool updateUniformBlock     (const Char8 *name, UInt32  value);
 132     bool getUniformBlock        (const Char8 *name, UInt32 &value);
 133     bool subUniformBlock        (const Char8 *name               );
 134
 135     /*! \}                                                                 */
 136     /*---------------------------------------------------------------------*/
 137     /*! \name                     Output                                   */
 138     /*! \{                                                                 */
 139     bool addShaderStorageBlock   (const Char8 *name, UInt32  value);
 140     bool updateShaderStorageBlock(const Char8 *name, UInt32  value);
 141     bool getShaderStorageBlock   (const Char8 *name, UInt32 &value);
 142     bool subShaderStorageBlock   (const Char8 *name               );
 143
 144     /*! \}                                                                 */
 145     /*---------------------------------------------------------------------*/
 146     /*! \name                      Init                                    */
 147     /*! \{                                                                 */
 148
 149     virtual void activate  (DrawEnv*,              UInt32 index = 0);
 150     virtual void changeFrom(DrawEnv*, StateChunk*, UInt32 index = 0);
 151     virtual void deactivate(DrawEnv*,              UInt32 index = 0);
 152
 153     /*! \}                                                                 */
 154     /*---------------------------------------------------------------------*/
 155     /*! \name                     Output                                   */
 156     /*! \{                                                                 */
 157
 158     void   addDestroyedFunctor   (ChangedFunctor func,
 159                                   std::string    createSymbol);
 160
 161     template<class FunctorT>
 162     void   subDestroyedFunctor   (FunctorT       func        );
 163
 164     template<class FunctorT>
 165     bool   hasDestroyedFunctor   (FunctorT       func        );
 166
 167     void   clearDestroyedFunctors(void                       );
 168
 169     /*! \}                                                                 */
 170     /*---------------------------------------------------------------------*/
 171     /*! \name                     Output                                   */
 172     /*! \{                                                                 */
 173
 174     void addParent(FieldContainer * const pParent,
 175                    UInt16                 uiParentFieldId);
 176
 177     void subParent(FieldContainer * const pParent        );
 178
 179     /*! \}                                                                 */
 180     /*---------------------------------------------------------------------*/
 181     /*! \name                     Output                                   */
 182     /*! \{                                                                 */
 183
 184     virtual void dump(      UInt32     uiIndent = 0,
 185                       const BitVector  bvFlags  = 0) const;
 186
 187     /*! \}                                                                 */
 188     /*=========================  PROTECTED  ===============================*/
 189
 190   protected:
 191
 192     typedef SimpleReusePool<Int32,
 193                             VariableIdPoolTag,
 194                             SingleLockPolicy > VarIdPool;
 195
 196
 197     static VarIdPool *_pVarIdPool;
 198
 199            UInt16     _uiVarId;
 200
 201     /*---------------------------------------------------------------------*/
 202
 203     static volatile UInt16 _uiChunkCounter;
 204
 205     UInt16 _uiChunkId;
 206
 207     // Variables should all be in ShaderProgramVariableChunkBase.
 208
 209     /*---------------------------------------------------------------------*/
 210     /*! \name                       Init                                   */
 211     /*! \{                                                                 */
 212
 213     void onCreate      (const ShaderProgramVariableChunk *source      = NULL);
 214     void onCreateAspect(const ShaderProgramVariableChunk *createAspect,
 215                         const ShaderProgramVariableChunk *source      = NULL);
 216
 217     /*! \}                                                                 */
 218     /*---------------------------------------------------------------------*/
 219     /*! \name                  Constructors                                */
 220     /*! \{                                                                 */
 221
 222     virtual void onDestroy(UInt32 uiId);
 223
 224     /*! \}                                                                 */
 225     /*---------------------------------------------------------------------*/
 226     /*! \name                  Constructors                                */
 227     /*! \{                                                                 */
 228
 229     ShaderProgramVariableChunk(void);
 230     ShaderProgramVariableChunk(const ShaderProgramVariableChunk &source);
 231
 232     /*! \}                                                                 */
 233     /*---------------------------------------------------------------------*/
 234     /*! \name                   Destructors                                */
 235     /*! \{                                                                 */
 236
 237     virtual ~ShaderProgramVariableChunk(void);
 238
 239     /*! \}                                                                 */
 240     /*---------------------------------------------------------------------*/
 241     /*! \name                      Init                                    */
 242     /*! \{                                                                 */
 243
 244     static void initMethod(InitPhase ePhase);
 245
 246     /*! \}                                                                 */
 247     /*---------------------------------------------------------------------*/
 248     /*! \name                      Init                                    */
 249     /*! \{                                                                 */
 250
 251     virtual void resolveLinks(void);
 252
 253     /*! \}                                                                 */
 254     /*==========================  PRIVATE  ================================*/
 255
 256   private:
 257
 258     // class. Used for indexing in State
 259     static StateChunkClass _class;
 260
 261     friend class FieldContainer;
 262     friend class ShaderProgramVariableChunkBase;
 263
 264     // prohibit default functions (move to 'public' if you need one)
 265     void operator =(const ShaderProgramVariableChunk &source);
 266 };
 267
 268 typedef ShaderProgramVariableChunk *ShaderProgramVariableChunkP;
 269
 270 OSG_END_NAMESPACE
 271
 272 #include "OSGShaderProgramVariableChunkBase.inl"
 273 #include "OSGShaderProgramVariableChunk.inl"
 274
 275 #endif /* _OSGSHADERPROGRAMVARIABLECHUNK_H_ */