Source/System/Window/Passive/OSGPassiveBackgroundBase.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 PassiveBackground
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGPASSIVEBACKGROUNDBASE_H_
  55 #define _OSGPASSIVEBACKGROUNDBASE_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 "OSGBackground.h" // Parent
  67
  68 #include "OSGSysFields.h"               // ClearFrameBufferObject type
  69 #include "OSGRenderFunctorCallbackFields.h" // ClearCallback type
  70
  71 #include "OSGPassiveBackgroundFields.h"
  72
  73 OSG_BEGIN_NAMESPACE
  74
  75
  76 class PassiveBackground;
  77
  78 //! \brief PassiveBackground Base Class.
  79
  80 class OSG_WINDOW_DLLMAPPING PassiveBackgroundBase : public Background
  81 {
  82   public:
  83
  84     typedef Background Inherited;
  85     typedef Background ParentContainer;
  86
  87     typedef Inherited::TypeObject TypeObject;
  88     typedef TypeObject::InitPhase InitPhase;
  89
  90     OSG_GEN_INTERNALPTR(PassiveBackground);
  91
  92     /*==========================  PUBLIC  =================================*/
  93
  94   public:
  95
  96     enum
  97     {
  98         ClearFrameBufferObjectFieldId = Inherited::NextFieldId,
  99         ClearCallbackFieldId = ClearFrameBufferObjectFieldId + 1,
 100         NextFieldId = ClearCallbackFieldId + 1
 101     };
 102
 103     static const OSG::BitVector ClearFrameBufferObjectFieldMask =
 104         (TypeTraits<BitVector>::One << ClearFrameBufferObjectFieldId);
 105     static const OSG::BitVector ClearCallbackFieldMask =
 106         (TypeTraits<BitVector>::One << ClearCallbackFieldId);
 107     static const OSG::BitVector NextFieldMask =
 108         (TypeTraits<BitVector>::One << NextFieldId);
 109
 110     typedef SFBool            SFClearFrameBufferObjectType;
 111     typedef SFRenderFunctorCallback SFClearCallbackType;
 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                   SFBool              *editSFClearFrameBufferObject(void);
 138             const SFBool              *getSFClearFrameBufferObject (void) const;
 139
 140
 141                   bool                &editClearFrameBufferObject(void);
 142                   bool                 getClearFrameBufferObject (void) const;
 143
 144     /*! \}                                                                 */
 145     /*---------------------------------------------------------------------*/
 146     /*! \name                    Field Set                                 */
 147     /*! \{                                                                 */
 148
 149             void setClearFrameBufferObject(const bool 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     /*---------------------------------------------------------------------*/
 170     /*! \name                   Construction                               */
 171     /*! \{                                                                 */
 172
 173     static  PassiveBackgroundTransitPtr  create          (void);
 174     static  PassiveBackground           *createEmpty     (void);
 175
 176     static  PassiveBackgroundTransitPtr  createLocal     (
 177                                                BitVector bFlags = FCLocal::All);
 178
 179     static  PassiveBackground            *createEmptyLocal(
 180                                               BitVector bFlags = FCLocal::All);
 181
 182     static  PassiveBackgroundTransitPtr  createDependent  (BitVector bFlags);
 183
 184     /*! \}                                                                 */
 185     /*---------------------------------------------------------------------*/
 186     /*! \name                       Copy                                   */
 187     /*! \{                                                                 */
 188
 189     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 190     virtual FieldContainerTransitPtr shallowCopyLocal(
 191                                        BitVector bFlags = FCLocal::All) const;
 192     virtual FieldContainerTransitPtr shallowCopyDependent(
 193                                                       BitVector bFlags) const;
 194
 195     /*! \}                                                                 */
 196     /*=========================  PROTECTED  ===============================*/
 197
 198   protected:
 199
 200     static TypeObject _type;
 201
 202     static       void   classDescInserter(TypeObject &oType);
 203     static const Char8 *getClassname     (void             );
 204
 205     /*---------------------------------------------------------------------*/
 206     /*! \name                      Fields                                  */
 207     /*! \{                                                                 */
 208
 209     SFBool            _sfClearFrameBufferObject;
 210     SFRenderFunctorCallback _sfClearCallback;
 211
 212     /*! \}                                                                 */
 213     /*---------------------------------------------------------------------*/
 214     /*! \name                   Constructors                               */
 215     /*! \{                                                                 */
 216
 217     PassiveBackgroundBase(void);
 218     PassiveBackgroundBase(const PassiveBackgroundBase &source);
 219
 220     /*! \}                                                                 */
 221     /*---------------------------------------------------------------------*/
 222     /*! \name                   Destructors                                */
 223     /*! \{                                                                 */
 224
 225     virtual ~PassiveBackgroundBase(void);
 226
 227     /*! \}                                                                 */
 228     /*---------------------------------------------------------------------*/
 229     /*! \name                     onCreate                                */
 230     /*! \{                                                                 */
 231
 232
 233     /*! \}                                                                 */
 234     /*---------------------------------------------------------------------*/
 235     /*! \name                    Generic Field Access                      */
 236     /*! \{                                                                 */
 237
 238      GetFieldHandlePtr  getHandleClearFrameBufferObject (void) const;
 239      EditFieldHandlePtr editHandleClearFrameBufferObject(void);
 240      GetFieldHandlePtr  getHandleClearCallback   (void) const;
 241      EditFieldHandlePtr editHandleClearCallback  (void);
 242
 243     /*! \}                                                                 */
 244     /*---------------------------------------------------------------------*/
 245     /*! \name                       Sync                                   */
 246     /*! \{                                                                 */
 247
 248 #ifdef OSG_MT_CPTR_ASPECT
 249     virtual void execSyncV(      FieldContainer    &oFrom,
 250                                  ConstFieldMaskArg  whichField,
 251                                  AspectOffsetStore &oOffsets,
 252                                  ConstFieldMaskArg  syncMode  ,
 253                            const UInt32             uiSyncInfo);
 254
 255             void execSync (      PassiveBackgroundBase *pFrom,
 256                                  ConstFieldMaskArg  whichField,
 257                                  AspectOffsetStore &oOffsets,
 258                                  ConstFieldMaskArg  syncMode  ,
 259                            const UInt32             uiSyncInfo);
 260 #endif
 261
 262     /*! \}                                                                 */
 263     /*---------------------------------------------------------------------*/
 264     /*! \name                       Edit                                   */
 265     /*! \{                                                                 */
 266
 267     /*! \}                                                                 */
 268     /*---------------------------------------------------------------------*/
 269     /*! \name                     Aspect Create                            */
 270     /*! \{                                                                 */
 271
 272 #ifdef OSG_MT_CPTR_ASPECT
 273     virtual FieldContainer *createAspectCopy(
 274                                     const FieldContainer *pRefAspect) const;
 275 #endif
 276
 277     /*! \}                                                                 */
 278     /*---------------------------------------------------------------------*/
 279     /*! \name                       Edit                                   */
 280     /*! \{                                                                 */
 281     /*! \}                                                                 */
 282     /*---------------------------------------------------------------------*/
 283     /*! \name                       Sync                                   */
 284     /*! \{                                                                 */
 285
 286     virtual void resolveLinks(void);
 287
 288     /*! \}                                                                 */
 289     /*==========================  PRIVATE  ================================*/
 290
 291   private:
 292     /*---------------------------------------------------------------------*/
 293
 294     // prohibit default functions (move to 'public' if you need one)
 295     void operator =(const PassiveBackgroundBase &source);
 296 };
 297
 298 typedef PassiveBackgroundBase *PassiveBackgroundBaseP;
 299
 300 OSG_END_NAMESPACE
 301
 302 #endif /* _OSGPASSIVEBACKGROUNDBASE_H_ */