Source/System/Window/Background/OSGTextureGrabBackgroundBase.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 TextureGrabBackground
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGTEXTUREGRABBACKGROUNDBASE_H_
  55 #define _OSGTEXTUREGRABBACKGROUNDBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGWindowDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGSolidBackground.h" // Parent
  67
  68 #include "OSGTextureObjChunkFields.h"   // Texture type
  69 #include "OSGSysFields.h"               // AutoResize type
  70 #include "OSGBaseFields.h"              // BindTarget type
  71
  72 #include "OSGTextureGrabBackgroundFields.h"
  73
  74 OSG_BEGIN_NAMESPACE
  75
  76
  77 class TextureGrabBackground;
  78
  79 //! \brief TextureGrabBackground Base Class.
  80
  81 class OSG_WINDOW_DLLMAPPING TextureGrabBackgroundBase : public SolidBackground
  82 {
  83   public:
  84
  85     typedef SolidBackground Inherited;
  86     typedef SolidBackground ParentContainer;
  87
  88     typedef Inherited::TypeObject TypeObject;
  89     typedef TypeObject::InitPhase InitPhase;
  90
  91     OSG_GEN_INTERNALPTR(TextureGrabBackground);
  92
  93     /*==========================  PUBLIC  =================================*/
  94
  95   public:
  96
  97     enum
  98     {
  99         TextureFieldId = Inherited::NextFieldId,
 100         AutoResizeFieldId = TextureFieldId + 1,
 101         BindTargetFieldId = AutoResizeFieldId + 1,
 102         CopyTargetFieldId = BindTargetFieldId + 1,
 103         NextFieldId = CopyTargetFieldId + 1
 104     };
 105
 106     static const OSG::BitVector TextureFieldMask =
 107         (TypeTraits<BitVector>::One << TextureFieldId);
 108     static const OSG::BitVector AutoResizeFieldMask =
 109         (TypeTraits<BitVector>::One << AutoResizeFieldId);
 110     static const OSG::BitVector BindTargetFieldMask =
 111         (TypeTraits<BitVector>::One << BindTargetFieldId);
 112     static const OSG::BitVector CopyTargetFieldMask =
 113         (TypeTraits<BitVector>::One << CopyTargetFieldId);
 114     static const OSG::BitVector NextFieldMask =
 115         (TypeTraits<BitVector>::One << NextFieldId);
 116
 117     typedef SFUnrecTextureObjChunkPtr SFTextureType;
 118     typedef SFBool            SFAutoResizeType;
 119     typedef SFGLenum          SFBindTargetType;
 120     typedef SFGLenum          SFCopyTargetType;
 121
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                    Class Get                                 */
 124     /*! \{                                                                 */
 125
 126     static FieldContainerType &getClassType   (void);
 127     static UInt32              getClassTypeId (void);
 128     static UInt16              getClassGroupId(void);
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                FieldContainer Get                            */
 133     /*! \{                                                                 */
 134
 135     virtual       FieldContainerType &getType         (void);
 136     virtual const FieldContainerType &getType         (void) const;
 137
 138     virtual       UInt32              getContainerSize(void) const;
 139
 140     /*! \}                                                                 */
 141     /*---------------------------------------------------------------------*/
 142     /*! \name                    Field Get                                 */
 143     /*! \{                                                                 */
 144
 145             const SFUnrecTextureObjChunkPtr *getSFTexture        (void) const;
 146                   SFUnrecTextureObjChunkPtr *editSFTexture        (void);
 147
 148                   SFBool              *editSFAutoResize     (void);
 149             const SFBool              *getSFAutoResize      (void) const;
 150
 151                   SFGLenum            *editSFBindTarget     (void);
 152             const SFGLenum            *getSFBindTarget      (void) const;
 153
 154                   SFGLenum            *editSFCopyTarget     (void);
 155             const SFGLenum            *getSFCopyTarget      (void) const;
 156
 157
 158                   TextureObjChunk * getTexture        (void) const;
 159
 160                   bool                &editAutoResize     (void);
 161                   bool                 getAutoResize      (void) const;
 162
 163                   GLenum              &editBindTarget     (void);
 164             const GLenum              &getBindTarget      (void) const;
 165
 166                   GLenum              &editCopyTarget     (void);
 167             const GLenum              &getCopyTarget      (void) const;
 168
 169     /*! \}                                                                 */
 170     /*---------------------------------------------------------------------*/
 171     /*! \name                    Field Set                                 */
 172     /*! \{                                                                 */
 173
 174             void setTexture        (TextureObjChunk * const value);
 175             void setAutoResize     (const bool value);
 176             void setBindTarget     (const GLenum &value);
 177             void setCopyTarget     (const GLenum &value);
 178
 179     /*! \}                                                                 */
 180     /*---------------------------------------------------------------------*/
 181     /*! \name                Ptr Field Set                                 */
 182     /*! \{                                                                 */
 183
 184     /*! \}                                                                 */
 185     /*---------------------------------------------------------------------*/
 186     /*! \name                Ptr MField Set                                */
 187     /*! \{                                                                 */
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                   Binary Access                              */
 192     /*! \{                                                                 */
 193
 194     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 195     virtual void   copyToBin  (BinaryDataHandler &pMem,
 196                                ConstFieldMaskArg  whichField);
 197     virtual void   copyFromBin(BinaryDataHandler &pMem,
 198                                ConstFieldMaskArg  whichField);
 199
 200
 201     /*! \}                                                                 */
 202     /*---------------------------------------------------------------------*/
 203     /*! \name                   Construction                               */
 204     /*! \{                                                                 */
 205
 206     static  TextureGrabBackgroundTransitPtr  create          (void);
 207     static  TextureGrabBackground           *createEmpty     (void);
 208
 209     static  TextureGrabBackgroundTransitPtr  createLocal     (
 210                                                BitVector bFlags = FCLocal::All);
 211
 212     static  TextureGrabBackground            *createEmptyLocal(
 213                                               BitVector bFlags = FCLocal::All);
 214
 215     static  TextureGrabBackgroundTransitPtr  createDependent  (BitVector bFlags);
 216
 217     /*! \}                                                                 */
 218     /*---------------------------------------------------------------------*/
 219     /*! \name                       Copy                                   */
 220     /*! \{                                                                 */
 221
 222     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 223     virtual FieldContainerTransitPtr shallowCopyLocal(
 224                                        BitVector bFlags = FCLocal::All) const;
 225     virtual FieldContainerTransitPtr shallowCopyDependent(
 226                                                       BitVector bFlags) const;
 227
 228     /*! \}                                                                 */
 229     /*=========================  PROTECTED  ===============================*/
 230
 231   protected:
 232
 233     static TypeObject _type;
 234
 235     static       void   classDescInserter(TypeObject &oType);
 236     static const Char8 *getClassname     (void             );
 237
 238     /*---------------------------------------------------------------------*/
 239     /*! \name                      Fields                                  */
 240     /*! \{                                                                 */
 241
 242     SFUnrecTextureObjChunkPtr _sfTexture;
 243     SFBool            _sfAutoResize;
 244     SFGLenum          _sfBindTarget;
 245     SFGLenum          _sfCopyTarget;
 246
 247     /*! \}                                                                 */
 248     /*---------------------------------------------------------------------*/
 249     /*! \name                   Constructors                               */
 250     /*! \{                                                                 */
 251
 252     TextureGrabBackgroundBase(void);
 253     TextureGrabBackgroundBase(const TextureGrabBackgroundBase &source);
 254
 255     /*! \}                                                                 */
 256     /*---------------------------------------------------------------------*/
 257     /*! \name                   Destructors                                */
 258     /*! \{                                                                 */
 259
 260     virtual ~TextureGrabBackgroundBase(void);
 261
 262     /*! \}                                                                 */
 263     /*---------------------------------------------------------------------*/
 264     /*! \name                     onCreate                                */
 265     /*! \{                                                                 */
 266
 267     void onCreate(const TextureGrabBackground *source = NULL);
 268
 269     /*! \}                                                                 */
 270     /*---------------------------------------------------------------------*/
 271     /*! \name                    Generic Field Access                      */
 272     /*! \{                                                                 */
 273
 274      GetFieldHandlePtr  getHandleTexture         (void) const;
 275      EditFieldHandlePtr editHandleTexture        (void);
 276      GetFieldHandlePtr  getHandleAutoResize      (void) const;
 277      EditFieldHandlePtr editHandleAutoResize     (void);
 278      GetFieldHandlePtr  getHandleBindTarget      (void) const;
 279      EditFieldHandlePtr editHandleBindTarget     (void);
 280      GetFieldHandlePtr  getHandleCopyTarget      (void) const;
 281      EditFieldHandlePtr editHandleCopyTarget     (void);
 282
 283     /*! \}                                                                 */
 284     /*---------------------------------------------------------------------*/
 285     /*! \name                       Sync                                   */
 286     /*! \{                                                                 */
 287
 288 #ifdef OSG_MT_CPTR_ASPECT
 289     virtual void execSyncV(      FieldContainer    &oFrom,
 290                                  ConstFieldMaskArg  whichField,
 291                                  AspectOffsetStore &oOffsets,
 292                                  ConstFieldMaskArg  syncMode  ,
 293                            const UInt32             uiSyncInfo);
 294
 295             void execSync (      TextureGrabBackgroundBase *pFrom,
 296                                  ConstFieldMaskArg  whichField,
 297                                  AspectOffsetStore &oOffsets,
 298                                  ConstFieldMaskArg  syncMode  ,
 299                            const UInt32             uiSyncInfo);
 300 #endif
 301
 302     /*! \}                                                                 */
 303     /*---------------------------------------------------------------------*/
 304     /*! \name                       Edit                                   */
 305     /*! \{                                                                 */
 306
 307     /*! \}                                                                 */
 308     /*---------------------------------------------------------------------*/
 309     /*! \name                     Aspect Create                            */
 310     /*! \{                                                                 */
 311
 312 #ifdef OSG_MT_CPTR_ASPECT
 313     virtual FieldContainer *createAspectCopy(
 314                                     const FieldContainer *pRefAspect) const;
 315 #endif
 316
 317     /*! \}                                                                 */
 318     /*---------------------------------------------------------------------*/
 319     /*! \name                       Edit                                   */
 320     /*! \{                                                                 */
 321     /*! \}                                                                 */
 322     /*---------------------------------------------------------------------*/
 323     /*! \name                       Sync                                   */
 324     /*! \{                                                                 */
 325
 326     virtual void resolveLinks(void);
 327
 328     /*! \}                                                                 */
 329     /*==========================  PRIVATE  ================================*/
 330
 331   private:
 332     /*---------------------------------------------------------------------*/
 333
 334     // prohibit default functions (move to 'public' if you need one)
 335     void operator =(const TextureGrabBackgroundBase &source);
 336 };
 337
 338 typedef TextureGrabBackgroundBase *TextureGrabBackgroundBaseP;
 339
 340 OSG_END_NAMESPACE
 341
 342 #endif /* _OSGTEXTUREGRABBACKGROUNDBASE_H_ */