Source/System/State/Shader/Variables/OSGShaderVariableOSGBase.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 ShaderVariableOSG
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSHADERVARIABLEOSGBASE_H_
  55 #define _OSGSHADERVARIABLEOSGBASE_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 "OSGShaderProcVariable.h" // Parent
  67
  68 #include "OSGSysFields.h"               // OsgVarType type
  69
  70 #include "OSGShaderVariableOSGFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class ShaderVariableOSG;
  76
  77 //! \brief ShaderVariableOSG Base Class.
  78
  79 class OSG_SYSTEM_DLLMAPPING ShaderVariableOSGBase : public ShaderProcVariable
  80 {
  81   public:
  82
  83     typedef ShaderProcVariable Inherited;
  84     typedef ShaderProcVariable ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(ShaderVariableOSG);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         OsgVarTypeFieldId = Inherited::NextFieldId,
  98         NextFieldId = OsgVarTypeFieldId + 1
  99     };
 100
 101     static const OSG::BitVector OsgVarTypeFieldMask =
 102         (TypeTraits<BitVector>::One << OsgVarTypeFieldId);
 103     static const OSG::BitVector NextFieldMask =
 104         (TypeTraits<BitVector>::One << NextFieldId);
 105
 106     typedef SFUInt32          SFOsgVarTypeType;
 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     /*---------------------------------------------------------------------*/
 140     /*! \name                   Construction                               */
 141     /*! \{                                                                 */
 142
 143     static  ShaderVariableOSGTransitPtr  create          (void);
 144     static  ShaderVariableOSG           *createEmpty     (void);
 145
 146     static  ShaderVariableOSGTransitPtr  createLocal     (
 147                                                BitVector bFlags = FCLocal::All);
 148
 149     static  ShaderVariableOSG            *createEmptyLocal(
 150                                               BitVector bFlags = FCLocal::All);
 151
 152     static  ShaderVariableOSGTransitPtr  createDependent  (BitVector bFlags);
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                       Copy                                   */
 157     /*! \{                                                                 */
 158
 159     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 160     virtual FieldContainerTransitPtr shallowCopyLocal(
 161                                        BitVector bFlags = FCLocal::All) const;
 162     virtual FieldContainerTransitPtr shallowCopyDependent(
 163                                                       BitVector bFlags) const;
 164
 165     /*! \}                                                                 */
 166     /*=========================  PROTECTED  ===============================*/
 167
 168   protected:
 169
 170     static TypeObject _type;
 171
 172     static       void   classDescInserter(TypeObject &oType);
 173     static const Char8 *getClassname     (void             );
 174
 175     /*---------------------------------------------------------------------*/
 176     /*! \name                      Fields                                  */
 177     /*! \{                                                                 */
 178
 179     SFUInt32          _sfOsgVarType;
 180
 181     /*! \}                                                                 */
 182     /*---------------------------------------------------------------------*/
 183     /*! \name                   Constructors                               */
 184     /*! \{                                                                 */
 185
 186     ShaderVariableOSGBase(void);
 187     ShaderVariableOSGBase(const ShaderVariableOSGBase &source);
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                   Destructors                                */
 192     /*! \{                                                                 */
 193
 194     virtual ~ShaderVariableOSGBase(void);
 195
 196     /*! \}                                                                 */
 197     /*---------------------------------------------------------------------*/
 198     /*! \name                     onCreate                                */
 199     /*! \{                                                                 */
 200
 201
 202     /*! \}                                                                 */
 203     /*---------------------------------------------------------------------*/
 204     /*! \name                    Generic Field Access                      */
 205     /*! \{                                                                 */
 206
 207      GetFieldHandlePtr  getHandleOsgVarType      (void) const;
 208      EditFieldHandlePtr editHandleOsgVarType     (void);
 209
 210     /*! \}                                                                 */
 211     /*---------------------------------------------------------------------*/
 212     /*! \name                    Field Get                                 */
 213     /*! \{                                                                 */
 214
 215
 216                   SFUInt32            *editSFOsgVarType     (void);
 217             const SFUInt32            *getSFOsgVarType      (void) const;
 218
 219
 220                   UInt32              &editOsgVarType     (void);
 221                   UInt32               getOsgVarType      (void) const;
 222
 223     /*! \}                                                                 */
 224     /*---------------------------------------------------------------------*/
 225     /*! \name                    Field Set                                 */
 226     /*! \{                                                                 */
 227
 228             void setOsgVarType     (const UInt32 value);
 229
 230     /*! \}                                                                 */
 231     /*---------------------------------------------------------------------*/
 232     /*! \name                Ptr MField Set                                */
 233     /*! \{                                                                 */
 234
 235     /*! \}                                                                 */
 236     /*---------------------------------------------------------------------*/
 237     /*! \name                       Sync                                   */
 238     /*! \{                                                                 */
 239
 240 #ifdef OSG_MT_CPTR_ASPECT
 241     virtual void execSyncV(      FieldContainer    &oFrom,
 242                                  ConstFieldMaskArg  whichField,
 243                                  AspectOffsetStore &oOffsets,
 244                                  ConstFieldMaskArg  syncMode  ,
 245                            const UInt32             uiSyncInfo);
 246
 247             void execSync (      ShaderVariableOSGBase *pFrom,
 248                                  ConstFieldMaskArg  whichField,
 249                                  AspectOffsetStore &oOffsets,
 250                                  ConstFieldMaskArg  syncMode  ,
 251                            const UInt32             uiSyncInfo);
 252 #endif
 253
 254     /*! \}                                                                 */
 255     /*---------------------------------------------------------------------*/
 256     /*! \name                       Edit                                   */
 257     /*! \{                                                                 */
 258
 259     /*! \}                                                                 */
 260     /*---------------------------------------------------------------------*/
 261     /*! \name                     Aspect Create                            */
 262     /*! \{                                                                 */
 263
 264 #ifdef OSG_MT_CPTR_ASPECT
 265     virtual FieldContainer *createAspectCopy(
 266                                     const FieldContainer *pRefAspect) const;
 267 #endif
 268
 269     /*! \}                                                                 */
 270     /*---------------------------------------------------------------------*/
 271     /*! \name                       Edit                                   */
 272     /*! \{                                                                 */
 273     /*! \}                                                                 */
 274     /*---------------------------------------------------------------------*/
 275     /*! \name                       Sync                                   */
 276     /*! \{                                                                 */
 277
 278     virtual void resolveLinks(void);
 279
 280     /*! \}                                                                 */
 281     /*==========================  PRIVATE  ================================*/
 282
 283   private:
 284     /*---------------------------------------------------------------------*/
 285
 286     // prohibit default functions (move to 'public' if you need one)
 287     void operator =(const ShaderVariableOSGBase &source);
 288 };
 289
 290 typedef ShaderVariableOSGBase *ShaderVariableOSGBaseP;
 291
 292 OSG_END_NAMESPACE
 293
 294 #endif /* _OSGSHADERVARIABLEOSGBASE_H_ */