Source/System/State/Shader/Chunks/OSGShaderExecutableVarChunk.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 _OSGSHADEREXECUTABLEVARCHUNK_H_
  40 #define _OSGSHADEREXECUTABLEVARCHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGShaderExecutableVarChunkBase.h"
  46 #include "OSGShaderExecutableChunk.h"
  47
  48 #include <map>
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 class ShaderCache;
  53 class SimpleSHLVariableChunk;
  54
  55 /*! \brief ShaderExecutableVarChunk class. See \ref
  56            PageStateShaderExecutableVarChunk for a description.
  57     \ingroup GrpSystemShaderChunks
  58     \ingroup GrpLibOSGSystem
  59     \includebasedoc
  60  */
  61
  62 class OSG_SYSTEM_DLLMAPPING ShaderExecutableVarChunk :
  63     public ShaderExecutableVarChunkBase
  64 {
  65   protected:
  66
  67     /*==========================  PUBLIC  =================================*/
  68
  69   public:
  70
  71     typedef ShaderExecutableVarChunkBase           Inherited;
  72     typedef ShaderExecutableVarChunk               Self;
  73
  74     typedef MFProgramVarChunksType::const_iterator VarChunksIt;
  75
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                 Chunk Class Access                           */
  78     /*! \{                                                                 */
  79
  80     virtual const StateChunkClass *getClass(void) const;
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name              Static Chunk Class Access                       */
  85     /*! \{                                                                 */
  86
  87     static       UInt32           getStaticClassId(void);
  88     static const StateChunkClass *getStaticClass  (void);
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                    Chunk Id                                  */
  93     /*! \{                                                                 */
  94
  95     virtual UInt16 getChunkId(void);
  96
  97     /*! \}                                                                 */
  98     /*---------------------------------------------------------------------*/
  99     /*! \name                      Sync                                    */
 100     /*! \{                                                                 */
 101
 102     virtual void changed(ConstFieldMaskArg whichField,
 103                          UInt32            origin,
 104                          BitVector         details    );
 105
 106     /*! \}                                                                 */
 107     /*---------------------------------------------------------------------*/
 108     /*! \name                     Output                                   */
 109     /*! \{                                                                 */
 110
 111     void setShaderExecutableChunk(ShaderExecutableChunk * const);
 112
 113     /*! \}                                                                 */
 114     /*---------------------------------------------------------------------*/
 115     /*! \name                     Output                                   */
 116     /*! \{                                                                 */
 117
 118     void merge(ShaderProgramVariableChunk *pVar);
 119
 120     /*! \}                                                                 */
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                     Output                                   */
 123     /*! \{                                                                 */
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                      Init                                    */
 128     /*! \{                                                                 */
 129
 130     virtual void activate  (DrawEnv*,              UInt32 index = 0);
 131     virtual void changeFrom(DrawEnv*, StateChunk*, UInt32 index = 0);
 132     virtual void deactivate(DrawEnv*,              UInt32 index = 0);
 133
 134     /*! \}                                                                 */
 135     /*---------------------------------------------------------------------*/
 136     /*! \name                     Output                                   */
 137     /*! \{                                                                 */
 138
 139     virtual void dump(      UInt32     uiIndent = 0,
 140                       const BitVector  bvFlags  = 0) const;
 141
 142     /*! \}                                                                 */
 143     /*=========================  PROTECTED  ===============================*/
 144
 145   protected:
 146
 147 #ifdef OSG_MULTISHADER_VARCHUNK
 148     typedef std::map<UInt32, MFInt32>                 ShaderVarLocMap;
 149     typedef std::map<UInt32, MFInt32>::value_type     ShaderVarLocMapValueT;
 150     typedef std::map<UInt32, MFInt32>::iterator       ShaderVarLocMapIt;
 151     typedef std::map<UInt32, MFInt32>::const_iterator ShaderVarLocMapConstIt;
 152 #endif
 153
 154     /*---------------------------------------------------------------------*/
 155
 156     static volatile UInt16 _uiChunkCounter;
 157
 158 #ifdef OSG_MULTISHADER_VARCHUNK
 159     ShaderVarLocMap _mShaderVarLocs;
 160 #endif
 161     UInt16          _uiChunkId;
 162
 163     // Variables should all be in SHLVariableChunkBase.
 164
 165     /*---------------------------------------------------------------------*/
 166     /*! \name                       Init                                   */
 167     /*! \{                                                                 */
 168
 169     void onCreate      (const ShaderExecutableVarChunk *source      = NULL);
 170     void onCreateAspect(const ShaderExecutableVarChunk *createAspect,
 171                         const ShaderExecutableVarChunk *source      = NULL);
 172
 173     /*! \}                                                                 */
 174     /*---------------------------------------------------------------------*/
 175     /*! \name                  Constructors                                */
 176     /*! \{                                                                 */
 177
 178     ShaderExecutableVarChunk(void);
 179     ShaderExecutableVarChunk(const ShaderExecutableVarChunk &source);
 180
 181     /*! \}                                                                 */
 182     /*---------------------------------------------------------------------*/
 183     /*! \name                   Destructors                                */
 184     /*! \{                                                                 */
 185
 186     virtual ~ShaderExecutableVarChunk(void);
 187
 188     /*! \}                                                                 */
 189     /*---------------------------------------------------------------------*/
 190     /*! \name                      Init                                    */
 191     /*! \{                                                                 */
 192
 193     static void initMethod(InitPhase ePhase);
 194
 195     /*! \}                                                                 */
 196     /*---------------------------------------------------------------------*/
 197     /*! \name                      Init                                    */
 198     /*! \{                                                                 */
 199
 200     void updateVariables (DrawEnv *pEnv);
 201     void remergeVariables(void         );
 202
 203     /*! \}                                                                 */
 204     /*---------------------------------------------------------------------*/
 205     /*! \name                      Init                                    */
 206     /*! \{                                                                 */
 207
 208     const MFProgramVarChunksType *getMFProgramVarChunks(void);
 209
 210     /*! \}                                                                 */
 211     /*==========================  PRIVATE  ================================*/
 212
 213   private:
 214
 215     // class. Used for indexing in State
 216     static StateChunkClass _class;
 217
 218     friend class FieldContainer;
 219     friend class ShaderExecutableVarChunkBase;
 220     friend class ShaderCache;
 221     friend class SimpleSHLVariableChunk;
 222
 223     // prohibit default functions (move to 'public' if you need one)
 224     void operator =(const ShaderExecutableVarChunk &source);
 225 };
 226
 227 typedef ShaderExecutableVarChunk *ShaderExecutableVarChunkP;
 228
 229 OSG_END_NAMESPACE
 230
 231 #include "OSGShaderExecutableVarChunkBase.inl"
 232 #include "OSGShaderExecutableVarChunk.inl"
 233
 234 #endif /* _OSGSHADEREXECUTABLEVARCHUNK_H_ */