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