idl/MEDPresentationManager.idl

   1 // Copyright (C) 2005-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   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 __MED_PRESENTATION_MANAGER_IDL_
  21 #define __MED_PRESENTATION_MANAGER_IDL_
  22
  23 #include "SALOME_GenericObj.idl"
  24 #include "MEDDataManager.idl"
  25
  26 module MEDCALC
  27 {
  28   /* Enumerations and constants */
  29
  30   enum ViewModeType {
  31     VIEW_MODE_OVERLAP,
  32     VIEW_MODE_REPLACE,
  33     VIEW_MODE_NEW_LAYOUT,
  34     VIEW_MODE_SPLIT_VIEW
  35   };
  36
  37   enum ColorMapType {
  38     COLOR_MAP_BLUE_TO_RED_RAINBOW,
  39     COLOR_MAP_COOL_TO_WARM
  40   };
  41
  42   enum ScalarBarRangeType {
  43     SCALAR_BAR_ALL_TIMESTEPS,
  44     SCALAR_BAR_CURRENT_TIMESTEP
  45   };
  46
  47   enum MeshModeType {
  48     MESH_MODE_WIREFRAME,
  49     MESH_MODE_SURFACE_EDGES,
  50     MESH_MODE_SURFACE
  51   };
  52
  53
  54
  55 //  struct ScalarBarRange {
  56 //    // (valMin,valMax) defines the scalar bar range from:
  57 //    //      (-1,timestep): the field values at the chosen timestep
  58 //    //      (-1,-1):      the field values across all timesteps
  59 //    //      (-2,-2):      the field values at current timestep
  60 //    //      (start,end):  a user-input range of values
  61 //    long valMin;
  62 //    long valMax;
  63 //  };
  64
  65   const string DISPLAY_EUCLIDEAN_NORM = "";  // Void string to avoid clash with a real component name -- never used actually?
  66
  67   enum SliceOrientationType {
  68     SLICE_NORMAL_TO_X,
  69     SLICE_NORMAL_TO_Y,
  70     SLICE_NORMAL_TO_Z,
  71     SLICE_NORMAL_TO_XY,
  72     SLICE_NORMAL_TO_XZ,
  73     SLICE_NORMAL_TO_YZ,
  74     SLICE_NORMAL_TO_XYZ
  75   };
  76
  77   /* Default values */
  78
  79   const ViewModeType VIEW_MODE_DEFAULT = VIEW_MODE_REPLACE;
  80   const ColorMapType COLOR_MAP_DEFAULT = COLOR_MAP_BLUE_TO_RED_RAINBOW;
  81   const ScalarBarRangeType SCALAR_BAR_RANGE_DEFAULT = SCALAR_BAR_ALL_TIMESTEPS;
  82   const MeshModeType MESH_MODE_DEFAULT = MESH_MODE_WIREFRAME;
  83 //  const long SCALAR_BAR_RANGE_VAL_MIN_DEFAULT = -1;
  84 //  const long SCALAR_BAR_RANGE_VAL_MAX_DEFAULT = -1;
  85   const string DISPLAY_DEFAULT = DISPLAY_EUCLIDEAN_NORM;
  86   const SliceOrientationType SLICE_ORIENTATION_DEFAULT = SLICE_NORMAL_TO_X;
  87   const long NB_CONTOURS_DEFAULT = 10;
  88   const long NB_SLICES_DEFAULT = 1;
  89
  90   /* Structs */
  91
  92   // Just showing the mesh
  93   struct MeshViewParameters {
  94     long fieldHandlerId;   // TODO should be a meshHandlerId really ...
  95     MeshModeType mode;
  96   };
  97
  98   // A simple scalar map
  99   struct ScalarMapParameters {
 100     long fieldHandlerId;
 101     string displayedComponent; // DISPLAY_EUCLIDEAN_NORM or any component name
 102     ScalarBarRangeType scalarBarRange;
 103     ColorMapType colorMap;
 104   };
 105
 106   // A contour is an isoline in 2D and an isosurface in 3D
 107   struct ContourParameters {   // Contour are only for scalar fields
 108     long fieldHandlerId;
 109     ScalarBarRangeType scalarBarRange;
 110     ColorMapType colorMap;
 111     long nbContours;
 112   };
 113
 114 //  struct VectorFieldParameters {
 115 //    long fieldHandlerId;
 116 //    string displayedComponent; // DISPLAY_EUCLIDEAN_NORM or any component name
 117 //    ScalarBarRangeType scalarBarRange;
 118 //    ColorMapType colorMap;
 119 //  };
 120 //
 121   struct SlicesParameters {
 122     long fieldHandlerId;
 123     string displayedComponent; // DISPLAY_EUCLIDEAN_NORM or any component name
 124     ScalarBarRangeType scalarBarRange;
 125     ColorMapType colorMap;
 126     SliceOrientationType orientation;
 127     long nbSlices;
 128   };
 129 //
 130 //  struct DeflectionShapeParameters {
 131 //    long fieldHandlerId;
 132 //  };
 133 //
 134 //  struct PointSpriteParameters {
 135 //    long fieldHandlerId;
 136 //    string displayedComponent; // DISPLAY_EUCLIDEAN_NORM or any component name
 137 //    ScalarBarRangeType scalarBarRange;
 138 //    ColorMapType colorMap;
 139 //  };
 140
 141   typedef sequence<long> PresentationsList;
 142
 143   /* Functions */
 144
 145   interface MEDPresentationManager : SALOME::GenericObj
 146   {
 147     long makeMeshView(in MeshViewParameters params, in ViewModeType viewMode);
 148     long makeScalarMap(in ScalarMapParameters params, in ViewModeType viewMode);
 149     long makeContour(in ContourParameters params, in ViewModeType viewMode)
 150       raises (SALOME::SALOME_Exception);
 151 //    long makeVectorField(in VectorFieldParameters params, in ViewModeType viewMode);
 152     long makeSlices(in SlicesParameters params, in ViewModeType viewMode);
 153 //    long makeDeflectionShape(in DeflectionShapeParameters params, in ViewModeType viewMode);
 154 //    long makePointSprite(in PointSpriteParameters params, in ViewModeType viewMode);
 155
 156     void setPresentationStringProperty(in long presId, in string propName, in string propValue);
 157     string getPresentationStringProperty(in long presId, in string propName);
 158     void setPresentationIntProperty(in long presId, in string propName, in long propValue);
 159     long getPresentationIntProperty(in long presId, in string propName);
 160
 161     MeshViewParameters  getMeshViewParameters(in long presId);
 162     ScalarMapParameters getScalarMapParameters(in long presId);
 163     ContourParameters   getContourParameters(in long presId);
 164     SlicesParameters     getSlicesParameters(in long presId);
 165
 166     void updateMeshView(in long presId, in MeshViewParameters params);
 167     void updateScalarMap(in long presId, in ScalarMapParameters params);
 168     void updateContour(in long presId, in ContourParameters params);
 169 //    void updateVectorField(in long presId, in VectorFieldParameters params);
 170     void updateSlices(in long presId, in SlicesParameters params);
 171 //    void updateDeflectionShape(in long presId, in DeflectionShapeParameters params);
 172 //    void updatePointSprite(in long presId, in PointSpriteParameters params);
 173
 174     boolean removePresentation(in long presId);
 175
 176     // Helper function to keep GUI sync
 177     boolean activateView(in long presentationId);
 178
 179     // Low level ParaVis dump
 180     string getParavisDump(in long presId);
 181
 182 //    ViewModeType getPresentationViewMode(in long presId);
 183
 184     PresentationsList getAllPresentations();
 185   };
 186 };
 187
 188 #endif