svx/inc/svx/viewpt3d.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: viewpt3d.hxx,v $
  10  * $Revision: 1.3.226.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _VIEWPT3D_HXX
  32 #define _VIEWPT3D_HXX
  33
  34 #include "svx/svxdllapi.h"
  35 #include <basegfx/matrix/b3dhommatrix.hxx>
  36 #include <basegfx/point/b3dpoint.hxx>
  37 #include <basegfx/vector/b3dvector.hxx>
  38 #include <tools/gen.hxx>
  39
  40 // predefines
  41 namespace basegfx {     class B3DRange; } // end of namespace basegfx
  42
  43 /*************************************************************************
  44 |*
  45 |* enums fuer Projektion und Seitenverhaeltnis
  46 |*
  47 \************************************************************************/
  48
  49 enum ProjectionType     { PR_PARALLEL, PR_PERSPECTIVE };
  50 enum AspectMapType      { AS_NO_MAPPING, AS_HOLD_SIZE, AS_HOLD_X, AS_HOLD_Y };
  51
  52
  53 /*************************************************************************
  54 |*
  55 |* 3D-Viewport nach PHIGS
  56 |*
  57 \************************************************************************/
  58
  59 class SVX_DLLPUBLIC Viewport3D
  60 {
  61  protected:
  62     basegfx::B3DHomMatrix               aViewTf;                // die eigentliche Transformationsmatrix
  63     basegfx::B3DPoint                   aVRP;                   // View Reference Point
  64     basegfx::B3DVector                  aVPN;                   // View Plane Normal
  65     basegfx::B3DVector                  aVUV;                   // View Up Vector
  66     basegfx::B3DPoint                   aPRP;                   // Projection Reference Point(View-Koordinaten)
  67                                     // bisher wird nur die Z-Koordinate beachtet
  68     double                      fVPD;                   // View Plane Distance
  69     double                      fNearClipDist;  // Abstand der vorderen Clippingebene
  70     double                      fFarClipDist;   // Abstand der hinteren Clippingebene
  71
  72     ProjectionType      eProjection;    // Art der Projektion
  73     AspectMapType       eAspectMapping; // Flag fuer Seitenverhaeltnis-Anpassung
  74                                     // bei Ausgabe auf das Geraet
  75     Rectangle aDeviceRect;                      // Position und Groesse des Ausgabebereichs
  76
  77     struct
  78     {
  79         double X, Y, W, H;                      // Position und Groesse des View-Windows
  80     } aViewWin;                                         // in View-Koordinaten
  81
  82     basegfx::B3DPoint           aViewPoint;             // Beobachterstandpunkt in Weltkoordinaten;
  83                                     // wird mit der Transformation berechnet
  84     BOOL                        bTfValid;               // Flag, ob Transformation gueltig ist
  85
  86     double fWRatio;                                     // Device/View-Seitenverhaeltnisse
  87     double fHRatio;
  88
  89     void MakeTransform(void);
  90
  91  public:
  92     Viewport3D();
  93
  94     void SetVRP(const basegfx::B3DPoint& rNewVRP);
  95     void SetVPN(const basegfx::B3DVector& rNewVPN);
  96     void SetVUV(const basegfx::B3DVector& rNewVUV);
  97     void SetPRP(const basegfx::B3DPoint& rNewPRP);
  98     void SetVPD(double fNewVPD);
  99     void SetNearClipDist(double fNewNCD);
 100     void SetFarClipDist(double fNewFCD);
 101
 102     const basegfx::B3DPoint&    GetVRP() const  { return aVRP; }
 103     const basegfx::B3DVector&   GetVPN() const  { return aVPN; }
 104     const basegfx::B3DVector&   GetVUV() const  { return aVUV; }
 105     const basegfx::B3DPoint&    GetPRP() const  { return aPRP; }
 106     double      GetVPD() const                  { return fVPD; }
 107     double      GetNearClipDist() const { return fNearClipDist; }
 108     double      GetFarClipDist() const  { return fFarClipDist; }
 109
 110     void SetProjection(ProjectionType ePrj)
 111         { eProjection = ePrj; bTfValid = FALSE; }
 112     ProjectionType GetProjection() const { return(eProjection); }
 113
 114     void SetAspectMapping(AspectMapType eAsp)
 115         { eAspectMapping = eAsp; bTfValid = FALSE; }
 116     AspectMapType GetAspectMapping() { return eAspectMapping; }
 117
 118     void SetViewWindow(double fX, double fY, double fW, double fH);
 119     void GetViewWindow(double& rX, double& rY, double& rW, double& rH) const;
 120
 121     void SetDeviceWindow(const Rectangle& rRect);
 122     const Rectangle& GetDeviceWindow() const { return aDeviceRect; }
 123
 124     // Beobachterstandpunkt in Weltkoordinaten zurueckgeben
 125     const basegfx::B3DPoint&    GetViewPoint();
 126
 127     // View-Transformationen
 128     const basegfx::B3DHomMatrix&        GetViewTransform();
 129
 130     // Projektion und Mapping
 131     basegfx::B3DPoint DoProjection(const basegfx::B3DPoint& rVec) const;
 132     basegfx::B3DPoint   MapToDevice(const basegfx::B3DPoint& rVec) const;
 133 };
 134
 135 #endif          // _VIEWPT3D_HXX