00001 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-00002 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-00003 // 
-00004 //  This library is free software; you can redistribute it and/or 
-00005 //  modify it under the terms of the GNU Lesser General Public 
-00006 //  License as published by the Free Software Foundation; either 
-00007 //  version 2.1 of the License. 
-00008 // 
-00009 //  This library is distributed in the hope that it will be useful, 
-00010 //  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-00011 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-00012 //  Lesser General Public License for more details. 
-00013 // 
-00014 //  You should have received a copy of the GNU Lesser General Public 
-00015 //  License along with this library; if not, write to the Free Software 
-00016 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-00017 // 
-00018 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
-00019 //
-00020 //  File   : VISU_Gen.idl
-00021 //  Author : Alexey Petrov
-00022 
-00029 #ifndef __VISU_GEN__
-00030 #define __VISU_GEN__
-00031 
-00032 #include "SALOME_Exception.idl"
-00033 #include "SALOME_GenericObj.idl"
-00034 #include "SALOME_Component.idl"
-00035 #include "SALOMEDS.idl"
-00036 #include "SALOMEDS_Attributes.idl"
-00037 #include "MED.idl"
-00038 
-00042 module VISU {
-00043   //-------------------------------------------------------
-00044   typedef string IdType;
-00045 
-00050   enum Scaling{ LINEAR, 
-00051           LOGARITHMIC 
-00052            };
-00053 
-00058   enum Entity{ NODE, 
-00059                EDGE, 
-00060             FACE, 
-00061             CELL  
-00062             };
-00063 
-00068   enum VISUType {
-00069     TNONE, 
-00070     TCURVE, 
-00071     TTABLE, 
-00072     TCONTAINER, 
-00073     TMESH, 
-00074     TSCALARMAP, 
-00075     TISOSURFACE, 
-00076     TDEFORMEDSHAPE, 
-00077     TSCALARMAPONDEFORMEDSHAPE, 
-00078     TGAUSSPOINTS, 
-00079     TPLOT3D, 
-00080     TCUTPLANES, 
-00081     TCUTLINES, 
-00082     TVECTORS, 
-00083     TSTREAMLINES, 
-00084     TVISUGEN, 
-00085     TVIEWMANAGER, 
-00086     TRESULT, 
-00087     TXYPLOT, 
-00088     TTABLEVIEW, 
-00089     TVIEW3D, 
-00090     TGAUSSVIEW, 
-00091     TENTITY, 
-00092     TFAMILY, 
-00093     TGROUP, 
-00094     TFIELD, 
-00095     TTIMESTAMP, 
-00096     TANIMATION, 
-00097     TALL
-00098   };
-00099 
-00100   interface Base {
-00104     IdType GetID();
-00105 
-00109     VISUType GetType();
-00110   };
-00111 
-00117   interface RemovableObject : Base {
-00121     void RemoveFromStudy();
-00122   };
-00123 
-00128   interface PrsObject : RemovableObject {
-00129   };
-00130 
-00131   //-------------------------------------------------------
-00136   interface Table : PrsObject {
-00141     void SetTitle(in string theTitle);
-00142 
-00147     string GetTitle();
-00148 
-00152     enum Orientation {
-00153       HORIZONTAL, 
-00154       VERTIACAL   
-00155     };
-00156 
-00162     void SetOrientation(in Orientation theOrientation);
-00163 
-00169     Orientation GetOrientation();
-00170 
-00175     long GetNbRows();
-00176 
-00181     long GetNbColumns();
-00182   };
-00183 
-00184   //-------------------------------------------------------
-00190   interface Curve : PrsObject {
-00195     void SetTitle(in string theTitle);
-00196 
-00201     string GetTitle();
-00202 
-00208     void SetColor(in SALOMEDS::Color theColor);
-00209 
-00215     SALOMEDS::Color GetColor();
-00216 
-00222     enum MarkerType { NONE,
-00223                 CIRCLE,
-00224                 RECTANGLE,
-00225                 DIAMOND,
-00226                 DTRIANGLE,
-00227                 UTRIANGLE,
-00228                 LTRIANGLE,
-00229                 RTRIANGLE,
-00230                 CROSS,
-00231                 XCROSS
-00232     };
-00233 
-00241     void SetMarker(in MarkerType theType);
-00242 
-00250     MarkerType GetMarker();
-00251 
-00256     enum LineType{ VOIDLINE, SOLIDLINE, DASHLINE, DOTLINE, DASHDOTLINE, DASHDOTDOTLINE};
-00257 
-00263     void SetLine(in LineType theType, in long theLineWidth);
-00264 
-00269     LineType GetLine();
-00270 
-00275     long GetLineWidth();
-00276   };
-00277 
-00278   //-------------------------------------------------------
-00284   interface Container : PrsObject {
-00289     void AddCurve(in Curve theCurve);
-00290 
-00295     void RemoveCurve(in Curve theCurve);
-00296 
-00301     long GetNbCurves();
-00302 
-00306     void Clear();
-00307   };
-00308 
-00309   //-------------------------------------------------------
-00314   interface Prs3d : PrsObject, SALOME::GenericObj {
-00315     //interface Prs3d : PrsObject{
-00316     void SetOffset(in float theDx, in float theDy, in float theDz);
-00317     void GetOffset(out float theDx, out float theDy, out float theDz);
-00318   };
-00319 
-00324   enum PresentationType{ POINT,
-00325                 WIREFRAME,
-00326                 SHADED,
-00327                 INSIDEFRAME,
-00328                 SURFACEFRAME,
-00329                 SHRINK
-00330   };
-00331 
-00337   interface Mesh : Prs3d {
-00342     void SetCellColor(in SALOMEDS::Color theColor);
-00343 
-00347     SALOMEDS::Color GetCellColor();
-00348 
-00353     void SetNodeColor(in SALOMEDS::Color theColor);
-00354 
-00358     SALOMEDS::Color GetNodeColor();
-00359 
-00364     void SetLinkColor(in SALOMEDS::Color theColor);
-00365 
-00369     SALOMEDS::Color GetLinkColor();
-00370 
-00376     void SetPresentationType(in PresentationType theType);
-00377 
-00382     PresentationType GetPresentationType();
-00383   };
-00384 
-00385 
-00386   //-------------------------------------------------------
-00395   interface ColoredPrs3d : Prs3d {
-00398     void SetScalarMode(in long theScalarMode);
-00399 
-00402     long GetScalarMode();
-00403 
-00407     double GetMin();
-00408 
-00412     double GetMax();
-00413 
-00420     void SetPosition(in double X, in double Y);
-00421 
-00425     double GetPosX();
-00426 
-00430     double GetPosY();
-00431 
-00438     void SetSize(in double theWidth, in double theHeight);
-00439 
-00444     double GetWidth();
-00445 
-00450     double GetHeight();
-00451 
-00456     void SetNbColors(in long theNbColors);
-00457 
-00463     long GetNbColors();
-00464 
-00470     void SetLabels(in long theNbLabels);
-00471 
-00477     long GetLabels();
-00478 
-00483     void SetTitle(in string theName);
-00484 
-00488     string GetTitle();
-00489   };
-00490 
-00491 
-00492   //-------------------------------------------------------
-00501   interface ScalarMap : ColoredPrs3d {
-00506     void SetScaling(in Scaling theScaling);
-00507 
-00511     Scaling GetScaling();
-00512 
-00518     void SetRange(in double theMin, in double theMax);
-00519 
-00521     enum Orientation {
-00522       HORIZONTAL, 
-00523       VERTICAL    
-00524     };
-00525 
-00531     void SetBarOrientation(in Orientation theOrientation);
-00532 
-00536     Orientation GetBarOrientation();
-00537   };
-00538 
-00539   //-------------------------------------------------------
-00544   //-------------------------------------------------------
-00545   interface GaussPoints : ColoredPrs3d {
-00546   };
-00547 
-00552   interface DeformedShape : ScalarMap {
-00557     void SetScale(in double theScale);
-00558 
-00562     double GetScale();
-00563 
-00566     boolean IsColored();
-00567 
-00572     void ShowColored(in boolean theColored);
-00573 
-00577     SALOMEDS::Color GetColor();
-00578 
-00583     void SetColor(in SALOMEDS::Color theColor);
-00584   };
-00585 
-00586   //-------------------------------------------------------
-00591   interface ScalarMapOnDeformedShape : ScalarMap {
-00592     
-00596     void SetSourceRange(in double theMinRange,in double theMaxRange);
-00600     double GetSourceRangeMin();
-00604     double GetSourceRangeMax();
-00605     
-00610     void SetScale(in double theScale);
-00611 
-00615     double GetScale();
-00616 
-00624     void SetScalarField(in string theMeshName,in string theFieldName,
-00625                in long theIteration,in Entity theEntity);
-00626 
-00627   };
-00628   //-------------------------------------------------------
-00636   interface Plot3D : ScalarMap {
-00641     enum Orientation { XY,   
-00642                  YZ,   
-00643                  ZX }; 
-00654     void SetOrientation (in Orientation theOrientation, in double theXAngle, in double theYAngle);
-00655 
-00659     Orientation GetOrientationType();
-00660 
-00665     double GetRotateX();
-00666 
-00671     double GetRotateY();
-00672 
-00678     void SetPlanePosition (in double  thePlanePosition,
-00679                   in boolean theIsRelative);
-00680 
-00684     double GetPlanePosition();
-00685 
-00689     boolean IsPositionRelative();
-00690 
-00696     void SetScaleFactor (in double theScaleFactor);
-00697 
-00702     double GetScaleFactor();
-00703 
-00708     void SetContourPrs (in boolean theIsContourPrs );
-00709 
-00713     boolean GetIsContourPrs();
-00714 
-00719     void SetNbOfContours (in long theNb);
-00720 
-00724     long GetNbOfContours();
-00725   };
-00726 
-00727   //-------------------------------------------------------
-00734   interface CutPlanes : ScalarMap {
-00739     enum Orientation {XY, 
-00740                       YZ, 
-00741                 ZX}; 
-00752     void SetOrientation(in Orientation theOrientation, in double theXAngle, in double theYAngle);
-00753 
-00757     Orientation GetOrientationType();
-00758 
-00762     double GetRotateX();
-00763 
-00767     double GetRotateY();
-00768 
-00778     void SetDisplacement(in double theDisp);
-00779 
-00783     double GetDisplacement();
-00784 
-00790      void SetPlanePosition(in long thePlaneNumber, in double thePlanePosition);
-00791 
-00796      void SetDefault(in long thePlaneNumber);
-00797 
-00801     double GetPlanePosition(in long thePlaneNumber);
-00802 
-00807     boolean IsDefault(in long thePlaneNumber);
-00808 
-00813     void SetNbPlanes(in long theNb);
-00814 
-00818     long GetNbPlanes();
-00819   };
-00820 
-00821   //-------------------------------------------------------
-00836   interface CutLines : ScalarMap {
-00845     void SetOrientation(in CutPlanes::Orientation theOrientation, in double theXAngle, in double theYAngle);
-00846 
-00856     void SetOrientation2(in CutPlanes::Orientation theOrientation, in double theXAngle, in double theYAngle);
-00857 
-00861     CutPlanes::Orientation GetOrientationType();
-00862 
-00866     CutPlanes::Orientation GetOrientationType2();
-00867 
-00871     double GetRotateX();
-00872 
-00876     double GetRotateX2();
-00877 
-00881     double GetRotateY();
-00882 
-00886     double GetRotateY2();
-00887 
-00894     void SetDisplacement(in double theDisp);
-00895 
-00902     void SetDisplacement2(in double theDisp);
-00903 
-00907     double GetDisplacement();
-00908 
-00912     double GetDisplacement2();
-00913 
-00917     void SetBasePlanePosition(in double thePlanePosition);
-00918 
-00921     double GetBasePlanePosition();
-00922 
-00927     void SetLinePosition(in long thePlaneNumber, in double thePlanePosition);
-00928 
-00932     double GetLinePosition(in long thePlaneNumber);
-00933 
-00936     void SetDefault();
-00937 
-00942     boolean IsDefault();
-00943 
-00948     void SetDefaultPosition(in long thePlaneNumber);
-00949 
-00955     boolean IsDefaultPosition(in long thePlaneNumber);
-00956 
-00961     void SetNbLines(in long theNb);
-00962 
-00966     long GetNbLines();
-00967 
-00971     void SetAllCurvesInverted(in boolean theInvert);
-00972 
-00976     boolean IsAllCurvesInverted();
-00977 
-00981     void SetUseAbsoluteLength(in boolean theAbsLength);
-00982 
-00985     boolean IsUseAbsoluteLength();
-00986   };
-00987 
-00997   interface StreamLines : DeformedShape {
-01001     enum Direction{ FORWARD,
-01002               BACKWARD,
-01003               BOTH
-01004     };
-01005 
-01026     boolean SetParams(in double theIntStep,
-01027                 in double thePropogationTime,
-01028                 in double theStepLength,
-01029                 in Prs3d thePrs3d,
-01030                 in double thePercents,
-01031                 in Direction theDirection);
-01032 
-01035     double GetIntegrationStep();
-01036 
-01039     double GetPropagationTime();
-01040 
-01043     double GetStepLength();
-01044 
-01047     Prs3d GetSource();
-01048 
-01052     double GetUsedPoints();
-01053 
-01056     Direction GetDirection();
-01057   };
-01058 
-01067   interface IsoSurfaces : ScalarMap {
-01073     void SetNbSurfaces(in long theNb);
-01074 
-01078     long GetNbSurfaces();
-01079   };
-01080 
-01081   //-------------------------------------------------------
-01086   interface Vectors : DeformedShape {
-01091     void SetLineWidth(in double theWidth);
-01092 
-01096     double GetLineWidth();
-01097 
-01101     enum GlyphType{ ARROW,
-01102                     CONE2,
-01103                     CONE6,
-01104                     NONE
-01105                   };
-01106 
-01112     void SetGlyphType(in GlyphType theType);
-01113 
-01117     GlyphType GetGlyphType();
-01118 
-01122     enum GlyphPos{ CENTER, 
-01123                    TAIL,   
-01124                    HEAD  
-01125                  };
-01126 
-01132     void SetGlyphPos(in GlyphPos thePos);
-01133 
-01137     GlyphPos GetGlyphPos();
-01138   };
-01139 
-01140   //-------------------------------------------------------
-01155   interface Animation : Base {
-01159     enum AnimationMode{ PARALLEL, 
-01160                SUCCCESSIVE 
-01161     };
-01162     
-01166     boolean addField(in SALOMEDS::SObject theObject);
-01167 
-01170     void clearFields();
-01171 
-01176     void generatePresentations(in long theFieldNum);
-01177 
-01183     boolean generateFrames();
-01184 
-01187     void clearView();
-01188 
-01192 
-01195     void startAnimation();
-01196 
-01199     void stopAnimation();
-01200 
-01203     void nextFrame();
-01204 
-01207     void prevFrame();
-01208 
-01211     void firstFrame();
-01212 
-01215     void lastFrame();
-01216 
-01220     void gotoFrame(in long theFrame);
-01225     long getNbFields();
-01226 
-01229     long getNbFrames();
-01230 
-01233     boolean isRunning();
-01234 
-01237     long getCurrentFrame();
-01238 
-01241     ColoredPrs3d getPresentation(in long theField, in long theFrame);
-01242 
-01246     void setPresentationType(in long theFieldNum, in VISUType theType);
-01247 
-01251     VISUType getPresentationType(in long theFieldNum);
-01252 
-01256     void setSpeed(in long theSpeed);
-01257 
-01260     long getSpeed();
-01261 
-01266     boolean isProportional();
-01267 
-01276     void setAnimationRange(in double theMin, in double theMax);
-01277 
-01280     double getMinRange();
-01281 
-01284     double getMaxRange();
-01285 
-01290     boolean isRangeDefined();
-01291 
-01296     void dumpTo(in string thePath);
-01297 
-01305     string setDumpFormat(in string theFormat);
-01306 
-01309     boolean isCycling();
-01310 
-01314     double getMinTime();
-01315 
-01319     double getMaxTime();
-01320 
-01326     void setProportional(in boolean theProp);
-01327 
-01333     void setCycling(in boolean theCycle);
-01334 
-01335     boolean isCleaningMemoryAtEachFrame();
-01336     void setCleaningMemoryAtEachFrame(in boolean theCycle);
-01337 
-01338     SALOMEDS::SObject publishInStudy();
-01339 
-01340     void saveAnimation();
-01341 
-01342     void restoreFromStudy(in SALOMEDS::SObject theSObj);
-01343 
-01344     boolean isSavedInStudy();
-01345     
-01350     void setAnimationMode(in AnimationMode theMode);
-01351 
-01355     AnimationMode getAnimationMode();
-01356 
-01366     void ApplyProperties(in long theFieldNum, in ColoredPrs3d thePrs);
-01367   };
-01368 
-01375   interface Result : RemovableObject, SALOME::GenericObj {
-01378     boolean BuildAll();
-01379 
-01381     boolean Build(in boolean theIsBuildAll, in boolean theIsAtOnce);
-01382 
-01384     boolean IsDone();
-01385 
-01387     boolean IsEntitiesDone();
-01388 
-01390     void SetBuildFields(in boolean theIsBuildFields, in boolean theIsCalculateMinMax);
-01391 
-01393     boolean IsFieldsDone();
-01394 
-01396     void SetBuildGroups(in boolean theIsBuildGroups);
-01397 
-01399     boolean IsGroupsDone();
-01400 
-01402     boolean IsMinMaxDone();
-01403   };
-01404 
-01405   //-------------------------------------------------------
-01406   interface ViewManager;
-01407   interface View3D;
-01408 
-01415   interface VISU_Gen : Engines::Component, SALOMEDS::Driver, Base {
-01418     void SetCurrentStudy(in SALOMEDS::Study theStudy);
-01419 
-01422     SALOMEDS::Study GetCurrentStudy();
-01423 
-01428     ViewManager GetViewManager();
-01429 
-01433     SALOMEDS::SObject ImportTables(in string theFileName);
-01434 
-01438     boolean ExportTableToFile(in SALOMEDS::SObject theTable, in string theFileName);
-01439 
-01445     Result ImportFile(in string theFileName);
-01446 
-01452     Result CreateResult(in string theFileName);
-01453 
-01459     Result CopyAndImportFile(in string theFileName);
-01460 
-01464     Result ImportMed(in SALOMEDS::SObject theMedSObject);
-01465 
-01469     Result ImportMedField(in SALOME_MED::FIELD theField);
-01470 
-01479     void RenameEntityInStudy(in Result theResult,
-01480                     in string theMeshName,
-01481                     in Entity theEntity,
-01482                     in string theNewName);
-01483     void RenameFamilyInStudy(in Result theResult,
-01484                     in string theMeshName,
-01485                     in Entity theEntity,
-01486                     in string theSubMeshName,
-01487                     in string theNewName);
-01488     void RenameGroupInStudy(in Result theResult,
-01489                    in string theMeshName,
-01490                    in string theSubMeshName,
-01491                    in string theNewName);
-01492 
-01499     Mesh MeshOnEntity(in Result theResult, in string theMeshName, in Entity theEntity);
-01500 
-01508     Mesh FamilyMeshOnEntity(in Result theResult, in string theMeshName,
-01509                    in Entity theEntity, in string theFamilyName);
-01510 
-01517     Mesh GroupMesh(in Result theResult, in string theMeshName, in string theGroupName);
-01518 
-01527     ScalarMap ScalarMapOnField(in Result theResult, in string theMeshName,
-01528                       in Entity theEntity, in string theFieldName,
-01529                       in double theIteration);
-01530 
-01539     GaussPoints GaussPointsOnField(in Result theResult, in string theMeshName,
-01540                        in Entity theEntity, in string theFieldName,
-01541                        in double theIteration);
-01542 
-01551     DeformedShape DeformedShapeOnField(in Result theResult, in string theMeshName,
-01552                            in Entity theEntity, in string theFieldName,
-01553                            in double theIteration);
-01554 
-01563     ScalarMapOnDeformedShape ScalarMapOnDeformedShapeOnField(in Result theResult, in string theMeshName,
-01564                                         in Entity theEntity, in string theFieldName,
-01565                                         in double theIteration);
-01566 
-01575     Vectors VectorsOnField(in Result theResult, in string theMeshName,
-01576                   in Entity theEntity, in string theFieldName,
-01577                   in double theIteration);
-01578 
-01587     IsoSurfaces IsoSurfacesOnField(in Result theResult, in string theMeshName,
-01588                        in Entity theEntity, in string theFieldName,
-01589                        in double theIteration);
-01590 
-01599     StreamLines StreamLinesOnField(in Result theResult, in string theMeshName,
-01600                        in Entity theEntity, in string theFieldName,
-01601                        in double theIteration);
-01602 
-01611     CutPlanes CutPlanesOnField(in Result theResult, in string theMeshName,
-01612                       in Entity theEntity, in string theFieldName,
-01613                       in double theIteration);
-01614 
-01623     CutLines CutLinesOnField(in Result theResult, in string theMeshName,
-01624                     in Entity theEntity, in string theFieldName,
-01625                     in double theIteration);
-01626 
-01635     Plot3D Plot3DOnField(in Result theResult, in string theMeshName,
-01636                 in Entity theEntity, in string theFieldName,
-01637                 in double theIteration);
-01638 
-01643     Table CreateTable(in string theTableEntry);
-01644 
-01651     Curve CreateCurve(in Table theTable, in long theHRow, in long theVRow);
-01652     
-01661     Curve CreateCurveWithZ( in Table theTable, in long theHRow, in long theVRow, in long theZRow );
-01662 
-01666     Container CreateContainer();
-01667 
-01671     Animation CreateAnimation(in View3D theView3d);
-01672 
-01673     void DeleteResult(in Result theResult);
-01674 
-01675     void DeletePrs3d(in Prs3d thePrs3d);
-01676   };
-01677 
-01684   interface View: Base {
-01685 
-01690     enum ViewRepresentation {
-01691       OBJECTBROWSER,
-01692       VIEWER,
-01693       PYTHON,
-01694       MESSAGES
-01695     };
-01696 
-01697     void ShowPart (in ViewRepresentation ViewRepr, in boolean state );
-01698 
-01699     boolean IsPartShown( in ViewRepresentation ViewRepr );
-01700 
-01710     void SplitRight();
-01711 
-01717     void SplitLeft();
-01718 
-01724     void SplitBottom();
-01725 
-01731     void SplitTop();
-01732 
-01736     void OnTop();
-01737 
-01744     void Attract (in View theView);
-01745 
-01752     void AttractAll (in View theView);
-01753 
-01761     void SetRelativePositionInSplitter (in double thePosition);
-01762 
-01770     void SetRelativeSizeInSplitter (in double theSize);
-01771 
-01777     void SetRelativePositionX (in double thePosition);
-01778 
-01784     void SetRelativePositionY (in double thePosition);
-01785 
-01791     void SetRelativeSizeX (in double theSize);
-01792 
-01798     void SetRelativeSizeY (in double theSize);
-01799 
-01803     void SetViewWidth (in long Width); //setting width of view
-01804     void SetViewHeight (in long Height); //setting height of view
-01805     long GetViewWidth(); //getting view width
-01806     long GetViewHeight(); //getting view height
-01807     enum ViewPosition {TOP, CENTER, BOTTOM, RIGHT, LEFT}; //position of the study frame
-01808     void SetViewPositionHorizontal (in ViewPosition ViewPosHor); //setting of the horizontal view position
-01809     void SetViewPositionVertical (in ViewPosition ViewPosVer); //setting of the vertical view position
-01810     void SetRelativePosition( in double x, in double y );
-01811     void SetRelativeSize( in double x, in double y );
-01812     void Minimize(); // Minimizes to the task bar or to the bottom of the Desktop the %View frame.
-01813     void Restore(); // Restores the %View frame.
-01814     void Maximize(); // Maximizes the %View frame.
-01815 
-01820     void SetTitle(in string theTitle);
-01821 
-01825     string GetTitle();
-01826 
-01831     void SetBackground(in SALOMEDS::Color theColor);
-01832 
-01836     SALOMEDS::Color GetBackground();
-01837 
-01841     void EraseAll();
-01842 
-01846     void DisplayAll();
-01847 
-01852     void Erase(in PrsObject thePrsObj);
-01853 
-01858     void Display(in PrsObject thePrsObj);
-01859 
-01865     void DisplayOnly(in PrsObject thePrsObj);
-01866 
-01870     void Update();
-01871 
-01877     boolean SavePicture(in string theFileName);
-01878   };
-01879 
-01880   //-------------------------------------------------------
-01885   interface View3D : View {
-01890     enum ViewType{ FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM};
-01891 
-01895     enum Axis{ XAxis, YAxis, ZAxis};
-01896 
-01900     typedef double XYZ[3];
-01901 
-01905     void FitAll();
-01906 
-01911     void SetView(in ViewType theType);
-01912 
-01918     void SetPointOfView(in XYZ theCoord);
-01919 
-01925     XYZ GetPointOfView();
-01926 
-01930     void SetViewUp(in XYZ theDir);
-01931 
-01935     XYZ GetViewUp();
-01936 
-01941     void SetFocalPoint(in XYZ theDir);
-01942 
-01947     XYZ GetFocalPoint();
-01948 
-01952     void SetParallelScale(in double theScale);
-01953 
-01957     double GetParallelScale();
-01958 
-01964     void ScaleView(in Axis theAxis, in double theParam);
-01965 
-01969     void RemoveScale();
-01970 
-01976     boolean SaveViewParams(in string theName);
-01977 
-01983     boolean RestoreViewParams(in string theName);
-01984 
-01985 
-01990     PresentationType GetPresentationType(in ScalarMap thePrs);
-01991 
-01997     string SetPresentationType(in ScalarMap thePrs, in PresentationType thePrsType);
-01998 
-02003     boolean IsShrinked(in ScalarMap thePrs);
-02004 
-02010     string SetShrinked(in ScalarMap thePrs, in boolean isShrinked);
-02011 
-02016     boolean IsShaded(in ScalarMap thePrs);
-02017 
-02023     string SetShaded(in ScalarMap thePrs, in boolean isShaded);
-02024 
-02029     double GetOpacity(in ScalarMap thePrs);
-02030 
-02036     string SetOpacity(in ScalarMap thePrs, in double theOpacity);
-02037 
-02042     double GetLineWidth(in ScalarMap thePrs);
-02043 
-02049     string SetLineWidth(in ScalarMap thePrs, in double theLineWidth);
-02050   };
-02051 
-02052   //-------------------------------------------------------
-02057   interface TableView : View {
-02058   };
-02059 
-02060   //-------------------------------------------------------
-02066   interface XYPlot : View {
-02070     void SetSubTitle(in string theTitle);
-02071 
-02074     string GetSubTitle();
-02075 
-02080     enum CurveType { POINTS, MULTYLINE, SPLINE};
-02081 
-02085     void SetCurveType(in CurveType theType);
-02086 
-02089     CurveType GetCurveType();
-02090 
-02095     void SetMarkerSize(in long theSize);
-02096 
-02100     long GetMarkerSize();
-02101 
-02104     void EnableXGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
-02105 
-02108     void EnableYGrid(in boolean theMajor, in long theNumMajor, in boolean theMinor, in long theNumMinor);
-02109 
-02113     void SetHorScaling(in Scaling theScaling);
-02114 
-02117     Scaling GetHorScaling();
-02118 
-02122     void SetVerScaling(in Scaling theScaling);
-02123 
-02126     Scaling GetVerScaling();
-02127 
-02131     void SetXTitle(in string theTitle);
-02132 
-02135     string GetXTitle();
-02136 
-02140     void SetYTitle(in string theTitle);
-02141 
-02144     string GetYTitle();
-02145 
-02148     void ShowLegend(in boolean theShowing);
-02149 
-02152     void FitAll();
-02153 
-02156     void FitXRange(in double xMin, in double xMax);
-02157 
-02160     void FitYRange(in double yMin, in double yMax);
-02161 
-02164     void FitRange(in double xMin, in double xMax,
-02165             in double yMin, in double yMax);
-02166 
-02167     void GetFitRanges(out double xMin,out double xMax,
-02168                 out double yMin,out double yMax);
-02169   };
-02170 
-02171   //-------------------------------------------------------
-02176   interface ViewManager: Base {
-02183     View GetCurrentView();
-02184 
-02189     View3D Create3DView();
-02190 
-02195     TableView CreateTableView(in Table theTable);
-02196 
-02201     XYPlot CreateXYPlot();
-02202 
-02206     void Destroy(in View theView);
-02207   };
-02208 };
-02209 
-02210 #endif
-

idl/VISU_Gen.idl File Reference

@@ -55,6 +53,16 @@ Include dependency graph for VISU_Gen.idl:

interface + + + + + + + + + + @@ -110,7 +118,9 @@ Include dependency graph for VISU_Gen.idl:

- + + + @@ -178,6 +191,6 @@ Include dependency graph for VISU_Gen.idl:

Detailed Description

This file conatins a set of interfaces of the VISU module. This module provides various forms of data visualization in SALOME application. These forms include data tables, XY plots, 3d representations and combination of these forms. +Generated on Thu Jun 21 14:30:37 2007 for SALOME - VISU - v.4.0.0 by

1.4.7 diff --git a/doc/salome/gui/VISU/visugenidl_doc/VISU__Gen_8idl__incl.jpg b/doc/salome/gui/VISU/visugenidl_doc/VISU__Gen_8idl__incl.jpg index 7d8a72ac..b39f3e1a 100644 Binary files a/doc/salome/gui/VISU/visugenidl_doc/VISU__Gen_8idl__incl.jpg and b/doc/salome/gui/VISU/visugenidl_doc/VISU__Gen_8idl__incl.jpg differ diff --git a/doc/salome/gui/VISU/visugenidl_doc/interfaceVISU_1_1Animation.html b/doc/salome/gui/VISU/visugenidl_doc/interfaceVISU_1_1Animation.html index 1f16a54a..4e0aa360 100644 --- a/doc/salome/gui/VISU/visugenidl_doc/interfaceVISU_1_1Animation.html +++ b/doc/salome/gui/VISU/visugenidl_doc/interfaceVISU_1_1Animation.html @@ -11,21 +11,25 @@ - +

VISU.Animation

VISU.Animation Interface Reference

Animation class More...

-import "VISU_Gen.idl"; +import "VISU_Gen.idl";

Inheritance diagram for VISU.Animation:

- +


Namespaces
namespace	VISU
VISU.ColoredPrs3d
	Basic Interface for the Colored 3D Presentations. More...
interface	VISU.ColoredPrs3dHolder
	ColoredPrs3dHolder interface. Interface of 3d presentation's holder, which represents colored 3d presentations, created on fields. It is publishing in the object browser in a separate folder and can be controled by viewer's slider. More...
struct	VISU.ColoredPrs3dHolder.BasicInput
struct	VISU.ColoredPrs3dHolder.TimeStampInfo
interface	VISU.ColoredPrs3dCache
	ColoredPrs3dCache interface. This interface is responsible for memory management of 3d presentations. One cache corresponds to one study. More...
interface	VISU.ScalarMap
	Interface of the Scalar Map. More...
Interface of the ViewManager. More...
Typedefs
typedef string	VISU.IdType
typedef string	VISU.IdType
typedef sequence< string >	VISU.string_array
Enumerations
enum	VISU.Scaling { VISU.LINEAR, @@ -131,7 +141,7 @@ Include dependency graph for VISU_Gen.idl: VISU.TMESH, VISU.TSCALARMAP, -VISU.TISOSURFACE, +VISU.TISOSURFACES, VISU.TDEFORMEDSHAPE, VISU.TSCALARMAPONDEFORMEDSHAPE, @@ -159,7 +169,10 @@ Include dependency graph for VISU_Gen.idl: VISU.TTIMESTAMP, VISU.TANIMATION, - VISU.TALL + VISU.TCOLOREDPRS3DHOLDER, +VISU.TCOLOREDPRS3DCACHE, +VISU.TPART, +VISU.TALL }

+ + + + @@ -69,9 +73,9 @@ Inheritance diagram for VISU.Animation:

boolean - + - + @@ -137,24 +141,16 @@ playing these animations in the VISU module.

Member Enumeration Documentation


Public Types
	PARALLEL
	SUCCCESSIVE
enum	AnimationMode { PARALLEL, SUCCCESSIVE }
isRangeDefined ()
void	dumpTo (in string thePath)
void	dumpTo (in string thePath)
string	setDumpFormat (in string theFormat)
string	setDumpFormat (in string theFormat)
boolean	isCycling ()

- - - -

- + +

- +

enum VISU::Animation::AnimationMode enum VISU::Animation::AnimationMode

- - - - succcessive mode of animation.

- -	+ + This enumeration contains a set of available animation modes. Enumerator: @@ -165,33 +161,25 @@ parallel mode of animation.

- - - + + +

Member Function Documentation

- - - - -

- + +

- - - - - - + + + + + +

boolean VISU.Animation.addField ( in SALOMEDS::SObject theObject ) boolean VISU.Animation.addField ( in SALOMEDS::SObject theObject )

- - - -

- -	+ + Defines the field which will be used as a base for generation of the animation. Parameters: @@ -199,59 +187,43 @@ Defines the field which will be used as a base for generation of the animation.
	theObject	The SObject corresponding to the field.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.Animation.clearFields ( ) void VISU.Animation.clearFields ( )

- - - - - -

- -	+ + -Remove all fields from Animation object.

- - - - -

- +Remove all fields from Animation object. + +

+ +

- - - - - - + + + + + +

void VISU.Animation.generatePresentations ( in long theFieldNum ) void VISU.Animation.generatePresentations ( in long theFieldNum )

- - - -

- -	+ + Generates presentations on the basis of the field. Parameters: @@ -259,249 +231,177 @@ Generates presentations on the basis of the field. Parameters
	theFieldNum	The number of the field, which will be used as the basis for construction of the presentation.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

boolean VISU.Animation.generateFrames ( ) boolean VISU.Animation.generateFrames ( )

- - - - - -

- -	+ + Generates a set of frames from the created by the method generatePresentations3D presentations. A sequence of these frames will be transformed into an animation. Returns: True, if the frames have been successfully generated. -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.Animation.clearView ( ) void VISU.Animation.clearView ( )

- - - - - -

- -	+ + -Clears the view before starting an animation.

- - - - -

- +Clears the view before starting an animation. + +

+ +

- - - - - + + + + +

void VISU.Animation.startAnimation ( ) void VISU.Animation.startAnimation ( )

- - - - - -

- -	+ + -Starts an animation.

- - - - -

- +Starts an animation. + +

+ +

- - - - - + + + + +

void VISU.Animation.stopAnimation ( ) void VISU.Animation.stopAnimation ( )

- - - - - -

- -	+ + -Stops an animation.

- - - - -

- +Stops an animation. + +

+ +

- - - - - + + + + +

void VISU.Animation.nextFrame ( ) void VISU.Animation.nextFrame ( )

- - - - - -

- -	+ + -Forwards to the next frame.

- - - - -

- +Forwards to the next frame. + +

+ +

- - - - - + + + + +

void VISU.Animation.prevFrame ( ) void VISU.Animation.prevFrame ( )

- - - - - -

- -	+ + -Returns to the previous frame.

- - - - -

- +Returns to the previous frame. + +

+ +

- - - - - + + + + +

void VISU.Animation.firstFrame ( ) void VISU.Animation.firstFrame ( )

- - - - - -

- -	+ + -Returns to the first frame of the animation.

- - - - -

- +Returns to the first frame of the animation. + +

+ +

- - - - - + + + + +

void VISU.Animation.lastFrame ( ) void VISU.Animation.lastFrame ( )

- - - - - -

- -	+ + -Forwards to the last frame of the animation.

- - - - -

- +Forwards to the last frame of the animation. + +

+ +

- - - - - - + + + + + +

void VISU.Animation.gotoFrame ( in long theFrame ) void VISU.Animation.gotoFrame ( in long theFrame )

- - - -

- -	+ + Passes to a definite frame of the animation. Parameters: @@ -509,242 +409,178 @@ Passes to a definite frame of the animation. Parameters:<
	theFrame	A long value defining the number of the frame.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.Animation.getNbFields ( ) long VISU.Animation.getNbFields ( )

- - - - - -

- -	+ + -Gets the number of time stamps (subfields) contained in the given field.

- - - - -

- +Gets the number of time stamps (subfields) contained in the given field. + +

+ +

- - - - - + + + + +

long VISU.Animation.getNbFrames ( ) long VISU.Animation.getNbFrames ( )

- - - - - -

- -	+ + -Gets the number of generated frames

- - - - -

- +Gets the number of generated frames + +

+ +

- - - - - + + + + +

boolean VISU.Animation.isRunning ( ) boolean VISU.Animation.isRunning ( )

- - - - - -

- -	+ + -Returns True, if the animation is currently running.

- - - - -

- +Returns True, if the animation is currently running. + +

+ +

- - - - - + + + + +

long VISU.Animation.getCurrentFrame ( ) long VISU.Animation.getCurrentFrame ( )

- - - - - -

- -	+ + -Returns the number of the current frame.

- - - - -

- +Returns the number of the current frame. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

ColoredPrs3d VISU.Animation.getPresentation	(	in long	theField,	ColoredPrs3d VISU.Animation.getPresentation	(	in long	theField,
		in long	theFrame			in long	theFrame
	)				)

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.Animation.setPresentationType	(	in long	theFieldNum,	void VISU.Animation.setPresentationType	(	in long	theFieldNum,
		in VISUType	theType			in VISUType	theType
	)				)

- - - - - -

- -	+ + -Sets the type of presentation (vectors, deformed shape etc.) which will be generated by the method generatePresentations.

- - - - -

- +Sets the type of presentation (vectors, deformed shape etc.) which will be generated by the method generatePresentations. + +

+ +

- - - - - - + + + + + +

VISUType VISU.Animation.getPresentationType ( in long theFieldNum ) VISUType VISU.Animation.getPresentationType ( in long theFieldNum )

- - - - - -

- -	+ + -Gets the type of presentation (vectors, deformed shape etc.) which will be generated by the method generatePresentations.

- - - - -

- +Gets the type of presentation (vectors, deformed shape etc.) which will be generated by the method generatePresentations. + +

+ +

- - - - - - + + + + + +

void VISU.Animation.setSpeed ( in long theSpeed ) void VISU.Animation.setSpeed ( in long theSpeed )

- - - -

- -	+ + Sets the speed of the animation. Parameters: @@ -752,95 +588,71 @@ Sets the speed of the animation. Parameters:
	theSpeed	The speed of the animation. The value varies from 1 to 99.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.Animation.getSpeed ( ) long VISU.Animation.getSpeed ( )

- - - - - -

- -	+ + -Gets the speed of the animation.

- - - - -

- +Gets the speed of the animation. + +

+ +

- - - - - + + + + +

boolean VISU.Animation.isProportional ( ) boolean VISU.Animation.isProportional ( )

- - - - - -

- -	+ + -Ruturns True, if playback of the animation is proportional. This option allows to render your animation with proportional periods of time between every frame (not depending on the time stamps).

- - - - -

- +Ruturns True, if playback of the animation is proportional. This option allows to render your animation with proportional periods of time between every frame (not depending on the time stamps). + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.Animation.setAnimationRange	(	in double	theMin,	void VISU.Animation.setAnimationRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)				)

- - - -

- -	+ + Sets the range of the animation. The range is defined on the basis of the time stamps of the field which have been used for generation of the animation. This method allows to bound the range of generated frames. If this method is not used, the animation will be generated on the basis of all time stamps contained in the field. Parameters: @@ -849,113 +661,81 @@ Sets the range of the animation. The range is defined on the basis of the time s
	theMax	The value of the last time stamp which will be used for generation of the animation.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.Animation.getMinRange ( ) double VISU.Animation.getMinRange ( )

- - - - - -

- -	+ + -Gets the number of the first time stamp which will be used for generation of the animation.

- - - - -

- +Gets the number of the first time stamp which will be used for generation of the animation. + +

+ +

- - - - - + + + + +

double VISU.Animation.getMaxRange ( ) double VISU.Animation.getMaxRange ( )

- - - - - -

- -	+ + -Gets the number of the last time stamp which will be used for generation of the animation.

- - - - -

- +Gets the number of the last time stamp which will be used for generation of the animation. + +

+ +

- - - - - + + + + +

boolean VISU.Animation.isRangeDefined ( ) boolean VISU.Animation.isRangeDefined ( )

- - - - - -

- -	+ + -Returns True if the range of the animation has been defined by the method setAnimationRange. Otherwise the animation will be generated on the basis of all time stamps contained in the field.

- - - - -

- +Returns True if the range of the animation has been defined by the method setAnimationRange. Otherwise the animation will be generated on the basis of all time stamps contained in the field. + +

+ +

- - - - - - + + + + + +

void VISU.Animation.dumpTo ( in string thePath ) void VISU.Animation.dumpTo ( in string thePath )

- - - -

- -	+ + Saves all the frames composing the animation into a definite directory. Pictures format is set with method setDumpFormat(). Parameters: @@ -963,32 +743,24 @@ Saves all the frames composing the animation into a definite directory. Pictures
	thePath	The directory where all the frames will be saved.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

string VISU.Animation.setDumpFormat ( in string theFormat ) string VISU.Animation.setDumpFormat ( in string theFormat )

- - - - - -

- -	+ + Set format for saving all the frames composing the animation. Parameters: @@ -997,115 +769,83 @@ Set format for saving all the frames composing the animation. Returns: Really set format. Differ from theFormat if theFormat is not available. -

- - - - -

- + + +

+ +

- - - - - + + + + +

boolean VISU.Animation.isCycling ( ) boolean VISU.Animation.isCycling ( )

- - - - - -

- -	+ + -Returns True, if the playback of the animation is cycling.

- - - - -

- +Returns True, if the playback of the animation is cycling. + +

+ +

- - - - - + + + + +

double VISU.Animation.getMinTime ( ) double VISU.Animation.getMinTime ( )

- - - - - -

- -	+ + Gets the first time stamp of the field defined at the input of the animation. Note: This method is used if animation range is NOT defined. -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.Animation.getMaxTime ( ) double VISU.Animation.getMaxTime ( )

- - - - - -

- -	+ + Gets the last time stamp of the field defined at the input of the animation. Note: This method is used if animation range is NOT defined. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Animation.setProportional ( in boolean theProp ) void VISU.Animation.setProportional ( in boolean theProp )

- - - -

- -	+ + Sets proprtional playback of the animation. This option allows to render your animation with proportional periods of time between every frame (not depending on the time stamps). Parameters: @@ -1113,32 +853,24 @@ Sets proprtional playback of the animation. This option allows to render your an
	theProp	If this boolean parameter is True, playback of your animation will be set as proportional.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Animation.setCycling ( in boolean theCycle ) void VISU.Animation.setCycling ( in boolean theCycle )

- - - -

- -	+ + Sets cycling playback of the animation. The number of cycles can be infinite, untill you use startAnimation method. Parameters: @@ -1146,196 +878,140 @@ Sets cycling playback of the animation. The number of cycles can be infinite, un
	theCycle	If this boolean parameter is True, playback of your animation will be set as cycling.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

boolean VISU.Animation.isCleaningMemoryAtEachFrame ( ) boolean VISU.Animation.isCleaningMemoryAtEachFrame ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Animation.setCleaningMemoryAtEachFrame ( in boolean theCycle ) void VISU.Animation.setCleaningMemoryAtEachFrame ( in boolean theCycle )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::SObject VISU.Animation.publishInStudy ( ) SALOMEDS::SObject VISU.Animation.publishInStudy ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.Animation.saveAnimation ( ) void VISU.Animation.saveAnimation ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Animation.restoreFromStudy ( in SALOMEDS::SObject theSObj ) void VISU.Animation.restoreFromStudy ( in SALOMEDS::SObject theSObj )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

boolean VISU.Animation.isSavedInStudy ( ) boolean VISU.Animation.isSavedInStudy ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Animation.setAnimationMode ( in AnimationMode theMode ) void VISU.Animation.setAnimationMode ( in AnimationMode theMode )

- - - -

- -	+ + Sets the animation mode. Parameters: @@ -1343,129 +1019,97 @@ Sets the animation mode. Parameters:
	theMode	The value of this parameter is taken from the AnimationMode enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

AnimationMode VISU.Animation.getAnimationMode ( ) AnimationMode VISU.Animation.getAnimationMode ( )

- - - - - -

- -	+ + -Gets the animation mode.

- - - - -

- +Gets the animation mode. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.Animation.ApplyProperties	(	in long	theFieldNum,	void VISU.Animation.ApplyProperties	(	in long	theFieldNum,
		in ColoredPrs3d	thePrs			in ColoredPrs3d	thePrs
	)				)

- - - - - -

- -

+ +

-Apply the presentation properties to all fields. The exception is raised in the following cases: 1) presentations for the given field is not yet created; 2) invalid dynamic cast of the given presentation to VISU.ColoredPrs3d_i; 3) the MED file is not the same; 4) the mesh name is not the same; 5) the field name is not the same; 6) the entity is not the same.

- - - - -

- +Apply the presentation properties to all fields. The exception is raised in the following cases: 1) presentations for the given field is not yet created; 2) invalid dynamic cast of the given presentation to VISU.ColoredPrs3d_i; 3) the MED file is not the same; 4) the mesh name is not the same; 5) the field name is not the same; 6) the entity is not the same. + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.Base Interface Reference

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) VISUType VISU.Base.GetType ( )

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.ColoredPrs3d Interface Reference

- - - - -

- - - - - - - + + +

+Implemented in VISU.Plot3D, and VISU.CutPlanes. + +

Member Function Documentation

+ +

long VISU.ColoredPrs3d.GetScalarMode

(

)

+ + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode )

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMin

(

)

+ + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( )

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- - - - - - - +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMax

(

)

+ + + + + +

double VISU.ColoredPrs3d.GetMin ( )

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the min boundary of the scalar bar. + +

+ +

+ + + + + + + +

double VISU.ColoredPrs3d.GetMax ( )

+ +

+Gets the max boundary of the scalar bar. +

+ +

+ - - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( )

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( )

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) boolean VISU.ColoredPrs3d.IsRangeFixed ( )

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -238,95 +302,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetPosX

(

)

+ + + + + +

double VISU.ColoredPrs3d.GetPosX ( )

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- - - - - - - +Gets horizontal position of the scalar bar origin. + +

+ +

double VISU.ColoredPrs3d.GetPosY

(

)

+ + + + + +

double VISU.ColoredPrs3d.GetPosY ( )

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)				)

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -335,88 +375,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetWidth

(

)

+ + + + + +

double VISU.ColoredPrs3d.GetWidth ( )

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetHeight

(

)

+ + + + + +

double VISU.ColoredPrs3d.GetHeight ( )

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetNbColors

(

in long

theNbColors

)

+ + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors )

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -424,60 +440,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetNbColors

(

)

+ + + + + +

long VISU.ColoredPrs3d.GetNbColors ( )

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetLabels

(

in long

theNbLabels

)

+ + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels )

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -485,60 +485,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetLabels

(

)

+ + + + + +

long VISU.ColoredPrs3d.GetLabels ( )

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetTitle

(

in string

theName

)

+ + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName )

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -546,205 +530,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- - - - - - - + + +

+ +

string VISU.ColoredPrs3d.GetTitle

(

)

+ + + + + +

string VISU.ColoredPrs3d.GetTitle ( )

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

+ + + + + + + + +

void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation )

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, Orientation VISU.ColoredPrs3d.GetBarOrientation ( )

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ + + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDy,		in float	theDy,
		in float	theDz		in float	theDz
	)	`[inherited]`		)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - +Gets offset parameters for the 3D presentation + +

+ +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

+ + + + + +

float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- - - - - - - +Gets memory size actually used by the presentation (Mb). + +

+ +

IdType VISU.Base.GetID ( ) [inherited]

+ + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- - - - - - - +Remove object from study. + +

+ +

VISUType VISU.Base.GetType ( ) [inherited]

+ + + + + +

IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.ColoredPrs3dCache Interface Reference

Member Enumeration Documentation

Member Function Documentation

VISU.ColoredPrs3dHolder Interface Reference

Member Typedef Documentation

Member Function Documentation

VISU.Container Interface Reference

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Container.RemoveCurve ( in Curve theCurve ) void VISU.Container.RemoveCurve ( in Curve theCurve )

- - - -

- -	+ + Removes a curve from the container. Parameters: @@ -110,147 +94,107 @@ Removes a curve from the container. Parameters:
	theCurve	The removed curve.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.Container.GetNbCurves ( ) long VISU.Container.GetNbCurves ( )

- - - - - -

- -	+ + Gets the number of curves which are stored in the container. Returns: A long value corresponding to the number of curves which are stored in the container. -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.Container.Clear ( ) void VISU.Container.Clear ( )

- - - - - -

- -	+ + -Removes all curves from the container.

- - - - -

- +Removes all curves from the container. + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.Curve Interface Reference

- - - - -

- + + +

+ +

- +

enum VISU::Curve::LineType enum VISU::Curve::LineType

- - - -

- -	+ + This enumeration contains a set of elements defining the type of presentation of a curve line on the graphics. Enumerator: @@ -168,33 +184,25 @@ This enumeration contains a set of elements defining the type of presentation of

- - - + + +

Member Function Documentation

- - - - -

- + +

- - - - - - + + + + + +

void VISU.Curve.SetTitle ( in string theTitle ) void VISU.Curve.SetTitle ( in string theTitle )

- - - -

- -	+ + Sets the title of the curve. Parameters: @@ -202,60 +210,44 @@ Sets the title of the curve. Parameters:
	theTitle	This string parameter defines the title of this curve.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.Curve.GetTitle ( ) string VISU.Curve.GetTitle ( )

- - - - - -

- -	+ + Gets the title of the curve. Returns: String value corresponding to the title of the curve. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Curve.SetColor ( in SALOMEDS::Color theColor ) void VISU.Curve.SetColor ( in SALOMEDS::Color theColor )

- - - -

- -	+ + Sets the color of the curve. Parameters: @@ -263,60 +255,44 @@ Sets the color of the curve. Parameters:
	theColor	The color of the curve. This parameter is taken from the Orientation enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.Curve.GetColor ( ) SALOMEDS::Color VISU.Curve.GetColor ( )

- - - - - -

- -	+ + Gets the color of the curve. Returns: Color of the curve. The returned value will correspond to one of the elements the Color enumeration. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Curve.SetMarker ( in MarkerType theType ) void VISU.Curve.SetMarker ( in MarkerType theType )

- - - -

- -	+ + Sets the presentation type of markers (data points) with help of which the curve is constructed on the graphics. Parameters: @@ -324,69 +300,53 @@ Sets the presentation type of markers (data points) with help of which the curve
	theType	This parameter defines the type of marker with help of which the curve is constructed on the graphics. It is taken from MarkerType enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

MarkerType VISU.Curve.GetMarker ( ) MarkerType VISU.Curve.GetMarker ( )

- - - - - -

- -

+ +

Gets the presentation type of markers (data points) with help of which the curve is constructed on the graphics.

Returns:: The type of marker with help of which the curve is constructed on the graphics. The returned value will correspond to one of the elements the MarkerType enumeration.

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.Curve.SetLine	(	in LineType	theType,	void VISU.Curve.SetLine	(	in LineType	theType,
		in long	theLineWidth			in long	theLineWidth
	)				)

- - - -

- -

+ +

Sets the type of presentation of curve lines on the graphics.

Parameters:

@@ -395,148 +355,108 @@ Sets the type of presentation of curve lines on the graphics.

theLineWidth

Long value defining the width of the curve line.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

LineType VISU.Curve.GetLine ( ) LineType VISU.Curve.GetLine ( )

- - - - - -

- -	+ + Gets the type of representation of curve lines on the graphics. Returns: The type of representation of curve lines on the graphics. -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.Curve.GetLineWidth ( ) long VISU.Curve.GetLineWidth ( )

- - - - - -

- -	+ + Gets the width of the curve line. Returns: Long value corresponding to the width of the curve line. -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.CutLines Interface Reference

Member Enumeration Documentation

Member Function Documentation

- - - - -

- + +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.CutLines.SetOrientation	(	in CutPlanes::Orientation	theOrientation,	void VISU.CutLines.SetOrientation	(	in CutPlanes::Orientation	theOrientation,
		in double	theXAngle,			in double	theXAngle,
		in double	theYAngle			in double	theYAngle
	)				)

- - - -

- -	+ + Sets the type of orientation in 3D space of the base plane of a cut lines presentation. Parameters: @@ -230,47 +232,39 @@ Sets the type of orientation in 3D space of the base plane of a cut lines presen
	theXAngle	The angle of rotation of the base plane around the second axis of the chosen orientation.

- - - -

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.CutLines.SetOrientation2	(	in CutPlanes::Orientation	theOrientation,	void VISU.CutLines.SetOrientation2	(	in CutPlanes::Orientation	theOrientation,
		in double	theXAngle,			in double	theXAngle,
		in double	theYAngle			in double	theYAngle
	)				)

- - - -

- -	+ + Sets the type of orientation in 3D space of the cutting planes of a cut lines presentation. Parameters: @@ -280,194 +274,138 @@ Sets the type of orientation in 3D space of the cutting planes of a cut lines pr
	theXAngle	The angle of rotation of the cutting planes around the second axis of the chosen orientation.

- - - -

- - - - -

- - - - - - - + + +

+ +

CutPlanes::Orientation VISU.CutLines.GetOrientationType

(

)

+ + + + + +

CutPlanes::Orientation VISU.CutLines.GetOrientationType ( )

- - - - - -

- -	+ + -Gets the type of orientation in 3D space of the base plane of a cut lines presentation.

- - - - -

- - - - - - - +Gets the type of orientation in 3D space of the base plane of a cut lines presentation. + +

+ +

CutPlanes::Orientation VISU.CutLines.GetOrientationType2

(

)

+ + + + + +

CutPlanes::Orientation VISU.CutLines.GetOrientationType2 ( )

- - - - - -

- -	+ + -Gets the type of orientation in 3D space of the cutting planes of a cut lines presentation.

- - - - -

- - - - - - - +Gets the type of orientation in 3D space of the cutting planes of a cut lines presentation. + +

+ +

double VISU.CutLines.GetRotateX

(

)

+ + + + + +

double VISU.CutLines.GetRotateX ( )

- - - - - -

- -	+ + -Gets rotation angle of the base plane around the first axis of the chosen orientation.

- - - - -

- - - - - - - +Gets rotation angle of the base plane around the first axis of the chosen orientation. + +

+ +

double VISU.CutLines.GetRotateX2

(

)

+ + + + + +

double VISU.CutLines.GetRotateX2 ( )

- - - - - -

- -	+ + -Gets rotation angle of the cutting planes around the first axis of the chosen orientation.

- - - - -

- - - - - - - +Gets rotation angle of the cutting planes around the first axis of the chosen orientation. + +

+ +

double VISU.CutLines.GetRotateY

(

)

+ + + + + +

double VISU.CutLines.GetRotateY ( )

- - - - - -

- -	+ + -Gets rotation angle of the base plane around the second axis of the chosen orientation.

- - - - -

- - - - - - - +Gets rotation angle of the base plane around the second axis of the chosen orientation. + +

+ +

double VISU.CutLines.GetRotateY2

(

)

+ + + + + +

double VISU.CutLines.GetRotateY2 ( )

- - - - - -

- -	+ + -Gets rotation angle of the cutting planes around the second axis of the chosen orientation.

- - - - -

- - - - - - - - +Gets rotation angle of the cutting planes around the second axis of the chosen orientation. + +

+ +

void VISU.CutLines.SetDisplacement

(

in double

theDisp

)

+ + + + + + +

void VISU.CutLines.SetDisplacement ( in double theDisp )

- - - -

- -	+ + Sets the displacement of the base plane of the cut lines presentation in 3D space. @@ -476,32 +414,24 @@ Sets the displacement of the base plane of the cut lines presentation in 3D spac
	theDisp	This parameter defines position of the base plane in 3D space. It varies from 0 to 1.

- - - -

- - - - -

- - - - - - - - + + +

+ +

void VISU.CutLines.SetDisplacement2

(

in double

theDisp

)

+ + + + + + +

void VISU.CutLines.SetDisplacement2 ( in double theDisp )

- - - -

- -	+ + Sets the displacement of the cutting planes of the cut lines presentation in 3D space. @@ -510,86 +440,62 @@ Sets the displacement of the cutting planes of the cut lines presentation in 3D
	theDisp	This parameter defines position of the cutting planes in 3D space. It varies from 0 to 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.CutLines.GetDisplacement

(

)

+ + + + + +

double VISU.CutLines.GetDisplacement ( )

- - - - - -

- -	+ + -Gets the displacement of the base plane of the cut lines presentation in 3D space.

- - - - -

- - - - - - - +Gets the displacement of the base plane of the cut lines presentation in 3D space. + +

+ +

double VISU.CutLines.GetDisplacement2

(

)

+ + + + + +

double VISU.CutLines.GetDisplacement2 ( )

- - - - - -

- -	+ + -Gets the displacement of the cutting planes of the cut lines presentation in 3D space.

- - - - -

- - - - - - - - +Gets the displacement of the cutting planes of the cut lines presentation in 3D space. + +

+ +

void VISU.CutLines.SetBasePlanePosition

(

in double

thePlanePosition

)

+ + + + + + +

void VISU.CutLines.SetBasePlanePosition ( in double thePlanePosition )

- - - -

- -	+ + Sets the position of the base plane in 3D space. Parameters: @@ -597,68 +503,52 @@ Sets the position of the base plane in 3D space. Parameters:<
	thePlanePosition	A double value defining the position of the base plane in 3D space.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.CutLines.GetBasePlanePosition

(

)

+ + + + + +

double VISU.CutLines.GetBasePlanePosition ( )

- - - - - -

- -	+ + -Gets the position of the base plane in 3D space.

- - - - -

- +Gets the position of the base plane in 3D space. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.CutLines.SetLinePosition	(	in long	thePlaneNumber,	void VISU.CutLines.SetLinePosition	(	in long	thePlaneNumber,
		in double	thePlanePosition			in double	thePlanePosition
	)				)

- - - -

- -	+ + Sets the position of one of cutting planes in 3D space. Parameters: @@ -667,32 +557,24 @@ Sets the position of one of cutting planes in 3D space. Param
	thePlanePosition	A double value defining the position of the base plane in 3D space.

- - - -

- - - - -

- - - - - - - - + + +

+ +

double VISU.CutLines.GetLinePosition

(

in long

thePlaneNumber

)

+ + + + + + +

double VISU.CutLines.GetLinePosition ( in long thePlaneNumber )

- - - -

- -	+ + Gets the position of one of cutting planes in 3D space. Parameters: @@ -700,87 +582,63 @@ Gets the position of one of cutting planes in 3D space. Param
	thePlaneNumber	A long value defining the order number of this cutting plane.

- - - -

- - - - -

- - - - - - - + + +

+ +

void VISU.CutLines.SetDefault

(

)

+ + + + + +

void VISU.CutLines.SetDefault ( )

- - - - - -

- -	+ + -Sets the position of the base plane to default value.

- - - - -

- - - - - - - +Sets the position of the base plane to default value. + +

+ +

boolean VISU.CutLines.IsDefault

(

)

+ + + + + +

boolean VISU.CutLines.IsDefault ( )

- - - - - -

- -	+ + Determines whether the base plane has default position. Returns: True if the base plane has default position. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.CutLines.SetDefaultPosition

(

in long

thePlaneNumber

)

+ + + + + + +

void VISU.CutLines.SetDefaultPosition ( in long thePlaneNumber )

- - - -

- -

+ +

Sets the position of the choosen cutting plane to default value.

Parameters:

@@ -788,32 +646,24 @@ Sets the position of the choosen cutting plane to default value.

thePlaneNumber

The number of this cutting plane.

- - - -

- - - - -

- - - - - - - - + + +

+ +

boolean VISU.CutLines.IsDefaultPosition

(

in long

thePlaneNumber

)

+ + + + + + +

boolean VISU.CutLines.IsDefaultPosition ( in long thePlaneNumber )

- - - -

- -	+ + Determines whether the choosen cutting plane has default position. Parameters: @@ -822,32 +672,24 @@ Determines whether the choosen cutting plane has default position. <

- - - - -

- - - - - - - - + + +

+ +

void VISU.CutLines.SetNbLines

(

in long

theNb

)

+ + + + + + +

void VISU.CutLines.SetNbLines ( in long theNb )

- - - -

- -	+ + Sets the number of cut lines. Parameters: @@ -855,59 +697,43 @@ Sets the number of cut lines. Parameters:
	theNb	The number of cut lines.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.CutLines.GetNbLines

(

)

+ + + + + +

long VISU.CutLines.GetNbLines ( )

- - - - - -

- -	+ + -Gets the number of cut lines.

- - - - -

- - - - - - - - +Gets the number of cut lines. + +

+ +

void VISU.CutLines.SetAllCurvesInverted

(

in boolean

theInvert

)

+ + + + + + +

void VISU.CutLines.SetAllCurvesInverted ( in boolean theInvert )

- - - -

- -	+ + Invert all curves of corresponding table Parameters: @@ -915,31 +741,23 @@ Invert all curves of corresponding table Parameters:
	theInvert	- Invert all curves, if value is TRUE, else not.

- - - -

- - - - -

- - - - - - - + + +

+ +

boolean VISU.CutLines.IsAllCurvesInverted

(

)

+ + + + + +

boolean VISU.CutLines.IsAllCurvesInverted ( )

- - - -

- -	+ + Checks the orientation of all curves Return values: @@ -947,32 +765,24 @@ Checks the orientation of all curves Return values: <
	TRUE	- if all curves are inverted, else FALSE

- - - -

- - - - -

- - - - - - - - + + +

+ +

void VISU.CutLines.SetUseAbsoluteLength

(

in boolean

theAbsLength

)

+ + + + + + +

void VISU.CutLines.SetUseAbsoluteLength ( in boolean theAbsLength )

- - - -

- -

+ +

Sets values which cutlines would be shown: aboslute or relative values

Parameters:

@@ -980,59 +790,43 @@ Sets values which cutlines would be shown: aboslute or relative values

theAbsLength

- boolean value, TRUE or false.

- - - -

- - - - -

- - - - - - - + + +

+ +

boolean VISU.CutLines.IsUseAbsoluteLength

(

)

+ + + + + +

boolean VISU.CutLines.IsUseAbsoluteLength ( )

- - - - - -

- -	+ + -Checks values of cutlines: using aboslute or relative values

- - - - -

- - - - - - - - +Checks values of cutlines: using aboslute or relative values + +

+ +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

+ + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -	+ + Sets the type of scaling of the values reflected by the scalar bar. Parameters: @@ -1040,68 +834,52 @@ Sets the type of scaling of the values reflected by the scalar bar.
	theScaling	The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- - - - - - - + + +

+ +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

+ + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -1110,210 +888,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ + + + + +

void VISU.ScalarMap.SetSourceRange ( ) [inherited]

- - - - - -

- -

+ +

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- - - - - - - + + +

+ +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited]

+ + + + + +

void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- - - - - - - - +PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- - - - - - - +Gets the min boundary of the scalar bar. + +

+ +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

+ + + + + + + +

double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ + + + + + + + +

double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ + + + + + + + +

boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ - - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,	void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y			in double	Y
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the position of the scalar bar origin on the screen. Parameters: @@ -1322,95 +1121,71 @@ Sets the position of the scalar bar origin on the screen. Par
	Y	Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- - - - - - - +Gets horizontal position of the scalar bar origin. + +

+ +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -1419,88 +1194,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -1508,60 +1259,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -1569,60 +1304,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -1630,205 +1349,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- - - - - - - + + +

+ +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

+ + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

+ + + + + + + + +

void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ + + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDy,		in float	theDy,
		in float	theDz		in float	theDz
	)	`[inherited]`		)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - +Gets offset parameters for the 3D presentation + +

+ +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

+ + + + + +

float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- - - - - - - +Gets memory size actually used by the presentation (Mb). + +

+ +

IdType VISU.Base.GetID ( ) [inherited]

+ + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- - - - - - - +Remove object from study. + +

+ +

VISUType VISU.Base.GetType ( ) [inherited]

+ + + + + +

IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.CutPlanes Interface Reference

Member Function Documentation

- - - - -

- + +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.CutPlanes.SetOrientation	(	in Orientation	theOrientation,	void VISU.CutPlanes.SetOrientation	(	in Orientation	theOrientation,
		in double	theXAngle,			in double	theXAngle,
		in double	theYAngle			in double	theYAngle
	)				)

- - - -

- -

+ +

Sets the type of orientation in 3D space of cut planes presentation.

Parameters:

@@ -204,113 +212,81 @@ Sets the type of orientation in 3D space of cut planes presentation.

theXAngle

The angle of rotation of the cut planes around the second axis of the chosen orientation.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.CutPlanes.GetOrientationType ( ) Orientation VISU.CutPlanes.GetOrientationType ( )

- - - - - -

- -	+ + -Gets the type of orientation in 3D space of cut planes presentation.

- - - - -

- +Gets the type of orientation in 3D space of cut planes presentation. + +

+ +

- - - - - + + + + +

double VISU.CutPlanes.GetRotateX ( ) double VISU.CutPlanes.GetRotateX ( )

- - - - - -

- -	+ + -Gets rotation angle of the cut plane presentation around the first axis of the chosen orientation.

- - - - -

- +Gets rotation angle of the cut plane presentation around the first axis of the chosen orientation. + +

+ +

- - - - - + + + + +

double VISU.CutPlanes.GetRotateY ( ) double VISU.CutPlanes.GetRotateY ( )

- - - - - -

- -	+ + -Gets rotation angle of the cut plane presentation around the second axis of the chosen orientation.

- - - - -

- +Gets rotation angle of the cut plane presentation around the second axis of the chosen orientation. + +

+ +

- - - - - - + + + + + +

void VISU.CutPlanes.SetDisplacement ( in double theDisp ) void VISU.CutPlanes.SetDisplacement ( in double theDisp )

- - - -

- -	+ + Sets the displacement of the cut planes in 3D space. @@ -319,68 +295,52 @@ Sets the displacement of the cut planes in 3D space.
	theDisp	This parameter defines position of the cut planes in 3D space. It varies from 0 to 1. If the chosen value is 0.5, the cut planes will be evenly located regarding each other; in other words, the distance between all of them will be equal. If the value is higher or lower than 0.5, the planes will be displaced to one or another side.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.CutPlanes.GetDisplacement ( ) double VISU.CutPlanes.GetDisplacement ( )

- - - - - -

- -	+ + -Gets the displacement of the cut planes in 3D space.

- - - - -

- +Gets the displacement of the cut planes in 3D space. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.CutPlanes.SetPlanePosition	(	in long	thePlaneNumber,	void VISU.CutPlanes.SetPlanePosition	(	in long	thePlaneNumber,
		in double	thePlanePosition			in double	thePlanePosition
	)				)

- - - -

- -

+ +

Sets the position of a definite cut plane.

Parameters:

@@ -389,32 +349,24 @@ Sets the position of a definite cut plane.

Parameters:

thePlanePosition

The position of this cut plane.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.CutPlanes.SetDefault ( in long thePlaneNumber ) void VISU.CutPlanes.SetDefault ( in long thePlaneNumber )

- - - -

- -	+ + Sets the position of the choosen plane to default value. Parameters: @@ -422,60 +374,44 @@ Sets the position of the choosen plane to default value. Para
	thePlaneNumber	The number of this cut plane.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

double VISU.CutPlanes.GetPlanePosition ( in long thePlaneNumber ) double VISU.CutPlanes.GetPlanePosition ( in long thePlaneNumber )

- - - - - -

- -	+ + -Gets the position of the choosen plane

- - - - -

- +Gets the position of the choosen plane + +

+ +

- - - - - - + + + + + +

boolean VISU.CutPlanes.IsDefault ( in long thePlaneNumber ) boolean VISU.CutPlanes.IsDefault ( in long thePlaneNumber )

- - - -

- -	+ + Determines whether the choosen plane has default position. Parameters: @@ -483,32 +419,24 @@ Determines whether the choosen plane has default position. Pa
	thePlaneNumber	The number of this cut plane.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.CutPlanes.SetNbPlanes ( in long theNb ) void VISU.CutPlanes.SetNbPlanes ( in long theNb )

- - - -

- -	+ + Sets the number of cut planes. Parameters: @@ -516,59 +444,43 @@ Sets the number of cut planes. Parameters:
	theNb	The number of cut planes.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.CutPlanes.GetNbPlanes ( ) long VISU.CutPlanes.GetNbPlanes ( )

- - - - - -

- -	+ + -Gets the number of cut planes.

- - - - -

- +Gets the number of cut planes. + +

+ +

- - - - - - + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited] void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -	+ + Sets the type of scaling of the values reflected by the scalar bar. Parameters: @@ -576,68 +488,52 @@ Sets the type of scaling of the values reflected by the scalar bar.
	theScaling	The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited] Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -646,210 +542,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + +

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited] void VISU.ScalarMap.SetSourceRange ( ) [inherited]

- - - - - -

- -

+ +

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited] void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- +PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited] void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited] long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited] double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- +Gets the min boundary of the scalar bar. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited] double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

- - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -858,95 +775,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited] double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- +Gets horizontal position of the scalar bar origin. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited] double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -955,88 +848,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited] double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited] double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited] void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -1044,60 +913,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited] long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited] void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -1105,60 +958,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited] long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited] void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -1166,205 +1003,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited] string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

- - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + +

in float theDy, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ - - - - + + + + - - - + + + + + + + + + + + + + + +

	in float	theDz	void VISU.Prs3d.SetOffset	(	in float	theDx,
)	`[inherited]`				in float	theDy,
	in float	theDz
)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Gets offset parameters for the 3D presentation + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Gets memory size actually used by the presentation (Mb). + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.DeformedShape Interface Reference

Member Function Documentation

- - - - -

- + +

- - - - - - + + + + + +

void VISU.DeformedShape.SetScale ( in double theScale ) void VISU.DeformedShape.SetScale ( in double theScale )

- - - -

- -

+ +

Sets the scale of the presentatable object.

Parameters:

@@ -174,86 +176,62 @@ Sets the scale of the presentatable object.

Parameters:

theScale

Double value defining the scale of this presentable object.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.DeformedShape.GetScale ( ) double VISU.DeformedShape.GetScale ( )

- - - - - -

- -	+ + -Gets the scale of the presentatable object.

- - - - -

- +Gets the scale of the presentatable object. + +

+ +

- - - - - + + + + +

boolean VISU.DeformedShape.IsColored ( ) boolean VISU.DeformedShape.IsColored ( )

- - - - - -

- -	+ + -This boolean method returns True if this deformed shape presentation is colored.

- - - - -

- +This boolean method returns True if this deformed shape presentation is colored. + +

+ +

- - - - - - + + + + + +

void VISU.DeformedShape.ShowColored ( in boolean theColored ) void VISU.DeformedShape.ShowColored ( in boolean theColored )

- - - -

- -	+ + Shows this presentation in colored mode. Parameters: @@ -261,60 +239,44 @@ Shows this presentation in colored mode. Parameters:
	theColored	If this boolean parameter is True this presentable object will be shown in colored mode.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.DeformedShape.GetColor ( ) SALOMEDS::Color VISU.DeformedShape.GetColor ( )

- - - - - -

- -	+ + Gets the color of this presentable object. Returns: The color of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.DeformedShape.SetColor ( in SALOMEDS::Color theColor ) void VISU.DeformedShape.SetColor ( in SALOMEDS::Color theColor )

- - - -

- -	+ + Sets the color of this presentation. Parameters: @@ -322,32 +284,24 @@ Sets the color of this presentation. Parameters:
	theColor	The color of this presentation. This parameter is taken from the Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited] void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -	+ + Sets the type of scaling of the values reflected by the scalar bar. Parameters: @@ -355,68 +309,52 @@ Sets the type of scaling of the values reflected by the scalar bar.
	theScaling	The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited] Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -425,210 +363,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + +

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited] void VISU.ScalarMap.SetSourceRange ( ) [inherited]

- - - - - -

- -

+ +

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited] void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- +PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited] void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited] long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited] double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- +Gets the min boundary of the scalar bar. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited] double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

- - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -637,95 +596,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited] double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- +Gets horizontal position of the scalar bar origin. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited] double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -734,88 +669,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited] double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited] double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited] void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -823,60 +734,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited] long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited] void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -884,60 +779,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited] long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited] void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -945,205 +824,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited] string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

- - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ + + + + + + + +

Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ - - - - + + + + - - - - + + + + - - - + + + + + + + + +

	in float	theDy,	void VISU.Prs3d.SetOffset	(	in float	theDx,
	in float	theDz			in float	theDy,
)	`[inherited]`				in float	theDz
)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Gets offset parameters for the 3D presentation + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Gets memory size actually used by the presentation (Mb). + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.GaussPoints Interface Reference

- - - - -

- - - - - - - + + +

+Implemented in VISU.Plot3D, and VISU.CutPlanes. + +

Member Function Documentation

+ +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- - - - - - - +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the min boundary of the scalar bar. + +

+ +

+ + + + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar. +

+ +

+ - - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -229,95 +293,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- - - - - - - +Gets horizontal position of the scalar bar origin. + +

+ +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -326,88 +366,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -415,60 +431,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -476,60 +476,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -537,205 +521,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- - - - - - - + + +

+ +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

+ + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

+ + + + + + + + +

void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ + + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDy,		in float	theDy,
		in float	theDz		in float	theDz
	)	`[inherited]`		)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - +Gets offset parameters for the 3D presentation + +

+ +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

+ + + + + +

float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- - - - - - - +Gets memory size actually used by the presentation (Mb). + +

+ +

IdType VISU.Base.GetID ( ) [inherited]

+ + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- - - - - - - +Remove object from study. + +

+ +

VISUType VISU.Base.GetType ( ) [inherited]

+ + + + + +

IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.IsoSurfaces Interface Reference

Member Enumeration Documentation

Member Function Documentation

- - - - -

- - - - - - - - - -

void VISU.IsoSurfaces.SetNbSurfaces

(

in long

theNb

)

- - - -

- -

+ +

+ + + + + + + + + +

void VISU.IsoSurfaces.SetNbSurfaces ( in long theNb )

Sets the number of isometric surfaces.

Parameters:

@@ -165,59 +167,43 @@ Sets the number of isometric surfaces.

Parameters:

theNb

A long value defining the number of isometric surfaces which will be used for construction of this presentation.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.IsoSurfaces.GetNbSurfaces ( ) long VISU.IsoSurfaces.GetNbSurfaces ( )

- - - - - -

- -	+ + -Gets the number of isometric surfaces

- - - - -

- - - - - - - - - -

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -

+Gets the number of isometric surfaces + +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

Sets the type of scaling of the values reflected by the scalar bar.

Parameters:

@@ -225,68 +211,52 @@ Sets the type of scaling of the values reflected by the scalar bar.

theScaling The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited] Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -295,210 +265,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- - - - - - - - - -

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + +

void VISU.ScalarMap.SetSourceRange ( ) [inherited]

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited] void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -

+PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

-Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited] long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited] double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- +Gets the min boundary of the scalar bar. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited] double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

- - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -507,95 +498,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited] double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- +Gets horizontal position of the scalar bar origin. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited] double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -604,88 +571,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited] double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited] double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

Sets the number of colors which will be used for presentation of this presentable object.

Parameters:: @@ -693,60 +636,44 @@ Sets the number of colors which will be used for presentation of this presentabl

theNbColors A long value defining the number of colors.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited] long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

Sets the number of labels which will be used for indication of color gradation of the scalar bar.

Parameters:: @@ -754,60 +681,44 @@ Sets the number of labels which will be used for indication of color gradation o

theNbLabels A long value defining the number of labels.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited] long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

Sets the title of the scalar bar. By default - the name of the selected result is used.

Parameters:: @@ -815,205 +726,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i

theName String parameter defining the name of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited] string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

+ + + + + + + + +

void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ - - - - + + + + - - - - + + + + - - - + + + + + + + + +

	in float	theDy,	void VISU.Prs3d.SetOffset	(	in float	theDx,
	in float	theDz			in float	theDy,
)	`[inherited]`				in float	theDz
)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Gets offset parameters for the 3D presentation + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Gets memory size actually used by the presentation (Mb). + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.Mesh Interface Reference

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.Mesh.GetCellColor ( ) SALOMEDS::Color VISU.Mesh.GetCellColor ( )

- - - - - -

- -	+ + -Gets the color of mesh cells.

- - - - -

- +Gets the color of mesh cells. + +

+ +

- - - - - - + + + + + +

void VISU.Mesh.SetNodeColor ( in SALOMEDS::Color theColor ) void VISU.Mesh.SetNodeColor ( in SALOMEDS::Color theColor )

- - - -

- -	+ + Sets the color of mesh nodes. Parameters: @@ -151,59 +129,43 @@ Sets the color of mesh nodes. Parameters:
	theColor	The color of the nodes. This parameter is taken from Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.Mesh.GetNodeColor ( ) SALOMEDS::Color VISU.Mesh.GetNodeColor ( )

- - - - - -

- -	+ + -Gets the color of mesh nodes.

- - - - -

- +Gets the color of mesh nodes. + +

+ +

- - - - - - + + + + + +

void VISU.Mesh.SetLinkColor ( in SALOMEDS::Color theColor ) void VISU.Mesh.SetLinkColor ( in SALOMEDS::Color theColor )

- - - -

- -	+ + Sets the color of mesh links. Parameters: @@ -211,59 +173,43 @@ Sets the color of mesh links. Parameters:
	theColor	The color of the links. This parameter is taken from Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.Mesh.GetLinkColor ( ) SALOMEDS::Color VISU.Mesh.GetLinkColor ( )

- - - - - -

- -	+ + -Gets the color of mesh links.

- - - - -

- +Gets the color of mesh links. + +

+ +

- - - - - - + + + + + +

void VISU.Mesh.SetPresentationType ( in PresentationType theType ) void VISU.Mesh.SetPresentationType ( in PresentationType theType )

- - - -

- -

+ +

Sets the type of representation of a mesh.

Parameters:

@@ -271,206 +217,177 @@ Sets the type of representation of a mesh.

Parameters:

theType

The of representation of a mesh. This parameter is taken from PresentationType enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

PresentationType VISU.Mesh.GetPresentationType ( ) PresentationType VISU.Mesh.GetPresentationType ( )

- - - - - -

- -	+ + Gets the type of representation of the mesh. Returns: The type of representation of the mesh. -

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,	void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDy,			in float	theDy,
		in float	theDz			in float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Gets offset parameters for the 3D presentation + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Gets memory size actually used by the presentation (Mb). + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.Plot3D Interface Reference

Member Function Documentation

- - - - -

- + +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Plot3D.SetOrientation	(	in Orientation	theOrientation,	void VISU.Plot3D.SetOrientation	(	in Orientation	theOrientation,
		in double	theXAngle,			in double	theXAngle,
		in double	theYAngle			in double	theYAngle
	)				)

- - - -

- -

+ +

Sets the orientation in 3D space of cutting plane for the presentation.

Parameters:

@@ -206,122 +214,90 @@ Sets the orientation in 3D space of cutting plane for the presentation.

theXAngle

The angle of rotation of the cutting plane around the second axis of the chosen orientation.

- - - -

- - - - -

- - - - - - - + + +

+ +

Orientation VISU.Plot3D.GetOrientationType

(

)

+ + + + + +

Orientation VISU.Plot3D.GetOrientationType ( )

- - - - - -

- -	+ + -Gets the type of orientation in 3D space of cutting plane.

- - - - -

- - - - - - - +Gets the type of orientation in 3D space of cutting plane. + +

+ +

double VISU.Plot3D.GetRotateX

(

)

+ + + + + +

double VISU.Plot3D.GetRotateX ( )

- - - - - -

- -	+ + -Gets rotation angle of the cutting plane around the first axis of the chosen orientation.

- - - - -

- - - - - - - +Gets rotation angle of the cutting plane around the first axis of the chosen orientation. + +

+ +

double VISU.Plot3D.GetRotateY

(

)

+ + + + + +

double VISU.Plot3D.GetRotateY ( )

- - - - - -

- -	+ + -Gets rotation angle of the cutting plane around the second axis of the chosen orientation.

- - - - -

- +Gets rotation angle of the cutting plane around the second axis of the chosen orientation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.Plot3D.SetPlanePosition	(	in double	thePlanePosition,	void VISU.Plot3D.SetPlanePosition	(	in double	thePlanePosition,
		in boolean	theIsRelative			in boolean	theIsRelative
	)				)

- - - -

- -

+ +

Sets the position of a cutting plane.

Parameters:

@@ -330,86 +306,62 @@ Sets the position of a cutting plane.

Parameters:

theIsRelative

Define, whether the input position is relative.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.Plot3D.GetPlanePosition

(

)

+ + + + + +

double VISU.Plot3D.GetPlanePosition ( )

- - - - - -

- -	+ + -Gets the position of the cutting plane

- - - - -

- - - - - - - +Gets the position of the cutting plane + +

+ +

boolean VISU.Plot3D.IsPositionRelative

(

)

+ + + + + +

boolean VISU.Plot3D.IsPositionRelative ( )

- - - - - -

- -	+ + -Returns true if a position of cutting plane is relative

- - - - -

- - - - - - - - +Returns true if a position of cutting plane is relative + +

+ +

void VISU.Plot3D.SetScaleFactor

(

in double

theScaleFactor

)

+ + + + + + +

void VISU.Plot3D.SetScaleFactor ( in double theScaleFactor )

- - - -

- -	+ + Sets the scale factor for scalar values (how much corresponding mesh elements should be translated). Parameters: @@ -417,59 +369,43 @@ Sets the scale factor for scalar values (how much corresponding mesh elements sh
	theScaleFactor	The scaling factor.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.Plot3D.GetScaleFactor

(

)

+ + + + + +

double VISU.Plot3D.GetScaleFactor ( )

- - - - - -

- -	+ + -Gets the scale factor for scalar values. (how much corresponding mesh elements is translated)

- - - - -

- - - - - - - - +Gets the scale factor for scalar values. (how much corresponding mesh elements is translated) + +

+ +

void VISU.Plot3D.SetContourPrs

(

in boolean

theIsContourPrs

)

+ + + + + + +

void VISU.Plot3D.SetContourPrs ( in boolean theIsContourPrs )

- - - -

- -

+ +

Sets presentation type: contour or surface.

Parameters:

@@ -477,59 +413,43 @@ Sets presentation type: contour or surface.

Parameters:

theIsContourPrs

Define, whether presentation type is contour.

- - - -

- - - - -

- - - - - - - + + +

+ +

boolean VISU.Plot3D.GetIsContourPrs

(

)

+ + + + + +

boolean VISU.Plot3D.GetIsContourPrs ( )

- - - - - -

- -	+ + -Returns true if presentation type is contour.

- - - - -

- - - - - - - - +Returns true if presentation type is contour. + +

+ +

void VISU.Plot3D.SetNbOfContours

(

in long

theNb

)

+ + + + + + +

void VISU.Plot3D.SetNbOfContours ( in long theNb )

- - - -

- -	+ + Sets the number of contours. Parameters: @@ -537,59 +457,43 @@ Sets the number of contours. Parameters:
	theNb	The number of contours.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.Plot3D.GetNbOfContours

(

)

+ + + + + +

long VISU.Plot3D.GetNbOfContours ( )

- - - - - -

- -	+ + -Gets the number of contours.

- - - - -

- - - - - - - - +Gets the number of contours. + +

+ +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

+ + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -	+ + Sets the type of scaling of the values reflected by the scalar bar. Parameters: @@ -597,68 +501,52 @@ Sets the type of scaling of the values reflected by the scalar bar.
	theScaling	The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- - - - - - - + + +

+ +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

+ + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -667,210 +555,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ + + + + +

void VISU.ScalarMap.SetSourceRange ( ) [inherited]

- - - - - -

- -

+ +

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- - - - - - - + + +

+ +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited]

+ + + + + +

void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- - - - - - - - +PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- - - - - - - +Gets the min boundary of the scalar bar. + +

+ +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

- - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -879,95 +788,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- - - - - - - +Gets horizontal position of the scalar bar origin. + +

+ +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -976,88 +861,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -1065,60 +926,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -1126,60 +971,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -1187,205 +1016,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- - - - - - - + + +

+ +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

+ + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

+ + + + + + + + +

void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ - - - - + + + + - - - - + + + + - - - + + + + + + + + +

	in float	theDy,	void VISU.Prs3d.SetOffset	(	in float	theDx,
	in float	theDz			in float	theDy,
)	`[inherited]`				in float	theDz
)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - +Gets offset parameters for the 3D presentation + +

+ +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

+ + + + + +

float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- - - - - - - +Gets memory size actually used by the presentation (Mb). + +

+ +

IdType VISU.Base.GetID ( ) [inherited]

+ + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- - - - - - - +Remove object from study. + +

+ +

VISUType VISU.Base.GetType ( ) [inherited]

+ + + + + +

IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.Prs3d Interface Reference

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)				)

- - - - - -

- -

+ +

- - - - -

- +Gets offset parameters for the 3D presentation + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] float VISU.Prs3d.GetMemorySize ( )

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Gets memory size actually used by the presentation (Mb). + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.PrsObject Interface Reference

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.RemovableObject Interface Reference

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.Result Interface Reference

- - - - -

- +Reads all data from the corresponding sources. By default the data is loaded on demand. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

boolean VISU.Result.Build	(	in boolean	theIsBuildAll,	boolean VISU.Result.Build	(	in boolean	theIsBuildAll,
		in boolean	theIsAtOnce			in boolean	theIsAtOnce
	)				)

- - - - - -

- -	+ + -Start to parse the source MED file and publish all its entities into the study

- - - - -

- +Start to parse the source MED file and publish all its entities into the study + +

+ +

- - - - - + + + + +

boolean VISU.Result.IsDone ( ) boolean VISU.Result.IsDone ( )

- - - - - -

- -	+ + -Allow to check is all requested MED entites already loaded or not

- - - - -

- +Allow to check is all requested MED entites already loaded or not + +

+ +

- - - - - + + + + +

boolean VISU.Result.IsEntitiesDone ( ) boolean VISU.Result.IsEntitiesDone ( )

- - - - - -

- -	+ + -Allow to check is corresponding MED entites already loaded or not

- - - - -

- +Allow to check is corresponding MED entites already loaded or not + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.Result.SetBuildFields	(	in boolean	theIsBuildFields,	void VISU.Result.SetBuildFields	(	in boolean	theIsBuildFields,
		in boolean	theIsCalculateMinMax			in boolean	theIsCalculateMinMax
	)				)

- - - - - -

- -	+ + -Choose to parse MED fields and perform global min / max on the MED timestamps.

- - - - -

- +Choose to parse MED fields and perform global min / max on the MED timestamps. + +

+ +

- - - - - + + + + +

boolean VISU.Result.IsFieldsDone ( ) boolean VISU.Result.IsFieldsDone ( )

- - - - - -

- -	+ + -Allow to check is corresponding MED fields already loaded or not

- - - - -

- +Allow to check is corresponding MED fields already loaded or not + +

+ +

- - - - - - + + + + + +

void VISU.Result.SetBuildGroups ( in boolean theIsBuildGroups ) void VISU.Result.SetBuildGroups ( in boolean theIsBuildGroups )

- - - - - -

- -	+ + -Choose to parse MED groups.

- - - - -

- +Choose to parse MED groups. + +

+ +

- - - - - + + + + +

boolean VISU.Result.IsGroupsDone ( ) boolean VISU.Result.IsGroupsDone ( )

- - - - - -

- -	+ + -Allow to check is corresponding MED groups and families already loaded or not

- - - - -

- +Allow to check is corresponding MED groups and families already loaded or not + +

+ +

- - - - - + + + + +

boolean VISU.Result.IsMinMaxDone ( ) boolean VISU.Result.IsMinMaxDone ( )

- - - - - -

- -	+ + -Allow to check is min / max calculation over field's components already perfrormed or not

- - - - -

- +Allow to check is min / max calculation over field's components already perfrormed or not + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.ScalarMap Interface Reference

Member Function Documentation

- - - - -

- - - - - - - - - -

void VISU.ScalarMap.SetScaling

(

in Scaling

theScaling

)

- - - -

- -

+ +

+ + + + + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling )

Sets the type of scaling of the values reflected by the scalar bar.

Parameters:

@@ -167,68 +169,52 @@ Sets the type of scaling of the values reflected by the scalar bar.

theScaling The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) Scaling VISU.ScalarMap.GetScaling ( )

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)				)

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -237,210 +223,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- - - - - - - - - -

void VISU.ScalarMap.SetBarOrientation

(

in Orientation

theOrientation

)

- - - - - -

- -

+ + +

+ +

+ + + + + + + + +

void VISU.ScalarMap.SetSourceRange ( )

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName )

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.ScalarMap.GetBarOrientation ( ) void VISU.ScalarMap.RemoveAllGeom ( )

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -

+PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

-Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- - - - - - - +Gets the min boundary of the scalar bar. + +

+ +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

+ + + + + + + +

double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ + + + + + + + +

double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ + + + + + + + +

boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ - - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,	void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y			in double	Y
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the position of the scalar bar origin on the screen. Parameters: @@ -449,95 +456,71 @@ Sets the position of the scalar bar origin on the screen. Par
	Y	Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited] double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- - - - - - - +Gets horizontal position of the scalar bar origin. + +

+ +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -546,88 +529,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited] double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited] double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

Sets the number of colors which will be used for presentation of this presentable object.

Parameters:: @@ -635,60 +594,44 @@ Sets the number of colors which will be used for presentation of this presentabl

theNbColors A long value defining the number of colors.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited] long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

Sets the number of labels which will be used for indication of color gradation of the scalar bar.

Parameters:: @@ -696,60 +639,44 @@ Sets the number of labels which will be used for indication of color gradation o

theNbLabels A long value defining the number of labels.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited] long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- - - - - - - - - -

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

Sets the title of the scalar bar. By default - the name of the selected result is used.

Parameters:: @@ -757,205 +684,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i

theName String parameter defining the name of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited] string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

+ + + + + + + + +

void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ + + + + + + + +

Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,	void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDy,			in float	theDy,
		in float	theDz			in float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - +Gets offset parameters for the 3D presentation + +

+ +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

+ + + + + +

float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- - - - - - - +Gets memory size actually used by the presentation (Mb). + +

+ +

IdType VISU.Base.GetID ( ) [inherited]

+ + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- - - - - - - +Remove object from study. + +

+ +

VISUType VISU.Base.GetType ( ) [inherited]

+ + + + + +

IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.ScalarMapOnDeformedShape Interface Reference

Member Function Documentation

- - - - -

- - - - - - - + +

void VISU.ScalarMapOnDeformedShape.SetSourceRange

(

in double

theMinRange,

- - - - - - - - - + + + + + +

		in double	theMaxRange
	)			void VISU.ScalarMapOnDeformedShape.SetScale	(	in double	theScale	)

- - - - - -

- -	+ + -Sets the source ranges of pipeline

- - - - -

- +Sets the scale of the presentatable object.

Parameters:: +

+ +

theScale

Double value defining the scale of this presentable object.

+ + + +

+ +

+ - - - - - + + + + +

double VISU.ScalarMapOnDeformedShape.GetSourceRangeMin ( ) double VISU.ScalarMapOnDeformedShape.GetScale ( )

- - - - - -

- -	+ + -Gets the minimum source range of pipeline

- - - - -

- +Gets the scale of the presentatable object. + +

+ +

- - - - - + + + + + + + + + + -

double VISU.ScalarMapOnDeformedShape.GetSourceRangeMax	(		)		void VISU.ScalarMapOnDeformedShape.SetScalarField	(	in Entity	theEntity,
		in string	theFieldName,

- - - - - -

- -	- - -Gets the maximum source range of pipeline

- - - - -

- - - - - - - + + + + + + + + +

void VISU.ScalarMapOnDeformedShape.SetScale	(	in double	theScale	)				in long	theTimeStampNumber
	)

- - - - - -

- -

+ +

-Sets the scale of the presentatable object.

Parameters:

+Sets the scalar field

Parameters:

- + + +

	theScale	Double value defining the scale of this presentable object.
	theEntity	- entity of scalar field
	theFieldName	- the name of scalar field
	theTimeStampNumber	- the timestamp number for the scalar field

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ScalarMapOnDeformedShape.GetScale ( ) Entity VISU.ScalarMapOnDeformedShape.GetScalarEntity ( )

- - - - - -

- -	+ + -Gets the scale of the presentatable object.

- - - - -

- - - - - - - +Get scalar entity + +

+ +

void VISU.ScalarMapOnDeformedShape.SetScalarField

(

in string

theMeshName,

- - - - - - - - - - - - - - - - + + + + + +

in string	theFieldName,
in long	theIteration,
in Entity	theEntity	string VISU.ScalarMapOnDeformedShape.GetScalarFieldName	(	)

+ +

+Get scalar field name +

+ +

+ - - - + + + + +

) long VISU.ScalarMapOnDeformedShape.GetScalarTimeStampNumber ( )

- - - - - -

- -

+ +

-Sets the scalar field

Parameters:

- - - - - -

	theMeshName	- mesh name
	theFieldName	- the name of scalar field
	theIteration	- the iteration number for scalar field
	theEntity	- entity of scalar field

- - - - -

- +Get timestamp number for the scalar field + +

+ +

- - - - - - + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited] void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -	+ + Sets the type of scaling of the values reflected by the scalar bar. Parameters: @@ -380,68 +317,52 @@ Sets the type of scaling of the values reflected by the scalar bar.
	theScaling	The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited] Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -450,210 +371,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + +

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited] void VISU.ScalarMap.SetSourceRange ( ) [inherited]

- - - - - -

- -

+ +

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited] void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- +PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited] void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited] long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited] double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- +Gets the min boundary of the scalar bar. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited] double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

- - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -662,95 +604,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited] double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- +Gets horizontal position of the scalar bar origin. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited] double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -759,88 +677,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited] double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited] double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited] void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -848,60 +742,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited] long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited] void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -909,60 +787,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited] long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited] void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -970,205 +832,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited] string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

- - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + + +

in float theDy, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ + + + + + + + + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDy,
		in float	theDz		in float	theDz
	)	`[inherited]`		)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Gets offset parameters for the 3D presentation + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Gets memory size actually used by the presentation (Mb). + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.StreamLines Interface Reference

Member Enumeration Documentation

- - - - -

- + + +

+ +

- +

enum VISU::ScalarMap::Orientation [inherited] enum VISU::ColoredPrs3d::Orientation [inherited]

- - - - - -

- -

+ +

Orientation of the scalar bar (to provide backward compatibility).

Enumerator:

- -

HORIZONTAL	+
HORIZONTAL	Horizontal orientation of the scalar bar.
VERTICAL	+
VERTICAL	Vertical orientation of the scalar bar.

-Implemented in VISU.Plot3D, and VISU.CutPlanes.

+Implemented in VISU.Plot3D, and VISU.CutPlanes. + +

Member Function Documentation

- - - - -

- + +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

boolean VISU.StreamLines.SetParams	(	in double	theIntStep,	boolean VISU.StreamLines.SetParams	(	in double	theIntStep,
		in double	thePropogationTime,			in double	thePropogationTime,
		in double	theStepLength,			in double	theStepLength,
		in Prs3d	thePrs3d,			in Prs3d	thePrs3d,
		in double	thePercents,			in double	thePercents,
		in Direction	theDirection			in Direction	theDirection
	)				)

- - - -

- -	+ + Sets the parameters of the stream lines presentation. Parameters: @@ -270,194 +270,138 @@ Sets the parameters of the stream lines presentation. Paramet

- - - - -

- - - - - - - + + +

+ +

double VISU.StreamLines.GetIntegrationStep

(

)

+ + + + + +

double VISU.StreamLines.GetIntegrationStep ( )

- - - - - -

- -	+ + -Gets the value of integration step of the stream lines presentation.

- - - - -

- - - - - - - +Gets the value of integration step of the stream lines presentation. + +

+ +

double VISU.StreamLines.GetPropagationTime

(

)

+ + + + + +

double VISU.StreamLines.GetPropagationTime ( )

- - - - - -

- -	+ + -Gets the value of propagation time of the stream lines presentation.

- - - - -

- - - - - - - +Gets the value of propagation time of the stream lines presentation. + +

+ +

double VISU.StreamLines.GetStepLength

(

)

+ + + + + +

double VISU.StreamLines.GetStepLength ( )

- - - - - -

- -	+ + -Gets the value of step length of the stream lines presentation.

- - - - -

- - - - - - - +Gets the value of step length of the stream lines presentation. + +

+ +

Prs3d VISU.StreamLines.GetSource

(

)

+ + + + + +

Prs3d VISU.StreamLines.GetSource ( )

- - - - - -

- -	+ + -Returns the source presentation used for generation of the stream lines.

- - - - -

- - - - - - - +Returns the source presentation used for generation of the stream lines. + +

+ +

double VISU.StreamLines.GetUsedPoints

(

)

+ + + + + +

double VISU.StreamLines.GetUsedPoints ( )

- - - - - -

- -	+ + -Gets the quantity of points of the field used as starting points for generation of the stream lines presentation.

- - - - -

- - - - - - - +Gets the quantity of points of the field used as starting points for generation of the stream lines presentation. + +

+ +

Direction VISU.StreamLines.GetDirection

(

)

+ + + + + +

Direction VISU.StreamLines.GetDirection ( )

- - - - - -

- -	+ + -Returns the direction of the stream lines.

- - - - -

- - - - - - - - +Returns the direction of the stream lines. + +

+ +

void VISU.DeformedShape.SetScale ( in double theScale ) [inherited]

+ + + + + + +

void VISU.DeformedShape.SetScale ( in double theScale ) [inherited]

- - - -

- -

+ +

Sets the scale of the presentatable object.

Parameters:

@@ -465,86 +409,62 @@ Sets the scale of the presentatable object.

Parameters:

theScale

Double value defining the scale of this presentable object.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.DeformedShape.GetScale ( ) [inherited]

+ + + + + +

double VISU.DeformedShape.GetScale ( ) [inherited]

- - - - - -

- -	+ + -Gets the scale of the presentatable object.

- - - - -

- - - - - - - +Gets the scale of the presentatable object. + +

+ +

boolean VISU.DeformedShape.IsColored ( ) [inherited]

+ + + + + +

boolean VISU.DeformedShape.IsColored ( ) [inherited]

- - - - - -

- -	+ + -This boolean method returns True if this deformed shape presentation is colored.

- - - - -

- - - - - - - - +This boolean method returns True if this deformed shape presentation is colored. + +

+ +

void VISU.DeformedShape.ShowColored ( in boolean theColored ) [inherited]

+ + + + + + +

void VISU.DeformedShape.ShowColored ( in boolean theColored ) [inherited]

- - - -

- -	+ + Shows this presentation in colored mode. Parameters: @@ -552,60 +472,44 @@ Shows this presentation in colored mode. Parameters:
	theColored	If this boolean parameter is True this presentable object will be shown in colored mode.

- - - -

- - - - -

- - - - - - - + + +

+ +

SALOMEDS::Color VISU.DeformedShape.GetColor ( ) [inherited]

+ + + + + +

SALOMEDS::Color VISU.DeformedShape.GetColor ( ) [inherited]

- - - - - -

- -	+ + Gets the color of this presentable object. Returns: The color of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.DeformedShape.SetColor ( in SALOMEDS::Color theColor ) [inherited]

+ + + + + + +

void VISU.DeformedShape.SetColor ( in SALOMEDS::Color theColor ) [inherited]

- - - -

- -	+ + Sets the color of this presentation. Parameters: @@ -613,32 +517,24 @@ Sets the color of this presentation. Parameters:
	theColor	The color of this presentation. This parameter is taken from the Color enumeration.

- - - -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

+ + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -	+ + Sets the type of scaling of the values reflected by the scalar bar. Parameters: @@ -646,68 +542,52 @@ Sets the type of scaling of the values reflected by the scalar bar.
	theScaling	The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- - - - - - - + + +

+ +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

+ + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -716,210 +596,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ + + + + +

void VISU.ScalarMap.SetSourceRange ( ) [inherited]

- - - - - -

- -

+ +

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- - - - - - - + + +

+ +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited]

+ + + + + +

void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- - - - - - - - +PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- - - - - - - +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- - - - - - - +Gets the min boundary of the scalar bar. + +

+ +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

- - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -928,95 +829,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- - - - - - - +Gets horizontal position of the scalar bar origin. + +

+ +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -1025,88 +902,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- - - - - - - + + +

+ +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

+ + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -1114,60 +967,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -1175,60 +1012,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- - - - - - - + + +

+ +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

+ + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- - - - - - - - + + +

+ +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

+ + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -1236,205 +1057,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- - - - - - - + + +

+ +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

+ + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

- - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + + +

in float theDy, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ + + + + + - - - - + + + + - - - + + + + + + + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDz		in float	theDy,
	)	`[inherited]`			in float	theDz
	)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - +Gets offset parameters for the 3D presentation + +

+ +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

+ + + + + +

float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- - - - - - - +Gets memory size actually used by the presentation (Mb). + +

+ +

IdType VISU.Base.GetID ( ) [inherited]

+ + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- - - - - - - +Remove object from study. + +

+ +

VISUType VISU.Base.GetType ( ) [inherited]

+ + + + + +

IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.Table Interface Reference

Member Function Documentation

- - - - -

- + +

- - - - - - + + + + + +

void VISU.Table.SetTitle ( in string theTitle ) void VISU.Table.SetTitle ( in string theTitle )

- - - -

- -	+ + Sets the title of the table. Parameters: @@ -118,60 +106,44 @@ Sets the title of the table. Parameters:
	theTitle	String parameter defining the title of this table.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.Table.GetTitle ( ) string VISU.Table.GetTitle ( )

- - - - - -

- -	+ + Gets the title of the table. Returns: A string value containing the title of the table. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.Table.SetOrientation ( in Orientation theOrientation ) void VISU.Table.SetOrientation ( in Orientation theOrientation )

- - - -

- -	+ + Sets orientation of the table. Parameters: @@ -179,176 +151,128 @@ Sets orientation of the table. Parameters:
	theOrientation	This input parameter defines the orientation of the table. It is taken from the Orientation enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.Table.GetOrientation ( ) Orientation VISU.Table.GetOrientation ( )

- - - - - -

- -	+ + Gets orientation of the table. Returns: Orientation of the table. The returned value will correspond to one of the elements the Orientation enumeration. -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.Table.GetNbRows ( ) long VISU.Table.GetNbRows ( )

- - - - - -

- -	+ + Gets the number of rows of the table. Returns: Long value corresponding to the number of rows of the table -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.Table.GetNbColumns ( ) long VISU.Table.GetNbColumns ( )

- - - - - -

- -	+ + Gets the number of columns of the table. Returns: Long value corresponding to the number of columns of the table -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.TableView Interface Reference

- - - - -

- + + +

+ +

- +

enum VISU::View::ViewPosition [inherited] enum VISU::View::ViewPosition [inherited]

- - - -

- -	+ + Enumerator: @@ -201,233 +203,169 @@ displaying part ("ALL" isn't setable) Enumerator:

- - - + + +

Member Function Documentation

- - - - -

- + +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,	void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,
		in boolean	state			in boolean	state
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr ) [inherited] boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.SplitRight ( ) [inherited] void VISU.View.SplitRight ( ) [inherited]

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view is moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view is moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitLeft ( ) [inherited] void VISU.View.SplitLeft ( ) [inherited]

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitBottom ( ) [inherited] void VISU.View.SplitBottom ( ) [inherited]

- - - - - -

- -	+ + -Vertically split workarea of this view. This view is moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view is moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitTop ( ) [inherited] void VISU.View.SplitTop ( ) [inherited]

- - - - - -

- -	+ + -Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.OnTop ( ) [inherited] void VISU.View.OnTop ( ) [inherited]

- - - - - -

- -	+ + -Put this view window on top of its work area.

- - - - -

- +Put this view window on top of its work area. + +

+ +

- - - - - - + + + + + +

void VISU.View.Attract ( in View theView ) [inherited] void VISU.View.Attract ( in View theView ) [inherited]

- - - -

- -

+ +

Put theView in workarea of this view right after it. If theView was alone in its workarea, workarea of theView will be destroyed. If theView was in the same workarea with this view, simple reordering will take place.

Parameters:: @@ -435,32 +373,24 @@ Put theView in workarea of this view right after it. If theView

theView

A view window to be attracted to this one.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.AttractAll ( in View theView ) [inherited] void VISU.View.AttractAll ( in View theView ) [inherited]

- - - -

- -	+ + Put all the view windows from workarea of theView in workarea of this view right after it. Workarea of theView will be destroyed. If theView was in the same workarea with this view, simple reordering will take place. Parameters: @@ -468,32 +398,24 @@ Put all the view windows from workarea of theView in workarea of this v
	theView	A view window to be attracted to this one together with all its workarea.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativePositionInSplitter ( in double thePosition ) [inherited] void VISU.View.SetRelativePositionInSplitter ( in double thePosition ) [inherited]

- - - -

- -	+ + Set position of this view window relatively its splitter. Parameters: @@ -501,32 +423,24 @@ Set position of this view window relatively its splitter. Par
	thePosition	Desired position of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of positioning is defined by the splitter orientation. - - -

- - - - -

- +Direction of positioning is defined by the splitter orientation. + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativeSizeInSplitter ( in double theSize ) [inherited] void VISU.View.SetRelativeSizeInSplitter ( in double theSize ) [inherited]

- - - -

- -	+ + Set size of this view window relatively its splitter. Parameters: @@ -534,32 +448,24 @@ Set size of this view window relatively its splitter. Paramet
	theSize	Desired size of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of resizing is defined by the splitter orientation. - - -

- - - - -

- +Direction of resizing is defined by the splitter orientation. + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativePositionX ( in double thePosition ) [inherited] void VISU.View.SetRelativePositionX ( in double thePosition ) [inherited]

- - - -

- -

+ +

Set horizontal position of this view window relatively its workstack.

Parameters:

@@ -567,32 +473,24 @@ Set horizontal position of this view window relatively its workstack.

thePosition

Desired horizontal position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativePositionY ( in double thePosition ) [inherited] void VISU.View.SetRelativePositionY ( in double thePosition ) [inherited]

- - - -

- -	+ + Set vertical position of this view window relatively its workstack. Parameters: @@ -600,32 +498,24 @@ Set vertical position of this view window relatively its workstack.
	thePosition	Desired vertical position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativeSizeX ( in double theSize ) [inherited] void VISU.View.SetRelativeSizeX ( in double theSize ) [inherited]

- - - -

- -

+ +

Set horizontal size of this view window relatively its workstack.

Parameters:

@@ -633,32 +523,24 @@ Set horizontal size of this view window relatively its workstack.

theSize

Desired horizontal size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativeSizeY ( in double theSize ) [inherited] void VISU.View.SetRelativeSizeY ( in double theSize ) [inherited]

- - - -

- -	+ + Set vertical size of this view window relatively its workstack. Parameters: @@ -666,353 +548,257 @@ Set vertical size of this view window relatively its workstack.
	theSize	Desired vertical size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewWidth ( in long Width ) [inherited] void VISU.View.SetViewWidth ( in long Width ) [inherited]

- - - - - -

- -	+ + -Old methods for view parameters management, they don't work now

- - - - -

- +Old methods for view parameters management, they don't work now + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewHeight ( in long Height ) [inherited] void VISU.View.SetViewHeight ( in long Height ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewWidth ( ) [inherited] long VISU.View.GetViewWidth ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewHeight ( ) [inherited] long VISU.View.GetViewHeight ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor ) [inherited] void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer ) [inherited] void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativePosition	(	in double	x,	void VISU.View.SetRelativePosition	(	in double	x,
		in double	y			in double	y
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativeSize	(	in double	x,	void VISU.View.SetRelativeSize	(	in double	x,
		in double	y			in double	y
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Minimize ( ) [inherited] void VISU.View.Minimize ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Restore ( ) [inherited] void VISU.View.Restore ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Maximize ( ) [inherited] void VISU.View.Maximize ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetTitle ( in string theTitle ) [inherited] void VISU.View.SetTitle ( in string theTitle ) [inherited]

- - - -

- -	+ + Sets the title of the View frame. Parameters: @@ -1020,59 +806,43 @@ Sets the title of the View frame. Parameters:
	theTitle	String parameter defining the title of the View frame.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.View.GetTitle ( ) [inherited] string VISU.View.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the View frame.

- - - - -

- +Gets the title of the View frame. + +

+ +

- - - - - - + + + + + +

void VISU.View.SetBackground ( in SALOMEDS::Color theColor ) [inherited] void VISU.View.SetBackground ( in SALOMEDS::Color theColor ) [inherited]

- - - -

- -	+ + Sets background color of the View frame. Parameters: @@ -1080,113 +850,81 @@ Sets background color of the View frame. Parameters:
	theColor	Background color defined in SALOMEDS.Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.View.GetBackground ( ) [inherited] SALOMEDS::Color VISU.View.GetBackground ( ) [inherited]

- - - - - -

- -	+ + -Gets background color of the View frame.

- - - - -

- +Gets background color of the View frame. + +

+ +

- - - - - + + + + +

void VISU.View.EraseAll ( ) [inherited] void VISU.View.EraseAll ( ) [inherited]

- - - - - -

- -	+ + -Removes all presentations (presentable objects) from the view.

- - - - -

- +Removes all presentations (presentable objects) from the view. + +

+ +

- - - - - + + + + +

void VISU.View.DisplayAll ( ) [inherited] void VISU.View.DisplayAll ( ) [inherited]

- - - - - -

- -	+ + -Displays all presentations (presentable objects) in the view.

- - - - -

- +Displays all presentations (presentable objects) in the view. + +

+ +

- - - - - - + + + + + +

void VISU.View.Erase ( in PrsObject thePrsObj ) [inherited] void VISU.View.Erase ( in PrsObject thePrsObj ) [inherited]

- - - -

- -	+ + Removes a definite presentation (presentable object) from the view. Parameters: @@ -1194,32 +932,24 @@ Removes a definite presentation (presentable object) from the view.
	thePrsObj	The presentation (presentable object) which should be deleted.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.Display ( in PrsObject thePrsObj ) [inherited] void VISU.View.Display ( in PrsObject thePrsObj ) [inherited]

- - - -

- -	+ + Displays a definite presentation (presentable object) in the view. Parameters: @@ -1227,32 +957,24 @@ Displays a definite presentation (presentable object) in the view. <
	thePrsObj	The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.DisplayOnly ( in PrsObject thePrsObj ) [inherited] void VISU.View.DisplayOnly ( in PrsObject thePrsObj ) [inherited]

- - - -

- -	+ + Allows to display only a definite presentation (presentable object) in the view. All other presentations are removed from the view. Parameters: @@ -1260,59 +982,43 @@ Allows to display only a definite presentation (presentable object) in the view.
	thePrsObj	The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Update ( ) [inherited] void VISU.View.Update ( ) [inherited]

- - - - - -

- -	+ + -Updates the view.

- - - - -

- +Updates the view. + +

+ +

- - - - - - + + + + + +

boolean VISU.View.SavePicture ( in string theFileName ) [inherited] boolean VISU.View.SavePicture ( in string theFileName ) [inherited]

- - - -

- -	+ + Saves the view. Parameters: @@ -1321,65 +1027,49 @@ Saves the view. Parameters:

- - - - -

- + + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.VISU_Gen Interface Reference

- - - - -

- - - - - - - +Sets a definite study to be current. + +

+ +

SALOMEDS::Study VISU.VISU_Gen.GetCurrentStudy

(

)

+ + + + + +

SALOMEDS::Study VISU.VISU_Gen.GetCurrentStudy ( )

- - - - - -

- -	+ + -Gets the current study.

- - - - -

- - - - - - - +Gets the current study. + +

+ +

ViewManager VISU.VISU_Gen.GetViewManager

(

)

+ + + + + +

ViewManager VISU.VISU_Gen.GetViewManager ( )

- - - - - -

- -	+ + -Gets the View Manager which is used for creation of post-processing presentations.

- - - - -

- - - - - - - - +Gets the View Manager which is used for creation of post-processing presentations. + +

+ +

SALOMEDS::SObject VISU.VISU_Gen.ImportTables

(

in string

theFileName

)

+ + + + + + +

SALOMEDS::SObject VISU.VISU_Gen.ImportTables ( in string theFileName )

- - - - - -

- -	+ + -Imports tables from a file and create TableAttribute in Sudy

- - - - -

- +Imports tables from a file and create TableAttribute in Sudy + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

boolean VISU.VISU_Gen.ExportTableToFile	(	in SALOMEDS::SObject	theTable,	boolean VISU.VISU_Gen.ExportTableToFile	(	in SALOMEDS::SObject	theTable,
		in string	theFileName			in string	theFileName
	)				)

- - - - - -

- -	+ + -Export table to a file

- - - - -

- - - - - - - - +Export table to a file + +

+ +

Result VISU.VISU_Gen.ImportFile

(

in string

theFileName

)

+ + + + + + +

Result VISU.VISU_Gen.ImportFile ( in string theFileName )

- - - -

- -	+ + Imports data from a file. The access to this file will be conserved outside of the application. Parameters: @@ -280,32 +234,24 @@ Imports data from a file. The access to this file will be conserved outside of t
	theFileName	String parameter defining the name of the file from which the data will be imported.

- - - -

- - - - -

- - - - - - - - + + +

+ +

Result VISU.VISU_Gen.CreateResult

(

in string

theFileName

)

+ + + + + + +

Result VISU.VISU_Gen.CreateResult ( in string theFileName )

- - - -

- -	+ + Create result and initialize its with the file. The access to this file will be conserved outside of the application. Parameters: @@ -313,32 +259,24 @@ Create result and initialize its with the file. The access to this file will be
	theFileName	String parameter defining the name of the file from which the data will be imported.

- - - -

- - - - -

- - - - - - - - + + +

+ +

Result VISU.VISU_Gen.CopyAndImportFile

(

in string

theFileName

)

+ + + + + + +

Result VISU.VISU_Gen.CopyAndImportFile ( in string theFileName )

- - - -

- -	+ + Imports data from a file. The access to this file will closed. Parameters: @@ -346,1046 +284,894 @@ Imports data from a file. The access to this file will closed. <
	theFileName	String parameter defining the name of the file from which the data will be imported.

- - - -

- - - - -

- - - - - - - - + + +

+ +

Result VISU.VISU_Gen.ImportMed

(

in SALOMEDS::SObject

theMedSObject

)

+ + + + + + +

Result VISU.VISU_Gen.ImportMed ( in SALOMEDS::SObject theMedSObject )

- - - - - -

- -	+ + -Imports data from a MED object.

- - - - -

- - - - - - - - +Imports data from a MED object. + +

+ +

Result VISU.VISU_Gen.ImportMedField

(

in SALOME_MED::FIELD

theField

)

+ + + + + + +

Result VISU.VISU_Gen.ImportMedField ( in SALOME_MED::FIELD theField )

- - - - - -

- -	+ + -Imports data from a MED field.

- - - - -

- +Imports data from a MED field. + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.VISU_Gen.RenameEntityInStudy	(	in Result	theResult,	void VISU.VISU_Gen.RenameEntityInStudy	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theNewName			in string	theNewName
	)				)

- - - - - -

- -

+ +

Rename a study object, representing a mesh, specified by given values.

Parameters:

- - + +

	theResult	Data generated in other sources (MED object or file).
	theMeshName	One of the meshes presented in MED file.
	theResult	Data generated in other sources (MED object or file).
	theMeshName	One of the meshes presented in MED file.
	theEntity	Type of entity where the field is defined.
	theSubMeshName	Name of sub-mesh (group or family).
	theNewName	Name to be given to the study object.

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.VISU_Gen.RenameFamilyInStudy	(	in Result	theResult,	void VISU.VISU_Gen.RenameFamilyInStudy	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theSubMeshName,			in string	theSubMeshName,
		in string	theNewName			in string	theNewName
	)				)

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.VISU_Gen.RenameGroupInStudy	(	in Result	theResult,	void VISU.VISU_Gen.RenameGroupInStudy	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in string	theSubMeshName,			in string	theSubMeshName,
		in string	theNewName			in string	theNewName
	)				)

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

Mesh VISU.VISU_Gen.MeshOnEntity	(	in Result	theResult,	Mesh VISU.VISU_Gen.MeshOnEntity	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity			in Entity	theEntity
	)				)

- - - - - -

- -

+ +

-Creates a mesh on the basis of the data generated in other sources (MED object or file).

Parameters:

+Creates a mesh on the basis of the data generated in other sources (MED object or file).

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

Mesh VISU.VISU_Gen.FamilyMeshOnEntity	(	in Result	theResult,	Mesh VISU.VISU_Gen.FamilyMeshOnEntity	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFamilyName			in string	theFamilyName
	)				)

- - - - - -

- -

+ +

Creates on the basis of a family a mesh which will be composed of geometrical elements, corresponding to the type of cells (node, edge, face or cell) of this family.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined.

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

Mesh VISU.VISU_Gen.GroupMesh	(	in Result	theResult,	Mesh VISU.VISU_Gen.GroupMesh	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in string	theGroupName			in string	theGroupName
	)				)

- - - - - -

- -

+ +

Creates a mesh on the basis of a group of families.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theGroupName	Name of the group.

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

ScalarMap VISU.VISU_Gen.ScalarMapOnField	(	in Result	theResult,	ScalarMap VISU.VISU_Gen.ScalarMapOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a scalar map presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

GaussPoints VISU.VISU_Gen.GaussPointsOnField	(	in Result	theResult,	GaussPoints VISU.VISU_Gen.GaussPointsOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a Gauss Points presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

DeformedShape VISU.VISU_Gen.DeformedShapeOnField	(	in Result	theResult,	DeformedShape VISU.VISU_Gen.DeformedShapeOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a deformed shape presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

ScalarMapOnDeformedShape VISU.VISU_Gen.ScalarMapOnDeformedShapeOnField	(	in Result	theResult,	ScalarMapOnDeformedShape VISU.VISU_Gen.ScalarMapOnDeformedShapeOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a deformed shape presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

Vectors VISU.VISU_Gen.VectorsOnField	(	in Result	theResult,	Vectors VISU.VISU_Gen.VectorsOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a vector presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

IsoSurfaces VISU.VISU_Gen.IsoSurfacesOnField	(	in Result	theResult,	IsoSurfaces VISU.VISU_Gen.IsoSurfacesOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates an iso surface presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

StreamLines VISU.VISU_Gen.StreamLinesOnField	(	in Result	theResult,	StreamLines VISU.VISU_Gen.StreamLinesOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates an stream lines presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

CutPlanes VISU.VISU_Gen.CutPlanesOnField	(	in Result	theResult,	CutPlanes VISU.VISU_Gen.CutPlanesOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a presentation of cut planes.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

CutLines VISU.VISU_Gen.CutLinesOnField	(	in Result	theResult,	CutLines VISU.VISU_Gen.CutLinesOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a presentation of cut lines.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

Plot3D VISU.VISU_Gen.Plot3DOnField	(	in Result	theResult,	Plot3D VISU.VISU_Gen.Plot3DOnField	(	in Result	theResult,
		in string	theMeshName,			in string	theMeshName,
		in Entity	theEntity,			in Entity	theEntity,
		in string	theFieldName,			in string	theFieldName,
		in double	theIteration			in long	theIteration
	)				)

- - - - - -

- -

+ +

Creates a Plot3D presentation.

Parameters:

- - + +

	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theResult	Data generated in other sources. (MED object or file)
	theMeshName	One of the meshes presented in MED file
	theEntity	Type of entity where the field is defined
	theFieldName	Group of data attributed to the MESH. The data can be scalar or vector.
	theIteration	Number of iteration on the field

- - - - -

- - - - - - - - + + +

+ +

Table VISU.VISU_Gen.CreateTable

(

in string

theTableEntry

)

+ + + + + + +

Table VISU.VISU_Gen.CreateTable ( in string theTableEntry )

- - - -

- -	+ + Creates a table presentation. Parameters: @@ -1393,47 +1179,39 @@ Creates a table presentation. Parameters:
	theTableEntry	The entry of the table which will be displayed.

- - - -

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

Curve VISU.VISU_Gen.CreateCurve	(	in Table	theTable,	Curve VISU.VISU_Gen.CreateCurve	(	in Table	theTable,
		in long	theHRow,			in long	theHRow,
		in long	theVRow			in long	theVRow
	)				)

- - - -

- -	+ + Creates a curve on the basis of points, whose values are taken from the table. Parameters: @@ -1443,53 +1221,45 @@ Creates a curve on the basis of points, whose values are taken from the table. <
	VRow	Index of the row in the table: ordinate of the point.

- - - -

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

Curve VISU.VISU_Gen.CreateCurveWithZ	(	in Table	theTable,	Curve VISU.VISU_Gen.CreateCurveWithZ	(	in Table	theTable,
		in long	theHRow,			in long	theHRow,
		in long	theVRow,			in long	theVRow,
		in long	theZRow			in long	theZRow
	)				)

- - - -

- -	+ + Creates a curve on the basis of points, whose values are taken from the table. Each point has also assigned value, that will be shown as tooltip in Plot2d Parameters: @@ -1500,59 +1270,43 @@ Creates a curve on the basis of points, whose values are taken from the table. E
	ZRow	Index of the row in the table: assigned value (so-called as Z).

- - - -

- - - - -

- - - - - - - + + +

+ +

Container VISU.VISU_Gen.CreateContainer

(

)

+ + + + + +

Container VISU.VISU_Gen.CreateContainer ( )

- - - - - -

- -	+ + -Creates a presentation form containing an array of references to the curves.

- - - - -

- - - - - - - - +Creates a presentation form containing an array of references to the curves. + +

+ +

Animation VISU.VISU_Gen.CreateAnimation

(

in View3D

theView3d

)

+ + + + + + +

Animation VISU.VISU_Gen.CreateAnimation ( in View3D theView3d )

- - - -

- -	+ + Creates an animation in the 3D view. Parameters: @@ -1560,121 +1314,109 @@ Creates an animation in the 3D view. Parameters:
	theView3d	The 3D view, where the animation will be rendered.

- - - -

- - - - -

- - - - - - - - + + +

+ +

void VISU.VISU_Gen.DeleteResult

(

in Result

theResult

)

+ + + + + + +

void VISU.VISU_Gen.DeleteResult ( in Result theResult )

- - - - - -

- -

+ +

- - - - -

- - - - - - - - + + +

+ +

void VISU.VISU_Gen.DeletePrs3d

(

in Prs3d

thePrs3d

)

+ + + + + + +

void VISU.VISU_Gen.DeletePrs3d ( in Prs3d thePrs3d )

- - - - - -

- -

+ +

- - - - -

- - - - - - - + + +

+ +

IdType VISU.Base.GetID ( ) [inherited]

+ + + + + + +

ColoredPrs3dCache VISU.VISU_Gen.GetColoredPrs3dCache ( in SALOMEDS::Study theStudy )

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- - - - - - - +Get or create ColoredPrs3dCache object. + +

+ +

VISUType VISU.Base.GetType ( ) [inherited]

+ + + + + +

IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.Vectors Interface Reference

- - - - -

- + + +

+ +

- +

enum VISU::Vectors::GlyphPos enum VISU::Vectors::GlyphPos

- - - - In the head of the vector.

- -	+ + This enumeration contains a set of elements defining the position of the vector head. Enumerator: @@ -197,66 +213,50 @@ In the tail of the vector.

- - - -

- - - - -

- + + +

+ +

- +

enum VISU::ScalarMap::Orientation [inherited] enum VISU::ColoredPrs3d::Orientation [inherited]

- - - - - -

- -

+ +

Orientation of the scalar bar (to provide backward compatibility).

Enumerator:

- -

HORIZONTAL	+
HORIZONTAL	Horizontal orientation of the scalar bar.
VERTICAL	+
VERTICAL	Vertical orientation of the scalar bar.

-Implemented in VISU.Plot3D, and VISU.CutPlanes.

+Implemented in VISU.Plot3D, and VISU.CutPlanes. + +

Member Function Documentation

- - - - -

- + +

- - - - - - + + + + + +

void VISU.Vectors.SetLineWidth ( in double theWidth ) void VISU.Vectors.SetLineWidth ( in double theWidth )

- - - -

- -

+ +

Sets the width of the lines of the vectors.

Parameters:

@@ -264,59 +264,43 @@ Sets the width of the lines of the vectors.

Parameters:

theWidth

A double value defining the width of the lines of the vectors.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.Vectors.GetLineWidth ( ) double VISU.Vectors.GetLineWidth ( )

- - - - - -

- -	+ + -Gets the width of the lines of the vectors.

- - - - -

- +Gets the width of the lines of the vectors. + +

+ +

- - - - - - + + + + + +

void VISU.Vectors.SetGlyphType ( in GlyphType theType ) void VISU.Vectors.SetGlyphType ( in GlyphType theType )

- - - -

- -	+ + Sets the type of representation of the vector head. Parameters: @@ -324,59 +308,43 @@ Sets the type of representation of the vector head. Parameter
	theType	This parameter defines the type of representation of the vector head. This value is taken from the GlyphType enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

GlyphType VISU.Vectors.GetGlyphType ( ) GlyphType VISU.Vectors.GetGlyphType ( )

- - - - - -

- -	+ + -Gets the type of representation of the vector head.

- - - - -

- +Gets the type of representation of the vector head. + +

+ +

- - - - - - + + + + + +

void VISU.Vectors.SetGlyphPos ( in GlyphPos thePos ) void VISU.Vectors.SetGlyphPos ( in GlyphPos thePos )

- - - -

- -

+ +

Sets the position of the vector head.

Parameters:

@@ -384,59 +352,43 @@ Sets the position of the vector head.

Parameters:

thePos

This parameter defines the position of the vector head. This value is taken from the GlyphPos enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

GlyphPos VISU.Vectors.GetGlyphPos ( ) GlyphPos VISU.Vectors.GetGlyphPos ( )

- - - - - -

- -	+ + -Gets the position of the vector head.

- - - - -

- +Gets the position of the vector head. + +

+ +

- - - - - - + + + + + +

void VISU.DeformedShape.SetScale ( in double theScale ) [inherited] void VISU.DeformedShape.SetScale ( in double theScale ) [inherited]

- - - -

- -

+ +

Sets the scale of the presentatable object.

Parameters:

@@ -444,86 +396,62 @@ Sets the scale of the presentatable object.

Parameters:

theScale

Double value defining the scale of this presentable object.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.DeformedShape.GetScale ( ) [inherited] double VISU.DeformedShape.GetScale ( ) [inherited]

- - - - - -

- -	+ + -Gets the scale of the presentatable object.

- - - - -

- +Gets the scale of the presentatable object. + +

+ +

- - - - - + + + + +

boolean VISU.DeformedShape.IsColored ( ) [inherited] boolean VISU.DeformedShape.IsColored ( ) [inherited]

- - - - - -

- -	+ + -This boolean method returns True if this deformed shape presentation is colored.

- - - - -

- +This boolean method returns True if this deformed shape presentation is colored. + +

+ +

- - - - - - + + + + + +

void VISU.DeformedShape.ShowColored ( in boolean theColored ) [inherited] void VISU.DeformedShape.ShowColored ( in boolean theColored ) [inherited]

- - - -

- -	+ + Shows this presentation in colored mode. Parameters: @@ -531,60 +459,44 @@ Shows this presentation in colored mode. Parameters:
	theColored	If this boolean parameter is True this presentable object will be shown in colored mode.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.DeformedShape.GetColor ( ) [inherited] SALOMEDS::Color VISU.DeformedShape.GetColor ( ) [inherited]

- - - - - -

- -	+ + Gets the color of this presentable object. Returns: The color of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.DeformedShape.SetColor ( in SALOMEDS::Color theColor ) [inherited] void VISU.DeformedShape.SetColor ( in SALOMEDS::Color theColor ) [inherited]

- - - -

- -	+ + Sets the color of this presentation. Parameters: @@ -592,32 +504,24 @@ Sets the color of this presentation. Parameters:
	theColor	The color of this presentation. This parameter is taken from the Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited] void VISU.ScalarMap.SetScaling ( in Scaling theScaling ) [inherited]

- - - -

- -	+ + Sets the type of scaling of the values reflected by the scalar bar. Parameters: @@ -625,68 +529,52 @@ Sets the type of scaling of the values reflected by the scalar bar.
	theScaling	The value of this parameter is taken from the Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.ScalarMap.GetScaling ( ) [inherited] Scaling VISU.ScalarMap.GetScaling ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of scaling of the values reflected by this presentation.

- - - - -

- +Gets the type of scaling of the values reflected by this presentation. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ScalarMap.SetRange	(	in double	theMin,	void VISU.ScalarMap.SetRange	(	in double	theMin,
		in double	theMax			in double	theMax
	)	`[inherited]`			)			`[inherited]`

- - - -

- -

+ +

Sets scalar range - min and max boundaries of the scalar bar.

Parameters:

@@ -695,210 +583,231 @@ Sets scalar range - min and max boundaries of the scalar bar.

theMax

Max boundary of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + +

void VISU.ScalarMap.SetBarOrientation ( in Orientation theOrientation ) [inherited] void VISU.ScalarMap.SetSourceRange ( ) [inherited]

- - - - - -

- -

+ +

-Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:: +Sets scalar range that corresponds to the source data. +

+ +

+ + + + + + + + + +

void VISU.ScalarMap.AddMeshOnGroup ( in string theGroupName ) [inherited]

+ +

+Add group as geometry of presentation.

Parameters:

- + +

	theOrientation	This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.
	theMeshName	- mesh name
	theGroupName	- group name

- - - - -

- + + +

+ +

- - - - - + + + + +

Orientation VISU.ScalarMap.GetBarOrientation ( ) [inherited] void VISU.ScalarMap.RemoveAllGeom ( ) [inherited]

- - - - - -

- -	+ + -Gets the type of orientation of the scalar bar (to provide backward compatibility).

- - - - -

- +PrsMerger method: Remove all groups.(The scalar map will be placed on all mesh). + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited] void VISU.ColoredPrs3d.SetScalarMode ( in long theScalarMode ) [inherited]

- - - - - -

- -	+ + -Sets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Sets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited] long VISU.ColoredPrs3d.GetScalarMode ( ) [inherited]

- - - - - -

- -	+ + -Gets the method of coloring of the elements composing a 3D presentation.

- - - - -

- +Gets the method of coloring of the elements composing a 3D presentation. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMin ( ) [inherited] double VISU.ColoredPrs3d.GetMin ( ) [inherited]

- - - - - -

- -	+ + -Gets the min boundary of the scalar bar.

- - - - -

- +Gets the min boundary of the scalar bar. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetMax ( ) [inherited] double VISU.ColoredPrs3d.GetMax ( ) [inherited]

- - - - - -

- -	+ + -Gets the max boundary of the scalar bar.

- - - - -

- +Gets the max boundary of the scalar bar. + +

+ +

- - - - + + + + + +

void VISU.ColoredPrs3d.SetPosition ( in double X, double VISU.ColoredPrs3d.GetSourceMin ( ) [inherited]

+ +

+Gets the min boundary of the scalar bar from source data. +

+ +

+ - - - - + + + + + +

in double Y double VISU.ColoredPrs3d.GetSourceMax ( ) [inherited]

+ +

+Gets the max boundary of the scalar bar from source data. +

+ +

+ - - - + + + + +

) [inherited] boolean VISU.ColoredPrs3d.IsRangeFixed ( ) [inherited]

- - - -

- -

+ +

+Defines whether the scalar range corresponds to the source data or not. +

+ +

+ + + + + + + + + + + + + + + + + + +

void VISU.ColoredPrs3d.SetPosition	(	in double	X,
		in double	Y
	)			`[inherited]`

Sets the position of the scalar bar origin on the screen.

Parameters:

@@ -907,95 +816,71 @@ Sets the position of the scalar bar origin on the screen.

Par

Y Vertical position. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosX ( ) [inherited] double VISU.ColoredPrs3d.GetPosX ( ) [inherited]

- - - - - -

- -	+ + -Gets horizontal position of the scalar bar origin.

- - - - -

- +Gets horizontal position of the scalar bar origin. + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetPosY ( ) [inherited] double VISU.ColoredPrs3d.GetPosY ( ) [inherited]

- - - - - -

- -	+ + -Gets vertical position of the scalar bar origin.

- - - - -

- +Gets vertical position of the scalar bar origin. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,	void VISU.ColoredPrs3d.SetSize	(	in double	theWidth,
		in double	theHeight			in double	theHeight
	)	`[inherited]`			)			`[inherited]`

- - - -

- -	+ + Sets the size of the scalar bar. Parameters: @@ -1004,88 +889,64 @@ Sets the size of the scalar bar. Parameters:
	theHeight	Height of this presentable object. The value can be between 0 and 1.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetWidth ( ) [inherited] double VISU.ColoredPrs3d.GetWidth ( ) [inherited]

- - - - - -

- -	+ + Gets the width of this presentable object. Returns: A double value corresponding to the width of this presentable object. -

- - - - -

- + + +

+ +

- - - - - + + + + +

double VISU.ColoredPrs3d.GetHeight ( ) [inherited] double VISU.ColoredPrs3d.GetHeight ( ) [inherited]

- - - - - -

- -	+ + Gets the height of this presentable object. Returns: A double value corresponding to the height of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited] void VISU.ColoredPrs3d.SetNbColors ( in long theNbColors ) [inherited]

- - - -

- -	+ + Sets the number of colors which will be used for presentation of this presentable object. Parameters: @@ -1093,60 +954,44 @@ Sets the number of colors which will be used for presentation of this presentabl
	theNbColors	A long value defining the number of colors.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetNbColors ( ) [inherited] long VISU.ColoredPrs3d.GetNbColors ( ) [inherited]

- - - - - -

- -	+ + Gets the number of colors which will be used for visualization of this presentable object. Returns: A long value corresponding to the number of colors which will be used for visualization of this presentable object. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited] void VISU.ColoredPrs3d.SetLabels ( in long theNbLabels ) [inherited]

- - - -

- -	+ + Sets the number of labels which will be used for indication of color gradation of the scalar bar. Parameters: @@ -1154,60 +999,44 @@ Sets the number of labels which will be used for indication of color gradation o
	theNbLabels	A long value defining the number of labels.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.ColoredPrs3d.GetLabels ( ) [inherited] long VISU.ColoredPrs3d.GetLabels ( ) [inherited]

- - - - - -

- -	+ + Gets the number of labels which will be used for indication of color gradation of the scalar bar. Returns: A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited] void VISU.ColoredPrs3d.SetTitle ( in string theName ) [inherited]

- - - -

- -	+ + Sets the title of the scalar bar. By default - the name of the selected result is used. Parameters: @@ -1215,205 +1044,220 @@ Sets the title of the scalar bar. By default - the name of the selected result i
	theName	String parameter defining the name of the scalar bar.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.ColoredPrs3d.GetTitle ( ) [inherited] string VISU.ColoredPrs3d.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the scalar bar.

- - - - -

- +Gets the title of the scalar bar. + +

+ +

+ + + + + + + + +

void VISU.ColoredPrs3d.SetBarOrientation ( in Orientation theOrientation ) [inherited]

+ +

+Sets the type of orientation of the scalar bar (to provide backward compatibility).

Parameters:

+ + +

theOrientation

This parameter defines the orientation of the scalar bar. It is taken from the Orientaton enumeration.

+ +

+ - - - - + + + + + + +

void VISU.Prs3d.SetOffset ( in float theDx, Orientation VISU.ColoredPrs3d.GetBarOrientation ( ) [inherited]

+ +

+Gets the type of orientation of the scalar bar (to provide backward compatibility). +

+ +

+ + + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.SetOffset	(	in float	theDx,
		in float	theDy,		in float	theDy,
		in float	theDz		in float	theDz
	)	`[inherited]`		)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Move the 3D presentation according to the given offset parameters + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.Prs3d.GetOffset	(	out float	theDx,	void VISU.Prs3d.GetOffset	(	out float	theDx,
		out float	theDy,			out float	theDy,
		out float	theDz			out float	theDz
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- +Gets offset parameters for the 3D presentation + +

+ +

- - - - - + + + + +

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited] float VISU.Prs3d.GetMemorySize ( ) [inherited]

- - - - - -

- -	+ + -Remove object from study.

- - - - -

- +Gets memory size actually used by the presentation (Mb). + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Remove object from study. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns ID of the object. + +

VISU.View Interface Reference

- - - - -

- + + +

+ +

- +

enum VISU::View::ViewPosition enum VISU::View::ViewPosition

- - - -

- -	+ + Enumerator: @@ -203,233 +205,169 @@ displaying part ("ALL" isn't setable) Enumerator:

- - - + + +

Member Function Documentation

- - - - -

- + +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,	void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,
		in boolean	state			in boolean	state
	)				)

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr ) boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.SplitRight ( ) void VISU.View.SplitRight ( )

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view is moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view is moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitLeft ( ) void VISU.View.SplitLeft ( )

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitBottom ( ) void VISU.View.SplitBottom ( )

- - - - - -

- -	+ + -Vertically split workarea of this view. This view is moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view is moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitTop ( ) void VISU.View.SplitTop ( )

- - - - - -

- -	+ + -Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.OnTop ( ) void VISU.View.OnTop ( )

- - - - - -

- -	+ + -Put this view window on top of its work area.

- - - - -

- +Put this view window on top of its work area. + +

+ +

- - - - - - + + + + + +

void VISU.View.Attract ( in View theView ) void VISU.View.Attract ( in View theView )

- - - -

- -

+ +

Parameters:: @@ -437,32 +375,24 @@ Put theView in workarea of this view right after it. If theView

theView

A view window to be attracted to this one.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.AttractAll ( in View theView ) void VISU.View.AttractAll ( in View theView )

- - - -

- -	+ + Put all the view windows from workarea of theView in workarea of this view right after it. Workarea of theView will be destroyed. If theView was in the same workarea with this view, simple reordering will take place. Parameters: @@ -470,32 +400,24 @@ Put all the view windows from workarea of theView in workarea of this v
	theView	A view window to be attracted to this one together with all its workarea.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativePositionInSplitter ( in double thePosition ) void VISU.View.SetRelativePositionInSplitter ( in double thePosition )

- - - -

- -	+ + Set position of this view window relatively its splitter. Parameters: @@ -503,32 +425,24 @@ Set position of this view window relatively its splitter. Par
	thePosition	Desired position of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of positioning is defined by the splitter orientation. - - -

- - - - -

- +Direction of positioning is defined by the splitter orientation. + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativeSizeInSplitter ( in double theSize ) void VISU.View.SetRelativeSizeInSplitter ( in double theSize )

- - - -

- -	+ + Set size of this view window relatively its splitter. Parameters: @@ -536,32 +450,24 @@ Set size of this view window relatively its splitter. Paramet
	theSize	Desired size of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of resizing is defined by the splitter orientation. - - -

- - - - -

- +Direction of resizing is defined by the splitter orientation. + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativePositionX ( in double thePosition ) void VISU.View.SetRelativePositionX ( in double thePosition )

- - - -

- -

+ +

Set horizontal position of this view window relatively its workstack.

Parameters:

@@ -569,32 +475,24 @@ Set horizontal position of this view window relatively its workstack.

thePosition

Desired horizontal position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativePositionY ( in double thePosition ) void VISU.View.SetRelativePositionY ( in double thePosition )

- - - -

- -	+ + Set vertical position of this view window relatively its workstack. Parameters: @@ -602,32 +500,24 @@ Set vertical position of this view window relatively its workstack.
	thePosition	Desired vertical position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativeSizeX ( in double theSize ) void VISU.View.SetRelativeSizeX ( in double theSize )

- - - -

- -

+ +

Set horizontal size of this view window relatively its workstack.

Parameters:

@@ -635,32 +525,24 @@ Set horizontal size of this view window relatively its workstack.

theSize

Desired horizontal size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetRelativeSizeY ( in double theSize ) void VISU.View.SetRelativeSizeY ( in double theSize )

- - - -

- -	+ + Set vertical size of this view window relatively its workstack. Parameters: @@ -668,353 +550,257 @@ Set vertical size of this view window relatively its workstack.
	theSize	Desired vertical size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewWidth ( in long Width ) void VISU.View.SetViewWidth ( in long Width )

- - - - - -

- -	+ + -Old methods for view parameters management, they don't work now

- - - - -

- +Old methods for view parameters management, they don't work now + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewHeight ( in long Height ) void VISU.View.SetViewHeight ( in long Height )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewWidth ( ) long VISU.View.GetViewWidth ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewHeight ( ) long VISU.View.GetViewHeight ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor ) void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer ) void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativePosition	(	in double	x,	void VISU.View.SetRelativePosition	(	in double	x,
		in double	y			in double	y
	)				)

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativeSize	(	in double	x,	void VISU.View.SetRelativeSize	(	in double	x,
		in double	y			in double	y
	)				)

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Minimize ( ) void VISU.View.Minimize ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Restore ( ) void VISU.View.Restore ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Maximize ( ) void VISU.View.Maximize ( )

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.SetTitle ( in string theTitle ) void VISU.View.SetTitle ( in string theTitle )

- - - -

- -	+ + Sets the title of the View frame. Parameters: @@ -1022,59 +808,43 @@ Sets the title of the View frame. Parameters:
	theTitle	String parameter defining the title of the View frame.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.View.GetTitle ( ) string VISU.View.GetTitle ( )

- - - - - -

- -	+ + -Gets the title of the View frame.

- - - - -

- +Gets the title of the View frame. + +

+ +

- - - - - - + + + + + +

void VISU.View.SetBackground ( in SALOMEDS::Color theColor ) void VISU.View.SetBackground ( in SALOMEDS::Color theColor )

- - - -

- -	+ + Sets background color of the View frame. Parameters: @@ -1082,113 +852,81 @@ Sets background color of the View frame. Parameters:
	theColor	Background color defined in SALOMEDS.Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.View.GetBackground ( ) SALOMEDS::Color VISU.View.GetBackground ( )

- - - - - -

- -	+ + -Gets background color of the View frame.

- - - - -

- +Gets background color of the View frame. + +

+ +

- - - - - + + + + +

void VISU.View.EraseAll ( ) void VISU.View.EraseAll ( )

- - - - - -

- -	+ + -Removes all presentations (presentable objects) from the view.

- - - - -

- +Removes all presentations (presentable objects) from the view. + +

+ +

- - - - - + + + + +

void VISU.View.DisplayAll ( ) void VISU.View.DisplayAll ( )

- - - - - -

- -	+ + -Displays all presentations (presentable objects) in the view.

- - - - -

- +Displays all presentations (presentable objects) in the view. + +

+ +

- - - - - - + + + + + +

void VISU.View.Erase ( in PrsObject thePrsObj ) void VISU.View.Erase ( in PrsObject thePrsObj )

- - - -

- -	+ + Removes a definite presentation (presentable object) from the view. Parameters: @@ -1196,32 +934,24 @@ Removes a definite presentation (presentable object) from the view.
	thePrsObj	The presentation (presentable object) which should be deleted.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.Display ( in PrsObject thePrsObj ) void VISU.View.Display ( in PrsObject thePrsObj )

- - - -

- -	+ + Displays a definite presentation (presentable object) in the view. Parameters: @@ -1229,32 +959,24 @@ Displays a definite presentation (presentable object) in the view. <
	thePrsObj	The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- + + +

+ +

- - - - - - + + + + + +

void VISU.View.DisplayOnly ( in PrsObject thePrsObj ) void VISU.View.DisplayOnly ( in PrsObject thePrsObj )

- - - -

- -	+ + Allows to display only a definite presentation (presentable object) in the view. All other presentations are removed from the view. Parameters: @@ -1262,59 +984,43 @@ Allows to display only a definite presentation (presentable object) in the view.
	thePrsObj	The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Update ( ) void VISU.View.Update ( )

- - - - - -

- -	+ + -Updates the view.

- - - - -

- +Updates the view. + +

+ +

- - - - - - + + + + + +

boolean VISU.View.SavePicture ( in string theFileName ) boolean VISU.View.SavePicture ( in string theFileName )

- - - -

- -	+ + Saves the view. Parameters: @@ -1323,65 +1029,49 @@ Saves the view. Parameters:

- - - - -

- + + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.View3D Interface Reference

Member Enumeration Documentation

- - - - -

- + +

- +

enum VISU::View3D::ViewType enum VISU::View3D::ViewType

- - - -

- -	+ + This enumeration contains a set of elements determining a predefined point of view (position of the camera in 3D space relative to the presentable object). Enumerator: @@ -258,27 +270,19 @@ This enumeration contains a set of elements determining a predefined point of vi

- - - -

- - - - -

- + + +

+ +

- +

enum VISU::View3D::Axis enum VISU::View3D::Axis

- - - -

- -	+ + This enumeration contains a set of elements determining the axis Enumerator: @@ -291,27 +295,19 @@ This enumeration contains a set of elements determining the axis

- - - -

- - - - -

- + + +

+ +

- +

enum VISU::View::ViewRepresentation [inherited] enum VISU::View::ViewRepresentation [inherited]

- - - -

- -	+ + displaying part ("ALL" isn't setable) Enumerator: @@ -326,27 +322,19 @@ displaying part ("ALL" isn't setable) Enumerator:

- - - -

- - - - -

- + + +

+ +

- +

enum VISU::View::ViewPosition [inherited] enum VISU::View::ViewPosition [inherited]

- - - -

- -	+ + Enumerator: @@ -363,317 +351,229 @@ displaying part ("ALL" isn't setable) Enumerator:

- - - + + +

Member Function Documentation

- - - - -

- + +

- - - - - + + + + +

void VISU.View3D.FitAll ( ) void VISU.View3D.FitAll ( )

- - - - - -

- -	+ + -Makes all presentations, which are currently present in the view, completely visible.

- - - - -

- - - - - - - - - -

void VISU.View3D.SetView

(

in ViewType

theType

)

- - - - - -

- -

+Makes all presentations, which are currently present in the view, completely visible. + +

+ +

+ + + + + + + + + +

void VISU.View3D.SetView ( in ViewType theType )

-Sets a predefined point of view (FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM). (In other words it means a predefined position of the camera in 3D space with respect to the object which is represented.)

- - - - -

- - - - - - - - - -

void VISU.View3D.SetPointOfView

(

in XYZ

theCoord

)

- - - - - -

- -

+Sets a predefined point of view (FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM). (In other words it means a predefined position of the camera in 3D space with respect to the object which is represented.) + +

+ +

+ + + + + + + + + +

void VISU.View3D.SetPointOfView ( in XYZ theCoord )

-Sets the position of the camera in 3D space. This point is used as the first point of the vector defining the view direction of the camera.

- - - - -

- +Sets the position of the camera in 3D space. This point is used as the first point of the vector defining the view direction of the camera. + +

+ +

- - - - - + + + + +

XYZ VISU.View3D.GetPointOfView ( ) XYZ VISU.View3D.GetPointOfView ( )

- - - - - -

- -	+ + -Gets the position of the camera in 3D space. This point is used as the first point of the vector defining the view direction of the camera.

- - - - -

- - - - - - - - - -

void VISU.View3D.SetViewUp

(

in XYZ

theDir

)

- - - - - -

- -

+Gets the position of the camera in 3D space. This point is used as the first point of the vector defining the view direction of the camera. + +

+ +

+ + + + + + + + + +

void VISU.View3D.SetViewUp ( in XYZ theDir )

-Sets the vertical line of the camera in 3D space.

- - - - -

- +Sets the vertical line of the camera in 3D space. + +

+ +

- - - - - + + + + +

XYZ VISU.View3D.GetViewUp ( ) XYZ VISU.View3D.GetViewUp ( )

- - - - - -

- -	+ + -Gets the vertical line of the camera in 3D space.

- - - - -

- - - - - - - - - -

void VISU.View3D.SetFocalPoint

(

in XYZ

theDir

)

- - - - - -

- -

+Gets the vertical line of the camera in 3D space. + +

+ +

+ + + + + + + + + +

void VISU.View3D.SetFocalPoint ( in XYZ theDir )

-Sets the point of sight of the camera. This point is used as the second point of the vector defining the view direction of the camera.

- - - - -

- +Sets the point of sight of the camera. This point is used as the second point of the vector defining the view direction of the camera. + +

+ +

- - - - - + + + + +

XYZ VISU.View3D.GetFocalPoint ( ) XYZ VISU.View3D.GetFocalPoint ( )

- - - - - -

- -	+ + -Gets the point of sight of the camera. This point is used as the second point of the vector defining the view direction of the camera.

- - - - -

- - - - - - - - - -

void VISU.View3D.SetParallelScale

(

in double

theScale

)

- - - - - -

- -

+Gets the point of sight of the camera. This point is used as the second point of the vector defining the view direction of the camera. + +

+ +

+ + + + + + + + + +

void VISU.View3D.SetParallelScale ( in double theScale )

-Zooming of the presentable object. Sets the scale.

- - - - -

- +Zooming of the presentable object. Sets the scale. + +

+ +

- - - - - + + + + +

double VISU.View3D.GetParallelScale ( ) double VISU.View3D.GetParallelScale ( )

- - - - - -

- -	+ + -Zooming of the presentable object. Gets the scale.

- - - - -

- +Zooming of the presentable object. Gets the scale. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View3D.ScaleView	(	in Axis	theAxis,	void VISU.View3D.ScaleView	(	in Axis	theAxis,
		in double	theParam			in double	theParam
	)				)

- - - -

- -

+ +

Scaling of the view along a definite axis.

Parameters:

@@ -682,59 +582,43 @@ Scaling of the view along a definite axis.

Parameters:

theParam

The coefficient of the scaling

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View3D.RemoveScale ( ) void VISU.View3D.RemoveScale ( )

- - - - - -

- -	+ + -Removes the scaling of the view.

- - - - -

- - - - - - - - - -

boolean VISU.View3D.SaveViewParams

(

in string

theName

)

- - - -

- -

+Removes the scaling of the view. + +

+ +

+ + + + + + + + + +

boolean VISU.View3D.SaveViewParams ( in string theName )

Saves view parameters.

Returns:: True if the view parameters have been created, False if the parameters have been modified.

@@ -743,32 +627,24 @@ Saves view parameters.

Returns:: True if the view

theName The name under which the view parameters will be saved.

- - - -

- - - - -

- - - - - - - - - -

boolean VISU.View3D.RestoreViewParams

(

in string

theName

)

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

boolean VISU.View3D.RestoreViewParams ( in string theName )

Restores view parameters.

Returns:: True if the view parameters have been found and applied to the view, False if the parameters with this name don't exist.

@@ -777,32 +653,24 @@ Restores view parameters.

Returns:: True if the vi

theName The name of the view parameters which will be restored.

- - - -

- - - - -

- - - - - - - - - -

PresentationType VISU.View3D.GetPresentationType

(

in ScalarMap

thePrs

)

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

PresentationType VISU.View3D.GetPresentationType ( in ScalarMap thePrs )

Get representation type of the given presentation in this view.

Parameters:

@@ -811,41 +679,33 @@ Get representation type of the given presentation in this view.

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

string VISU.View3D.SetPresentationType	(	in ScalarMap	thePrs,	string VISU.View3D.SetPresentationType	(	in ScalarMap	thePrs,
		in PresentationType	thePrsType			in PresentationType	thePrsType
	)				)

- - - -

- -	+ + Set representation type of the given presentation in this view. Parameters: @@ -855,32 +715,24 @@ Set representation type of the given presentation in this view.

- - - - -

- - - - - - - - - -

boolean VISU.View3D.IsShrinked

(

in ScalarMap

thePrs

)

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

boolean VISU.View3D.IsShrinked ( in ScalarMap thePrs )

Get shrink state of the given presentation in this view.

Parameters:

@@ -889,41 +741,33 @@ Get shrink state of the given presentation in this view.

Para

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

string VISU.View3D.SetShrinked	(	in ScalarMap	thePrs,	string VISU.View3D.SetShrinked	(	in ScalarMap	thePrs,
		in boolean	isShrinked			in boolean	isShrinked
	)				)

- - - -

- -	+ + Make the given presentation shrinked or not shrinked in this view. Parameters: @@ -933,32 +777,24 @@ Make the given presentation shrinked or not shrinked in this view. <

- - - - -

- - - - - - - - - -

boolean VISU.View3D.IsShaded

(

in ScalarMap

thePrs

)

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

boolean VISU.View3D.IsShaded ( in ScalarMap thePrs )

Get shading state of the given presentation in this view.

Parameters:

@@ -967,41 +803,33 @@ Get shading state of the given presentation in this view.

Par

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

string VISU.View3D.SetShaded	(	in ScalarMap	thePrs,	string VISU.View3D.SetShaded	(	in ScalarMap	thePrs,
		in boolean	isShaded			in boolean	isShaded
	)				)

- - - -

- -	+ + Make the given presentation shaded or not shaded in this view. Parameters: @@ -1011,32 +839,24 @@ Make the given presentation shaded or not shaded in this view. <

- - - - -

- - - - - - - - - -

double VISU.View3D.GetOpacity

(

in ScalarMap

thePrs

)

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

double VISU.View3D.GetOpacity ( in ScalarMap thePrs )

Get opacity of the given presentation in this view.

Parameters:

@@ -1045,41 +865,33 @@ Get opacity of the given presentation in this view.

Parameter

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

string VISU.View3D.SetOpacity	(	in ScalarMap	thePrs,	string VISU.View3D.SetOpacity	(	in ScalarMap	thePrs,
		in double	theOpacity			in double	theOpacity
	)				)

- - - -

- -	+ + Set opacity of the given presentation in this view. Parameters: @@ -1089,32 +901,24 @@ Set opacity of the given presentation in this view. Parameter

- - - - -

- - - - - - - - - -

double VISU.View3D.GetLineWidth

(

in ScalarMap

thePrs

)

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

double VISU.View3D.GetLineWidth ( in ScalarMap thePrs )

Get line width of the given presentation in this view.

Parameters:

@@ -1123,41 +927,33 @@ Get line width of the given presentation in this view.

Parame

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

string VISU.View3D.SetLineWidth	(	in ScalarMap	thePrs,	string VISU.View3D.SetLineWidth	(	in ScalarMap	thePrs,
		in double	theLineWidth			in double	theLineWidth
	)				)

- - - -

- -	+ + Set line width of the given presentation in this view. Parameters: @@ -1167,232 +963,168 @@ Set line width of the given presentation in this view. Parame

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,	void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,
		in boolean	state			in boolean	state
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - - - -

boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr ) [inherited]

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.SplitRight ( ) [inherited] void VISU.View.SplitRight ( ) [inherited]

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view is moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view is moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitLeft ( ) [inherited] void VISU.View.SplitLeft ( ) [inherited]

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitBottom ( ) [inherited] void VISU.View.SplitBottom ( ) [inherited]

- - - - - -

- -	+ + -Vertically split workarea of this view. This view is moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view is moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitTop ( ) [inherited] void VISU.View.SplitTop ( ) [inherited]

- - - - - -

- -	+ + -Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.OnTop ( ) [inherited] void VISU.View.OnTop ( ) [inherited]

- - - - - -

- -	+ + -Put this view window on top of its work area.

- - - - -

- - - - - - - - - -

void VISU.View.Attract ( in View theView ) [inherited]

- - - -

- -

+Put this view window on top of its work area. + +

+ +

+ + + + + + + + + +

void VISU.View.Attract ( in View theView ) [inherited]

Parameters:: @@ -1400,32 +1132,24 @@ Put theView in workarea of this view right after it. If theView

theView

A view window to be attracted to this one.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.AttractAll ( in View theView ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.AttractAll ( in View theView ) [inherited]

Put all the view windows from workarea of theView in workarea of this view right after it. Workarea of theView will be destroyed. If theView was in the same workarea with this view, simple reordering will take place.

Parameters:: @@ -1433,32 +1157,24 @@ Put all the view windows from workarea of theView in workarea of this v

theView A view window to be attracted to this one together with all its workarea.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativePositionInSplitter ( in double thePosition ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativePositionInSplitter ( in double thePosition ) [inherited]

Set position of this view window relatively its splitter.

Parameters:

@@ -1466,32 +1182,24 @@ Set position of this view window relatively its splitter.

Par

thePosition Desired position of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of positioning is defined by the splitter orientation. - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativeSizeInSplitter ( in double theSize ) [inherited]

- - - -

- -

+Direction of positioning is defined by the splitter orientation. + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativeSizeInSplitter ( in double theSize ) [inherited]

Set size of this view window relatively its splitter.

Parameters:

@@ -1499,32 +1207,24 @@ Set size of this view window relatively its splitter.

Paramet

theSize Desired size of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of resizing is defined by the splitter orientation. - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativePositionX ( in double thePosition ) [inherited]

- - - -

- -

+Direction of resizing is defined by the splitter orientation. + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativePositionX ( in double thePosition ) [inherited]

Set horizontal position of this view window relatively its workstack.

Parameters:

@@ -1532,32 +1232,24 @@ Set horizontal position of this view window relatively its workstack.

thePosition

Desired horizontal position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativePositionY ( in double thePosition ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativePositionY ( in double thePosition ) [inherited]

Set vertical position of this view window relatively its workstack.

Parameters:

@@ -1565,32 +1257,24 @@ Set vertical position of this view window relatively its workstack.

thePosition Desired vertical position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativeSizeX ( in double theSize ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativeSizeX ( in double theSize ) [inherited]

Set horizontal size of this view window relatively its workstack.

Parameters:

@@ -1598,32 +1282,24 @@ Set horizontal size of this view window relatively its workstack.

theSize

Desired horizontal size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativeSizeY ( in double theSize ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativeSizeY ( in double theSize ) [inherited]

Set vertical size of this view window relatively its workstack.

Parameters:

@@ -1631,353 +1307,257 @@ Set vertical size of this view window relatively its workstack.

theSize Desired vertical size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetViewWidth ( in long Width ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewWidth ( in long Width ) [inherited]

-Old methods for view parameters management, they don't work now

- - - - -

- - - - - - - - - -

void VISU.View.SetViewHeight ( in long Height ) [inherited]

- - - - - -

- -

+Old methods for view parameters management, they don't work now + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewHeight ( in long Height ) [inherited]

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewWidth ( ) [inherited] long VISU.View.GetViewWidth ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewHeight ( ) [inherited] long VISU.View.GetViewHeight ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- - - - - - - - - -

void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor ) [inherited]

- - - - -

- - - - - - - - - -

void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer ) [inherited]

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativePosition	(	in double	x,	void VISU.View.SetRelativePosition	(	in double	x,
		in double	y			in double	y
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativeSize	(	in double	x,	void VISU.View.SetRelativeSize	(	in double	x,
		in double	y			in double	y
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Minimize ( ) [inherited] void VISU.View.Minimize ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Restore ( ) [inherited] void VISU.View.Restore ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Maximize ( ) [inherited] void VISU.View.Maximize ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- - - - - - - - - -

void VISU.View.SetTitle ( in string theTitle ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetTitle ( in string theTitle ) [inherited]

Sets the title of the View frame.

Parameters:

@@ -1985,59 +1565,43 @@ Sets the title of the View frame.

Parameters:

theTitle String parameter defining the title of the View frame.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.View.GetTitle ( ) [inherited] string VISU.View.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the View frame.

- - - - -

- - - - - - - - - -

void VISU.View.SetBackground ( in SALOMEDS::Color theColor ) [inherited]

- - - -

- -

+Gets the title of the View frame. + +

+ +

+ + + + + + + + + +

void VISU.View.SetBackground ( in SALOMEDS::Color theColor ) [inherited]

Sets background color of the View frame.

Parameters:

@@ -2045,113 +1609,81 @@ Sets background color of the View frame.

Parameters:

theColor Background color defined in SALOMEDS.Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.View.GetBackground ( ) [inherited] SALOMEDS::Color VISU.View.GetBackground ( ) [inherited]

- - - - - -

- -	+ + -Gets background color of the View frame.

- - - - -

- +Gets background color of the View frame. + +

+ +

- - - - - + + + + +

void VISU.View.EraseAll ( ) [inherited] void VISU.View.EraseAll ( ) [inherited]

- - - - - -

- -	+ + -Removes all presentations (presentable objects) from the view.

- - - - -

- +Removes all presentations (presentable objects) from the view. + +

+ +

- - - - - + + + + +

void VISU.View.DisplayAll ( ) [inherited] void VISU.View.DisplayAll ( ) [inherited]

- - - - - -

- -	+ + -Displays all presentations (presentable objects) in the view.

- - - - -

- - - - - - - - - -

void VISU.View.Erase ( in PrsObject thePrsObj ) [inherited]

- - - -

- -

+Displays all presentations (presentable objects) in the view. + +

+ +

+ + + + + + + + + +

void VISU.View.Erase ( in PrsObject thePrsObj ) [inherited]

Removes a definite presentation (presentable object) from the view.

Parameters:

@@ -2159,32 +1691,24 @@ Removes a definite presentation (presentable object) from the view.

thePrsObj The presentation (presentable object) which should be deleted.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.Display ( in PrsObject thePrsObj ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.Display ( in PrsObject thePrsObj ) [inherited]

Displays a definite presentation (presentable object) in the view.

Parameters:

@@ -2192,32 +1716,24 @@ Displays a definite presentation (presentable object) in the view.

thePrsObj The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.DisplayOnly ( in PrsObject thePrsObj ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.DisplayOnly ( in PrsObject thePrsObj ) [inherited]

Allows to display only a definite presentation (presentable object) in the view. All other presentations are removed from the view.

Parameters:: @@ -2225,59 +1741,43 @@ Allows to display only a definite presentation (presentable object) in the view.

thePrsObj The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Update ( ) [inherited] void VISU.View.Update ( ) [inherited]

- - - - - -

- -	+ + -Updates the view.

- - - - -

- - - - - - - - - -

boolean VISU.View.SavePicture ( in string theFileName ) [inherited]

- - - -

- -

+Updates the view. + +

+ +

+ + + + + + + + + +

boolean VISU.View.SavePicture ( in string theFileName ) [inherited]

Saves the view.

Parameters:

@@ -2286,65 +1786,49 @@ Saves the view.

Parameters:

- - - - -

- + + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.ViewManager Interface Reference

- - - - -

- + + +

+ +

- - - - - + + + + +

View3D VISU.ViewManager.Create3DView ( ) View3D VISU.ViewManager.Create3DView ( )

- - - - - -

- -	+ + -Returns an object reference to the newly created 3D View.

- - - - -

- +Returns an object reference to the newly created 3D View. + +

+ +

- - - - - - + + + + + +

TableView VISU.ViewManager.CreateTableView ( in Table theTable ) TableView VISU.ViewManager.CreateTableView ( in Table theTable )

- - - - - -

- -	+ + -Returns an object reference to the newly created Table View.

- - - - -

- +Returns an object reference to the newly created Table View. + +

+ +

- - - - - + + + + +

XYPlot VISU.ViewManager.CreateXYPlot ( ) XYPlot VISU.ViewManager.CreateXYPlot ( )

- - - - - -

- -	+ + -Returns an object reference to the newly created 2D plot View.

- - - - -

- +Returns an object reference to the newly created 2D plot View. + +

+ +

- - - - - - + + + + + +

void VISU.ViewManager.Destroy ( in View theView ) void VISU.ViewManager.Destroy ( in View theView )

- - - -

- -	+ + Deletes a definite view. Parameters: @@ -190,65 +150,49 @@ Deletes a definite view. Parameters:
	theView	The view which should be deleted.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +

VISU.XYPlot Interface Reference

- - - - -

- + + +

+ +

- +

enum VISU::View::ViewRepresentation [inherited] enum VISU::View::ViewRepresentation [inherited]

- - - -

- -	+ + displaying part ("ALL" isn't setable) Enumerator: @@ -246,27 +254,19 @@ displaying part ("ALL" isn't setable) Enumerator:

- - - -

- - - - -

- + + +

+ +

- +

enum VISU::View::ViewPosition [inherited] enum VISU::View::ViewPosition [inherited]

- - - -

- -	+ + Enumerator: @@ -283,33 +283,25 @@ displaying part ("ALL" isn't setable) Enumerator:

- - - + + +

Member Function Documentation

- - - - -

- - - - - - - - - -

void VISU.XYPlot.SetSubTitle

(

in string

theTitle

)

- - - -

- -

+ +

+ + + + + + + + + +

void VISU.XYPlot.SetSubTitle ( in string theTitle )

Sets the title of the XY plot

Parameters:

@@ -317,59 +309,43 @@ Sets the title of the XY plot

Parameters:

theTitle The title of the XY plot

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.XYPlot.GetSubTitle ( ) string VISU.XYPlot.GetSubTitle ( )

- - - - - -

- -	+ + -Gets the title of the XY plot

- - - - -

- - - - - - - - - -

void VISU.XYPlot.SetCurveType

(

in CurveType

theType

)

- - - -

- -

+Gets the title of the XY plot + +

+ +

+ + + + + + + + + +

void VISU.XYPlot.SetCurveType ( in CurveType theType )

Sets the type of the curve lines.

Parameters:

@@ -377,59 +353,43 @@ Sets the type of the curve lines.

Parameters:

theType The type of the curve lines taken from CurveType enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

CurveType VISU.XYPlot.GetCurveType ( ) CurveType VISU.XYPlot.GetCurveType ( )

- - - - - -

- -	+ + -Gets the type of the curve lines.

- - - - -

- - - - - - - - - -

void VISU.XYPlot.SetMarkerSize

(

in long

theSize

)

- - - -

- -

+Gets the type of the curve lines. + +

+ +

+ + + + + + + + + +

void VISU.XYPlot.SetMarkerSize ( in long theSize )

Sets the size of the markers (data points) with help of which the curve is constructed on the graphics.

Parameters:: @@ -437,157 +397,125 @@ Sets the size of the markers (data points) with help of which the curve is const

theSize Long value defining the size of the markers.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.XYPlot.GetMarkerSize ( ) long VISU.XYPlot.GetMarkerSize ( )

- - - - - -

- -	+ + -Gets the size of the markers (data points) with help of which the curve is constructed on the graphics.

- - - - -

- +Gets the size of the markers (data points) with help of which the curve is constructed on the graphics. + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.XYPlot.EnableXGrid	(	in boolean	theMajor,	void VISU.XYPlot.EnableXGrid	(	in boolean	theMajor,
		in long	theNumMajor,			in long	theNumMajor,
		in boolean	theMinor,			in boolean	theMinor,
		in long	theNumMinor			in long	theNumMinor
	)				)

- - - - - -

- -	+ + -Enable/disables X-axis grid of the 2D plot.

- - - - -

- +Enable/disables X-axis grid of the 2D plot. + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.XYPlot.EnableYGrid	(	in boolean	theMajor,	void VISU.XYPlot.EnableYGrid	(	in boolean	theMajor,
		in long	theNumMajor,			in long	theNumMajor,
		in boolean	theMinor,			in boolean	theMinor,
		in long	theNumMinor			in long	theNumMinor
	)				)

- - - - - -

- -	+ + -Enable/disables Y-axis grid of the 2D plot.

- - - - -

- - - - - - - - - -

void VISU.XYPlot.SetHorScaling

(

in Scaling

theScaling

)

- - - -

- -

+Enable/disables Y-axis grid of the 2D plot. + +

+ +

+ + + + + + + + + +

void VISU.XYPlot.SetHorScaling ( in Scaling theScaling )

Sets horizontal scaling of the 2D plot.

Parameters:

@@ -595,59 +523,43 @@ Sets horizontal scaling of the 2D plot.

Parameters:

theScaling Type of scaling taken from Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.XYPlot.GetHorScaling ( ) Scaling VISU.XYPlot.GetHorScaling ( )

- - - - - -

- -	+ + -Gets the type horizontal scaling of the 2D plot.

- - - - -

- - - - - - - - - -

void VISU.XYPlot.SetVerScaling

(

in Scaling

theScaling

)

- - - -

- -

+Gets the type horizontal scaling of the 2D plot. + +

+ +

+ + + + + + + + + +

void VISU.XYPlot.SetVerScaling ( in Scaling theScaling )

Sets vertical scaling of the 2D plot.

Parameters:

@@ -655,59 +567,43 @@ Sets vertical scaling of the 2D plot.

Parameters:

theScaling

Type of scaling taken from Scaling enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

Scaling VISU.XYPlot.GetVerScaling ( ) Scaling VISU.XYPlot.GetVerScaling ( )

- - - - - -

- -	+ + -Gets the type vertical scaling of the 2D plot.

- - - - -

- - - - - - - - - -

void VISU.XYPlot.SetXTitle

(

in string

theTitle

)

- - - -

- -

+Gets the type vertical scaling of the 2D plot. + +

+ +

+ + + + + + + + + +

void VISU.XYPlot.SetXTitle ( in string theTitle )

Sets the title of the X-axis of the plot.

Parameters:

@@ -715,59 +611,43 @@ Sets the title of the X-axis of the plot.

Parameters:

theTitle

String value defining the title of the X-axis of the plot.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.XYPlot.GetXTitle ( ) string VISU.XYPlot.GetXTitle ( )

- - - - - -

- -	+ + -Gets the title of the X-axis of the plot.

- - - - -

- - - - - - - - - -

void VISU.XYPlot.SetYTitle

(

in string

theTitle

)

- - - -

- -

+Gets the title of the X-axis of the plot. + +

+ +

+ + + + + + + + + +

void VISU.XYPlot.SetYTitle ( in string theTitle )

Sets the title of the Y-axis of the plot.

Parameters:

@@ -775,486 +655,366 @@ Sets the title of the Y-axis of the plot.

Parameters:

theTitle

String value defining the title of the X-axis of the plot.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.XYPlot.GetYTitle ( ) string VISU.XYPlot.GetYTitle ( )

- - - - - -

- -	+ + -Gets the title of the Y-axis of the plot.

- - - - -

- - - - - - - - - -

void VISU.XYPlot.ShowLegend

(

in boolean

theShowing

)

- - - - - -

- -

+Gets the title of the Y-axis of the plot. + +

+ +

+ + + + + + + + + +

void VISU.XYPlot.ShowLegend ( in boolean theShowing )

-Shows/hides the legend (description) of the 2D plot.

- - - - -

- +Shows/hides the legend (description) of the 2D plot. + +

+ +

- - - - - + + + + +

void VISU.XYPlot.FitAll ( ) void VISU.XYPlot.FitAll ( )

- - - - - -

- -	+ + -Shrinks and enlarges the 2D plot to fit the 2D viewer.

- - - - -

- +Shrinks and enlarges the 2D plot to fit the 2D viewer. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.XYPlot.FitXRange	(	in double	xMin,	void VISU.XYPlot.FitXRange	(	in double	xMin,
		in double	xMax			in double	xMax
	)				)

- - - - - -

- -	+ + -Set range of the 2D plot to X axis of the 2D viewer.

- - - - -

- +Set range of the 2D plot to X axis of the 2D viewer. + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.XYPlot.FitYRange	(	in double	yMin,	void VISU.XYPlot.FitYRange	(	in double	yMin,
		in double	yMax			in double	yMax
	)				)

- - - - - -

- -	+ + -Set range of the 2D plot to Y axis of the 2D viewer.

- - - - -

- +Set range of the 2D plot to Y axis of the 2D viewer. + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.XYPlot.FitRange	(	in double	xMin,	void VISU.XYPlot.FitRange	(	in double	xMin,
		in double	xMax,			in double	xMax,
		in double	yMin,			in double	yMin,
		in double	yMax			in double	yMax
	)				)

- - - - - -

- -	+ + -Set range of the 2D plot to XY axis of the 2D viewer.

- - - - -

- +Set range of the 2D plot to XY axis of the 2D viewer. + +

+ +

- - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + +

void VISU.XYPlot.GetFitRanges	(	out double	xMin,	void VISU.XYPlot.GetFitRanges	(	out double	xMin,
		out double	xMax,			out double	xMax,
		out double	yMin,			out double	yMin,
		out double	yMax			out double	yMax
	)				)

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,	void VISU.View.ShowPart	(	in ViewRepresentation	ViewRepr,
		in boolean	state			in boolean	state
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- - - - - - - - - -

boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

boolean VISU.View.IsPartShown ( in ViewRepresentation ViewRepr ) [inherited]

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.SplitRight ( ) [inherited] void VISU.View.SplitRight ( ) [inherited]

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view is moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view is moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitLeft ( ) [inherited] void VISU.View.SplitLeft ( ) [inherited]

- - - - - -

- -	+ + -Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area.

- - - - -

- +Horizontally split workarea of this view. This view stays in an old left area, others are moved in a new right area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitBottom ( ) [inherited] void VISU.View.SplitBottom ( ) [inherited]

- - - - - -

- -	+ + -Vertically split workarea of this view. This view is moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view is moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.SplitTop ( ) [inherited] void VISU.View.SplitTop ( ) [inherited]

- - - - - -

- -	+ + -Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area.

- - - - -

- +Vertically split workarea of this view. This view stays in an old top area, others are moved in a new bottom area. + +

+ +

- - - - - + + + + +

void VISU.View.OnTop ( ) [inherited] void VISU.View.OnTop ( ) [inherited]

- - - - - -

- -	+ + -Put this view window on top of its work area.

- - - - -

- - - - - - - - - -

void VISU.View.Attract ( in View theView ) [inherited]

- - - -

- -

+Put this view window on top of its work area. + +

+ +

+ + + + + + + + + +

void VISU.View.Attract ( in View theView ) [inherited]

Parameters:: @@ -1262,32 +1022,24 @@ Put theView in workarea of this view right after it. If theView

theView

A view window to be attracted to this one.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.AttractAll ( in View theView ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.AttractAll ( in View theView ) [inherited]

Parameters:: @@ -1295,32 +1047,24 @@ Put all the view windows from workarea of theView in workarea of this v

theView A view window to be attracted to this one together with all its workarea.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativePositionInSplitter ( in double thePosition ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativePositionInSplitter ( in double thePosition ) [inherited]

Set position of this view window relatively its splitter.

Parameters:

@@ -1328,32 +1072,24 @@ Set position of this view window relatively its splitter.

Par

thePosition Desired position of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of positioning is defined by the splitter orientation. - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativeSizeInSplitter ( in double theSize ) [inherited]

- - - -

- -

+Direction of positioning is defined by the splitter orientation. + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativeSizeInSplitter ( in double theSize ) [inherited]

Set size of this view window relatively its splitter.

Parameters:

@@ -1361,32 +1097,24 @@ Set size of this view window relatively its splitter.

Paramet

theSize Desired size of this view window relatively its splitter. Meaningfull values lays in range [0..1].

-Direction of resizing is defined by the splitter orientation. - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativePositionX ( in double thePosition ) [inherited]

- - - -

- -

+Direction of resizing is defined by the splitter orientation. + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativePositionX ( in double thePosition ) [inherited]

Set horizontal position of this view window relatively its workstack.

Parameters:

@@ -1394,32 +1122,24 @@ Set horizontal position of this view window relatively its workstack.

thePosition

Desired horizontal position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativePositionY ( in double thePosition ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativePositionY ( in double thePosition ) [inherited]

Set vertical position of this view window relatively its workstack.

Parameters:

@@ -1427,32 +1147,24 @@ Set vertical position of this view window relatively its workstack.

thePosition Desired vertical position of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativeSizeX ( in double theSize ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativeSizeX ( in double theSize ) [inherited]

Set horizontal size of this view window relatively its workstack.

Parameters:

@@ -1460,32 +1172,24 @@ Set horizontal size of this view window relatively its workstack.

theSize

Desired horizontal size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetRelativeSizeY ( in double theSize ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetRelativeSizeY ( in double theSize ) [inherited]

Set vertical size of this view window relatively its workstack.

Parameters:

@@ -1493,353 +1197,257 @@ Set vertical size of this view window relatively its workstack.

theSize Desired vertical size of this view window relatively its workstack. Meaningfull values lays in range [0..1].

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.SetViewWidth ( in long Width ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewWidth ( in long Width ) [inherited]

-Old methods for view parameters management, they don't work now

- - - - -

- - - - - - - - - -

void VISU.View.SetViewHeight ( in long Height ) [inherited]

- - - - - -

- -

+Old methods for view parameters management, they don't work now + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewHeight ( in long Height ) [inherited]

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewWidth ( ) [inherited] long VISU.View.GetViewWidth ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

long VISU.View.GetViewHeight ( ) [inherited] long VISU.View.GetViewHeight ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- - - - - - - - - -

void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewPositionHorizontal ( in ViewPosition ViewPosHor ) [inherited]

- - - - -

- - - - - - - - - -

void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer ) [inherited]

- - - - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetViewPositionVertical ( in ViewPosition ViewPosVer ) [inherited]

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativePosition	(	in double	x,	void VISU.View.SetRelativePosition	(	in double	x,
		in double	y			in double	y
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - + + + + - - - - + + + + - - - + + +

void VISU.View.SetRelativeSize	(	in double	x,	void VISU.View.SetRelativeSize	(	in double	x,
		in double	y			in double	y
	)	`[inherited]`			)			`[inherited]`

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Minimize ( ) [inherited] void VISU.View.Minimize ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Restore ( ) [inherited] void VISU.View.Restore ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Maximize ( ) [inherited] void VISU.View.Maximize ( ) [inherited]

- - - - - -

- -

+ +

- - - - -

- - - - - - - - - -

void VISU.View.SetTitle ( in string theTitle ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.SetTitle ( in string theTitle ) [inherited]

Sets the title of the View frame.

Parameters:

@@ -1847,59 +1455,43 @@ Sets the title of the View frame.

Parameters:

theTitle String parameter defining the title of the View frame.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

string VISU.View.GetTitle ( ) [inherited] string VISU.View.GetTitle ( ) [inherited]

- - - - - -

- -	+ + -Gets the title of the View frame.

- - - - -

- - - - - - - - - -

void VISU.View.SetBackground ( in SALOMEDS::Color theColor ) [inherited]

- - - -

- -

+Gets the title of the View frame. + +

+ +

+ + + + + + + + + +

void VISU.View.SetBackground ( in SALOMEDS::Color theColor ) [inherited]

Sets background color of the View frame.

Parameters:

@@ -1907,113 +1499,81 @@ Sets background color of the View frame.

Parameters:

theColor Background color defined in SALOMEDS.Color enumeration.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

SALOMEDS::Color VISU.View.GetBackground ( ) [inherited] SALOMEDS::Color VISU.View.GetBackground ( ) [inherited]

- - - - - -

- -	+ + -Gets background color of the View frame.

- - - - -

- +Gets background color of the View frame. + +

+ +

- - - - - + + + + +

void VISU.View.EraseAll ( ) [inherited] void VISU.View.EraseAll ( ) [inherited]

- - - - - -

- -	+ + -Removes all presentations (presentable objects) from the view.

- - - - -

- +Removes all presentations (presentable objects) from the view. + +

+ +

- - - - - + + + + +

void VISU.View.DisplayAll ( ) [inherited] void VISU.View.DisplayAll ( ) [inherited]

- - - - - -

- -	+ + -Displays all presentations (presentable objects) in the view.

- - - - -

- - - - - - - - - -

void VISU.View.Erase ( in PrsObject thePrsObj ) [inherited]

- - - -

- -

+Displays all presentations (presentable objects) in the view. + +

+ +

+ + + + + + + + + +

void VISU.View.Erase ( in PrsObject thePrsObj ) [inherited]

Removes a definite presentation (presentable object) from the view.

Parameters:

@@ -2021,32 +1581,24 @@ Removes a definite presentation (presentable object) from the view.

thePrsObj The presentation (presentable object) which should be deleted.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.Display ( in PrsObject thePrsObj ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.Display ( in PrsObject thePrsObj ) [inherited]

Displays a definite presentation (presentable object) in the view.

Parameters:

@@ -2054,32 +1606,24 @@ Displays a definite presentation (presentable object) in the view.

thePrsObj The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- - - - - - - - - -

void VISU.View.DisplayOnly ( in PrsObject thePrsObj ) [inherited]

- - - -

- -

+ + +

+ +

+ + + + + + + + + +

void VISU.View.DisplayOnly ( in PrsObject thePrsObj ) [inherited]

Allows to display only a definite presentation (presentable object) in the view. All other presentations are removed from the view.

Parameters:: @@ -2087,59 +1631,43 @@ Allows to display only a definite presentation (presentable object) in the view.

thePrsObj The presentation (presentable object) which should be displayed.

- - - -

- - - - -

- + + +

+ +

- - - - - + + + + +

void VISU.View.Update ( ) [inherited] void VISU.View.Update ( ) [inherited]

- - - - - -

- -	+ + -Updates the view.

- - - - -

- - - - - - - - - -

boolean VISU.View.SavePicture ( in string theFileName ) [inherited]

- - - -

- -

+Updates the view. + +

+ +

+ + + + + + + + + +

boolean VISU.View.SavePicture ( in string theFileName ) [inherited]

Saves the view.

Parameters:

@@ -2148,65 +1676,49 @@ Saves the view.

Parameters:

- - - - -

- + + +

+ +

- - - - - + + + + +

IdType VISU.Base.GetID ( ) [inherited] IdType VISU.Base.GetID ( ) [inherited]

- - - - - -

- -	+ + -Returns ID of the object.

- - - - -

- +Returns ID of the object. + +

+ +

- - - - - + + + + +

VISUType VISU.Base.GetType ( ) [inherited] VISUType VISU.Base.GetType ( ) [inherited]

- - - - - -

- -	+ + -Returns the type of the presentable object

+Returns the type of the presentable object + +


Public Types
	HORIZONTAL
	VERTICAL
enum	Orientation { HORIZONTAL, +VERTICAL + }
Public Member Functions
void	SetScalarMode (in long theScalarMode)
GetMax ()
double	GetSourceMin ()
double	GetSourceMax ()
boolean	IsRangeFixed ()
void	SetPosition (in double X, in double Y)
	Position of the scalar bar.
GetLabels ()
void	SetTitle (in string theName)
void	SetTitle (in string theName)
string	GetTitle ()
void	SetBarOrientation (in Orientation theOrientation)
string	GetTitle ()
Orientation	GetBarOrientation ()
void	SetOffset (in float theDx, in float theDy, in float theDz)
void	GetOffset (out float theDx, out float theDy, out float theDz)
float	GetMemorySize ()
void	RemoveFromStudy ()
IdType	GetID ()


Public Types
	MINIMAL
	LIMITED
	NO_ENLARGE
	ENLARGE
	IMPOSSIBLE
enum	MemoryMode { MINIMAL, +LIMITED + }
enum	EnlargeType { NO_ENLARGE, +ENLARGE, +IMPOSSIBLE + }
Public Member Functions
void	SetMemoryMode (in MemoryMode theMode)
MemoryMode	GetMemoryMode ()
void	SetLimitedMemory (in float theMemorySize)
float	GetLimitedMemory ()
float	GetMemorySize ()
ColoredPrs3dHolder	CreateHolder (in VISUType theType, in ColoredPrs3dHolder::BasicInput theInput)
EnlargeType	GetRequiredMemory (in VISUType theType, in ColoredPrs3dHolder::BasicInput theInput, out float theRequiredMemory)
void	RemoveFromStudy ()
IdType	GetID ()
VISUType	GetType ()

MINIMAL	+Minimal memory mode (default behaviour).
LIMITED	+Limited memory mode (fixed memory size for presentations).

NO_ENLARGE	+No need to enlarge (default behaviour).
ENLARGE	+Enlarge limited memory.
IMPOSSIBLE	+Impossible to enlarge (not enough free memory).

ColoredPrs3dHolder VISU.ColoredPrs3dCache.CreateHolder	(	in VISUType	theType,
		in ColoredPrs3dHolder::BasicInput	theInput
	)

HORIZONTAL	+Horizontal orientation of the scalar bar.
VERTICAL	+Vertical orientation of the scalar bar.

EnlargeType VISU.ColoredPrs3dCache.GetRequiredMemory	(	in VISUType	theType,
		in ColoredPrs3dHolder::BasicInput	theInput,
		out float	theRequiredMemory
	)


Public Types
typedef sequence< TimeStampInfo >	TimeStampsRange
Public Member Functions
boolean	Apply (in ColoredPrs3d thePrs3d, in BasicInput theInput, in View3D theView3D)
ColoredPrs3d	GetDevice ()
VISUType	GetPrsType ()
TimeStampsRange	GetTimeStampsRange ()
BasicInput	GetBasicInput ()
ColoredPrs3dCache	GetCache ()
float	GetMemorySize ()
void	RemoveFromStudy ()
IdType	GetID ()
VISUType	GetType ()
Data Structures
struct	BasicInput
struct	TimeStampInfo

boolean VISU.ColoredPrs3dHolder.Apply	(	in ColoredPrs3d	thePrs3d,
		in BasicInput	theInput,
		in View3D	theView3D
	)

- -	+ + Adds a curve into the container. Parameters: @@ -77,32 +69,24 @@ Adds a curve into the container. Parameters:
	theCurve	The added curve.


Public Types
	NONE
	CIRCLE
	RECTANGLE
	DIAMOND
	DTRIANGLE
	UTRIANGLE
	LTRIANGLE
	RTRIANGLE
	CROSS
	XCROSS
	VOIDLINE
	SOLIDLINE
	DASHLINE
	DOTLINE
	DASHDOTLINE
	DASHDOTDOTLINE
enum	MarkerType { NONE, CIRCLE, @@ -56,9 +88,9 @@ Inheritance diagram for VISU.Curve: Public Member Functions
void	SetTitle (in string theTitle)
void	SetTitle (in string theTitle)
string	GetTitle ()
string	GetTitle ()
void	SetColor (in SALOMEDS::Color theColor)


Public Types
enum	Orientation { HORIZONTAL, -VERTICAL +
	HORIZONTAL
	VERTICAL
enum	Orientation { HORIZONTAL, +VERTICAL }
Public Member Functions
SetRange (in double theMin, in double theMax)
void	SetBarOrientation (in Orientation theOrientation)
void	SetSourceRange ()
Orientation	GetBarOrientation ()
void	AddMeshOnGroup (in string theGroupName)
void	RemoveAllGeom ()
void	SetScalarMode (in long theScalarMode)
GetMax ()
double	GetSourceMin ()
double	GetSourceMax ()
boolean	IsRangeFixed ()
void	SetPosition (in double X, in double Y)
	Position of the scalar bar.
GetLabels ()
void	SetTitle (in string theName)
void	SetTitle (in string theName)
string	GetTitle ()
string	GetTitle ()
void	SetBarOrientation (in Orientation theOrientation)
Orientation	GetBarOrientation ()
void	SetOffset (in float theDx, in float theDy, in float theDz)
void	GetOffset (out float theDx, out float theDy, out float theDz)
float	GetMemorySize ()
void	RemoveFromStudy ()
IdType	GetID ()


Public Types
	XY
	YZ
	ZX
enum	Orientation { XY, YZ, ZX }
	HORIZONTAL
	VERTICAL
Public Member Functions
void	SetOrientation (in Orientation theOrientation, in double theXAngle, in double theYAngle)
SetRange (in double theMin, in double theMax)
void	SetBarOrientation (in Orientation theOrientation)
void	SetSourceRange ()
Orientation	GetBarOrientation ()
void	AddMeshOnGroup (in string theGroupName)
void	RemoveAllGeom ()
void	SetScalarMode (in long theScalarMode)
GetMax ()
double	GetSourceMin ()
double	GetSourceMax ()
boolean	IsRangeFixed ()
void	SetPosition (in double X, in double Y)
	Position of the scalar bar.
GetLabels ()
void	SetTitle (in string theName)
void	SetTitle (in string theName)
string	GetTitle ()
string	GetTitle ()
void	SetBarOrientation (in Orientation theOrientation)
Orientation	GetBarOrientation ()
void	SetOffset (in float theDx, in float theDy, in float theDz)
void	GetOffset (out float theDx, out float theDy, out float theDz)
float	GetMemorySize ()
void	RemoveFromStudy ()
IdType	GetID ()

- -	+ + Sets the color of mesh cells. Parameters: @@ -91,59 +85,43 @@ Sets the color of mesh cells. Parameters:
	theColor	The color of the cells. This parameter is taken from Color enumeration.


Public Types
	FORWARD
	BACKWARD
	BOTH
enum	Direction { FORWARD, BACKWARD, BOTH }
enum	Orientation { HORIZONTAL, -VERTICAL +
	HORIZONTAL
	VERTICAL
enum	Orientation { HORIZONTAL, +VERTICAL }
Public Member Functions
SetRange (in double theMin, in double theMax)
void	SetBarOrientation (in Orientation theOrientation)
void	SetSourceRange ()
void	AddMeshOnGroup (in string theGroupName)
Orientation	GetBarOrientation ()
void	RemoveAllGeom ()
void	SetScalarMode (in long theScalarMode)
GetMax ()
double	GetSourceMin ()
double	GetSourceMax ()
boolean	IsRangeFixed ()
void	SetPosition (in double X, in double Y)
	Position of the scalar bar.
GetLabels ()
void	SetTitle (in string theName)
void	SetTitle (in string theName)
string	GetTitle ()
string	GetTitle ()
void	SetBarOrientation (in Orientation theOrientation)
Orientation	GetBarOrientation ()
void	SetOffset (in float theDx, in float theDy, in float theDz)
void	GetOffset (out float theDx, out float theDy, out float theDz)
float	GetMemorySize ()
void	RemoveFromStudy ()
IdType	GetID ()


Public Types
	HORIZONTAL
	VERTIACAL
enum	Orientation { HORIZONTAL, VERTIACAL }
Public Member Functions
void	SetTitle (in string theTitle)
void	SetTitle (in string theTitle)
string	GetTitle ()
string	GetTitle ()
void	SetOrientation (in Orientation theOrientation)


Public Types
	OBJECTBROWSER
	VIEWER
	PYTHON
	MESSAGES
	TOP
	CENTER
	BOTTOM
	RIGHT
	LEFT
enum	ViewRepresentation { OBJECTBROWSER, VIEWER, PYTHON, @@ -91,9 +109,9 @@ Inheritance diagram for VISU.TableView: void	SetViewPositionVertical (in ViewPosition ViewPosVer)
void	SetRelativePosition (in double x, in double y)
void	SetRelativePosition (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	Minimize ()
Maximize ()
void	SetTitle (in string theTitle)
void	SetTitle (in string theTitle)
string	GetTitle ()
string	GetTitle ()
void	SetBackground (in SALOMEDS::Color theColor)
Update ()
boolean	SavePicture (in string theFileName)
boolean	SavePicture (in string theFileName)
IdType	GetID ()


GetViewManager ()
SALOMEDS::SObject	ImportTables (in string theFileName)
SALOMEDS::SObject	ImportTables (in string theFileName)
boolean	ExportTableToFile (in SALOMEDS::SObject theTable, in string theFileName)
boolean	ExportTableToFile (in SALOMEDS::SObject theTable, in string theFileName)
Result	ImportFile (in string theFileName)
Result	ImportFile (in string theFileName)
Result	CreateResult (in string theFileName)
Result	CreateResult (in string theFileName)
Result	CopyAndImportFile (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	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	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)
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	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	FamilyMeshOnEntity (in Result theResult, in string theMeshName, in Entity theEntity, in string theFamilyName)
Mesh	GroupMesh (in Result theResult, in string theMeshName, in string theGroupName)
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)
ScalarMap	ScalarMapOnField (in Result theResult, in string theMeshName, in Entity theEntity, in string theFieldName, in long theIteration)
GaussPoints	GaussPointsOnField (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 long theIteration)
DeformedShape	DeformedShapeOnField (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 long theIteration)
ScalarMapOnDeformedShape	ScalarMapOnDeformedShapeOnField (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 long theIteration)
Vectors	VectorsOnField (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 long theIteration)
IsoSurfaces	IsoSurfacesOnField (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 long theIteration)
StreamLines	StreamLinesOnField (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 long theIteration)
CutPlanes	CutPlanesOnField (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 long theIteration)
CutLines	CutLinesOnField (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 long theIteration)
Plot3D	Plot3DOnField (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 long theIteration)
Table	CreateTable (in string theTableEntry)
Table	CreateTable (in string theTableEntry)
Curve	CreateCurve (in Table theTable, in long theHRow, in long theVRow)
DeletePrs3d (in Prs3d thePrs3d)
ColoredPrs3dCache	GetColoredPrs3dCache (in SALOMEDS::Study theStudy)
IdType	GetID ()
VISUType	GetType ()


Public Types
	ARROW
	CONE2
	CONE6
	NONE
	CENTER
	TAIL
	HEAD
enum	GlyphType { ARROW, CONE2, CONE6, @@ -44,8 +58,12 @@ Inheritance diagram for VISU.Vectors: HEAD }
enum	Orientation { HORIZONTAL, -VERTICAL +
	HORIZONTAL
	VERTICAL
enum	Orientation { HORIZONTAL, +VERTICAL }
Public Member Functions
SetRange (in double theMin, in double theMax)
void	SetBarOrientation (in Orientation theOrientation)
void	SetSourceRange ()
Orientation	GetBarOrientation ()
void	AddMeshOnGroup (in string theGroupName)
void	RemoveAllGeom ()
void	SetScalarMode (in long theScalarMode)
GetMax ()
double	GetSourceMin ()
double	GetSourceMax ()
boolean	IsRangeFixed ()
void	SetPosition (in double X, in double Y)
	Position of the scalar bar.
GetLabels ()
void	SetTitle (in string theName)
void	SetTitle (in string theName)
string	GetTitle ()
string	GetTitle ()
void	SetBarOrientation (in Orientation theOrientation)
Orientation	GetBarOrientation ()
void	SetOffset (in float theDx, in float theDy, in float theDz)
void	GetOffset (out float theDx, out float theDy, out float theDz)
float	GetMemorySize ()
void	RemoveFromStudy ()
IdType	GetID ()


Public Types
typedef double	XYZ [3]
	FRONT
	BACK
	LEFT
	RIGHT
	TOP
	BOTTOM
	XAxis
	YAxis
	ZAxis
enum	ViewType { FRONT, BACK, @@ -45,6 +63,16 @@ Inheritance diagram for VISU.View3D: ZAxis }
	OBJECTBROWSER
	VIEWER
	PYTHON
	MESSAGES
	CENTER
enum	ViewRepresentation { OBJECTBROWSER, VIEWER, PYTHON, @@ -87,29 +115,29 @@ Inheritance diagram for VISU.View3D: void	RemoveScale ()
boolean	SaveViewParams (in string theName)
boolean	SaveViewParams (in string theName)
boolean	RestoreViewParams (in string theName)
boolean	RestoreViewParams (in string theName)
PresentationType	GetPresentationType (in ScalarMap thePrs)
string	SetPresentationType (in ScalarMap thePrs, in PresentationType thePrsType)
string	SetPresentationType (in ScalarMap thePrs, in PresentationType thePrsType)
boolean	IsShrinked (in ScalarMap thePrs)
string	SetShrinked (in ScalarMap thePrs, in boolean isShrinked)
string	SetShrinked (in ScalarMap thePrs, in boolean isShrinked)
boolean	IsShaded (in ScalarMap thePrs)
string	SetShaded (in ScalarMap thePrs, in boolean isShaded)
string	SetShaded (in ScalarMap thePrs, in boolean isShaded)
double	GetOpacity (in ScalarMap thePrs)
string	SetOpacity (in ScalarMap thePrs, in double theOpacity)
string	SetOpacity (in ScalarMap thePrs, in double theOpacity)
double	GetLineWidth (in ScalarMap thePrs)
string	SetLineWidth (in ScalarMap thePrs, in double theLineWidth)
string	SetLineWidth (in ScalarMap thePrs, in double theLineWidth)
void	ShowPart (in ViewRepresentation ViewRepr, in boolean state)
SetViewPositionVertical (in ViewPosition ViewPosVer)
void	SetRelativePosition (in double x, in double y)
void	SetRelativePosition (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	Minimize ()
Maximize ()
void	SetTitle (in string theTitle)
void	SetTitle (in string theTitle)
string	GetTitle ()
string	GetTitle ()
void	SetBackground (in SALOMEDS::Color theColor)
Update ()
boolean	SavePicture (in string theFileName)
boolean	SavePicture (in string theFileName)
IdType	GetID ()


Public Types
	POINTS
	MULTYLINE
	SPLINE
enum	CurveType { POINTS, MULTYLINE, SPLINE }
	OBJECTBROWSER
	VIEWER
	PYTHON
	MESSAGES
	TOP
	CENTER
	BOTTOM
	RIGHT
	LEFT
enum	ViewRepresentation { OBJECTBROWSER, VIEWER, PYTHON, @@ -50,9 +74,9 @@ Inheritance diagram for VISU.XYPlot: Public Member Functions
void	SetSubTitle (in string theTitle)
void	SetSubTitle (in string theTitle)
string	GetSubTitle ()
string	GetSubTitle ()
void	SetCurveType (in CurveType theType)
GetVerScaling ()
void	SetXTitle (in string theTitle)
void	SetXTitle (in string theTitle)
string	GetXTitle ()
string	GetXTitle ()
void	SetYTitle (in string theTitle)
void	SetYTitle (in string theTitle)
string	GetYTitle ()
string	GetYTitle ()
void	ShowLegend (in boolean theShowing)
SetViewPositionVertical (in ViewPosition ViewPosVer)
void	SetRelativePosition (in double x, in double y)
void	SetRelativePosition (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	Minimize ()
Maximize ()
void	SetTitle (in string theTitle)
void	SetTitle (in string theTitle)
string	GetTitle ()
string	GetTitle ()
void	SetBackground (in SALOMEDS::Color theColor)
Update ()
boolean	SavePicture (in string theFileName)
boolean	SavePicture (in string theFileName)
IdType	GetID ()


Data Structures
interface	Base
interface	RemovableObject
	Removable object interface. More...
interface	PrsObject
	Presentable object interface. More...
interface	Table
	Table representation interface More...
interface	Curve
	Interface of curve representation. More...
interface	Container
	Container presentable object interface More...
interface	Prs3d
	3D presentation interface More...
interface	Mesh
	Interface of the mesh. More...
interface	ColoredPrs3d
	Basic Interface for the Colored 3D Presentations. More...
interface	ColoredPrs3dHolder
	ColoredPrs3dHolder interface. Interface of 3d presentation's holder, which represents colored 3d presentations, created on fields. It is publishing in the object browser in a separate folder and can be controled by viewer's slider. More...
interface	ColoredPrs3dCache
	ColoredPrs3dCache interface. This interface is responsible for memory management of 3d presentations. One cache corresponds to one study. More...
interface	ScalarMap
	Interface of the Scalar Map. More...
interface	GaussPoints
	Gauss Points presentation interface. More...
interface	DeformedShape
	Deformed shape presentation interface. More...
interface	ScalarMapOnDeformedShape
	Scalar Map on Deformed shape presentation interface. More...
interface	Plot3D
	Plot3D interface. More...
interface	CutPlanes
	Cut planes interface. More...
interface	CutLines
	Cut lines presentation. More...
interface	StreamLines
	Interface of the stream lines representation. More...
interface	IsoSurfaces
	Interface of the isometric surface presentation. More...
interface	Vectors
	Interface of the vector presentation. More...
interface	Animation
	Animation class More...
interface	Result
	Interface Result. More...
interface	VISU_Gen
	VISU_Gen interface More...
interface	View
	View interface More...
interface	View3D
	3D view interface More...
interface	TableView
	Interface of the Table view. More...
interface	XYPlot
	Interface of the 2D plot view. More...
interface	ViewManager
	Interface of the ViewManager. More...
Typedefs
typedef string	IdType
typedef sequence< string >	string_array
Enumerations
enum	Scaling { LINEAR, +LOGARITHMIC + }
enum	Entity { NODE, +EDGE, +FACE, +CELL + }
enum	VISUType { + TNONE, +TCURVE, +TTABLE, +TCONTAINER, + + TMESH, +TSCALARMAP, +TISOSURFACES, +TDEFORMEDSHAPE, + + TSCALARMAPONDEFORMEDSHAPE, +TGAUSSPOINTS, +TPLOT3D, +TCUTPLANES, + + TCUTLINES, +TVECTORS, +TSTREAMLINES, +TVISUGEN, + + TVIEWMANAGER, +TRESULT, +TXYPLOT, +TTABLEVIEW, + + TVIEW3D, +TGAUSSVIEW, +TENTITY, +TFAMILY, + + TGROUP, +TFIELD, +TTIMESTAMP, +TANIMATION, + + TCOLOREDPRS3DHOLDER, +TCOLOREDPRS3DCACHE, +TPART, +TALL + + }
enum	PresentationType { + POINT, +WIREFRAME, +SHADED, +INSIDEFRAME, + + SURFACEFRAME, +SHRINK + + }

LINEAR	+Linear type of scaling.
LOGARITHMIC	+Logarithmic type of scaling.

NODE	+Node corresponds to a geometrical point.
EDGE	+Edge corresponds to a geometrical line connecting two points.
FACE	+Face corresponds to a geometrical plane bounded by several lines.
CELL	+Cell is a volumic element of a mesh

TNONE	+Not a VISU object
TCURVE	+Curve line object for construction of 2D XY plots
TTABLE	+Table containing numerical data
TCONTAINER	+Container object used for storing a set of curve lines
TMESH	+Meshing object
TSCALARMAP	+Scalarmap 3D presentation object
TISOSURFACES	+Iso surface 3D presentation object
TDEFORMEDSHAPE	+Deformed shape 3D presentation object
TSCALARMAPONDEFORMEDSHAPE	+Scalar map on deformed shape 3D presentation object
TGAUSSPOINTS	+Gauss Points 3D presentation object
TPLOT3D	+Plot3D 3D presentation object
TCUTPLANES	+Cut planes 3D presentation object
TCUTLINES	+Cut lines 3D presentation object
TVECTORS	+Vectors 3D presentation object
TSTREAMLINES	+Streamlines 3D presentation object
TVISUGEN	+VISU generator used for performing operations with different VISU objects
TVIEWMANAGER	+View manager used for performing operations with different views
TRESULT	+The data on which different presentations are based
TXYPLOT	+2D XY plot consisting of one or several curve lines
TTABLEVIEW	+Table view is used for displaying data tables
TVIEW3D	+3D view is used for displaying 3D graphical presentations
TGAUSSVIEW	+3D view is used for displaying Gauss Points graphical presentations
TENTITY	+An element composing a mesh: node, edge, face or cell
TFAMILY	+The whole mesh can be divided into one or several submeshes, called families, which are defined by the user. Each family in its turn is composed of entities of a definite type.
TGROUP	+A group of families
TFIELD	+Field represents the results of calculations (it can be scalar or vector values), grouped together under one physical concept.
TTIMESTAMP	+Time stamp represents a subfield: the results of calculations are taken in one definite moment.
TANIMATION	+Represents Animation object.
TCOLOREDPRS3DHOLDER	+Colored 3D presentation holder
TCOLOREDPRS3DCACHE	+Colored 3D presentation cache
TPART	+MULTIPR: part of a mesh
TALL	+

idl/VISU_Gen.idl

idl/VISU_Gen.idl File Reference

Namespaces

Typedefs

Enumerations

Detailed Description

VISU.Animation Interface Reference

Public Types

Member Enumeration Documentation

Member Function Documentation

VISU.Base Interface Reference

VISU.Base Interface Reference

VISU.ColoredPrs3d Interface Reference

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

Member Enumeration Documentation

Member Function Documentation

VISU.ColoredPrs3dCache Interface Reference

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation

VISU.ColoredPrs3dHolder Interface Reference

Public Types

Public Member Functions

Data Structures

Member Typedef Documentation

Member Function Documentation

VISU.Container Interface Reference

VISU.Curve Interface Reference

Public Types

Public Member Functions

Member Function Documentation

VISU.CutLines Interface Reference

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation

VISU.CutPlanes Interface Reference

Public Types

Public Member Functions

Member Function Documentation

VISU.DeformedShape Interface Reference

Public Types

Public Member Functions

Member Function Documentation

VISU.GaussPoints Interface Reference

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

Member Enumeration Documentation

Member Function Documentation

VISU.IsoSurfaces Interface Reference

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation

VISU.Mesh Interface Reference

Member Function Documentation

VISU.Plot3D Interface Reference

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation

VISU.Prs3d Interface Reference

VISU.PrsObject Interface Reference

VISU.RemovableObject Interface Reference

VISU.Result Interface Reference

Detailed Description

Member Function Documentation

VISU.ScalarMap Interface Reference

Public Types

Public Member Functions

Member Function Documentation

VISU.ScalarMapOnDeformedShape Interface Reference

Public Types

Public Member Functions

POINT	+
WIREFRAME	+
SHADED	+
INSIDEFRAME	+
SURFACEFRAME	+
SHRINK	+