src/MEDCalc/cmp/MEDPresentation.hxx

   1 // Copyright (C) 2011-2016  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 // Authors: A Bruneton (CEA), C Aguerre (EdF)
  20
  21 #ifndef SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_
  22 #define SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_
  23
  24 #include <Python.h>
  25 #include "MEDCouplingRefCountObject.hxx"
  26 #include "MEDCALC.hxx"
  27
  28 #include <SALOMEconfig.h>
  29 #include CORBA_SERVER_HEADER(MEDDataManager)
  30 #include CORBA_SERVER_HEADER(MEDPresentationManager)
  31
  32 #include <vector>
  33 #include <map>
  34 #include <string>
  35
  36 class MEDCALC_EXPORT MEDPresentation
  37 {
  38   friend class MEDPresentationManager_i;
  39
  40 public:
  41   typedef ::CORBA::Long TypeID;
  42
  43   virtual ~MEDPresentation();
  44
  45   static const std::string PROP_NAME;                 // name of the presentation
  46   static const std::string PROP_NB_COMPONENTS;        // number of field components
  47   static const std::string PROP_SELECTED_COMPONENT;   // index of the selected component - 0 means Euclidean norm
  48   static const std::string PROP_COMPONENT;            // string prefix for all properties storing component names
  49
  50   static const std::string PROP_COLOR_MAP;            // color map - TODO: arch fix - should be in params only
  51   static const std::string PROP_SCALAR_BAR_RANGE;     // scalar bar range - TODO: arch fix - should be in params only
  52
  53   virtual void setStringProperty(const std::string& propName, const std::string& propValue);
  54   const std::string getStringProperty(const std::string& propName) const;
  55
  56   virtual void setIntProperty(const std::string& propName, const int propValue);
  57   int getIntProperty(const std::string& propName) const;
  58
  59   void activateView();  // non const because generates a Python trace
  60
  61   void dumpIntProperties() const;
  62   void dumpStringProperties() const;
  63
  64   std::string paravisDump() const;
  65
  66   long getPyViewID() const { return _renderViewPyId; }
  67   void setPyViewID(long id) { _renderViewPyId = id; }
  68
  69 protected:
  70   typedef std::pair<int, PyObject *> PyObjectId;
  71   static int GeneratePythonId();
  72
  73   MEDPresentation(MEDPresentation::TypeID fieldHandlerId, const std::string& name,
  74                   const MEDCALC::MEDPresentationViewMode viewMode,
  75                   const MEDCALC::MEDPresentationColorMap colorMap,
  76                   const MEDCALC::MEDPresentationScalarBarRange sbRange);
  77   std::string getRenderViewCommand() const;
  78   std::string getRenderViewVar() const;
  79   std::string getResetCameraCommand() const;
  80
  81   std::string getComponentSelectionCommand() const;
  82   std::string getColorMapCommand() const;
  83   std::string getRescaleCommand() const;
  84
  85   virtual void internalGeneratePipeline();
  86   PyObject* getPythonObjectFromMain(const char* var) const;
  87 //  void pushPyObjects(PyObjectId obj, PyObjectId disp);
  88   void execPyLine(const std::string & lin);
  89   void pushAndExecPyLine(const std::string & lin);
  90
  91   MEDPresentation::TypeID getID() const { return _fieldHandlerId; }
  92
  93   void fillAvailableFieldComponents();
  94
  95 //  virtual MEDCALC::MEDPresentationViewMode getViewMode() = 0;
  96
  97   template<typename PresentationType, typename PresentationParameters>
  98   void updateComponent(const std::string& newCompo);
  99
 100   template<typename PresentationType, typename PresentationParameters>
 101   void updateColorMap(MEDCALC::MEDPresentationColorMap colorMap);
 102
 103   template<typename PresentationType, typename PresentationParameters>
 104   void updateScalarBarRange(MEDCALC::MEDPresentationScalarBarRange sbRange);
 105
 106   template<typename PresentationType, typename PresentationParameters>
 107   void getParameters(PresentationParameters& params) const;
 108
 109   template<typename PresentationType, typename PresentationParameters>
 110   void setParameters(const PresentationParameters& params);
 111
 112 private:
 113   std::string getFieldTypeString(MEDCoupling::TypeOfField fieldType) const;
 114
 115   // The following functions are reserved to friend class MEDPresentationManager
 116   void generatePipeline();
 117
 118   template<typename PresentationType, typename PresentationParameters>
 119   void updatePipeline(const PresentationParameters& params);
 120
 121 protected:
 122   std::string _fileName;
 123   std::string _fieldName;
 124   std::string _fieldType;
 125
 126   MEDPresentation::TypeID _fieldHandlerId;
 127
 128   int _selectedComponentIndex;
 129   MEDCALC::MEDPresentationViewMode _viewMode;
 130   MEDCALC::MEDPresentationColorMap _colorMap;
 131   MEDCALC::MEDPresentationScalarBarRange _sbRange;
 132
 133   ///! Identifier (in the Python dump) of the render view
 134   int _renderViewPyId;
 135   ///! ParaView object variable in the Python scripting commands (source object)
 136   std::string _srcObjVar;
 137   ///! ParaView object variable in the Python scripting commands (final object on which all display commands are done)
 138   std::string _objVar;
 139   ///! ParaView display variable in the Python scripting commands
 140   std::string _dispVar;
 141   ///! ParaView LUT variable in the Python scripting commands
 142   std::string _lutVar;
 143
 144 private:
 145   ///! Pipeline elements
 146 //  std::vector<PyObjectId> _pipeline;
 147
 148   ///! Corresponding display object, if any:
 149 //  std::vector<PyObjectId> _display;
 150
 151   ///! Presentation properties <key,value>
 152   std::map<std::string, std::string> _propertiesStr;
 153   std::map<std::string, int> _propertiesInt;
 154
 155   std::vector<std::string> _pythonCmds;
 156
 157   mutable PyObject* _globalDict;
 158 };
 159
 160 #include "MEDPresentation.txx"
 161
 162 #endif /* SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_ */