src/IVtk/IVtk_IView.hxx

   1 // Created on: 2011-10-11
   2 // Created by: Roman KOZLOV
   3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef __IVTK_IVIEW_H__
  17 #define __IVTK_IVIEW_H__
  18
  19 #include <IVtk_Interface.hxx>
  20 #include <gp_XY.hxx>
  21 #include <gp_XYZ.hxx>
  22
  23 DEFINE_STANDARD_HANDLE( IVtk_IView, IVtk_Interface )
  24
  25 //! @class IVtk_IView
  26 //! @brief Interface for obtaining view transformation parameters.
  27 //!
  28 //! These parameters are used by selection algorithm to compute
  29 //! projections of selectable (active) 3D shapes.
  30 class IVtk_IView : public IVtk_Interface
  31 {
  32
  33 public:
  34   typedef Handle(IVtk_IView) Handle;
  35
  36   //! Destructor
  37   virtual ~IVtk_IView() { }
  38
  39   //! @return true if this is a perspective view, and false otherwise.
  40   virtual bool    IsPerspective() const = 0;
  41
  42   //! @return The focal distance of the view
  43   virtual double  GetDistance() const = 0;
  44
  45   //! @return The world coordinates of the view position
  46   virtual void    GetPosition (double& theX, double& theY, double& theZ) const = 0;
  47
  48   //! @return The "view up" direction of the view
  49   virtual void    GetViewUp (double& theDx, double& theDy, double& theDz) const = 0;
  50
  51   //! @return The projection direction vector of this view
  52   virtual void    GetDirectionOfProjection (double& theDx,
  53                                             double& theDy,
  54                                             double& theDz) const = 0;
  55
  56   //! @return Three doubles contaning scale components of the view transformation
  57   virtual void    GetScale (double& theX, double& theY, double& theZ) const = 0;
  58
  59   //! @return The current view's zoom factor (for parallel projection)
  60   virtual double  GetParallelScale() const = 0;
  61
  62   //! @return The current view angle (for perspective projection)
  63   virtual double  GetViewAngle() const = 0;
  64
  65   //! @return Two doubles containing the display coordinates of the view window center
  66   virtual void    GetViewCenter (double& theX, double& theY) const = 0;
  67
  68   //! Converts 3D display coordinates into 3D world coordinates.
  69   //! @param [in] theDisplayPnt 2d point of display coordinates
  70   //! @param [out] theWorldPnt 3d point of world coordinates
  71   //! @return true if conversion was successful, false otherwise
  72   virtual bool    DisplayToWorld (const gp_XY& theDisplayPnt, gp_XYZ& theWorldPnt) const = 0;
  73
  74   DEFINE_STANDARD_RTTI( IVtk_IView )
  75 };
  76
  77 #endif // __IVTK_IVIEW_H__