-// Copyright (C) 2011-2016 CEA/DEN, EDF R&D
+// Copyright (C) 2011-2022 CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
+
// Authors: A Bruneton (CEA), C Aguerre (EdF)
#ifndef SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_
#define SRC_MEDCALC_CMP_MEDPRESENTATION_HXX_
-#include "MEDCouplingRefCountObject.hxx"
#include <Python.h>
+#include "MEDCouplingRefCountObject.hxx"
#include "MEDCALC.hxx"
#include <SALOMEconfig.h>
#include <map>
#include <string>
+struct ComponentThresold {
+
+ ComponentThresold() {
+ _thresholdVar = "";
+ _thresholdDispVar = "";
+ _thresholdLutVar = "";
+ _thresholdInitialized = false;
+ _active = false;
+ }
+
+ ///! ParaView Threshold filter variable to hide data outside custom range in Python scripting
+ std::string _thresholdVar;
+ ///! ParaView Threshold display variable to hide data outside custom range in Python scripting
+ std::string _thresholdDispVar;
+ ///! ParaView Threshold LUT variable in the Python scripting commands
+ std::string _thresholdLutVar;
+
+ ///! Initialization flag
+ bool _thresholdInitialized;
+ ///! Active flag
+ bool _active;
+
+ void clear() {
+ _thresholdInitialized = false;
+ _active = false;
+ }
+};
+
+typedef std::vector<ComponentThresold> PresentationThresolds;
+
class MEDCALC_EXPORT MEDPresentation
{
friend class MEDPresentationManager_i;
public:
-
typedef ::CORBA::Long TypeID;
+ virtual void initFieldMeshInfos();
+
virtual ~MEDPresentation();
- void setProperty(const std::string& propName, const std::string& propValue);
- const std::string getProperty(const std::string& propName) const;
+ static const std::string PROP_NAME; // name of the presentation
+ static const std::string PROP_NB_COMPONENTS; // number of field components
+ static const std::string PROP_SELECTED_COMPONENT; // index of the selected component - 0 means Euclidean norm
+ static const std::string PROP_COMPONENT; // string prefix for all properties storing component names
+ static const std::string PROP_COLOR_MAP; // color map - TODO: arch fix - should be in params only
+ static const std::string PROP_SCALAR_BAR_RANGE; // scalar bar range - TODO: arch fix - should be in params only
+ static const std::string PROP_VISIBILITY; // presentation visibility
+ static const std::string PROP_SCALAR_BAR_VISIBILITY; // scalar bar visiblity
+ static const std::string PROP_SCALAR_BAR_MIN_VALUE; // min value of scalar bar range
+ static const std::string PROP_SCALAR_BAR_MAX_VALUE; // max value of scalar bar range
+ static const std::string PROP_HIDE_DATA_OUTSIDE_CUSTOM_RANGE; // Hide data outside custom range
+
+
+ virtual void setStringProperty(const std::string& propName, const std::string& propValue);
+ const std::string getStringProperty(const std::string& propName) const;
+
+ virtual void setIntProperty(const std::string& propName, const int propValue);
+ int getIntProperty(const std::string& propName) const;
+
+ virtual void setDoubleProperty(const std::string& propName, const double propValue);
+ double getDoubleProperty(const std::string& propName) const;
+
+ // returns True if the view was still alive, False if it must have been recreated
+ // because the user closed it.
+ virtual bool activateView();
+ virtual void recreateViewSetup();
+
+ void dumpIntProperties() const;
+ void dumpStringProperties() const;
+ void dumpDoubleProperties() const;
+
+ std::string paravisDump() const;
+
+ long getPyViewID() const { return _renderViewPyId; }
+ void setPyViewID(long id) { _renderViewPyId = id; }
+
+ static std::string toScriptCellType(const std::string&);
protected:
+ typedef std::pair<int, PyObject *> PyObjectId;
+ static int GeneratePythonId();
+
+ MEDPresentation(MEDPresentation::TypeID handlerId, const std::string& name,
+ const MEDCALC::ViewModeType viewMode,
+ const MEDCALC::ColorMapType colorMap,
+ const MEDCALC::ScalarBarRangeType sbRange);
+ std::string getRenderViewVar() const;
- MEDPresentation(MEDPresentation::TypeID fieldHandlerId, const std::string& name);
- std::string getRenderViewCommand(MEDCALC::MEDPresentationViewMode viewMode) const;
- std::string getResetCameraCommand() const;
- std::string getColorMapCommand(MEDCALC::MEDPresentationColorMap colorMap) const;
+ // The most common elements of the ParaView pipeline:
+ void setOrCreateRenderView();
+ void createSource();
+ void setTimestamp();
+ void selectFieldComponent();
+ void virtual showObject();
+ void virtual hideObject();
+ void colorBy();
+ virtual void showScalarBar();
+ virtual void hideScalarBar();
+ void scalarBarVisibility();
+ void rescaleTransferFunction();
+ void selectColorMap(const bool updateFieldComponent=true);
+ virtual void scalarBarTitle();
+ void resetCameraAndRender();
+ virtual void visibility();
+ void threshold();
+ void thresholdPresentation();
+ void unThresholdPresentation();
+ void thresholdValues();
+ virtual void additionalThresholdActions() {};
+ virtual std::string additionalThresholdVisualizationActions() { return ""; };
+ virtual std::string additionalThresholdInitializationActions() { return ""; };
+ virtual void additionalUnThresholdActions() {};
+ virtual std::string getFieldName() const;
+ virtual std::string getThresholdFieldName() const;
- virtual void internalGeneratePipeline() = 0;
+ std::string getScriptCellType() const;
+ bool isThresoldActive() const;
+
+ virtual void internalGeneratePipeline();
+ virtual void internalGenerateThreshold();
+ const std::string& getDispVar();
+ const std::string& getLutVar();
PyObject* getPythonObjectFromMain(const char* var) const;
- void pushInternal(PyObject* obj, PyObject* disp = NULL);
+ void execPyLine(const std::string & lin);
+ void pushAndExecPyLine(const std::string & lin);
- MEDPresentation::TypeID getID() const { return _fieldHandlerId; }
+ MEDPresentation::TypeID getID() const { return _handlerId; }
-private:
+ void fillAvailableFieldComponents();
+ void applyCellToPointIfNeeded();
+ void extractFileName(const std::string& name);
+// void convertTo3DVectorField();
+
+ virtual MEDCALC::PresentationVisibility presentationStateInActiveView();
- std::string getFieldTypeString(MEDCoupling::TypeOfField fieldType) const;
+ template<typename PresentationType, typename PresentationParameters>
+ void updateComponent(const std::string& newCompo);
+
+ template<typename PresentationType, typename PresentationParameters>
+ void updateColorMap(MEDCALC::ColorMapType colorMap);
+
+ template<typename PresentationType, typename PresentationParameters>
+ void updateScalarBarRange(MEDCALC::ScalarBarRangeType sbRange,
+ bool hideDataoutsideCustomRange,
+ double minValue, double maxValue);
+
+ template<typename PresentationType, typename PresentationParameters>
+ void updateVisibility(const bool theVisibility);
+
+ template<typename PresentationType, typename PresentationParameters>
+ void updateScalarBarVisibility(const bool theVisibility);
+
+ template<typename PresentationType, typename PresentationParameters>
+ void getParameters(PresentationParameters& params) const;
+
+ template<typename PresentationType, typename PresentationParameters>
+ void setParameters(const PresentationParameters& params);
+
+ int getThresholdIndex() const;
+
+ void deleteThresholds();
+
+private:
+ std::string getPVFieldTypeString(MEDCoupling::TypeOfField fieldType) const;
// The following functions are reserved to friend class MEDPresentationManager
void generatePipeline();
template<typename PresentationType, typename PresentationParameters>
- void updatePipeline(PresentationParameters params);
+ void updatePipeline(const PresentationParameters& params);
protected:
-
+ std::string _meshName;
std::string _fileName;
std::string _fieldName;
- std::string _fieldType;
-private:
+ ///! MEDCoupling field type (ON_NODES, ON_CELLS, ON_GAUSS_PT, ON_GAUSS_NE
+ MEDCoupling::TypeOfField _mcFieldType;
+ ///! ParaView field type: "CELLS" or "POINTS"
+ std::string _pvFieldType;
+ ///! ParaView field type: "CELLS" or "POINTS" used in the ColorBy method. Not necessarily equal to _pvFieldType.
+ std::string _colorByType;
+
+ MEDPresentation::TypeID _handlerId; // either a field or a mesh id (a field ID though, most of the time)
+
+ int _selectedComponentIndex;
+ int _nbComponents;
+ int _nbComponentsInThresholdInput;
+ MEDCALC::ViewModeType _viewMode;
+ MEDCALC::ColorMapType _colorMap;
+ MEDCALC::ScalarBarRangeType _sbRange;
+ bool _presentationVisibility;
+ bool _scalarBarVisibility;
+ bool _hideDataOutsideCustomRange;
+ double _scalarBarRangeArray[2];
- MEDPresentation::TypeID _fieldHandlerId;
+ ///! Identifier (in the Python dump) of the render view
+ int _renderViewPyId;
+ ///! ParaView object variable in the Python scripting commands (source object)
+ std::string _srcObjVar;
+ ///! ParaView object variable in the Python scripting commands (final object on which all display commands are done)
+ std::string _objVar;
+ ///! ParaView display variable in the Python scripting commands
+ std::string _dispVar;
+ ///! ParaView LUT variable in the Python scripting commands
+ std::string _lutVar;
+ ///! ParaView variable in Python holding the data range
+ std::string _rangeVar;
+ ///! Prorgammable variable in the Python scripting commands
+ std::string _programmableVar;
+ bool _programmableInitialized;
- ///! Pipeline elements
- std::vector<PyObject*> _pipeline;
+ //Thresolds
+ PresentationThresolds _presentationThresolds;
- ///! Corresponding display object, if any:
- std::vector<PyObject*> _display;
+private:
///! Presentation properties <key,value>
- std::map<std::string, std::string> _properties;
+ std::map<std::string, std::string> _propertiesStr;
+ std::map<std::string, int> _propertiesInt;
+ std::map<std::string, double> _propertiesDouble;
+
+ std::vector<std::string> _pythonCmds;
+
+ mutable PyObject* _globalDict;
};
#include "MEDPresentation.txx"
