src/IVtkVTK/IVtkVTK_View.hxx

   1 // Created on: 2011-10-14
   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 __IVTKVTK_VIEW_H__
  17 #define __IVTKVTK_VIEW_H__
  18
  19 #include <IVtk_IView.hxx>
  20 #include <vtkSmartPointer.h>
  21
  22 class vtkRenderer;
  23
  24 class IVtkVTK_View;
  25 DEFINE_STANDARD_HANDLE( IVtkVTK_View, IVtk_IView )
  26
  27 //! @class IVtkVTK_View
  28 //! @brief ICamera implementation for VTK.
  29 //!
  30 //! This class is used for obtaining view transformation parameters.
  31 //! These parameters are used by selection algorithm to compute
  32 //! projections of selectable (active) 3D shapes.
  33 class IVtkVTK_View : public IVtk_IView
  34 {
  35
  36 public:
  37   typedef Handle(IVtkVTK_View) Handle;
  38
  39   Standard_EXPORT IVtkVTK_View (vtkRenderer* theRenderer);
  40
  41   //! Destructor
  42   Standard_EXPORT virtual ~IVtkVTK_View();
  43
  44   //! @return true if this is a perspective view, and false otherwise.
  45   Standard_EXPORT virtual bool    IsPerspective() const Standard_OVERRIDE;
  46
  47   //! @return The focal distance of the view
  48   Standard_EXPORT virtual double  GetDistance() const Standard_OVERRIDE;
  49
  50   //! @return The world coordinates of the view position
  51   Standard_EXPORT virtual void    GetPosition (double& theX, double& theY, double& theZ) const Standard_OVERRIDE;
  52
  53   //! @return The "view up" direction of the view
  54   Standard_EXPORT virtual void    GetViewUp (double& theDx, double& theDy, double& theDz) const Standard_OVERRIDE;
  55
  56   //! @return The projection direction vector of this view
  57   Standard_EXPORT virtual void    GetDirectionOfProjection (double& theDx,
  58                                                             double& theDy,
  59                                                             double& theDz) const Standard_OVERRIDE;
  60
  61   //! @return Three doubles containing scale components of the view transformation
  62   Standard_EXPORT virtual void    GetScale (double& theX, double& theY, double& theZ) const Standard_OVERRIDE;
  63
  64   //! @return The current view's zoom factor (for parallel projection)
  65   Standard_EXPORT virtual double  GetParallelScale() const Standard_OVERRIDE;
  66
  67   //! @return The current view angle (for perspective projection)
  68   Standard_EXPORT virtual double  GetViewAngle() const Standard_OVERRIDE;
  69
  70   //! @return Two doubles containing the display coordinates of the view window center
  71   Standard_EXPORT virtual void    GetViewCenter (double& theX, double& theY) const Standard_OVERRIDE;
  72
  73   //! Gets window size in screen coordinates in pixels
  74   Standard_EXPORT virtual void    GetWindowSize (int& theX, int& theY) const Standard_OVERRIDE;
  75
  76   //! Gets camera projection and orientation matrices
  77   Standard_EXPORT virtual void    GetCamera (Graphic3d_Mat4d& theProj,
  78                                              Graphic3d_Mat4d& theOrient,
  79                                              Standard_Boolean& theIsOrtho) const Standard_OVERRIDE;
  80
  81   //! Gets viewport coordinates
  82   Standard_EXPORT virtual void   GetViewport (Standard_Real& theX,
  83                                               Standard_Real& theY,
  84                                               Standard_Real& theWidth,
  85                                               Standard_Real& theHeight) const Standard_OVERRIDE;
  86
  87   //! Converts 3D display coordinates into 3D world coordinates.
  88   //! @param [in] theDisplayPnt 2d point of display coordinates
  89   //! @param [out] theWorldPnt 3d point of world coordinates
  90   //! @return true if conversion was successful, false otherwise
  91   Standard_EXPORT virtual bool DisplayToWorld (const gp_XY& theDisplayPnt, gp_XYZ& theWorldPnt) const Standard_OVERRIDE;
  92
  93   DEFINE_STANDARD_RTTIEXT(IVtkVTK_View,IVtk_IView)
  94
  95 private:
  96   vtkSmartPointer<vtkRenderer> myRenderer;
  97 };
  98
  99 #endif // __IVTKVTK_VIEW_H__