Source/System/State/Shader/Variables/OSGShaderVariableUniformBlock.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2013 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  * contact: dirk@opensg.org, gerrit.voss@vossg.org, carsten_neumann@gmx.net  *
  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 _OSGSHADERVARIABLEUNIFORMBLOCK_H_
  40 #define _OSGSHADERVARIABLEUNIFORMBLOCK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGShaderVariableUniformBlockBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief ShaderVariableUniformBlock class. See \ref
  50            PageSystemShaderVariableUniformBlock for a description.
  51 */
  52
  53 class OSG_SYSTEM_DLLMAPPING ShaderVariableUniformBlock : public ShaderVariableUniformBlockBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef ShaderVariableUniformBlockBase Inherited;
  62     typedef ShaderVariableUniformBlock     Self;
  63
  64     /*---------------------------------------------------------------------*/
  65     /*! \name                      Sync                                    */
  66     /*! \{                                                                 */
  67
  68     virtual void changed(ConstFieldMaskArg whichField,
  69                          UInt32            origin,
  70                          BitVector         details    );
  71
  72     /*! \}                                                                 */
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                     Output                                   */
  75     /*! \{                                                                 */
  76
  77     virtual void dump(      UInt32     uiIndent = 0,
  78                       const BitVector  bvFlags  = 0) const;
  79
  80     /*! \}                                                                 */
  81     /*=========================  PROTECTED  ===============================*/
  82
  83   protected:
  84
  85     // Variables should all be in ShaderVariableUniformBlockBase.
  86
  87     /*---------------------------------------------------------------------*/
  88     /*! \name                  Constructors                                */
  89     /*! \{                                                                 */
  90
  91     ShaderVariableUniformBlock(void);
  92     ShaderVariableUniformBlock(const ShaderVariableUniformBlock &source);
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                   Destructors                                */
  97     /*! \{                                                                 */
  98
  99     virtual ~ShaderVariableUniformBlock(void);
 100
 101     /*! \}                                                                 */
 102     /*---------------------------------------------------------------------*/
 103     /*! \name                      Init                                    */
 104     /*! \{                                                                 */
 105
 106     static void initMethod(InitPhase ePhase);
 107
 108     /*! \}                                                                 */
 109     /*==========================  PRIVATE  ================================*/
 110
 111   private:
 112
 113     friend class FieldContainer;
 114     friend class ShaderVariableUniformBlockBase;
 115
 116     // prohibit default functions (move to 'public' if you need one)
 117     void operator =(const ShaderVariableUniformBlock &source);
 118 };
 119
 120 typedef ShaderVariableUniformBlock *ShaderVariableUniformBlockP;
 121
 122 OSG_END_NAMESPACE
 123
 124 #include "OSGShaderVariableUniformBlockBase.inl"
 125 #include "OSGShaderVariableUniformBlock.inl"
 126
 127 #endif /* _OSGSHADERVARIABLEUNIFORMBLOCK_H_ */