Source/Contrib/CgFXMaterial/OSGCgFXTechniqueBase.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 CgFXTechnique
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGCGFXTECHNIQUEBASE_H_
  55 #define _OSGCGFXTECHNIQUEBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGContribCgFXDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGPrimeMaterial.h" // Parent
  67
  68 #include "OSGStateFields.h"             // RenderPassStates type
  69
  70 #include "OSGCgFXTechniqueFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class CgFXTechnique;
  76
  77 //! \brief CgFXTechnique Base Class.
  78
  79 class OSG_CONTRIBCGFX_DLLMAPPING CgFXTechniqueBase : public PrimeMaterial
  80 {
  81   public:
  82
  83     typedef PrimeMaterial Inherited;
  84     typedef PrimeMaterial ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(CgFXTechnique);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         RenderPassStatesFieldId = Inherited::NextFieldId,
  98         NextFieldId = RenderPassStatesFieldId + 1
  99     };
 100
 101     static const OSG::BitVector RenderPassStatesFieldMask =
 102         (TypeTraits<BitVector>::One << RenderPassStatesFieldId);
 103     static const OSG::BitVector NextFieldMask =
 104         (TypeTraits<BitVector>::One << NextFieldId);
 105
 106     typedef MFUnrecStatePtr   MFRenderPassStatesType;
 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  CgFXTechniqueTransitPtr  create          (void);
 144     static  CgFXTechnique           *createEmpty     (void);
 145
 146     static  CgFXTechniqueTransitPtr  createLocal     (
 147                                                BitVector bFlags = FCLocal::All);
 148
 149     static  CgFXTechnique            *createEmptyLocal(
 150                                               BitVector bFlags = FCLocal::All);
 151
 152     static  CgFXTechniqueTransitPtr  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     MFUnrecStatePtr   _mfRenderPassStates;
 180
 181     /*! \}                                                                 */
 182     /*---------------------------------------------------------------------*/
 183     /*! \name                   Constructors                               */
 184     /*! \{                                                                 */
 185
 186     CgFXTechniqueBase(void);
 187     CgFXTechniqueBase(const CgFXTechniqueBase &source);
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                   Destructors                                */
 192     /*! \{                                                                 */
 193
 194     virtual ~CgFXTechniqueBase(void);
 195
 196     /*! \}                                                                 */
 197     /*---------------------------------------------------------------------*/
 198     /*! \name                     onCreate                                */
 199     /*! \{                                                                 */
 200
 201     void onCreate(const CgFXTechnique *source = NULL);
 202
 203     /*! \}                                                                 */
 204     /*---------------------------------------------------------------------*/
 205     /*! \name                    Generic Field Access                      */
 206     /*! \{                                                                 */
 207
 208      GetFieldHandlePtr  getHandleRenderPassStates (void) const;
 209      EditFieldHandlePtr editHandleRenderPassStates(void);
 210
 211     /*! \}                                                                 */
 212     /*---------------------------------------------------------------------*/
 213     /*! \name                    Field Get                                 */
 214     /*! \{                                                                 */
 215
 216             const MFUnrecStatePtr     *getMFRenderPassStates (void) const;
 217
 218
 219                   State * getRenderPassStates(const UInt32 index) const;
 220
 221     /*! \}                                                                 */
 222     /*---------------------------------------------------------------------*/
 223     /*! \name                    Field Set                                 */
 224     /*! \{                                                                 */
 225
 226
 227     /*! \}                                                                 */
 228     /*---------------------------------------------------------------------*/
 229     /*! \name                Ptr MField Set                                */
 230     /*! \{                                                                 */
 231
 232     void addPassState              (State * const value   );
 233     void assignRenderPassStates          (const MFUnrecStatePtr   &value);
 234     void clearPassStates            (void                          );
 235     void insertPassState      (UInt32         uiIndex,
 236                                              State * const value   );
 237     void replacePassState  (UInt32         uiIndex,
 238                                              State * const value   );
 239     void replacePassStateByObj (State * const pOldElem,
 240                                              State * const pNewElem);
 241     void subPassState    (UInt32                uiIndex );
 242     void subPassStateByObj(State * const value   );
 243
 244     /*! \}                                                                 */
 245     /*---------------------------------------------------------------------*/
 246     /*! \name                       Sync                                   */
 247     /*! \{                                                                 */
 248
 249 #ifdef OSG_MT_CPTR_ASPECT
 250     virtual void execSyncV(      FieldContainer    &oFrom,
 251                                  ConstFieldMaskArg  whichField,
 252                                  AspectOffsetStore &oOffsets,
 253                                  ConstFieldMaskArg  syncMode  ,
 254                            const UInt32             uiSyncInfo);
 255
 256             void execSync (      CgFXTechniqueBase *pFrom,
 257                                  ConstFieldMaskArg  whichField,
 258                                  AspectOffsetStore &oOffsets,
 259                                  ConstFieldMaskArg  syncMode  ,
 260                            const UInt32             uiSyncInfo);
 261 #endif
 262
 263     /*! \}                                                                 */
 264     /*---------------------------------------------------------------------*/
 265     /*! \name                       Edit                                   */
 266     /*! \{                                                                 */
 267
 268     /*! \}                                                                 */
 269     /*---------------------------------------------------------------------*/
 270     /*! \name                     Aspect Create                            */
 271     /*! \{                                                                 */
 272
 273 #ifdef OSG_MT_CPTR_ASPECT
 274     virtual FieldContainer *createAspectCopy(
 275                                     const FieldContainer *pRefAspect) const;
 276 #endif
 277
 278     /*! \}                                                                 */
 279     /*---------------------------------------------------------------------*/
 280     /*! \name                       Edit                                   */
 281     /*! \{                                                                 */
 282     /*! \}                                                                 */
 283     /*---------------------------------------------------------------------*/
 284     /*! \name                       Sync                                   */
 285     /*! \{                                                                 */
 286
 287     virtual void resolveLinks(void);
 288
 289     /*! \}                                                                 */
 290     /*==========================  PRIVATE  ================================*/
 291
 292   private:
 293     /*---------------------------------------------------------------------*/
 294
 295     // prohibit default functions (move to 'public' if you need one)
 296     void operator =(const CgFXTechniqueBase &source);
 297 };
 298
 299 typedef CgFXTechniqueBase *CgFXTechniqueBaseP;
 300
 301 OSG_END_NAMESPACE
 302
 303 #endif /* _OSGCGFXTECHNIQUEBASE_H_ */