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