Source/System/Window/Base/OSGCameraDecorator.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 _OSGCAMERADECORATOR_H_
  40 #define _OSGCAMERADECORATOR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGCameraDecoratorBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief Camera Decorator base class, see \ref
  50     PageSystemWindowCameraDecorators for a description.
  51
  52   \ingroup GrpSystemWindowCamera
  53   \ingroup GrpLibOSGSystem
  54   \includebasedoc
  55 */
  56
  57 class OSG_SYSTEM_DLLMAPPING CameraDecorator : public CameraDecoratorBase
  58 {
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     typedef CameraDecoratorBase                           Inherited;
  64
  65     /*---------------------------------------------------------------------*/
  66     /*! \name                      Sync                                    */
  67     /*! \{                                                                 */
  68
  69     virtual void changed(ConstFieldMaskArg whichField,
  70                          UInt32            origin,
  71                          BitVector         detail);
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name                      your_category                           */
  76     /*! \{                                                                 */
  77
  78     virtual void getProjection           (Matrix        &result,
  79                                           UInt32 width,
  80                                           UInt32 height);
  81
  82     virtual void getProjectionTranslation(Matrix        &result,
  83                                           UInt32 width,
  84                                           UInt32 height);
  85
  86     virtual void getViewing              (Matrix        &result,
  87                                           UInt32 width,
  88                                           UInt32 height);
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                     Output                                   */
  93     /*! \{                                                                 */
  94
  95     virtual Vec2u tileGetFullSize(void) const;
  96     virtual Vec4f tileGetRegion  (void) const;
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                     Output                                   */
 101     /*! \{                                                                 */
 102
 103     virtual void dump(      UInt32     uiIndent = 0,
 104                       const BitVector  bvFlags  = 0) const;
 105
 106     /*! \}                                                                 */
 107     /*=========================  PROTECTED  ===============================*/
 108
 109   protected:
 110
 111     // Variables should all be in CameraDecoratorBase.
 112
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                  Constructors                                */
 115     /*! \{                                                                 */
 116
 117     CameraDecorator(void);
 118     CameraDecorator(const CameraDecorator &source);
 119
 120     /*! \}                                                                 */
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                   Destructors                                */
 123     /*! \{                                                                 */
 124
 125     virtual ~CameraDecorator(void);
 126
 127     /*! \}                                                                 */
 128     /*---------------------------------------------------------------------*/
 129     /*! \name                       Init                                   */
 130     /*! \{                                                                 */
 131
 132     static void initMethod(InitPhase ePhase);
 133
 134     /*! \}                                                                 */
 135     /*==========================  PRIVATE  ================================*/
 136   private:
 137
 138     friend class FieldContainer;
 139     friend class CameraDecoratorBase;
 140
 141     // prohibit default functions (move to 'public' if you need one)
 142     void operator =(const CameraDecorator &source);
 143 };
 144
 145 //---------------------------------------------------------------------------
 146 //   Exported Types
 147 //---------------------------------------------------------------------------
 148
 149 typedef CameraDecorator              *CameraDecoratorP;
 150
 151 OSG_END_NAMESPACE
 152
 153 #include "OSGCameraDecoratorBase.inl"
 154 #include "OSGCameraDecorator.inl"
 155
 156 #endif /* _OSGCAMERADECORATOR_H_ */