idl/VISU_Gen.idl

Go to the documentation of this file.

//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
// 
//  This library is free software; you can redistribute it and/or 
//  modify it under the terms of the GNU Lesser General Public 
//  License as published by the Free Software Foundation; either 
//  version 2.1 of the License. 
// 
//  This library is distributed in the hope that it will be useful, 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
//  Lesser General Public License for more details. 
// 
//  You should have received a copy of the GNU Lesser General Public 
//  License along with this library; if not, write to the Free Software 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
// 
//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
//  File   : VISU_Gen.idl
//  Author : Alexey Petrov

#ifndef __VISU_GEN__
#define __VISU_GEN__

#include "SALOME_Exception.idl"
#include "SALOME_GenericObj.idl"
#include "SALOME_Component.idl"
#include "SALOMEDS.idl"
#include "SALOMEDS_Attributes.idl"
#include "MED.idl"

module VISU {
  //-------------------------------------------------------
  typedef string IdType;

  enum Scaling{ LINEAR, 
          LOGARITHMIC 
           };

  enum Entity{ NODE, 
               EDGE, 
            FACE, 
            CELL  
            };

  enum VISUType {
    TNONE, 
    TCURVE, 
    TTABLE, 
    TCONTAINER, 
    TMESH, 
    TSCALARMAP, 
    TISOSURFACE, 
    TDEFORMEDSHAPE, 
    TSCALARMAPONDEFORMEDSHAPE, 
    TGAUSSPOINTS, 
    TPLOT3D, 
    TCUTPLANES, 
    TCUTLINES, 
    TVECTORS, 
    TSTREAMLINES, 
    TVISUGEN, 
    TVIEWMANAGER, 
    TRESULT, 
    TXYPLOT, 
    TTABLEVIEW, 
    TVIEW3D, 
    TGAUSSVIEW, 
    TENTITY, 
    TFAMILY, 
    TGROUP, 
    TFIELD, 
    TTIMESTAMP, 
    TANIMATION, 
    TALL
  };

  interface Base {
    IdType GetID();

    VISUType GetType();
  };

  interface RemovableObject : Base {
    void RemoveFromStudy();
  };

  interface PrsObject : RemovableObject {
  };

  //-------------------------------------------------------
  interface Table : PrsObject {
    void SetTitle(in string theTitle);

    string GetTitle();

    enum Orientation {
      HORIZONTAL, 
      VERTIACAL   
    };

    void SetOrientation(in Orientation theOrientation);

    Orientation GetOrientation();

    long GetNbRows();

    long GetNbColumns();
  };

  //-------------------------------------------------------
  interface Curve : PrsObject {
    void SetTitle(in string theTitle);

    string GetTitle();

    void SetColor(in SALOMEDS::Color theColor);

    SALOMEDS::Color GetColor();

    enum MarkerType { NONE,
                CIRCLE,
                RECTANGLE,
                DIAMOND,
                DTRIANGLE,
                UTRIANGLE,
                LTRIANGLE,
                RTRIANGLE,
                CROSS,
                XCROSS
    };

    void SetMarker(in MarkerType theType);

    MarkerType GetMarker();

    enum LineType{ VOIDLINE, SOLIDLINE, DASHLINE, DOTLINE, DASHDOTLINE, DASHDOTDOTLINE};

    void SetLine(in LineType theType, in long theLineWidth);

    LineType GetLine();

    long GetLineWidth();
  };

  //-------------------------------------------------------
  interface Container : PrsObject {
    void AddCurve(in Curve theCurve);

    void RemoveCurve(in Curve theCurve);

    long GetNbCurves();

    void Clear();
  };

  //-------------------------------------------------------
  interface Prs3d : PrsObject, SALOME::GenericObj {
    //interface Prs3d : PrsObject{
    void SetOffset(in float theDx, in float theDy, in float theDz);
    void GetOffset(out float theDx, out float theDy, out float theDz);
  };

  enum PresentationType{ POINT,
                WIREFRAME,
                SHADED,
                INSIDEFRAME,
                SURFACEFRAME,
                SHRINK
  };

  interface Mesh : Prs3d {
    void SetCellColor(in SALOMEDS::Color theColor);

    SALOMEDS::Color GetCellColor();

    void SetNodeColor(in SALOMEDS::Color theColor);

    SALOMEDS::Color GetNodeColor();

    void SetLinkColor(in SALOMEDS::Color theColor);

    SALOMEDS::Color GetLinkColor();

    void SetPresentationType(in PresentationType theType);

    PresentationType GetPresentationType();
  };


  //-------------------------------------------------------
  interface ColoredPrs3d : Prs3d {
    void SetScalarMode(in long theScalarMode);

    long GetScalarMode();

    double GetMin();

    double GetMax();

    void SetPosition(in double X, in double Y);

    double GetPosX();

    double GetPosY();

    void SetSize(in double theWidth, in double theHeight);

    double GetWidth();

    double GetHeight();

    void SetNbColors(in long theNbColors);

    long GetNbColors();

    void SetLabels(in long theNbLabels);

    long GetLabels();

    void SetTitle(in string theName);

    string GetTitle();
  };


  //-------------------------------------------------------
  interface ScalarMap : ColoredPrs3d {
    void SetScaling(in Scaling theScaling);

    Scaling GetScaling();

    void SetRange(in double theMin, in double theMax);

    enum Orientation {
      HORIZONTAL, 
      VERTICAL    
    };

    void SetBarOrientation(in Orientation theOrientation);

    Orientation GetBarOrientation();
  };

  //-------------------------------------------------------
  //-------------------------------------------------------
  interface GaussPoints : ColoredPrs3d {
  };

  interface DeformedShape : ScalarMap {
    void SetScale(in double theScale);

    double GetScale();

    boolean IsColored();

    void ShowColored(in boolean theColored);

    SALOMEDS::Color GetColor();

    void SetColor(in SALOMEDS::Color theColor);
  };

  //-------------------------------------------------------
  interface ScalarMapOnDeformedShape : ScalarMap {
    
    void SetSourceRange(in double theMinRange,in double theMaxRange);
    double GetSourceRangeMin();
    double GetSourceRangeMax();
    
    void SetScale(in double theScale);

    double GetScale();

    void SetScalarField(in string theMeshName,in string theFieldName,
               in long theIteration,in Entity theEntity);

  };
  //-------------------------------------------------------
  interface Plot3D : ScalarMap {
    enum Orientation { XY,   
                 YZ,   
                 ZX }; 
    void SetOrientation (in Orientation theOrientation, in double theXAngle, in double theYAngle);

    Orientation GetOrientationType();

    double GetRotateX();

    double GetRotateY();

    void SetPlanePosition (in double  thePlanePosition,
                  in boolean theIsRelative);

    double GetPlanePosition();

    boolean IsPositionRelative();

    void SetScaleFactor (in double theScaleFactor);

    double GetScaleFactor();

    void SetContourPrs (in boolean theIsContourPrs );

    boolean GetIsContourPrs();

    void SetNbOfContours (in long theNb);

    long GetNbOfContours();
  };

  //-------------------------------------------------------
  interface CutPlanes : ScalarMap {
    enum Orientation {XY, 
                      YZ, 
                ZX}; 
    void SetOrientation(in Orientation theOrientation, in double theXAngle, in double theYAngle);

    Orientation GetOrientationType();

    double GetRotateX();

    double GetRotateY();

    void SetDisplacement(in double theDisp);

    double GetDisplacement();

     void SetPlanePosition(in long thePlaneNumber, in double thePlanePosition);

     void SetDefault(in long thePlaneNumber);

    double GetPlanePosition(in long thePlaneNumber);

    boolean IsDefault(in long thePlaneNumber);

    void SetNbPlanes(in long theNb);

    long GetNbPlanes();
  };

  //-------------------------------------------------------
  interface CutLines : ScalarMap {
    void SetOrientation(in CutPlanes::Orientation theOrientation, in double theXAngle, in double theYAngle);

    void SetOrientation2(in CutPlanes::Orientation theOrientation, in double theXAngle, in double theYAngle);

    CutPlanes::Orientation GetOrientationType();

    CutPlanes::Orientation GetOrientationType2();

    double GetRotateX();

    double GetRotateX2();

    double GetRotateY();

    double GetRotateY2();

    void SetDisplacement(in double theDisp);

    void SetDisplacement2(in double theDisp);

    double GetDisplacement();

    double GetDisplacement2();

    void SetBasePlanePosition(in double thePlanePosition);

    double GetBasePlanePosition();

    void SetLinePosition(in long thePlaneNumber, in double thePlanePosition);

    double GetLinePosition(in long thePlaneNumber);

    void SetDefault();

    boolean IsDefault();

    void SetDefaultPosition(in long thePlaneNumber);

    boolean IsDefaultPosition(in long thePlaneNumber);

    void SetNbLines(in long theNb);

    long GetNbLines();
  };

  interface StreamLines : DeformedShape {
    enum Direction{ FORWARD,
              BACKWARD,
              BOTH
    };

    boolean SetParams(in double theIntStep,
                in double thePropogationTime,
                in double theStepLength,
                in Prs3d thePrs3d,
                in double thePercents,
                in Direction theDirection);

    double GetIntegrationStep();

    double GetPropagationTime();

    double GetStepLength();

    Prs3d GetSource();

    double GetUsedPoints();

    Direction GetDirection();
  };

  interface IsoSurfaces : ScalarMap {
    void SetNbSurfaces(in long theNb);

    long GetNbSurfaces();
  };

  //-------------------------------------------------------
  interface Vectors : DeformedShape {
    void SetLineWidth(in double theWidth);

    double GetLineWidth();

    enum GlyphType{ ARROW,
                    CONE2,
                    CONE6,
                    NONE
                  };

    void SetGlyphType(in GlyphType theType);

    GlyphType GetGlyphType();

    enum GlyphPos{ CENTER, 
                   TAIL,   
                   HEAD  
                 };

    void SetGlyphPos(in GlyphPos thePos);

    GlyphPos GetGlyphPos();
  };

  //-------------------------------------------------------
  interface Animation : Base {
    void addField(in SALOMEDS::SObject theObject);

    void generatePresentations(in long theFieldNum);

    boolean generateFrames();

    void clearView();


    void startAnimation();

    void stopAnimation();

    void nextFrame();

    void prevFrame();

    void firstFrame();

    void lastFrame();

    void gotoFrame(in long theFrame);
    long getNbFields();

    long getNbFrames();

    boolean isRunning();

    long getCurrentFrame();

    ColoredPrs3d getPresentation(in long theField, in long theFrame);

    void setPresentationType(in long theFieldNum, in VISUType theType);

    VISUType getPresentationType(in long theFieldNum);

    void setSpeed(in long theSpeed);

    long getSpeed();

    boolean isProportional();

    void setAnimationRange(in double theMin, in double theMax);

    double getMinRange();

    double getMaxRange();

    boolean isRangeDefined();

    void dumpTo(in string thePath);

    string setDumpFormat(in string theFormat);

    boolean isCycling();

    double getMinTime();

    double getMaxTime();

    void setProportional(in boolean theProp);

    void setCycling(in boolean theCycle);

    SALOMEDS::SObject publishInStudy();

    void saveAnimation();

    void restoreFromStudy(in SALOMEDS::SObject theSObj);

    boolean isSavedInStudy();
  };

  interface Result : RemovableObject, SALOME::GenericObj {
    boolean BuildAll();

    boolean Build(in boolean theIsBuildAll, in boolean theIsAtOnce);

    boolean IsDone();

    boolean IsEntitiesDone();

    void SetBuildFields(in boolean theIsBuildFields, in boolean theIsCalculateMinMax);

    boolean IsFieldsDone();

    void SetBuildGroups(in boolean theIsBuildGroups);

    boolean IsGroupsDone();

    boolean IsMinMaxDone();
  };

  //-------------------------------------------------------
  interface ViewManager;
  interface View3D;

  interface VISU_Gen : Engines::Component, SALOMEDS::Driver, Base {
    void SetCurrentStudy(in SALOMEDS::Study theStudy);

    SALOMEDS::Study GetCurrentStudy();

    ViewManager GetViewManager();

    SALOMEDS::SObject ImportTables(in string theFileName);

    boolean ExportTableToFile(in SALOMEDS::SObject theTable, in string theFileName);

    Result ImportFile(in string theFileName);

    Result CreateResult(in string theFileName);

    Result CopyAndImportFile(in string theFileName);

    Result ImportMed(in SALOMEDS::SObject theMedSObject);

    Result ImportMedField(in SALOME_MED::FIELD theField);

    void RenameEntityInStudy(in Result theResult,
                    in string theMeshName,
                    in Entity theEntity,
                    in string theNewName);
    void RenameFamilyInStudy(in Result theResult,
                    in string theMeshName,
                    in Entity theEntity,
                    in string theSubMeshName,
                    in string theNewName);
    void RenameGroupInStudy(in Result theResult,
                   in string theMeshName,
                   in string theSubMeshName,
                   in string theNewName);

    Mesh MeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity);

    Mesh FamilyMeshOnEntity(in Result theResult, in string theMeshName,
                   in Entity theEntity, in string theFamilyName);

    Mesh GroupMesh(in Result theResult, in string theMeshName, in string theGroupName);

    ScalarMap ScalarMapOnField(in Result theResult, in string theMeshName,
                      in Entity theEntity, in string theFieldName,
                      in double theIteration);

    GaussPoints GaussPointsOnField(in Result theResult, in string theMeshName,
                       in Entity theEntity, in string theFieldName,
                       in double theIteration);

    DeformedShape DeformedShapeOnField(in Result theResult, in string theMeshName,
                           in Entity theEntity, in string theFieldName,
                           in double theIteration);

    ScalarMapOnDeformedShape ScalarMapOnDeformedShapeOnField(in Result theResult, in string theMeshName,
                                        in Entity theEntity, in string theFieldName,
                                        in double theIteration);

    Vectors VectorsOnField(in Result theResult, in string theMeshName,
                  in Entity theEntity, in string theFieldName,
                  in double theIteration);

    IsoSurfaces IsoSurfacesOnField(in Result theResult, in string theMeshName,
                       in Entity theEntity, in string theFieldName,
                       in double theIteration);

    StreamLines StreamLinesOnField(in Result theResult, in string theMeshName,
                       in Entity theEntity, in string theFieldName,
                       in double theIteration);

    CutPlanes CutPlanesOnField(in Result theResult, in string theMeshName,
                      in Entity theEntity, in string theFieldName,
                      in double theIteration);

    CutLines CutLinesOnField(in Result theResult, in string theMeshName,
                    in Entity theEntity, in string theFieldName,
                    in double theIteration);

    Plot3D Plot3DOnField(in Result theResult, in string theMeshName,
                in Entity theEntity, in string theFieldName,
                in double theIteration);

    Table CreateTable(in string theTableEntry);

    Curve CreateCurve(in Table theTable, in long theHRow, in long theVRow);
    
    Curve CreateCurveWithZ( in Table theTable, in long theHRow, in long theVRow, in long theZRow );

    Container CreateContainer();

    Animation CreateAnimation(in View3D theView3d);

    void DeleteResult(in Result theResult);

    void DeletePrs3d(in Prs3d thePrs3d);
  };

  interface View: Base {

    enum ViewRepresentation {
      OBJECTBROWSER,
      VIEWER,
      PYTHON,
      MESSAGES
    };

    void ShowPart (in ViewRepresentation ViewRepr, in boolean state );

    boolean IsPartShown( in ViewRepresentation ViewRepr );

    void SplitRight();

    void SplitLeft();

    void SplitBottom();

    void SplitTop();

    void OnTop();

    void Attract (in View theView);

    void AttractAll (in View theView);

    void SetRelativePositionInSplitter (in double thePosition);

    void SetRelativeSizeInSplitter (in double theSize);

    void SetRelativePositionX (in double thePosition);

    void SetRelativePositionY (in double thePosition);

    void SetRelativeSizeX (in double theSize);

    void SetRelativeSizeY (in double theSize);

    void SetViewWidth (in long Width); //setting width of view
    void SetViewHeight (in long Height); //setting height of view
    long GetViewWidth(); //getting view width
    long GetViewHeight(); //getting view height
    enum ViewPosition {TOP, CENTER, BOTTOM, RIGHT, LEFT}; //position of the study frame
    void SetViewPositionHorizontal (in ViewPosition ViewPosHor); //setting of the horizontal view position
    void SetViewPositionVertical (in ViewPosition ViewPosVer); //setting of the vertical view position
    void SetRelativePosition( in double x, in double y );
    void SetRelativeSize( in double x, in double y );
    void Minimize(); // Minimizes to the task bar or to the bottom of the Desktop the %View frame.
    void Restore(); // Restores the %View frame.
    void Maximize(); // Maximizes the %View frame.

    void SetTitle(in string theTitle);

    string GetTitle();

    void SetBackground(in SALOMEDS::Color theColor);

    SALOMEDS::Color GetBackground();

    void EraseAll();

    void DisplayAll();

    void Erase(in PrsObject thePrsObj);

    void Display(in PrsObject thePrsObj);

    void DisplayOnly(in PrsObject thePrsObj);

    void Update();

    boolean SavePicture(in string theFileName);
  };

  //-------------------------------------------------------
  interface View3D : View {
    enum ViewType{ FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM};

    enum Axis{ XAxis, YAxis, ZAxis};

    typedef double XYZ[3];

    void FitAll();

    void SetView(in ViewType theType);

    void SetPointOfView(in XYZ theCoord);

    XYZ GetPointOfView();

    void SetViewUp(in XYZ theDir);

    XYZ GetViewUp();

    void SetFocalPoint(in XYZ theDir);

    XYZ GetFocalPoint();

    void SetParallelScale(in double theScale);

    double GetParallelScale();

    void ScaleView(in Axis theAxis, in double theParam);

    void RemoveScale();

    boolean SaveViewParams(in string theName);

    boolean RestoreViewParams(in string theName);


    PresentationType GetPresentationType(in ScalarMap thePrs);

    string SetPresentationType(in ScalarMap thePrs, in PresentationType thePrsType);

    boolean IsShrinked(in ScalarMap thePrs);

    string SetShrinked(in ScalarMap thePrs, in boolean isShrinked);

    boolean IsShaded(in ScalarMap thePrs);

    string SetShaded(in ScalarMap thePrs, in boolean isShaded);

    double GetOpacity(in ScalarMap thePrs);

    string SetOpacity(in ScalarMap thePrs, in double theOpacity);

    double GetLineWidth(in ScalarMap thePrs);

    string SetLineWidth(in ScalarMap thePrs, in double theLineWidth);
  };

  //-------------------------------------------------------
  interface TableView : View {
  };

  //-------------------------------------------------------
  interface XYPlot : View {
    void SetSubTitle(in string theTitle);

    string GetSubTitle();

    enum CurveType { POINTS, MULTYLINE, SPLINE};

    void SetCurveType(in CurveType theType);

    CurveType GetCurveType();

    void SetMarkerSize(in long theSize);

    long GetMarkerSize();

    void EnableXGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);

    void EnableYGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);

    void SetHorScaling(in Scaling theScaling);

    Scaling GetHorScaling();

    void SetVerScaling(in Scaling theScaling);

    Scaling GetVerScaling();

    void SetXTitle(in string theTitle);

    string GetXTitle();

    void SetYTitle(in string theTitle);

    string GetYTitle();

    void ShowLegend(in boolean theShowing);

    void FitAll();

    void FitXRange(in double xMin, in double xMax);

    void FitYRange(in double yMin, in double yMax);

    void FitRange(in double xMin, in double xMax,
            in double yMin, in double yMax);

    void GetFitRanges(out double xMin,out double xMax,
                out double yMin,out double yMax);
  };

  //-------------------------------------------------------
  interface ViewManager: Base {
    View GetCurrentView();

    View3D Create3DView();

    TableView CreateTableView(in Table theTable);

    XYPlot CreateXYPlot();

    void Destroy(in View theView);
  };
};

#endif

Generated on Tue Sep 19 10:03:23 2006 for SALOME - VISU - v.3.2.2 by  1.4.6