// File : VISU_Gen.idl // Created : // Author : Alexey Petrov // Project : SALOME // Copyright : OPEN CASCADE // $HEADERS: /*! \file VISU_Gen.idl This file conatins a set of interfaces of %VISU module. This module will provide various forms of data visualization in %SALOME application. These forms include data tables, XY plots, 3d representations and combination of these forms. */ /*! \defgroup Visu SALOME VISU module */ #ifndef __VISU_GEN__ #define __VISU_GEN__ #include "SALOME_Exception.idl" #include "SALOME_Component.idl" #include "SALOMEDS.idl" #include "SALOMEDS_Attributes.idl" #include "MED.idl" /*! \ingroup Visu The main package of interfaces of the module %VISU. */ module VISU { //------------------------------------------------------- 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."; typedef string IdType; enum Scaling{ LINEAR, LOGARITHMIC}; enum Entity{ NODE, EDGE, FACE, CELL}; /*! This enumeration contains a set of elements defining the type of the module. */ enum VISUType{ TNONE, TCURVE, TTABLE, TCONTAINER, TMESH, TSCALARMAP, TISOSURFACE, TDEFORMEDSHAPE, TCUTPLANES, TVECTORS, TSTREAMLINES, TVISUGEN, TVIEWMANAGER, TRESULT, TXYPLOT, TTABLEVIEW, TVIEW3D, TENTITY, TFAMILY, TGROUP, TFIELD, TTIMESTAMP, TALL}; interface Base { /*! Returns ID of the object. */ IdType GetID(); const string GetID__doc__ = "Returns ID of the object."; /*! Returns the type of the presentable object */ VISUType GetType(); const string GetType__doc__ = "Returns the type of the module interface"; }; /*! \brief Presentable object interface It is the root class of all presentable objects. */ interface PrsObject : Base{ }; const string PrsObject__doc__ = "It is the root class of all presentable objects."; //------------------------------------------------------- /*! \brief %Table representation interface Presentation parameters of the %Table view. */ interface Table : PrsObject { /*! Sets the title of the table. */ void SetTitle(in string theTitle); const string SetTitle__doc__ = "Sets the title of the table."; /*! Gets the title of the table. */ string GetTitle(); const string GetTitle__doc__ = "Gets the title of the table."; /*! This enumeration contains a set of elements defining the orientation of the table. */ enum Orientation{ HORIZONTAL, /*!Returns nil if there are no views currently opened. */ View GetCurrentView(); const string GetCurrentView__doc__ = "Getting an active View Frame.\nReturns an object reference to the active view frame."; /*! \brief Creation of a 3d %View. Returns an object reference to the newly created 3d %View. */ View3D Create3DView(); const string Create3DView__doc__ = "Creation of a 3d view.\nReturns an object reference to the newly created 3d view."; TableView CreateTableView(in Table theTable); const string CreateTableView__doc__ = "Creation of a table view.\nReturns an object reference to the newly created table view."; XYPlot CreateXYPlot(); const string CreateXYPlot__doc__ = "Creation of a 2d view.\nReturns an object reference to the newly created XYPlot view."; void Destroy(in View theView); const string Destroy__doc__ = "Destroying of the view"; }; const string ViewManager__doc__ = "The ViewManager interface is necessary for work\nwith view windows (creation and deletion)."; }; #endif