1 // Copyright (C) 2011-2016 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 // Authors: A Bruneton (CEA), C Aguerre (EdF)
21 #ifndef SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_
22 #define SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_
25 #include "MEDCouplingRefCountObject.hxx"
26 #include "MEDCALC.hxx"
28 #include <SALOMEconfig.h>
29 #include CORBA_SERVER_HEADER(MEDDataManager)
30 #include CORBA_SERVER_HEADER(MEDPresentationManager)
36 class MEDCALC_EXPORT MEDPresentation
38 friend class MEDPresentationManager_i;
41 typedef ::CORBA::Long TypeID;
43 virtual ~MEDPresentation();
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 static const std::string PROP_COLOR_MAP; // color map - TODO: arch fix - should be in params only
50 static const std::string PROP_SCALAR_BAR_RANGE; // scalar bar range - TODO: arch fix - should be in params only
52 virtual void setStringProperty(const std::string& propName, const std::string& propValue);
53 const std::string getStringProperty(const std::string& propName) const;
55 virtual void setIntProperty(const std::string& propName, const int propValue);
56 int getIntProperty(const std::string& propName) const;
58 void activateView(); // non const because generates a Python trace
60 void dumpIntProperties() const;
61 void dumpStringProperties() const;
63 std::string paravisDump() const;
65 long getPyViewID() const { return _renderViewPyId; }
66 void setPyViewID(long id) { _renderViewPyId = id; }
69 typedef std::pair<int, PyObject *> PyObjectId;
70 static int GeneratePythonId();
72 MEDPresentation(MEDPresentation::TypeID fieldHandlerId, const std::string& name,
73 const MEDCALC::ViewModeType viewMode,
74 const MEDCALC::ColorMapType colorMap,
75 const MEDCALC::ScalarBarRangeType sbRange);
76 std::string getRenderViewVar() const;
78 // The most common elements of the ParaView pipeline:
79 void setOrCreateRenderView();
81 void selectFieldComponent();
83 void colorBy(const std::string & fieldType);
85 void rescaleTransferFunction();
86 void selectColorMap();
87 void scalarBarTitle();
88 void resetCameraAndRender();
90 virtual void internalGeneratePipeline();
91 PyObject* getPythonObjectFromMain(const char* var) const;
92 void execPyLine(const std::string & lin);
93 void pushAndExecPyLine(const std::string & lin);
95 MEDPresentation::TypeID getID() const { return _fieldHandlerId; }
97 void fillAvailableFieldComponents();
98 void applyCellToPointIfNeeded();
99 // void convertTo3DVectorField();
101 // virtual MEDCALC::ViewModeType getViewMode() = 0;
103 template<typename PresentationType, typename PresentationParameters>
104 void updateComponent(const std::string& newCompo);
106 template<typename PresentationType, typename PresentationParameters>
107 void updateColorMap(MEDCALC::ColorMapType colorMap);
109 template<typename PresentationType, typename PresentationParameters>
110 void updateScalarBarRange(MEDCALC::ScalarBarRangeType sbRange);
112 template<typename PresentationType, typename PresentationParameters>
113 void getParameters(PresentationParameters& params) const;
115 template<typename PresentationType, typename PresentationParameters>
116 void setParameters(const PresentationParameters& params);
119 std::string getPVFieldTypeString(MEDCoupling::TypeOfField fieldType) const;
121 // The following functions are reserved to friend class MEDPresentationManager
122 void generatePipeline();
124 template<typename PresentationType, typename PresentationParameters>
125 void updatePipeline(const PresentationParameters& params);
128 std::string _meshName;
129 std::string _fileName;
130 std::string _fieldName;
132 ///! MEDCoupling field type (ON_NODES, ON_CELLS, ON_GAUSS_PT, ON_GAUSS_NE
133 MEDCoupling::TypeOfField _mcFieldType;
134 ///! ParaView field type: "CELLS" or "POINTS"
135 std::string _pvFieldType;
137 MEDPresentation::TypeID _fieldHandlerId;
139 int _selectedComponentIndex;
140 MEDCALC::ViewModeType _viewMode;
141 MEDCALC::ColorMapType _colorMap;
142 MEDCALC::ScalarBarRangeType _sbRange;
144 ///! Identifier (in the Python dump) of the render view
146 ///! ParaView object variable in the Python scripting commands (source object)
147 std::string _srcObjVar;
148 ///! ParaView object variable in the Python scripting commands (final object on which all display commands are done)
150 ///! ParaView display variable in the Python scripting commands
151 std::string _dispVar;
152 ///! ParaView LUT variable in the Python scripting commands
154 ///! ParaView variable in Python holding the data range
155 std::string _rangeVar;
158 ///! Presentation properties <key,value>
159 std::map<std::string, std::string> _propertiesStr;
160 std::map<std::string, int> _propertiesInt;
162 std::vector<std::string> _pythonCmds;
164 mutable PyObject* _globalDict;
167 #include "MEDPresentation.txx"
169 #endif /* SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_ */