src/GeomAPI/GeomAPI_IScreenParams.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef GeomAPI_IScreenParams_H_
  22 #define GeomAPI_IScreenParams_H_
  23
  24 #include "GeomAPI_Pln.h"
  25
  26 /**
  27 * A class which defines an interface of object which has to be provided with
  28 * current screen parameters
  29 */
  30 class GeomAPI_IScreenParams
  31 {
  32 public:
  33   virtual ~GeomAPI_IScreenParams() {}
  34
  35   /**
  36   * Set plane of active view screen
  37   *   \param theScreenPlane - the screen plane
  38   */
  39   virtual void setScreenPlane(GeomPlanePtr theScreenPlane) = 0;
  40
  41   /**
  42   * Set a scale of active view
  43   * \param theScale a view scale
  44   */
  45   virtual void setViewScale(double theScale) = 0;
  46 };
  47
  48 typedef std::shared_ptr<GeomAPI_IScreenParams> GeomScreenParamsPtr;
  49
  50 #endif