Source/System/Window/Base/OSGBackground.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 #ifndef _OSGBACKGROUND_H_
  40 #define _OSGBACKGROUND_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBackgroundBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 class DrawEnv;
  50
  51 /*! \brief Background clearing base class. See \ref
  52     PageSystemWindowBackground for a description.
  53
  54   \ingroup GrpSystemWindowBase
  55   \ingroup GrpLibOSGSystem
  56   \includebasedoc
  57  */
  58
  59 class OSG_SYSTEM_DLLMAPPING Background : public BackgroundBase
  60 {
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     /*---------------------------------------------------------------------*/
  66     /*! \name                    access fields                             */
  67     /*! \{                                                                 */
  68
  69     virtual void clear(DrawEnv *pEnv) = 0;
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                     transformation                           */
  74     /*! \{                                                                 */
  75
  76     virtual void changed(ConstFieldMaskArg whichField,
  77                          UInt32            origin,
  78                          BitVector         detail);
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                   dump                                       */
  83     /*! \{                                                                 */
  84
  85     virtual void dump(      UInt32    uiIndent = 0,
  86                       const BitVector bvFlags  = 0) const;
  87
  88     /*! \}                                                                 */
  89     /*=========================  PROTECTED  ===============================*/
  90
  91   protected:
  92
  93     /*---------------------------------------------------------------------*/
  94     /*! \name                   Constructors                               */
  95     /*! \{                                                                 */
  96
  97     Background(void);
  98     Background(const Background &source);
  99
 100     /*! \}                                                                 */
 101     /*---------------------------------------------------------------------*/
 102     /*! \name                   Destructors                                */
 103     /*! \{                                                                 */
 104
 105     virtual ~Background(void);
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                       Init                                   */
 110     /*! \{                                                                 */
 111
 112     static void initMethod(InitPhase ePhase);
 113
 114     /*! \}                                                                 */
 115     /*=========================  PRIVATE    ===============================*/
 116
 117   private:
 118
 119     typedef BackgroundBase Inherited;
 120
 121     friend class FieldContainer;
 122     friend class BackgroundBase;
 123
 124     // prohibit default functions (move to 'public' if you need one)
 125     void operator =(const Background &source);
 126 };
 127
 128 //---------------------------------------------------------------------------
 129 //   Exported Types
 130 //---------------------------------------------------------------------------
 131
 132 typedef Background *BackgroundP;
 133
 134 OSG_END_NAMESPACE
 135
 136 #include "OSGBackgroundBase.inl"
 137 #include "OSGBackground.inl"
 138
 139 #endif /* _OSGBACKGROUND_H_ */