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