Source/WindowSystem/CoreGL/OSGCoreGLWindow.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGCOREGLWINDOW_H_
  40 #define _OSGCOREGLWINDOW_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #if defined(__APPLE__) || defined(OSG_DO_DOC)
  46
  47 #include "OSGCoreGLWindowBase.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief CoreGLWindow class. See \ref
  52            PageWindowCoreGL for a description.
  53     \ingroup GrpWindowCoreGLObj
  54     \ingroup GrpLibOSGWindowCoreGL
  55     \includebasedoc
  56  */
  57
  58 class OSG_WINDOWCOREGL_DLLMAPPING CoreGLWindow : public CoreGLWindowBase
  59 {
  60   protected:
  61
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     typedef CoreGLWindowBase Inherited;
  67     typedef CoreGLWindow     Self;
  68
  69     /*---------------------------------------------------------------------*/
  70     /*! \name                      Sync                                    */
  71     /*! \{                                                                 */
  72
  73     virtual void changed(ConstFieldMaskArg whichField,
  74                          UInt32            origin,
  75                          BitVector         details    );
  76
  77     /*! \}                                                                 */
  78     /*---------------------------------------------------------------------*/
  79     /*! \name                     Output                                   */
  80     /*! \{                                                                 */
  81
  82     virtual void dump(      UInt32     uiIndent = 0,
  83                       const BitVector  bvFlags  = 0) const;
  84
  85     /*! \}                                                                 */
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                Window functions                              */
  88     /*! \{                                                                 */
  89
  90     virtual void init     (GLInitFunctor oFunc = GLInitFunctor());
  91     virtual void terminate(void                                 );
  92
  93
  94     /*! \}                                                                 */
  95     /*=========================  PROTECTED  ===============================*/
  96
  97   protected:
  98
  99     // Variables should all be in CoreGLWindowBase.
 100
 101     /*---------------------------------------------------------------------*/
 102     /*! \name                  Constructors                                */
 103     /*! \{                                                                 */
 104
 105     CoreGLWindow(void);
 106     CoreGLWindow(const CoreGLWindow &source);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Destructors                                */
 111     /*! \{                                                                 */
 112
 113     virtual ~CoreGLWindow(void);
 114
 115     /*! \}                                                                 */
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                      Init                                    */
 118     /*! \{                                                                 */
 119
 120     static void initMethod(InitPhase ePhase);
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name      Window system implementation functions                  */
 125     /*! \{                                                                 */
 126
 127     virtual void doActivate  (void);
 128     virtual void doDeactivate(void);
 129     virtual bool doSwap      (void);
 130
 131     virtual bool hasContext  (void);
 132
 133     /*! \}                                                                 */
 134     /*==========================  PRIVATE  ================================*/
 135
 136   private:
 137
 138     friend class FieldContainer;
 139     friend class CoreGLWindowBase;
 140
 141     // prohibit default functions (move to 'public' if you need one)
 142     void operator =(const CoreGLWindow &source);
 143 };
 144
 145 typedef CoreGLWindow *CoreGLWindowP;
 146
 147 OSG_END_NAMESPACE
 148
 149 #include "OSGCoreGLWindowBase.inl"
 150 #include "OSGCoreGLWindow.inl"
 151
 152 #endif /* __APPLE__ */
 153
 154 #endif /* _OSGCOREGLWINDOW_H_ */