Source/System/State/Shader/SHL/OSGSimpleSHLVariableChunkBase.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 SimpleSHLVariableChunk
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSIMPLESHLVARIABLECHUNKBASE_H_
  55 #define _OSGSIMPLESHLVARIABLECHUNKBASE_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 "OSGStateChunk.h" // Parent
  67
  68 #include "OSGShaderProgramVariablesFields.h" // Variables type
  69 #include "OSGSysFields.h"               // VariableLocations type
  70
  71 #include "OSGSimpleSHLVariableChunkFields.h"
  72
  73 OSG_BEGIN_NAMESPACE
  74
  75
  76 class SimpleSHLVariableChunk;
  77
  78 //! \brief SimpleSHLVariableChunk Base Class.
  79
  80 class OSG_SYSTEM_DLLMAPPING SimpleSHLVariableChunkBase : public StateChunk
  81 {
  82   public:
  83
  84     typedef StateChunk Inherited;
  85     typedef StateChunk ParentContainer;
  86
  87     typedef Inherited::TypeObject TypeObject;
  88     typedef TypeObject::InitPhase InitPhase;
  89
  90     OSG_GEN_INTERNALPTR(SimpleSHLVariableChunk);
  91
  92     /*==========================  PUBLIC  =================================*/
  93
  94   public:
  95
  96     enum
  97     {
  98         VariablesFieldId = Inherited::NextFieldId,
  99         VariableLocationsFieldId = VariablesFieldId + 1,
 100         NextFieldId = VariableLocationsFieldId + 1
 101     };
 102
 103     static const OSG::BitVector VariablesFieldMask =
 104         (TypeTraits<BitVector>::One << VariablesFieldId);
 105     static const OSG::BitVector VariableLocationsFieldMask =
 106         (TypeTraits<BitVector>::One << VariableLocationsFieldId);
 107     static const OSG::BitVector NextFieldMask =
 108         (TypeTraits<BitVector>::One << NextFieldId);
 109
 110     typedef SFUnrecChildShaderProgramVariablesPtr SFVariablesType;
 111     typedef MFInt32           MFVariableLocationsType;
 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             const SFUnrecChildShaderProgramVariablesPtr *getSFVariables      (void) const;
 137                   SFUnrecChildShaderProgramVariablesPtr *editSFVariables      (void);
 138
 139
 140                   ShaderProgramVariables * getVariables      (void) const;
 141
 142     /*! \}                                                                 */
 143     /*---------------------------------------------------------------------*/
 144     /*! \name                    Field Set                                 */
 145     /*! \{                                                                 */
 146
 147             void setVariables      (ShaderProgramVariables * const value);
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                Ptr Field Set                                 */
 152     /*! \{                                                                 */
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                Ptr MField Set                                */
 157     /*! \{                                                                 */
 158
 159     /*! \}                                                                 */
 160     /*---------------------------------------------------------------------*/
 161     /*! \name                   Binary Access                              */
 162     /*! \{                                                                 */
 163
 164     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 165     virtual void   copyToBin  (BinaryDataHandler &pMem,
 166                                ConstFieldMaskArg  whichField);
 167     virtual void   copyFromBin(BinaryDataHandler &pMem,
 168                                ConstFieldMaskArg  whichField);
 169
 170
 171     /*! \}                                                                 */
 172     /*---------------------------------------------------------------------*/
 173     /*! \name                   Construction                               */
 174     /*! \{                                                                 */
 175
 176     static  SimpleSHLVariableChunkTransitPtr  create          (void);
 177     static  SimpleSHLVariableChunk           *createEmpty     (void);
 178
 179     static  SimpleSHLVariableChunkTransitPtr  createLocal     (
 180                                                BitVector bFlags = FCLocal::All);
 181
 182     static  SimpleSHLVariableChunk            *createEmptyLocal(
 183                                               BitVector bFlags = FCLocal::All);
 184
 185     static  SimpleSHLVariableChunkTransitPtr  createDependent  (BitVector bFlags);
 186
 187     /*! \}                                                                 */
 188     /*---------------------------------------------------------------------*/
 189     /*! \name                       Copy                                   */
 190     /*! \{                                                                 */
 191
 192     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 193     virtual FieldContainerTransitPtr shallowCopyLocal(
 194                                        BitVector bFlags = FCLocal::All) const;
 195     virtual FieldContainerTransitPtr shallowCopyDependent(
 196                                                       BitVector bFlags) const;
 197
 198     /*! \}                                                                 */
 199     /*=========================  PROTECTED  ===============================*/
 200
 201   protected:
 202
 203     static TypeObject _type;
 204
 205     static       void   classDescInserter(TypeObject &oType);
 206     static const Char8 *getClassname     (void             );
 207
 208     /*---------------------------------------------------------------------*/
 209     /*! \name                      Fields                                  */
 210     /*! \{                                                                 */
 211
 212     SFUnrecChildShaderProgramVariablesPtr _sfVariables;
 213     MFInt32           _mfVariableLocations;
 214
 215     /*! \}                                                                 */
 216     /*---------------------------------------------------------------------*/
 217     /*! \name                   Constructors                               */
 218     /*! \{                                                                 */
 219
 220     SimpleSHLVariableChunkBase(void);
 221     SimpleSHLVariableChunkBase(const SimpleSHLVariableChunkBase &source);
 222
 223     /*! \}                                                                 */
 224     /*---------------------------------------------------------------------*/
 225     /*! \name                   Destructors                                */
 226     /*! \{                                                                 */
 227
 228     virtual ~SimpleSHLVariableChunkBase(void);
 229
 230     /*! \}                                                                 */
 231     /*---------------------------------------------------------------------*/
 232     /*! \name                     onCreate                                */
 233     /*! \{                                                                 */
 234
 235     void onCreate(const SimpleSHLVariableChunk *source = NULL);
 236
 237     /*! \}                                                                 */
 238     /*---------------------------------------------------------------------*/
 239     /*! \name Child linking                                                */
 240     /*! \{                                                                 */
 241
 242     virtual bool unlinkChild(FieldContainer * const pChild,
 243                              UInt16           const childFieldId);
 244
 245     /*! \}                                                                 */
 246     /*---------------------------------------------------------------------*/
 247     /*! \name                    Generic Field Access                      */
 248     /*! \{                                                                 */
 249
 250      GetFieldHandlePtr  getHandleVariables       (void) const;
 251      EditFieldHandlePtr editHandleVariables      (void);
 252      GetFieldHandlePtr  getHandleVariableLocations (void) const;
 253      EditFieldHandlePtr editHandleVariableLocations(void);
 254
 255     /*! \}                                                                 */
 256     /*---------------------------------------------------------------------*/
 257     /*! \name                    Field Get                                 */
 258     /*! \{                                                                 */
 259
 260
 261                   MFInt32             *editMFVariableLocations(void);
 262             const MFInt32             *getMFVariableLocations (void) const;
 263
 264
 265                   MFInt32            ::reference editVariableLocations(const UInt32 index);
 266                   Int32                getVariableLocations (const UInt32 index) const;
 267
 268     /*! \}                                                                 */
 269     /*---------------------------------------------------------------------*/
 270     /*! \name                    Field Set                                 */
 271     /*! \{                                                                 */
 272
 273
 274     /*! \}                                                                 */
 275     /*---------------------------------------------------------------------*/
 276     /*! \name                Ptr MField Set                                */
 277     /*! \{                                                                 */
 278
 279     /*! \}                                                                 */
 280     /*---------------------------------------------------------------------*/
 281     /*! \name                       Sync                                   */
 282     /*! \{                                                                 */
 283
 284 #ifdef OSG_MT_CPTR_ASPECT
 285     virtual void execSyncV(      FieldContainer    &oFrom,
 286                                  ConstFieldMaskArg  whichField,
 287                                  AspectOffsetStore &oOffsets,
 288                                  ConstFieldMaskArg  syncMode  ,
 289                            const UInt32             uiSyncInfo);
 290
 291             void execSync (      SimpleSHLVariableChunkBase *pFrom,
 292                                  ConstFieldMaskArg  whichField,
 293                                  AspectOffsetStore &oOffsets,
 294                                  ConstFieldMaskArg  syncMode  ,
 295                            const UInt32             uiSyncInfo);
 296 #endif
 297
 298     /*! \}                                                                 */
 299     /*---------------------------------------------------------------------*/
 300     /*! \name                       Edit                                   */
 301     /*! \{                                                                 */
 302
 303     /*! \}                                                                 */
 304     /*---------------------------------------------------------------------*/
 305     /*! \name                     Aspect Create                            */
 306     /*! \{                                                                 */
 307
 308 #ifdef OSG_MT_CPTR_ASPECT
 309     virtual FieldContainer *createAspectCopy(
 310                                     const FieldContainer *pRefAspect) const;
 311 #endif
 312
 313     /*! \}                                                                 */
 314     /*---------------------------------------------------------------------*/
 315     /*! \name                       Edit                                   */
 316     /*! \{                                                                 */
 317     /*! \}                                                                 */
 318     /*---------------------------------------------------------------------*/
 319     /*! \name                       Sync                                   */
 320     /*! \{                                                                 */
 321
 322     virtual void resolveLinks(void);
 323
 324     /*! \}                                                                 */
 325     /*==========================  PRIVATE  ================================*/
 326
 327   private:
 328     /*---------------------------------------------------------------------*/
 329
 330     // prohibit default functions (move to 'public' if you need one)
 331     void operator =(const SimpleSHLVariableChunkBase &source);
 332 };
 333
 334 typedef SimpleSHLVariableChunkBase *SimpleSHLVariableChunkBaseP;
 335
 336 OSG_END_NAMESPACE
 337
 338 #endif /* _OSGSIMPLESHLVARIABLECHUNKBASE_H_ */