doc/salome/tui/VISU/sources/static/overview_VISU.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">\r
   2 <html>\r
   3 <head>\r
   4    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
   5    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">\r
   6    <title>Main Page</title>\r
   7 <link href="doxygen.css" rel="stylesheet" type="text/css">\r
   8 </head>\r
   9 <body>\r
  10 &nbsp;\r
  11 <center><table WIDTH="96%" >\r
  12 <tr>\r
  13 <td><a href="http://www.opencascade.com"><img src="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>\r
  14 \r
  15 \r
  16 <td>\r
  17 <div align=right><a href="http://www.opencascade.org/SALOME/"><img src="sources/application.gif" BORDER=0 height=46 width=108></a></div>\r
  18 </td>\r
  19 </tr>\r
  20 </table></center>\r
  21 \r
  22 \r
  23 <h1><a name="page2">General overview</a>\r
  24 </h1>\r
  25 <a name="cont"></a><h2>Table of contents </h2>\r
  26 <b><i>\r
  27 <ul>\r
  28   <li><a href="#1">1. Introduction</a></li>\r
  29   <li><a href="#2">2. Definitions </a></li>\r
  30                 \r
  31   <li><a href="#3">3. Forms of data visualization </a></li>\r
  32   <ul>\r
  33                 <li><a href="#3_1">3.1 Data tables</a></li>\r
  34                 <li><a href="#3_2">3.2 XY plots  </a></li>\r
  35                 <li><a href="#3_3">3.3 3D presentations  </a></li>\r
  36                 </ul>\r
  37         <li><a href="#4">4. Data structure</a></li>\r
  38         <li><a href="#5">5. VISU module features and services</a></li>\r
  39         <ul>\r
  40                 <li><a href="#5_1">5.1 Base class</a></li>\r
  41                 <li><a href="#5_2">5.2 ViewManager class  </a></li>\r
  42                 <li><a href="#5_3">5.3 View class  </a></li>\r
  43                 <ul>\r
  44                 <li><a href="#5_3_1">5.3.1 3dView class  </a></li>\r
  45                 <li><a href="#5_3_2">5.3.2 TableView class  </a></li>\r
  46                 <li><a href="#5_3_3">5.3.3 XYPlotView class  </a></li>\r
  47                 </ul>\r
  48                 <li><a href="#5_4">5.4 Result class  </a></li>\r
  49                 <li><a href="#5_5">5.5 PrsObject class  </a></li>\r
  50                 <ul>\r
  51                 <li><a href="#5_5_1">5.5.1 Curve class  </a></li>\r
  52                 <li><a href="#5_5_2">5.5.2 Table class  </a></li>\r
  53                 <li><a href="#5_5_3">5.5.3 Container class </a></li>\r
  54                 <li><a href="#5_5_4">5.5.4 Prs3d class  </a></li>\r
  55                 <li><a href="#5_5_5">5.5.5 Mesh class  </a></li>\r
  56                 <li><a href="#5_5_6">5.5.6 ScalarMap class  </a></li>\r
  57                 <li><a href="#5_5_7">5.5.7 CutLines class  </a></li>\r
  58                 <li><a href="#5_5_8">5.5.8 CutPlanes class  </a></li>\r
  59                 <li><a href="#5_5_9">5.5.9 IsoSurfaces class  </a></li>\r
  60                 <li><a href="#5_5_10">5.5.10 DeformedShape class  </a></li>\r
  61                 <li><a href="#5_5_11">5.5.11 Vectors class  </a></li>\r
  62                 <li><a href="#5_5_12">5.5.12 StreamLines class  </a></li>\r
  63                 \r
  64                 </ul>\r
  65                 <li><a href="#5_6">5.6 Animation class  </a></li>\r
  66                 <li><a href="#5_7">5.7 VISU_Gen class  </a></li>\r
  67                 \r
  68         </ul>\r
  69 </ul>\r
  70 </i> </b> <br>\r
  71 <a name="1"></a><h2>1. Introduction </h2>\r
  72 <p>Post-processing module VISU for SALOME is destined for visualization of data \r
  73   produced by other components. VISU provides various forms of data visualization \r
  74   including: </p>\r
  75   \r
  76 <ul>\r
  77   <li>Data tables, </li>\r
  78   <li>XY plots based on data from tables, </li>\r
  79   <li>3D presentations, </li>  \r
  80   <ul>\r
  81     <li> Scalar Map,</li>\r
  82     <li> Deformed Shape, </li>\r
  83     <li> Vectors,</li>\r
  84     <li> Iso Surfaces,</li>\r
  85     <li> Cut Planes,</li>\r
  86     <li> Stream Lines,</li>\r
  87     <li> Cut Lines.</li>\r
  88   </ul>\r
  89 </ul>\r
  90 <i><a href="#cont">Back to the contents</a></i>\r
  91 <a name="2"></a><h2>2. Defintions </h2>\r
  92 <p>The following terms are used for presentation of the VISU module:</p>\r
  93 <dl>\r
  94 <dt><b>Study</b></dt> \r
  95 <dd>manages data produced by various component of SALOME platform. More detailed description of the SALOME Study can be found in the document named "Data Structure and Persistence Specifications".</dd>\r
  96 <dt><b>Component</b></dt> \r
  97 <dd>a SALOME software module that implements predefined interfaces. \r
  98 The component provides the data for the SALOME study in a form of links (stored in the Study) \r
  99 to the specific data stored in the component. All components are CORBA servers and it allows them \r
 100 to be running on different host stations.</dd>\r
 101 <dt><b>Geometry</b></dt> <dd>a coherent set of data produced by component GEOM or any other geometry tool \r
 102 and imported using geometry exchange interface (like BRep, IGES and so on).</dd>\r
 103 <dt><b>Mesh</b></dt> <dd>a collection of elements used as a support for numeric simulation.</dd>\r
 104 <dt><b>Field</b></dt> <dd>the set of results of the same type allocated to mesh elements. \r
 105 Fields can be one of next types: scalars, vectors, tensors, matrices, character strings.</dd>\r
 106 </dl>\r
 107 <i><a href="#cont">Back to the contents</a></i>\r
 108 <a name="3"></a><h2>3. Forms of data visualization </h2>\r
 109 <a name="3_1"></a><h3>3.1 Data tables </h3>\r
 110 <p>Table represents data in spreadsheet-like form. For these purposes the QTable \r
 111   widget will be provided. This widget can be reused in any module for any dialog \r
 112   box as a control. For post-processing data visualization needs this widget is \r
 113   used inside of Table window (based on non-modal window frame). Data represented \r
 114   in Table window of post-processing module is be editable. </p>\r
 115  <a name="3_2"></a> <h3>3.2 XY plots</h3>\r
 116 <p>XY plot represents calculation data in form of 2D (XY) plotting. \r
 117 XY plot view is shown in a separated view window (non-modal dialog box), which can be moved in any position of the screen for convenience. \r
 118 The QWT extension of QT toolkit is used for XY plotting. \r
 119 QWT provides unlimited number of displayed curves (data sets) and supports logarithmic scale, zooming, and selection.</p>\r
 120 <a name="3_3"></a>\r
 121 <h3>3.3 3D presentations </h3>\r
 122 <p>A 3D presentation shows geometry, mesh and fields in 3D space. \r
 123 Provides selection, rotation, zooming, scaling, and panning of 3d scene. \r
 124 Color bar for scalar data presentation is supplied. \r
 125 For 3D presentation window of the current implementation of VTK viewer in study window is used.</p>\r
 126 <i><a href="#cont">Back to the contents</a></i>\r
 127 <a name="4"></a><h2>4. Data structure </h2>\r
 128 <p>Source data for post-processing module can be imported from MED file or MED object in study data structure (CORBA object) can be used for this purposes. </p>\r
 129 <p>In case of import MED file the data from this file will be converted in form of VTK Data Source format and stored in VISU data structure. In case of using of MED object from study the label in VISU data structure will be created with reference to the corresponded MED object.</p>\r
 130 <p>Available result data is displayed under corresponded MED data label. For every result the number of presentations can be created dependently on result type. </p>\r
 131 <p>Presentation is represented in data structure in form of list of presentation creation parameters. This could be:</p>\r
 132 <ul>\r
 133 <li>Presentation type (table, XY plot, 3d view);</li>\r
 134 <li>Presentation subtype (for example for 3d: scalar map, iso-surfaces, combined view and so on);</li>\r
 135 <li>Parameters of the presentation dependently on its type (number of colors, type of scale, font parameters, grid parameters and so on).</li>\r
 136 </ul>\r
 137 <p>Parameters of presentation are persistent data, which will be stored in study file.</p>\r
 138 \r
 139 \r
 140 <div align="center"><img src="DataStruct.gif"> </div>\r
 141 <i><a href="#cont">Back to the contents</a></i>\r
 142 <a name="5"></a><h2>5. VISU module features and services </h2>\r
 143 <p>The functionality of the VISU module is provided by a set of classes which are combined into \r
 144 the <b>VISU</b> package.\r
 145 <p>The API reference of the VISU component can be found <a href="namespaceVISU.html">here</a>.</p>\r
 146 <a name="5_1"></a><h3>5.1 Base class</h3>\r
 147 <p>This is a root class for all objects of the VISU module.</p>\r
 148  <p>The API reference for this class can be found <a href="interfaceVISU_1_1Base.html">here</a>.</p>\r
 149 \r
 150 <a name="5_2"></a><h3>5.2 ViewManager class</h3>\r
 151 <p>This class is used for management of the view windows (creation and deletion).</p>\r
 152  <p>The API reference for this class can be found <a href="interfaceVISU_1_1ViewManager.html">here</a>.</p>\r
 153 \r
 154 <a name="5_3"></a><h3>5.3 View class</h3>\r
 155 <p>View class is a base for all other classes, necessary for creation of different views .</p>\r
 156  \r
 157 <div align="center"><img src="View.gif"> </div>\r
 158 <p>The API reference for this class can be found <a href="interfaceVISU_1_1View.html">here</a>.</p>\r
 159 \r
 160 <a name="5_3_1"></a><h4>5.3.1 3dView class</h4>\r
 161 <p>This class provides a set of methods for creation of a 3d view window.</p>\r
 162 <p>The API reference for this class can be found <a href="interfaceVISU_1_13dView.html">here</a>.</p>\r
 163 \r
 164 <a name="5_3_2"></a><h4>5.3.2 TableView class</h4>\r
 165 <p>This class provides a set of methods for creation of a Table view window.</p>\r
 166 <p>The API reference for this class can be found <a href="interfaceVISU_1_1TableView.html">here</a>.</p>\r
 167 \r
 168 <a name="5_3_3"></a><h4>5.3.3 XYPlotView class</h4>\r
 169 <p>This class provides a set of methods for creation of a XYPlot view window.</p>\r
 170 <p>The API reference for this class can be found <a href="interfaceVISU_1_1XYPlotView.html">here</a>.</p>\r
 171 \r
 172 <a name="5_4"></a><h3>5.4 Result class</h3>\r
 173 <p>This class serves for inner representation of data generated in other sources. \r
 174 (MED object or file) This data is needed for further construction of graphical presentations.</p> \r
 175 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Result.html">here</a>.</p>\r
 176 <a name="5_5"></a><h3>5.5 PrsObject class</h3>\r
 177 <p>It is the root class of all presentable objects. </p>\r
 178 <div align="center"><img src="PrsObj.gif"> </div>\r
 179 <p>The API reference for this class can be found <a href="interfaceVISU_1_1PrsObject.html">here</a>.</p>\r
 180 \r
 181 <a name="5_5_1"></a><h4>5.5.1 Curve class</h4>\r
 182 <p>Manages presentation parameters of one curve. \r
 183 This object can be used for presentation of set of curves using Container class. </p>\r
 184 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Curve.html">here</a>.</p>\r
 185 \r
 186 <a name="5_5_2"></a><h4>5.5.2 Table class</h4>\r
 187 <p>Manages presentation parameters of a table.  </p>\r
 188 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Table.html">here</a>.</p>\r
 189 \r
 190 <a name="5_5_3"></a><h4>5.5.3 Container class</h4>\r
 191 <p>This class is provided in order to create one presentation using several presentable objects. This can provide combination of a set of curves to display them in XY plot view. \r
 192 </p>\r
 193 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Container.html">here</a>.</p>\r
 194 \r
 195 <a name="5_5_4"></a><h4>5.5.4 Prs3d class</h4>\r
 196 <p>Root class for all 3D presentations. </p>\r
 197 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Prs3d.html">here</a>.</p>\r
 198 \r
 199 <a name="5_5_5"></a><h4>5.5.5 Mesh class</h4>\r
 200 <p>Manages presentation parameters of a 3D presentattion of a mesh. \r
 201 This object can be used for presentation of set of curves using Container class. </p>\r
 202 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Mesh.html">here</a>.</p>\r
 203 \r
 204 <a name="5_5_6"></a><h4>5.5.6 ScalarMap class</h4>\r
 205 <p>Manages presentation parameters of the scalar bar.  </p>\r
 206 <p>The API reference for this class can be found <a href="interfaceVISU_1_1ScalarMap.html">here</a>.</p>\r
 207 \r
 208 <a name="5_5_7"></a><h4>5.5.7 CutLines class</h4>\r
 209 <p>Manages presentation parameters of the cut lines presentation.  </p>\r
 210 <p>The API reference for this class can be found <a href="interfaceVISU_1_1CutLines.html">here</a>.</p>\r
 211 \r
 212 <a name="5_5_8"></a><h4>5.5.8 CutPlanes class</h4>\r
 213 <p>Manages presentation parameters of the cut planes presentation.   </p>\r
 214 <p>The API reference for this class can be found <a href="interfaceVISU_1_1CutPlanes.html">here</a>.</p>\r
 215 \r
 216 <a name="5_5_9"></a><h4>5.5.9 IsoSurfaces class</h4>\r
 217 <p>Manages presentation parameters of the iso surfaces presentation.  </p>\r
 218 <p>The API reference for this class can be found <a href="interfaceVISU_1_1IsoSurfaces.html">here</a>.</p>\r
 219 \r
 220 <a name="5_5_10"></a><h4>5.5.10 DeformedShape class</h4>\r
 221 <p>Manages presentation parameters of the deformed shape presentation.   </p>\r
 222 <p>The API reference for this class can be found <a href="interfaceVISU_1_1DeformedShape.html">here</a>.</p>\r
 223 \r
 224 <a name="5_5_11"></a><h4>5.5.11 Vectors class</h4>\r
 225 <p>Manages presentation parameters of the vector presentation.  </p>\r
 226 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Vectors.html">here</a>.</p>\r
 227 \r
 228 <a name="5_5_12"></a><h4>5.5.12 StreamLines class</h4>\r
 229 <p>Manages presentation parameters of the streamlines presentation.  </p>\r
 230 <p>The API reference for this class can be found <a href="interfaceVISU_1_1StreamLines.html">here</a>.</p>\r
 231 \r
 232 <a name="5_6"></a><h3>5.6 Animation class</h3>\r
 233 <p>This class provides a set of methods used for:</p>\r
 234 <ul>\r
 235   <li>generating different animations, </li>\r
 236   <li>setting the parameters of the animations,</li>\r
 237   <li>playing these animations in the VISU module.</li>\r
 238 </ul> \r
 239 <p>The API reference for this class can be found <a href="interfaceVISU_1_1Animation.html">here</a>.</p>\r
 240 \r
 241 <a name="5_7"></a><h3>5.7 VISU_Gen class</h3>\r
 242 <p>This is the main clas of the VISU component in SALOME application. It is used for  , \r
 243 using the views provided by ViewManager. This class provides a set of methods used for:</p>\r
 244 <ul>\r
 245   <li>creation of all types of post-processing presentations from given Result and Table object reference   </li>\r
 246   <li>creation of animations</li>\r
 247   \r
 248 </ul> \r
 249 <p>The API reference for this class can be found <a href="interfaceVISU_1_1VISU__Gen.html">here</a>.</p>\r
 250 <i><a href="#cont">Back to the contents</a></i>\r
 251 </body>\r
 252 </html>\r