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

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2002 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 _OSGSHADERVALUEVARIABLE_H_
  40 #define _OSGSHADERVALUEVARIABLE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGShaderValueVariableBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief ShaderVariableOSG class. See \ref
  50            PageSystemShaderVariableOSG for a description.
  51     \ingroup GrpSystemShaderVariables
  52     \ingroup GrpLibOSGSystem
  53     \includebasedoc
  54  */
  55
  56 class OSG_SYSTEM_DLLMAPPING ShaderValueVariable : public ShaderValueVariableBase
  57 {
  58   private:
  59
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     typedef ShaderValueVariableBase Inherited;
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                      Sync                                    */
  68     /*! \{                                                                 */
  69
  70     virtual void changed(ConstFieldMaskArg whichField,
  71                          UInt32            origin,
  72                          BitVector         details);
  73
  74     /*! \}                                                                 */
  75     /*---------------------------------------------------------------------*/
  76     /*! \name                     Output                                   */
  77     /*! \{                                                                 */
  78
  79     virtual void dump(      UInt32     uiIndent = 0,
  80                       const BitVector  bvFlags  = 0) const;
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                     Output                                   */
  85     /*! \{                                                                 */
  86
  87     /*! \}                                                                 */
  88     /*---------------------------------------------------------------------*/
  89     /*! \name                     Output                                   */
  90     /*! \{                                                                 */
  91
  92     /*! \}                                                                 */
  93     /*=========================  PROTECTED  ===============================*/
  94
  95   protected:
  96
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                  Constructors                                */
  99     /*! \{                                                                 */
 100
 101     ShaderValueVariable(void);
 102     ShaderValueVariable(const ShaderValueVariable &source);
 103
 104     /*! \}                                                                 */
 105     /*---------------------------------------------------------------------*/
 106     /*! \name                   Destructors                                */
 107     /*! \{                                                                 */
 108
 109     virtual ~ShaderValueVariable(void);
 110
 111     /*! \}                                                                 */
 112     /*---------------------------------------------------------------------*/
 113     /*! \name                     Init                                     */
 114     /*! \{                                                                 */
 115
 116     static void initMethod(InitPhase ePhase);
 117
 118     /*! \}                                                                 */
 119     /*---------------------------------------------------------------------*/
 120     /*! \name                     Init                                     */
 121     /*! \{                                                                 */
 122
 123     virtual bool linkParent  (FieldContainer * const pParent,
 124                               UInt16           const childFieldId,
 125                               UInt16           const parentFieldId);
 126     virtual bool unlinkParent(FieldContainer * const pParent,
 127                               UInt16           const parentFieldId);
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name                     Init                                     */
 132     /*! \{                                                                 */
 133
 134     void addParent   (FieldContainer * const pParent,
 135                       UInt16                 uiParentFieldId,
 136                       UInt16                 uiVarIdx       );
 137
 138     void subParent   (FieldContainer * const pParent        );
 139
 140     void addExeParent(FieldContainer * const pParent,
 141                       UInt16                 uiParentFieldId,
 142                       UInt16                 uiVarIdx       );
 143
 144     void subExeParent(FieldContainer * const pParent        );
 145
 146     /*! \}                                                                 */
 147     /*==========================  PRIVATE  ================================*/
 148
 149   private:
 150
 151     friend class FieldContainer;
 152     friend class ShaderValueVariableBase;
 153
 154     friend class ShaderProgramVariables;
 155
 156     // prohibit default functions (move to 'public' if you need one)
 157     void operator =(const ShaderValueVariable &source);
 158 };
 159
 160 typedef ShaderValueVariable *ShaderValueVariableP;
 161
 162 OSG_END_NAMESPACE
 163
 164 #include "OSGShaderValueVariableBase.inl"
 165 #include "OSGShaderValueVariable.inl"
 166
 167 #endif /* _OSGSHADERVALUEVARIABLE_H_ */