Salome HOME
Update Help for VISU module.
[modules/visu.git] / src / VISU_I / VISU_Gen_i.hh
1 //  Copyright (C) 2003  CEA/DEN, EDF R&D
2 //
3 //
4 //
5 //  File   : VISU_GEN_i.h file
6 //  Author : Alexey Petrov
7 //  Module : VISU
8 //  $Header:
9
10 #ifndef __VISU_GEN_I_H__
11 #define __VISU_GEN_I_H__
12
13 #include "VISUConfig.hh"
14
15 #include "SALOME_Component_i.hxx"
16 #include "SALOME_NamingService.hxx"
17
18 namespace VISU{
19   class Result_i;
20   class VISU_Gen_i : public virtual POA_VISU::VISU_Gen,
21                      public virtual ::Engines_Component_i,
22                      public virtual Base_i
23   {
24     SALOMEDS::Study_var myStudyDocument;
25     VISU_Gen_i();
26     VISU_Gen_i(const VISU::VISU_Gen_i &);
27   public:
28     VISU_Gen_i(CORBA::ORB_ptr theORB,
29                PortableServer::POA_ptr thePOA,
30                SALOME_NamingService* theNamingService,
31                QMutex* theMutex);
32     virtual ~VISU_Gen_i();
33
34     virtual char* GetID();
35     virtual VISU::VISUType GetType() { return VISU::TVISUGEN;};
36
37     virtual void SetCurrentStudy(SALOMEDS::Study_ptr theStudy);
38     virtual SALOMEDS::Study_ptr GetCurrentStudy();
39
40     virtual ViewManager_ptr GetViewManager();
41
42     virtual SALOMEDS::SObject_ptr ImportTables(const char* theFileName);
43     virtual CORBA::Boolean ExportTableToFile(SALOMEDS::SObject_ptr theTable, const char* theFileName );
44
45     //Create Result
46     virtual Result_ptr ImportFile(const char* theFileName);
47     virtual Result_ptr CopyAndImportFile(const char* theFileName);
48     virtual Result_ptr ImportMed(SALOMEDS::SObject_ptr theMedSObject);
49     virtual Result_ptr ImportMedField(SALOME_MED::FIELD_ptr theField);
50
51     //Create Presentation Of Submeshes
52     virtual Mesh_ptr MeshOnEntity(Result_ptr theResult, const char* theMeshName, VISU::Entity theEntity);
53     virtual Mesh_ptr FamilyMeshOnEntity(Result_ptr theResult, const char* theMeshName,
54                                         VISU::Entity theEntity, const char* theFamilyName);
55     virtual Mesh_ptr GroupMesh(Result_ptr theResult, const char* theMeshName, const char* theGroupName);
56
57     //Create 3D collored Presentation Of Different Types
58     template<typename TPrs3d_i> TPrs3d_i*
59     CreatePrs3d(Result_ptr theResult, const char* theMeshName, VISU::Entity theEntity,
60                 const char* theFieldName, CORBA::Double theIteration, bool theAddToStudy = true)
61     {
62       TPrs3d_i* aPresent = NULL;
63       if(myStudyDocument->GetProperties()->IsLocked()) 
64         return aPresent;
65
66       typedef typename TPrs3d_i::TInterface TPrs3d;
67       typename TPrs3d::_var_type aPrs3d;
68       Mutex mt(myMutex);
69       if(Result_i* pResult = dynamic_cast<Result_i*>(GetServant(theResult).in())){
70         if(TPrs3d_i::IsPossible(pResult,theMeshName,theEntity,theFieldName,int(theIteration))){
71           aPresent = new TPrs3d_i(pResult,theAddToStudy);
72           if(aPresent->Create(theMeshName,theEntity,theFieldName,int(theIteration)) == NULL){
73             aPresent->_remove_ref();
74             aPresent = NULL;
75           }
76         }
77       }
78       return aPresent;
79     }
80
81     template<typename TPrs3d_i> typename TPrs3d_i::TInterface::_var_type
82     Prs3dOnField(Result_ptr theResult, const char* theMeshName, VISU::Entity theEntity,
83                const char* theFieldName, CORBA::Double theIteration, bool theAddToStudy = true)
84     {
85       typedef typename TPrs3d_i::TInterface TPrs3d;
86       typename TPrs3d::_var_type aPrs3d;
87       if(TPrs3d_i* aPrs3d = CreatePrs3d<TPrs3d_i>(theResult,theMeshName,theEntity,theFieldName,theIteration,theAddToStudy))
88         return aPrs3d->_this();
89       return TPrs3d::_nil();
90     }
91
92     virtual ScalarMap_ptr ScalarMapOnField(Result_ptr theResult,
93                                            const char* theMeshName, VISU::Entity theEntity,
94                                            const char* theFieldName, CORBA::Double theIteration);
95     virtual DeformedShape_ptr DeformedShapeOnField(Result_ptr theResult,
96                                                    const char* theMeshName, VISU::Entity theEntity,
97                                                    const char* theFieldName, CORBA::Double theIteration);
98     virtual Vectors_ptr VectorsOnField(Result_ptr theResult,
99                                        const char* theMeshName, VISU::Entity theEntity,
100                                        const char* theFieldName, CORBA::Double theIteration);
101     virtual IsoSurfaces_ptr IsoSurfacesOnField(Result_ptr theResult,
102                                                const char* theMeshName, VISU::Entity theEntity,
103                                                const char* theFieldName, CORBA::Double theIteration);
104     virtual CutPlanes_ptr CutPlanesOnField(Result_ptr theResult,
105                                            const char* theMeshName, VISU::Entity theEntity,
106                                            const char* theFieldName, CORBA::Double theIteration);
107     virtual CutLines_ptr CutLinesOnField(Result_ptr theResult,
108                                          const char* theMeshName, VISU::Entity theEntity,
109                                          const char* theFieldName, CORBA::Double theIteration);
110     virtual StreamLines_ptr StreamLinesOnField(Result_ptr theResult,
111                                                const char* theMeshName, VISU::Entity theEntity,
112                                                const char* theFieldName, CORBA::Double theIteration);
113     virtual Plot3D_ptr Plot3DOnField(Result_ptr theResult,
114                                      const char* theMeshName, VISU::Entity theEntity,
115                                      const char* theFieldName, CORBA::Double theIteration);
116     //Create Digital Presentation
117     virtual Table_ptr CreateTable(const char* theTableEntry);
118     virtual Curve_ptr CreateCurve(Table_ptr theTable, CORBA::Long theHRow, CORBA::Long theVRow);
119     virtual Container_ptr CreateContainer();
120     virtual Animation_ptr CreateAnimation(View3D_ptr theView3d);
121
122     virtual void DeleteResult(Result_ptr theResult);
123     virtual void DeletePrs3d(Prs3d_ptr thePrs3d);
124
125     // inherited methods from Engines::Component
126     virtual
127     Engines::TMPFile*
128     DumpPython(CORBA::Object_ptr theStudy,
129                CORBA::Boolean theIsPublished,
130                CORBA::Boolean& theIsValidScript);
131     // inherited methods from SALOMEDS::Driver
132     virtual SALOMEDS::TMPFile* Save(SALOMEDS::SComponent_ptr theComponent,
133                                     const char* theURL,
134                                     bool isMultiFile);
135     virtual SALOMEDS::TMPFile* SaveASCII(SALOMEDS::SComponent_ptr theComponent,
136                                          const char* theURL,
137                                          bool isMultiFile);
138     virtual bool Load(SALOMEDS::SComponent_ptr,
139                       const SALOMEDS::TMPFile &,
140                       const char* theURL,
141                       bool isMultiFile);
142     virtual bool LoadASCII(SALOMEDS::SComponent_ptr,
143                            const SALOMEDS::TMPFile &,
144                            const char* theURL,
145                            bool isMultiFile);
146
147     virtual void Close(SALOMEDS::SComponent_ptr IORSComponent);
148
149     virtual char* ComponentDataType();
150
151     virtual char* IORToLocalPersistentID(SALOMEDS::SObject_ptr theSObject,
152                                          const char* IORString,
153                                          CORBA::Boolean isMultiFile,
154                                          CORBA::Boolean isASCII);
155     virtual char* LocalPersistentIDToIOR(SALOMEDS::SObject_ptr theSObject,
156                                          const char* aLocalPersistentID,
157                                          CORBA::Boolean isMultiFile,
158                                          CORBA::Boolean isASCII);
159
160     virtual bool CanPublishInStudy(CORBA::Object_ptr theIOR);
161     virtual SALOMEDS::SObject_ptr PublishInStudy(SALOMEDS::Study_ptr theStudy,
162                                                  SALOMEDS::SObject_ptr theSObject,
163                                                  CORBA::Object_ptr theObject,
164                                                  const char* theName) throw (SALOME::SALOME_Exception);
165
166     CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
167     SALOMEDS::TMPFile* CopyFrom(SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID);
168     CORBA::Boolean CanPaste(const char* theComponentName, CORBA::Long theObjectID);
169     SALOMEDS::SObject_ptr PasteInto(const SALOMEDS::TMPFile& theStream,
170                                     CORBA::Long theObjectID,
171                                     SALOMEDS::SObject_ptr theObject);
172   };
173 }
174 #endif