src/GeomAPI/GeomAPI_IScreenParams.h

   1 // Copyright (C) 2014-2021  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomAPI_IScreenParams_H_
  21 #define GeomAPI_IScreenParams_H_
  22
  23 #include "GeomAPI_Pln.h"
  24
  25 /**
  26 * A class which defines an interface of object which has to be provided with
  27 * current screen parameters
  28 */
  29 class GeomAPI_IScreenParams
  30 {
  31 public:
  32   virtual ~GeomAPI_IScreenParams() {}
  33
  34   /**
  35   * Set plane of active view screen
  36   *   \param theScreenPlane - the screen plane
  37   */
  38   virtual void setScreenPlane(GeomPlanePtr theScreenPlane) = 0;
  39
  40   /**
  41   * Set a scale of active view
  42   * \param theScale a view scale
  43   */
  44   virtual void setViewScale(double theScale) = 0;
  45 };
  46
  47 typedef std::shared_ptr<GeomAPI_IScreenParams> GeomScreenParamsPtr;
  48
  49 #endif