Source/System/State/Shader/Variables/OSGShaderProcVariableBase.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 ShaderProcVariable
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSHADERPROCVARIABLEBASE_H_
  55 #define _OSGSHADERPROCVARIABLEBASE_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 "OSGShaderVariable.h" // Parent
  67
  68 #include "OSGSysFields.h"               // Dependency type
  69 #include "OSGFieldContainerFields.h"    // Parents type
  70
  71 #include "OSGShaderProcVariableFields.h"
  72
  73 OSG_BEGIN_NAMESPACE
  74
  75
  76 class ShaderProcVariable;
  77
  78 //! \brief ShaderProcVariable Base Class.
  79
  80 class OSG_SYSTEM_DLLMAPPING ShaderProcVariableBase : public ShaderVariable
  81 {
  82   public:
  83
  84     typedef ShaderVariable Inherited;
  85     typedef ShaderVariable ParentContainer;
  86
  87     typedef Inherited::TypeObject TypeObject;
  88     typedef TypeObject::InitPhase InitPhase;
  89
  90     OSG_GEN_INTERNALPTR(ShaderProcVariable);
  91
  92     /*==========================  PUBLIC  =================================*/
  93
  94   public:
  95
  96     enum
  97     {
  98         DependencyFieldId = Inherited::NextFieldId,
  99         ParentsFieldId = DependencyFieldId + 1,
 100         NextFieldId = ParentsFieldId + 1
 101     };
 102
 103     static const OSG::BitVector DependencyFieldMask =
 104         (TypeTraits<BitVector>::One << DependencyFieldId);
 105     static const OSG::BitVector ParentsFieldMask =
 106         (TypeTraits<BitVector>::One << ParentsFieldId);
 107     static const OSG::BitVector NextFieldMask =
 108         (TypeTraits<BitVector>::One << NextFieldId);
 109
 110     typedef SFUInt32          SFDependencyType;
 111     typedef MFParentFieldContainerPtr MFParentsType;
 112
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                    Class Get                                 */
 115     /*! \{                                                                 */
 116
 117     static FieldContainerType &getClassType   (void);
 118     static UInt32              getClassTypeId (void);
 119     static UInt16              getClassGroupId(void);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                FieldContainer Get                            */
 124     /*! \{                                                                 */
 125
 126     virtual       FieldContainerType &getType         (void);
 127     virtual const FieldContainerType &getType         (void) const;
 128
 129     virtual       UInt32              getContainerSize(void) const;
 130
 131     /*! \}                                                                 */
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                    Field Get                                 */
 134     /*! \{                                                                 */
 135
 136
 137                   SFUInt32            *editSFDependency     (void);
 138             const SFUInt32            *getSFDependency      (void) const;
 139
 140
 141                   UInt32              &editDependency     (void);
 142                   UInt32               getDependency      (void) const;
 143
 144     /*! \}                                                                 */
 145     /*---------------------------------------------------------------------*/
 146     /*! \name                    Field Set                                 */
 147     /*! \{                                                                 */
 148
 149             void setDependency     (const UInt32 value);
 150
 151     /*! \}                                                                 */
 152     /*---------------------------------------------------------------------*/
 153     /*! \name                Ptr MField Set                                */
 154     /*! \{                                                                 */
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                   Binary Access                              */
 159     /*! \{                                                                 */
 160
 161     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 162     virtual void   copyToBin  (BinaryDataHandler &pMem,
 163                                ConstFieldMaskArg  whichField);
 164     virtual void   copyFromBin(BinaryDataHandler &pMem,
 165                                ConstFieldMaskArg  whichField);
 166
 167
 168     /*! \}                                                                 */
 169     /*=========================  PROTECTED  ===============================*/
 170
 171   protected:
 172
 173     static TypeObject _type;
 174
 175     static       void   classDescInserter(TypeObject &oType);
 176     static const Char8 *getClassname     (void             );
 177
 178     /*---------------------------------------------------------------------*/
 179     /*! \name                      Fields                                  */
 180     /*! \{                                                                 */
 181
 182     SFUInt32          _sfDependency;
 183     MFParentFieldContainerPtr _mfParents;
 184
 185     /*! \}                                                                 */
 186     /*---------------------------------------------------------------------*/
 187     /*! \name                   Constructors                               */
 188     /*! \{                                                                 */
 189
 190     ShaderProcVariableBase(void);
 191     ShaderProcVariableBase(const ShaderProcVariableBase &source);
 192
 193     /*! \}                                                                 */
 194     /*---------------------------------------------------------------------*/
 195     /*! \name                   Destructors                                */
 196     /*! \{                                                                 */
 197
 198     virtual ~ShaderProcVariableBase(void);
 199
 200     /*! \}                                                                 */
 201     /*---------------------------------------------------------------------*/
 202     /*! \name                     onCreate                                */
 203     /*! \{                                                                 */
 204
 205
 206     /*! \}                                                                 */
 207     /*---------------------------------------------------------------------*/
 208     /*! \name Parent linking                                               */
 209     /*! \{                                                                 */
 210
 211     virtual bool linkParent  (FieldContainer * const pParent,
 212                               UInt16           const childFieldId,
 213                               UInt16           const parentFieldId);
 214     virtual bool unlinkParent(FieldContainer * const pParent,
 215                               UInt16           const parentFieldId);
 216
 217     /*! \}                                                                 */
 218     /*---------------------------------------------------------------------*/
 219     /*! \name                    Generic Field Access                      */
 220     /*! \{                                                                 */
 221
 222      GetFieldHandlePtr  getHandleDependency      (void) const;
 223      EditFieldHandlePtr editHandleDependency     (void);
 224      GetFieldHandlePtr  getHandleParents         (void) const;
 225      EditFieldHandlePtr editHandleParents        (void);
 226
 227     /*! \}                                                                 */
 228     /*---------------------------------------------------------------------*/
 229     /*! \name                       Sync                                   */
 230     /*! \{                                                                 */
 231
 232 #ifdef OSG_MT_CPTR_ASPECT
 233     virtual void execSyncV(      FieldContainer    &oFrom,
 234                                  ConstFieldMaskArg  whichField,
 235                                  AspectOffsetStore &oOffsets,
 236                                  ConstFieldMaskArg  syncMode  ,
 237                            const UInt32             uiSyncInfo);
 238
 239             void execSync (      ShaderProcVariableBase *pFrom,
 240                                  ConstFieldMaskArg  whichField,
 241                                  AspectOffsetStore &oOffsets,
 242                                  ConstFieldMaskArg  syncMode  ,
 243                            const UInt32             uiSyncInfo);
 244 #endif
 245
 246     /*! \}                                                                 */
 247     /*---------------------------------------------------------------------*/
 248     /*! \name                       Edit                                   */
 249     /*! \{                                                                 */
 250
 251     /*! \}                                                                 */
 252     /*---------------------------------------------------------------------*/
 253     /*! \name                     Aspect Create                            */
 254     /*! \{                                                                 */
 255
 256     /*! \}                                                                 */
 257     /*---------------------------------------------------------------------*/
 258     /*! \name                       Edit                                   */
 259     /*! \{                                                                 */
 260     /*! \}                                                                 */
 261     /*---------------------------------------------------------------------*/
 262     /*! \name                       Sync                                   */
 263     /*! \{                                                                 */
 264
 265     virtual void resolveLinks(void);
 266
 267     /*! \}                                                                 */
 268     /*==========================  PRIVATE  ================================*/
 269
 270   private:
 271     /*---------------------------------------------------------------------*/
 272
 273     // prohibit default functions (move to 'public' if you need one)
 274     void operator =(const ShaderProcVariableBase &source);
 275 };
 276
 277 typedef ShaderProcVariableBase *ShaderProcVariableBaseP;
 278
 279 OSG_END_NAMESPACE
 280
 281 #endif /* _OSGSHADERPROCVARIABLEBASE_H_ */