3 // Author : Alexey Petrov
5 // Copyright : OPEN CASCADE
8 /*! \file VISU_Gen.idl This file conatins a set of interfaces of %VISU module.
9 This module will provide various forms of data visualization in %SALOME application.
10 These forms include data tables, XY plots, 3d representations
11 and combination of these forms.
14 \defgroup Visu SALOME VISU module
20 #include "SALOME_Exception.idl"
21 #include "SALOME_Component.idl"
22 #include "SALOMEDS.idl"
23 #include "SALOMEDS_Attributes.idl"
27 The main package of interfaces of the module %VISU.
30 //-------------------------------------------------------
31 const string VISU__doc__ = "Module VISU provides various forms of data visualization in SALOME application.\nThese forms include data tables, XY plots,\n3d representations and combination of these forms.";
32 typedef string IdType;
33 enum Scaling{ LINEAR, LOGARITHMIC};
34 enum Entity{ NODE, EDGE, FACE, CELL};
36 This enumeration contains a set of elements defining the type of the module.
39 TCURVE, TTABLE, TCONTAINER, TMESH, TSCALARMAP,
40 TISOSURFACE, TDEFORMEDSHAPE, TCUTPLANES, TVECTORS, TSTREAMLINES,
41 TVISUGEN, TVIEWMANAGER, TRESULT,
42 TXYPLOT, TTABLEVIEW, TVIEW3D,
43 TENTITY, TFAMILY, TGROUP, TFIELD, TTIMESTAMP,
47 Returns ID of the object.
50 const string GetID__doc__ = "Returns ID of the object.";
52 Returns the type of the presentable object
55 const string GetType__doc__ = "Returns the type of the module interface";
57 /*! \brief Presentable object interface
59 It is the root class of all presentable objects.
61 interface PrsObject : Base{
63 const string PrsObject__doc__ = "It is the root class of all presentable objects.";
64 //-------------------------------------------------------
65 /*! \brief %Table representation interface
67 Presentation parameters of the %Table view.
69 interface Table : PrsObject {
71 Sets the title of the table.
73 void SetTitle(in string theTitle);
74 const string SetTitle__doc__ = "Sets the title of the table.";
76 Gets the title of the table.
79 const string GetTitle__doc__ = "Gets the title of the table.";
81 This enumeration contains a set of elements defining the orientation of the table.
83 enum Orientation{ HORIZONTAL, /*!<Horizontal orientation of the table.*/
84 VERTIACAL /*!<Vertical orientation of the table.*/
87 Sets orientation of the table.
89 void SetOrientation(in Orientation theOrientation);
90 const string SetOrientation__doc__ = "Sets orientation of the table.";
92 Gets orientation of the table.
94 Orientation GetOrientation();
95 const string GetOrientation__doc__ = "Gets orientation of the table.";
97 Gets the number of rows of the table
100 const string GetNbRows__doc__ = "Gets the number of rows of the table.";
102 Gets the number of columns of the table
105 const string GetNbColumns__doc__ ="Gets the number of columns of the table.";
107 const string Table__doc__ = "The Table interface contains presentation\nparameters of the %Table view.";
108 //-------------------------------------------------------
109 /*! \brief Interface of curve representation.
111 Manages presentation parameters of one curve.
112 It can be used for presentation of a set of curves using a combined presentation.
114 interface Curve : PrsObject{
116 Sets the title of the curve.
118 void SetTitle(in string theTitle);
119 const string SetTitle__doc__ = "Sets the title of the curve.";
121 Gets the title of the curve.
124 const string GetTitle__doc__ = "Gets the title of the curve.";
126 Sets the color of the curve.
128 void SetColor(in SALOMEDS::Color theColor);
129 const string SetColor__doc__ = "Sets the color of the curve.";
131 Gets the color of the curve.
133 SALOMEDS::Color GetColor();
134 const string GetColor__doc__ = "Gets the color of the curve.";
136 This enumeration contains a set of elements defining the representation type of markers (data points) with help of
137 which the curve is constructed on the graphics.
139 enum MarkerType{ NONE, CIRCLE, RECTANGLE, DIAMOND,
140 DTRIANGLE, UTRIANGLE, LTRIANGLE, RTRIANGLE,
143 Sets the representation type of markers (data points) with help of
144 which the curve is constructed on the graphics.
146 void SetMarker(in MarkerType theType);
147 const string SetMarker__doc__ = "Sets the representation type of markers\n(data points) with help of which\nthe curve is constructed on the graphics.";
149 Gets the representation type of markers (data points) with help of
150 which the curve is constructed on the graphics.
152 MarkerType GetMarker();
153 const string GetMarker__doc__ = "Gets the representation type of markers\n(data points) with help of which the\ncurve is constructed on the graphics.";
155 This enumeration contains a set of elements defining the
156 type of representation of curve lines on the graphics.
158 enum LineType{ VOIDLINE, SOLIDLINE, DASHLINE, DOTLINE, DASHDOTLINE, DASHDOTDOTLINE};
160 Sets the type of representation of curve lines on the graphics.
162 void SetLine(in LineType theType, in long theLineWidth);
163 const string SetLine__doc__ = "Sets the type of representation of curve\nlines on the graphics.";
165 Gets the type of representation of curve lines on the graphics.
168 const string GetLine__doc__ = "Gets the type of representation of curve\nlines on the graphics.";
171 Gets the width of the curve line.
174 const string GetLineWidth__doc__ = "Gets the width of the curve line.";
176 const string Curve__doc__ = "The curve representation interface manages\npresentation parameters of one curve. It can be used\nfor presentation of a set of curves\nusing a combined presentation.";
177 //-------------------------------------------------------
178 /*! \brief The %Container presentable object interface
179 This interface contains a set of methods used for management of a group of curves
180 which are stored in the container.
182 interface Container : PrsObject{
184 Adds a curve into the container.
186 void AddCurve(in Curve theCurve);
187 const string AddCurve__doc__ = "Adds a curve into the container.";
189 Removes a curve from the container.
191 void RemoveCurve(in Curve theCurve);
192 const string RemoveCurve__doc__ = "Removes a curve from the container.";
194 Gets the number of curves which are stored in the container.
197 const string GetNbCurves__doc__ = "Gets the number of curves which\nare stored in the container.";
199 Removes all curves from the container.
202 const string Clear__doc__ = "Removes all curves from the container.";
205 const string Container__doc__ = "The Container presentable object\ninterface contains a set of methods\nused for management of a group of curves which\nare stored in the container.";
206 //-------------------------------------------------------
208 This enumeration contains a set of elements defining the
209 type of representation of the mesh.
212 enum PresentationType{ POINT,
217 /*! \brief Interface of the mesh.
219 This interface manages the presentation parameters of the mesh.
221 interface Mesh : PrsObject{
223 Sets the color of mesh cells.
225 void SetCellColor(in SALOMEDS::Color theColor);
226 const string SetCellColor__doc__ = "Sets the color of mesh cells.";
228 Gets the color of mesh cells.
230 SALOMEDS::Color GetCellColor();
231 const string GetCellColor__doc__ = "Gets the color of mesh cells.";
233 Sets the color of mesh nodes.
235 void SetNodeColor(in SALOMEDS::Color theColor);
236 const string SetNodeColor__doc__ = "Sets the color of mesh nodes.";
238 Gets the color of mesh nodes.
240 SALOMEDS::Color GetNodeColor();
241 const string GetNodeColor__doc__ = "Gets the color of mesh nodes.";
244 Sets the color of mesh links.
246 void SetLinkColor(in SALOMEDS::Color theColor);
247 const string SetLinkColor__doc__ = "Sets the color of mesh links.";
249 Gets the color of mesh links.
251 SALOMEDS::Color GetLinkColor();
252 const string GetLinkColor__doc__ = "Gets the color of mesh links.";
254 Sets the type of representation of the mesh.
256 void SetPresentationType(in PresentationType theType);
257 const string SetPresentationType__doc__ = "Sets the type of representation of the mesh.";
259 Gets the type of representation of the mesh.
261 PresentationType GetPresentationType();
262 const string GetPresentationType__doc__ = "Gets the type of representation of the mesh.";
264 const string Mesh__doc__ = "The Mesh interface manages the presentation parameters\nof the mesh.";
265 //-------------------------------------------------------
266 /*! \brief Interface of the %Scalar Map presentation
268 This interface contains presentation parameters of the ScalarMap presentation
270 interface ScalarMap : PrsObject{
271 void SetScalarMode(in long theScaling);
272 long GetScalarMode();
273 void SetScaling(in Scaling theScaling);
274 const string SetScaling__doc__ = "Sets the type of scaling of the values\nreflected by this presentation.";
276 Gets the type of scaling of the values reflected by this presentation.
278 Scaling GetScaling();
279 const string GetScaling__doc__ = "Gets the type of scaling of the values\nreflected by this presentation.";
281 Sets scalar range - min and max boundaries of this presentable object.
282 \param theMin Min boundary of this presentable object.
283 \param theMax Max boundary of this presentable object.
285 void SetRange(in double theMin, in double theMax);
286 const string SetRange__doc__ = "Sets scalar range - min and max boundaries\nof this presentable object.";
288 Gets the min boundary of this presentable object.
291 const string GetMin__doc__ = "Gets the min boundary of this presentable object.";
293 Gets the max boundary of this presentable object.
296 const string GetMax__doc__ = "Gets the max boundary of this presentable object.";
298 /*! %Orientation of this presentable object. */
300 HORIZONTAL, /*!< Horizontal orientation of this presentable object.*/
301 VERTICAL /*!< Vertical orientation of this presentable object.*/
304 Sets the type of orientation of this presentable object.
306 void SetOrientation(in Orientation theOrientation);
307 const string SetOrientation__doc__ = "Sets the type of orientation of this presentable object.";
309 Gets the type of orientation of this presentable object.
311 Orientation GetOrientation();
312 const string GetOrientation__doc__ = "Gets the type of orientation of this presentable object.";
314 /*! \brief Position of this presentable object.
316 Sets the position of this presentable object origin on the screen.
317 \param X Horizontal position. The value can be between 0 and 1.
318 \param Y Vertical position. The value can be between 0 and 1.
320 void SetPosition(in double X, in double Y);
321 const string SetPosition__doc__ = "Sets the position of this presentable object\norigin on the screen.";
323 Gets horizontal position of this presentable object origin.
326 const string GetPosX__doc__ = "Gets horizontal position of this presentable object origin.";
328 Gets vertical position of this presentable object origin.
331 const string GetPosY__doc__ = "Gets vertical position of this presentable object origin.";
332 /*! \brief Size of this presentable object.
334 Sets the size of the scalar bar.
335 \param theWidth Width of this presentable object. The value can be between 0 and 1.
336 \param theHeight Height of this presentable object. The value can be between 0 and 1.
338 void SetSize(in double theWidth, in double theHeight);
339 const string SetSize__doc__ = "Sets the size of the scalar bar.";
341 Gets the width of this presentable object.
344 const string GetWidth__doc__ = "Gets the width of this presentable object.";
346 Gets the height of this presentable object.
349 const string GetHeight__doc__ = "Gets the height of this presentable object.";
351 Sets the number of colors which will be used for presentation of this presentable object.
353 void SetNbColors(in long theNbColors);
354 const string SetNbColors__doc__ = "Sets the number of colors which will be\nused for presentation of this presentable object.";
356 Gets the number of colors which will be used for presentation of this presentable object.
359 const string GetNbColors__doc__ = "Gets the number of colors which will be\nused for presentation of this presentable object.";
361 Sets the number of labels which will be used for indication of the gradation
362 of this presentable object.
364 void SetLabels(in long theNbLabels);
365 const string SetLabels__doc__ = "Sets the number of labels which will be used\nfor indication of the gradation of this presentable object.";
367 Gets the number of labels which will be used for indication of the gradation
368 of this presentable object.
371 const string GetLabels__doc__ = "Gets the number of labels which will be used\nfor indication of the gradation of this presentable object.";
374 Sets the title of this presentable object. For scalar bar by default - the name of the selected result is used.
376 void SetTitle(in string theName);
377 const string SetTitle__doc__ = "Sets the title of this presentable object. For scalar bar by default - the name of the selected result is used.";
379 Gets the title of this presentable object.
382 const string GetTitle__doc__ = "Gets the title of this presentable object.";
384 const string ScalarMap__doc__ = "The scalarmap interface contains presentation\nparameters of the ScalarMap presentation.";
385 //-------------------------------------------------------
386 /*! \brief Deformed shape presentation interface
388 Presentation parameters of the deformed shape presentation.
390 interface DeformedShape : ScalarMap{
392 Sets the scale of the presentatable object.
394 void SetScale(in double theScale);
395 const string SetScale__doc__ = "Sets the scale of the deformed shape.";
397 Gets the scale of the presentatable object.
400 const string GetScale__doc__ = "Gets the scale of the deformed shape";
402 const string DeformedShape__doc__ = "The deformed shape interface contains\nthe presentation parameters of the deformed shape.";
403 //-------------------------------------------------------
404 /*! \brief Cut planes interface
406 Presentation parameters of Cut planes presentation.
408 interface CutPlanes : ScalarMap{
410 This enumeration contains a set of elements defining the orientation in 3D space
411 of cut planes presentation.
413 enum Orientation {XY, YZ, ZX};
415 Sets the type of orientation in 3D space of cut planes presentation.
417 void SetOrientationType(in Orientation theNb);
418 const string SetOrientationType__doc__ = "Sets the type of orientation in 3D\nspace of cut planes presentation.";
420 Gets the type of orientation in 3D space of cut planes presentation.
422 Orientation GetOrientationType();
423 const string GetOrientationType__doc__ = "Gets the type of orientation in 3D\nspace of cut planes presentation.";
425 Sets the number of cut planes.
427 void SetNbPlanes(in long theNb);
428 const string SetNbPlanes__doc__ = "Sets the number of cut planes.";
430 Gets the number of cut planes.
433 const string GetNbPlanes__doc__ = "Gets the number of cut planes.";
434 /*! Rotation around X-axis.
435 Sets rotation angle of the cut plane presentation.
437 void SetRotateX(in double theAngle);
438 const string SetRotateX__doc__ = "Rotation around X-axis.\nSets rotation angle of the cut plane presentation.";
439 /*! Rotation around X-axis.
440 Gets rotation angle of the cut plane presentation.
443 const string GetRotateX__doc__ = "Rotation around X-axis.\nGets rotation angle of the cut plane presentation.";
444 /*! Rotation around Y-axis.
445 Sets rotation angle of the cut plane presentation.
447 void SetRotateY(in double theAngle);
448 const string SetRotateY__doc__ = "Rotation around Y-axis.\nSets rotation angle of the cut plane presentation.";
449 /*! Rotation around Y-axis.
450 Sets rotation angle of the cut plane presentation.
453 const string GetRotateY__doc__ = "Rotation around Y-axis.\nGets rotation angle of the cut plane presentation.";
455 const string CutPlanes__doc__ = "The cut planes interface contains\nthe presentation parameters of cut planes presentation.";
456 //-------------------------------------------------------
457 /*! \brief Interface of the stream lines representation
458 This interface contains presentation parameters of
459 stream lines presentations.
461 interface StreamLines : DeformedShape{
462 enum Direction{ FORWARD,
467 const string StreamLines__doc__ = "";
470 /*! \brief Interface of the isometric surface representation
472 This interface contains presentation parameters of
473 isometric surface presentations.
475 interface IsoSurfaces : ScalarMap{
477 Sets the number of isometric surfaces.
479 void SetNbSurfaces(in long theNb);
480 const string SetNbSurfaces__doc__ = "Sets the number of isometric surfaces.";
482 Gets the number of isometric surfaces
484 long GetNbSurfaces();
485 const string GetNbSurfaces__doc__ = "Gets the number of isometric surfaces.";
487 const string IsoSurfaces__doc__ = "The isometric surface interface contains\nthe presentation parameters of the isometric surface presentations.";
488 //-------------------------------------------------------
489 /*! \brief Interface of the vector presentation.
491 This interface contains presentation parameters of the vector.
493 interface Vectors : DeformedShape{
495 Sets the width of the line of the vector.
497 void SetLineWidth(in double theWidth);
498 const string SetLineWidth__doc__ = "Sets the width of the line of the vector.";
500 Gets the width of the line of the vector.
502 double GetLineWidth();
503 const string GetLineWidth__doc__ = "Gets the width of the line of the vector.";
505 This enumeration contains a set of elements defining the type of representation of the vector head.
507 enum GlyphType{ ARROW,
513 Sets the type of representation of the vector head.
515 void SetGlyphType(in GlyphType theType);
516 const string SetGlyphType__doc__ = "Sets the type of representation of the vector head.";
518 Gets the type of representation of the vector head.
520 GlyphType GetGlyphType();
521 const string GetGlyphType__doc__ = "Gets the type of representation of the vector head.";
523 This enumeration contains a set of elements defining the position of the vector head.
526 enum GlyphPos{ CENTER, /*!<In the center of the vector.*/
527 TAIL, /*!<In the tail of the vector.*/
528 HEAD /*!<In the head of the vector.*/
531 Sets the position of the vector head.
533 void SetGlyphPos(in GlyphPos thePos);
534 const string SetGlyphPos__doc__ = "Sets the position of the vector head.";
536 Gets the position of the vector head.
538 GlyphPos GetGlyphPos();
539 const string GetGlyphPos__doc__ = "Gets the position of the vector head.";
541 const string Vectors__doc__ = "Interface of the vector presentation contains\nthe presentation parameters of the vector.";
542 //-------------------------------------------------------
543 /*! \brief Interface %Result
545 This interface serves for inner representation of data generated in other sources. (MED object or file)
546 This data is needed for further construction of graphical presentations.
548 interface Result : Base {
550 const string Result__doc__ = "This interface serves for inner representation\nof data generated in other sources. (MED object or file) This data is needed for further construction of graphical presentations.";
551 //-------------------------------------------------------
552 interface ViewManager;
553 /*! \brief %VISU_Gen interface
555 This is the main interface of %VISU component. It is necessary for creation of
556 post-processing presentations from given %Result and %Table object reference, using the views
557 provided by %ViewManager.
559 interface VISU_Gen : Engines::Component, SALOMEDS::Driver, Base{
560 void SetCurrentStudy(in SALOMEDS::Study theStudy);
561 SALOMEDS::Study GetCurrentStudy();
563 Gets the %ViewManager which is used for creation of
564 post-processing presentations.
566 ViewManager GetViewManager();
567 const string GetViewManager__doc__ = "Gets the ViewManager which is used for creation\nof post-processing presentations.";
570 Imports tables from a file and create TableAttribute in Sudy
572 SALOMEDS::SObject ImportTables(in string theFileName);
574 Imports data from a file.
576 Result ImportFile(in string theFileName);
577 const string ImportFile__doc__ = "Imports data from a file.";
579 Imports data from a %MED object field.
581 Result ImportMed(in SALOME_MED::FIELD theField);
582 const string ImportMed__doc__ = "Imports data from a MED object field.";
584 Imports data from a %MED object mesh.
586 Result ImportMedMesh(in SALOME_MED::MESH theMesh);
587 const string ImportMedMesh__doc__ = "Imports data from a MED object mesh.";
590 Imports data from a %MED object SUPPORT.
592 Result ImportMedSupport(in SALOME_MED::SUPPORT theSupport);
593 const string ImportMedSupport__doc__ = "Imports data from a MED support.";
596 Creates a %Mesh on the basis of the data generated in other sources (MED object or file).
598 const string CreateMesh__doc__ = "Creates a Mesh on the basis of the data\ngenerated in other sources (MED object or file).";
599 Mesh MeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity);
600 Mesh FamilyMeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity, in string theFamilyName);
601 Mesh GroupMesh(in Result theResult, in string theMeshName, in string theGroupName);
603 Creates a scalar bar presentation.
604 \param theResult Data generated in other sources. (MED object or file)
605 \param theMeshName One of the meshes presented in MED file
606 \param theEntity Type of entity where the field is defined
607 \param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
608 \param theIteration Number of iteration on the field
610 ScalarMap ScalarMapOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
611 const string CreateScalarMap__doc__ = "Creates a scalar bar presentation.";
613 Creates a deformed shape presentation.
614 \param theResult Data generated in other sources. (MED object or file)
615 \param theMeshName One of the meshes presented in MED file
616 \param theEntity Type of entity where the field is defined
617 \param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
618 \param theIteration Number of iteration on the field
620 DeformedShape DeformedShapeOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
621 const string CreateDeformedShape__doc__ = "Creates a deformed shape presentation.";
623 Creates a vector presentation.
624 \param theResult Data generated in other sources. (MED object or file)
625 \param theMeshName One of the meshes presented in MED file
626 \param theEntity Type of entity where the field is defined
627 \param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
628 \param theIteration Number of iteration on the field
631 Vectors VectorsOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
632 const string CreateVectors__doc__ = "Creates a vector presentation.";
634 Creates an iso surface presentation.
635 \param theResult Data generated in other sources. (MED object or file)
636 \param theMeshName One of the meshes presented in MED file
637 \param theEntity Type of entity where the field is defined
638 \param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
639 \param theIteration Number of iteration on the field
642 IsoSurfaces IsoSurfacesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
643 const string CreateIsoSurfaces__doc__ = "Creates an iso surface presentation.";
645 Creates an stream lines presentation.
646 \param theResult Data generated in other sources. (MED object or file)
647 \param theMeshName One of the meshes presented in MED file
648 \param theEntity Type of entity where the field is defined
649 \param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
650 \param theIteration Number of iteration on the field
652 StreamLines StreamLinesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
653 const string CreateStreamLines__doc__ = "Creates an stream lines presentation.";
656 Creates a presentation of cut planes.
657 \param theResult Data generated in other sources. (MED object or file)
658 \param theMeshName One of the meshes presented in MED file
659 \param theEntity Type of entity where the field is defined
660 \param theFieldName Group of data attributed to the %MESH. The data can be scalar or vector.
661 \param theIteration Number of iteration on the field
663 CutPlanes CutPlanesOnField(in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in double theIteration);
664 const string CreateCutPlanes__doc__ = "Creates a presentation of cut planes.";
666 Creates a table presentation.
668 Table CreateTable(in string theTableEntry);
669 const string CreateTable__doc__ = "Creates a table prasentation containing the data.";
671 Creates a curve on the basis of points, whose values are taken from the table.
672 \param theTable Table containing the data for construction of curves.
673 \param HRow Index of the row in the table: abscissa of the point.
674 \param VRow Index of the row in the table: ordinate of the point.
676 Curve CreateCurve(in Table theTable, in long theHRow, in long theVRow);
677 const string CreateCurve__doc__ = "Creates a curve on the basis of points, whose values\nare taken from the table.";
679 Creates a presentation form containing an array of references to the curves.
681 Container CreateContainer();
682 const string CreateContainer__doc__ = "Creates a presentation form containing an array\nof references to the curves.";
684 const string VISU_Gen__doc__ = "This is the main interface of the VISU component. It is\nnecessary for creation of post-processing presentations from given result and table object reference, using the views provided by the viewmanager.";
685 /*! \brief %View interface
687 Contains a set of methods used by the %View frame, which can be one of
688 the following types: 3d, Table, XY plot.
689 %View interface is a base for all types of %view interfaces.
691 interface View: Base{
693 Sets the title of the %View frame.
695 void SetTitle(in string theTitle);
696 const string SetTitle__doc__ = "Sets the title of the view frame.";
698 Gets the title of the %View frame.
701 const string GetTitle__doc__ = "Gets the title of the view frame.";
703 Sets background color of the %View frame.
705 void SetBackground(in SALOMEDS::Color theColor);
706 const string SetBackground__doc__ = "Sets background color of the view frame.";
708 Gets background color of the %View frame.
710 SALOMEDS::Color GetBackground();
711 const string GetBackground__doc__ = "Gets background color of the view frame.";
713 Minimizes to the task bar or to the bottom of the Desktop the %View frame.
716 const string Minimize__doc__ = "Minimizes to the task bar or to the bottom of the\nDesktop the view frame.";
718 Restores the %View frame.
721 const string Restore__doc__ = "Restores the view frame.";
723 Maximizes the %View frame.
726 const string Maximize__doc__ = "Maximizes the view frame.";
728 Removes all presentations (presentable objects) from the %view.
731 const string EraseAll__doc__ = "Removes all presentations (presentable objects) from the view.";
733 Displays all presentations (presentable objects) in the %view.
736 const string DisplayAll__doc__ = "Displays all presentations (presentable objects) in the view.";
738 Removes a definite presentation (presentable object) from the %view.
740 void Erase(in PrsObject thePrsObj);
741 const string Erase__doc__ = "Removes a definite presentation (presentable object) from the view.";
743 Displays a definite presentation (presentable object) in the %view.
745 void Display(in PrsObject thePrsObj);
746 const string Display__doc__ = "Displays a definite presentation (presentable object) in the view.";
748 Allows to display only a definite presentation (presentable object) in the %view.
749 All other presentations are removed from the %view.
751 void DisplayOnly(in PrsObject thePrsObj);
752 const string DisplayOnly__doc__ = "Allows to display only a definite presentation\n(presentable object) in the view. All other presentations are\nremoved from the view.";
757 const string Update__doc__ = "Updates the view.";
762 boolean SavePicture(in string theFileName);
763 const string SavePicture__doc__ = "Saves the view contents into image file.";
766 const string View__doc__ = "Contains a set of methods used by the view frame,\nwhich can be one of the following types:\n3d, table, XY plot.";
767 //-------------------------------------------------------
768 /*! \brief 3D view interface
770 This interface contains a set of methods necessary for representation of objects in 3D space.
773 interface View3D : View {
775 This enumeration contains a set of elements determining a predefined point of view
776 (position of the camera in 3D space relative to the presentable object).
778 enum ViewType{ FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM};
780 This enumeration contains a set of elements determining the axis
782 enum Axis{ XAxis, YAxis, ZAxis};
784 Data type defining coordinates in 3D space.
786 typedef double XYZ[3];
789 Makes all presentations, which are currently present in the %view, completely visible.
793 const string FitAll__doc__ = "Makes all presentations, which are currently present in the\nview, completely visible.";
796 Sets a predefined point of view (FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM). (In other words it means
797 a predefined position of the camera in 3D space with respect to the object which is represented.)
799 void SetView(in ViewType theType);
800 const string SetView__doc__ = "Sets a predefined point of view\n(FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM).";
803 Sets the position of the camera in 3D space. This point is used as the first point of the vector defining
804 the view direction of the camera.
806 void SetPointOfView(in XYZ theCoord);
807 const string SetPointOfView__doc__ = "Sets the position of the camera in 3D space.";
809 Gets the position of the camera in 3D space.This point is used as the first point of the vector defining
810 the view direction of the camera.
812 XYZ GetPointOfView();
813 const string GetPointOfView__doc__ = "Gets the position of the camera in 3D space.";
815 Sets the vertical line of the camera in 3D space.
817 void SetViewUp(in XYZ theDir);
818 const string SetViewUp__doc__ = "Sets the vertical line of the camera in 3D space.";
820 Gets the vertical line of the camera in 3D space.
823 const string GetViewUp__doc__ = "Gets the vertical line of the camera in 3D space.";
825 Sets the point of sight of the camera. This point is used as the second point of the vector defining
826 the view direction of the camera.
828 void SetFocalPoint(in XYZ theDir);
829 const string SetFocalPoint__doc__ = "Sets the point of sight of the camera.";
831 Gets the point of sight of the camera. This point is used as the second point of the vector defining
832 the view direction of the camera.
835 const string GetFocalPoint__doc__ = "Gets the point of sight of the camera.";
837 Zooming of the presentable object. Sets the scale.
839 void SetParallelScale(in double theScale);
840 const string SetParallelScale__doc__ = "Zooming of the presentable object. Sets the scale.";
842 Zooming of the presentable object. Gets the scale.
844 double GetParallelScale();
845 const string GetParallelScale__doc__ = "Zooming of the presentable object. Gets the scale.";
847 Scaling of the view along a definite axis.
848 \param theAxis The axis of the scaling
849 \param theParam The coefficient of the scaling
851 void ScaleView(in Axis theAxis, in double theParam);
852 const string ScaleView__doc__ = "Scaling of the view along a definite axis and with a\ndefinite coefficient of the scaling.";
854 Removes the scaling of the view.
857 const string RemoveScale__doc__ = "Removes the scaling of the view.";
859 Returns True if the view parameters have been created, False if the parameters have been modified.
861 boolean SaveViewParams(in string theName);
862 const string SaveViewParams__doc__ = "Returns True if the view parameters have been created,\nFalse if the parameters have been modified.";
864 Returns True if the view parameters have been found and applied to the view,
865 False if the parameters with this name don't exist.
867 boolean RestoreViewParams(in string theName);
868 const string RestoreViewParams__doc__ = "Returns True if the view parameters have been found and\napplied to the view, False if the parameters with this name don't exist.";
870 const string View3D__doc__ = "This interface contains a set of methods necessary for representation\nof objects in 3D space.";
873 //-------------------------------------------------------
874 interface TableView : View {
879 //-------------------------------------------------------
880 interface XYPlot : View {
881 void SetSubTitle(in string theTitle);
882 string GetSubTitle();
884 enum CurveType { POINTS, MULTYLINE, SPLINE};
885 void SetCurveType(in CurveType theType);
886 CurveType GetCurveType();
888 void SetMarkerSize(in long theSize);
889 long GetMarkerSize();
891 void EnableXGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
892 void EnableYGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
894 void SetHorScaling(in Scaling theScaling);
895 Scaling GetHorScaling();
896 void SetVerScaling(in Scaling theScaling);
897 Scaling GetVerScaling();
899 void SetXTitle(in string theTitle);
902 void SetYTitle(in string theTitle);
905 void ShowLegend(in boolean theShowing);
910 //-------------------------------------------------------
911 /*! \brief Interface of the %ViewManager
913 The %ViewManager is necessary for work with view windows (creation and deletion).
916 interface ViewManager: Base{
917 /*! \brief Getting an active %View Frame
919 Returns an object reference to the active %View Frame.
920 Type of the %View must be checked.
921 \note <BR>Returns nil if there are no views currently opened.
924 View GetCurrentView();
925 const string GetCurrentView__doc__ = "Getting an active View Frame.\nReturns an object reference to the active view frame.";
926 /*! \brief Creation of a 3d %View.
928 Returns an object reference to the newly created 3d %View.
930 View3D Create3DView();
931 const string Create3DView__doc__ = "Creation of a 3d view.\nReturns an object reference to the newly created 3d view.";
933 TableView CreateTableView(in Table theTable);
935 const string CreateTableView__doc__ = "Creation of a table view.\nReturns an object reference to the newly created table view.";
936 XYPlot CreateXYPlot();
938 const string CreateXYPlot__doc__ = "Creation of a 2d view.\nReturns an object reference to the newly created XYPlot view.";
939 void Destroy(in View theView);
941 const string Destroy__doc__ = "Destroying of the view";
945 const string ViewManager__doc__ = "The ViewManager interface is necessary for work\nwith view windows (creation and deletion).";