Source/System/State/Shader/Base/OSGShaderVariableBase.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 /*****************************************************************************\
  40  *****************************************************************************
  41  **                                                                         **
  42  **                  This file is automatically generated.                  **
  43  **                                                                         **
  44  **          Any changes made to this file WILL be lost when it is          **
  45  **           regenerated, which can become necessary at any time.          **
  46  **                                                                         **
  47  **     Do not change this file, changes should be done in the derived      **
  48  **     class ShaderVariable
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSHADERVARIABLEBASE_H_
  55 #define _OSGSHADERVARIABLEBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGSystemDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGFieldContainer.h" // Parent
  67
  68 #include "OSGBaseFields.h"              // Name type
  69
  70 #include "OSGShaderVariableFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class ShaderVariable;
  76
  77 //! \brief ShaderVariable Base Class.
  78
  79 class OSG_SYSTEM_DLLMAPPING ShaderVariableBase : public FieldContainer
  80 {
  81   public:
  82
  83     typedef FieldContainer Inherited;
  84     typedef FieldContainer ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(ShaderVariable);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         NameFieldId = Inherited::NextFieldId,
  98         NextFieldId = NameFieldId + 1
  99     };
 100
 101     static const OSG::BitVector NameFieldMask =
 102         (TypeTraits<BitVector>::One << NameFieldId);
 103     static const OSG::BitVector NextFieldMask =
 104         (TypeTraits<BitVector>::One << NextFieldId);
 105
 106     typedef SFString          SFNameType;
 107
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                    Class Get                                 */
 110     /*! \{                                                                 */
 111
 112     static FieldContainerType &getClassType   (void);
 113     static UInt32              getClassTypeId (void);
 114     static UInt16              getClassGroupId(void);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                FieldContainer Get                            */
 119     /*! \{                                                                 */
 120
 121     virtual       FieldContainerType &getType         (void);
 122     virtual const FieldContainerType &getType         (void) const;
 123
 124     virtual       UInt32              getContainerSize(void) const;
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name                   Binary Access                              */
 129     /*! \{                                                                 */
 130
 131     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 132     virtual void   copyToBin  (BinaryDataHandler &pMem,
 133                                ConstFieldMaskArg  whichField);
 134     virtual void   copyFromBin(BinaryDataHandler &pMem,
 135                                ConstFieldMaskArg  whichField);
 136
 137
 138     /*! \}                                                                 */
 139     /*=========================  PROTECTED  ===============================*/
 140
 141   protected:
 142
 143     static TypeObject _type;
 144
 145     static       void   classDescInserter(TypeObject &oType);
 146     static const Char8 *getClassname     (void             );
 147
 148     /*---------------------------------------------------------------------*/
 149     /*! \name                      Fields                                  */
 150     /*! \{                                                                 */
 151
 152     SFString          _sfName;
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                   Constructors                               */
 157     /*! \{                                                                 */
 158
 159     ShaderVariableBase(void);
 160     ShaderVariableBase(const ShaderVariableBase &source);
 161
 162     /*! \}                                                                 */
 163     /*---------------------------------------------------------------------*/
 164     /*! \name                   Destructors                                */
 165     /*! \{                                                                 */
 166
 167     virtual ~ShaderVariableBase(void);
 168
 169     /*! \}                                                                 */
 170     /*---------------------------------------------------------------------*/
 171     /*! \name                     onCreate                                */
 172     /*! \{                                                                 */
 173
 174
 175     /*! \}                                                                 */
 176     /*---------------------------------------------------------------------*/
 177     /*! \name                    Generic Field Access                      */
 178     /*! \{                                                                 */
 179
 180      GetFieldHandlePtr  getHandleName            (void) const;
 181      EditFieldHandlePtr editHandleName           (void);
 182
 183     /*! \}                                                                 */
 184     /*---------------------------------------------------------------------*/
 185     /*! \name                    Field Get                                 */
 186     /*! \{                                                                 */
 187
 188
 189                   SFString            *editSFName           (void);
 190             const SFString            *getSFName            (void) const;
 191
 192
 193                   std::string         &editName           (void);
 194             const std::string         &getName            (void) const;
 195
 196     /*! \}                                                                 */
 197     /*---------------------------------------------------------------------*/
 198     /*! \name                    Field Set                                 */
 199     /*! \{                                                                 */
 200
 201             void setName           (const std::string &value);
 202
 203     /*! \}                                                                 */
 204     /*---------------------------------------------------------------------*/
 205     /*! \name                Ptr MField Set                                */
 206     /*! \{                                                                 */
 207
 208     /*! \}                                                                 */
 209     /*---------------------------------------------------------------------*/
 210     /*! \name                       Sync                                   */
 211     /*! \{                                                                 */
 212
 213 #ifdef OSG_MT_CPTR_ASPECT
 214     virtual void execSyncV(      FieldContainer    &oFrom,
 215                                  ConstFieldMaskArg  whichField,
 216                                  AspectOffsetStore &oOffsets,
 217                                  ConstFieldMaskArg  syncMode  ,
 218                            const UInt32             uiSyncInfo);
 219
 220             void execSync (      ShaderVariableBase *pFrom,
 221                                  ConstFieldMaskArg  whichField,
 222                                  AspectOffsetStore &oOffsets,
 223                                  ConstFieldMaskArg  syncMode  ,
 224                            const UInt32             uiSyncInfo);
 225 #endif
 226
 227     /*! \}                                                                 */
 228     /*---------------------------------------------------------------------*/
 229     /*! \name                       Edit                                   */
 230     /*! \{                                                                 */
 231
 232     /*! \}                                                                 */
 233     /*---------------------------------------------------------------------*/
 234     /*! \name                     Aspect Create                            */
 235     /*! \{                                                                 */
 236
 237     /*! \}                                                                 */
 238     /*---------------------------------------------------------------------*/
 239     /*! \name                       Edit                                   */
 240     /*! \{                                                                 */
 241     /*! \}                                                                 */
 242     /*---------------------------------------------------------------------*/
 243     /*! \name                       Sync                                   */
 244     /*! \{                                                                 */
 245
 246     virtual void resolveLinks(void);
 247
 248     /*! \}                                                                 */
 249     /*==========================  PRIVATE  ================================*/
 250
 251   private:
 252     /*---------------------------------------------------------------------*/
 253
 254     // prohibit default functions (move to 'public' if you need one)
 255     void operator =(const ShaderVariableBase &source);
 256 };
 257
 258 typedef ShaderVariableBase *ShaderVariableBaseP;
 259
 260 OSG_END_NAMESPACE
 261
 262 #endif /* _OSGSHADERVARIABLEBASE_H_ */