Source/System/Window/Base/OSGViewarea.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 _OSGVIEWAREA_H_
  40 #define _OSGVIEWAREA_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGViewareaBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 class RenderActionBase;
  50 class TraversalValidator;
  51 class FrameBufferObject;
  52 class Window;
  53
  54 /*! \brief Viewarea base class. See \ref
  55     PageSystemWindowViewareas for a description.
  56
  57   \ingroup GrpSystemWindowBase
  58   \ingroup GrpLibOSGSystem
  59   \includebasedoc
  60  */
  61
  62 class OSG_SYSTEM_DLLMAPPING Viewarea : public ViewareaBase
  63 {
  64     /*==========================  PUBLIC  =================================*/
  65
  66   public:
  67
  68     typedef ViewareaBase                           Inherited;
  69
  70     /*---------------------------------------------------------------------*/
  71     /*! \name                    access                                    */
  72     /*! \{                                                                 */
  73
  74     void setSize          (Real32   left,
  75                            Real32   bottom,
  76                            Real32   right,
  77                            Real32   top           );
  78
  79     void computePixelSizes(Window  *pWin,
  80
  81                            UInt32   &uiPixelWidth,
  82                            UInt32   &uiPixelHeight);
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                    your_category                             */
  86     /*! \{                                                                 */
  87
  88     virtual void render      (RenderActionBase *action);
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                      Sync                                    */
  93     /*! \{                                                                 */
  94
  95     virtual bool               isPassive(void);
  96     virtual FrameBufferObject *getTarget(void);
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                      Sync                                    */
 101     /*! \{                                                                 */
 102
 103     TraversalValidator *getTravValidator(void);
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                   change                                     */
 108     /*! \{                                                                 */
 109
 110     virtual void changed(ConstFieldMaskArg whichField,
 111                          UInt32            origin,
 112                          BitVector         detail);
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                   dump                                       */
 117     /*! \{                                                                 */
 118
 119     virtual void dump(      UInt32    uiIndent = 0,
 120                       const BitVector bvFlags  = 0) const;
 121
 122     /*! \}                                                                 */
 123     /*=========================  PROTECTED  ===============================*/
 124
 125  protected:
 126
 127     TraversalValidator *_pTravValidator;
 128
 129     /*---------------------------------------------------------------------*/
 130     /*! \name                   Constructors                               */
 131     /*! \{                                                                 */
 132
 133     Viewarea(void);
 134     Viewarea(const Viewarea &source);
 135
 136     /*! \}                                                                 */
 137     /*---------------------------------------------------------------------*/
 138     /*! \name                   Destructors                                */
 139     /*! \{                                                                 */
 140
 141     virtual ~Viewarea(void);
 142
 143     /*! \}                                                                 */
 144     /*---------------------------------------------------------------------*/
 145     /*! \name                   Destructors                                */
 146     /*! \{                                                                 */
 147
 148     static void initMethod(InitPhase ePhase);
 149
 150     /*! \}                                                                 */
 151     /*---------------------------------------------------------------------*/
 152     /*! \name                MT Construction                               */
 153     /*! \{                                                                 */
 154
 155     /*! \}                                                                 */
 156     /*---------------------------------------------------------------------*/
 157     /*! \name                MT Construction                               */
 158     /*! \{                                                                 */
 159
 160     void onCreate       (const Viewarea *source = NULL);
 161
 162     void onCreateAspect (const Viewarea *createAspect,
 163                          const Viewarea *source = NULL);
 164
 165     void onDestroy      (      UInt32    uiContainerId);
 166
 167     void onDestroyAspect(      UInt32    uiContainerId,
 168                                UInt32    uiAspect     );
 169
 170     /*! \}                                                                 */
 171     /*=========================  PRIVATE    ===============================*/
 172
 173  private:
 174
 175     friend class FieldContainer;
 176     friend class ViewareaBase;
 177     friend class ViewareaDrawTask;
 178
 179     // prohibit default functions (move to 'public' if you need one)
 180     void operator =(const Viewarea &source);
 181 };
 182
 183 //---------------------------------------------------------------------------
 184 //   Exported Types
 185 //---------------------------------------------------------------------------
 186
 187 typedef Viewarea *ViewareaP;
 188
 189 OSG_END_NAMESPACE
 190
 191 #include "OSGViewareaBase.inl"
 192 #include "OSGViewarea.inl"
 193
 194 #endif /* _OSGVIEWAREA_H_ */