Source/System/Window/Passive/OSGPassiveBackground.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  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 #ifndef _OSGPASSIVEBACKGROUND_H_
  41 #define _OSGPASSIVEBACKGROUND_H_
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGPassiveBackgroundBase.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class Viewport;
  51
  52 /*! \brief Passive Background  class. See \ref
  53            PageSystemWindowBackgroundPassive for a description.
  54     \ingroup GrpWindowPassiveObj
  55     \ingroup GrpLibOSGWindow
  56     \includebasedoc
  57  */
  58
  59 class OSG_WINDOW_DLLMAPPING PassiveBackground :
  60     public PassiveBackgroundBase
  61 {
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     typedef PassiveBackgroundBase                       Inherited;
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name                     your_category                            */
  70     /*! \{                                                                 */
  71
  72     void clear(DrawEnv *pEnv);
  73
  74     /*! \}                                                                 */
  75     /*---------------------------------------------------------------------*/
  76     /*! \name                     transformation                           */
  77     /*! \{                                                                 */
  78
  79     void setClearCallback(RenderFunctor func,
  80                           std::string   createSymbol);
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                     transformation                           */
  85     /*! \{                                                                 */
  86
  87     virtual void changed(ConstFieldMaskArg whichField,
  88                          UInt32            origin,
  89                          BitVector         detail);
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                   dump                                       */
  93     /*! \{                                                                 */
  94
  95     virtual void dump(      UInt32    uiIndent = 0,
  96                       const BitVector bvFlags  = 0) const;
  97
  98     /*! \}                                                                 */
  99     /*=========================  PROTECTED  ===============================*/
 100
 101   protected:
 102
 103     static UInt32 _uiFramebufferObjectExt;
 104     static UInt32 _uiFramebufferBlitExt;
 105
 106     static UInt32 _uiFuncBindFramebuffer;
 107     static UInt32 _uiFuncBlitFramebuffer;
 108
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Constructors                               */
 111     /*! \{                                                                 */
 112
 113     PassiveBackground(void);
 114
 115     PassiveBackground(const PassiveBackground &source);
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                   Destructors                                */
 120     /*! \{                                                                 */
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                   Destructors                                */
 125     /*! \{                                                                 */
 126
 127     virtual ~PassiveBackground(void);
 128
 129
 130     static void initMethod( InitPhase ePhase );
 131
 132     /*! \}                                                                 */
 133     /*=========================  PRIVATE  =================================*/
 134
 135   private:
 136
 137     friend class FieldContainer;
 138     friend class PassiveBackgroundBase;
 139
 140     void operator =(const PassiveBackground &source);
 141 };
 142
 143 //---------------------------------------------------------------------------
 144 //   Exported Types
 145 //---------------------------------------------------------------------------
 146
 147
 148 /** \brief class pointer
 149  */
 150 typedef PassiveBackground *PassiveBackgroundP;
 151
 152 OSG_END_NAMESPACE
 153
 154 #include "OSGPassiveBackgroundBase.inl"
 155 #include "OSGPassiveBackground.inl"
 156
 157 #endif /* _OSGPASSIVEBACKGROUND_H_ */