Version: 9.15.0
SALOMEGUI_Swig.hxx
Go to the documentation of this file.
1 // Copyright (C) 2007-2025 CEA, EDF, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 
23 // SALOME SALOMEGUI : implementation of desktop and GUI kernel
24 // File : SALOMEGUI_Swig.hxx
25 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
26 //
27 #ifndef SALOMEGUI_SWIG_HXX
28 #define SALOMEGUI_SWIG_HXX
29 
30 #include <string>
31 #include <list>
32 
34 {
35 public:
38 
39  bool hasDesktop();
40 
41  void updateObjBrowser();
42 
43  const char* getActiveStudyName();
44 
45  const char* getComponentName( const char* );
46  const char* getComponentUserName( const char* );
47 
48  int SelectedCount();
49  const char* getSelected( int i );
50  void AddIObject( const char* );
51  void RemoveIObject( const char* );
52  void ClearIObjects();
53 
54  void Display( const char* );
55  void DisplayOnly( const char* );
56  void Erase( const char* );
57  void DisplayAll();
58  void EraseAll();
59  bool IsInCurrentView( const char* );
60  void UpdateView();
61 
62  void FitAll();
63  void FitSelection();
64  void FitIObjects(const std::list<std::string>&);
65  void ResetView();
66  void ViewTop();
67  void ViewBottom();
68  void ViewLeft();
69  void ViewRight();
70  void ViewFront();
71  void ViewBack();
72 
73  const char* getViewParameters();
74  void setCameraPosition( double x, double y, double z );
75  void setCameraFocalPoint( double x, double y, double z );
76  void setCameraViewUp( double x, double y, double z );
77  void setViewScale( double parallelScale,double x, double y, double z );
78 };
79 
80 #endif // SALOMEGUI_SWIG_HXX
Python interface module for SALOME GUI.
Definition: SALOMEGUI_Swig.hxx:34
~SALOMEGUI_Swig()
Destructor.
Definition: SALOMEGUI_Swig.cxx:149
void AddIObject(const char *)
Add an object to the current selection.
Definition: SALOMEGUI_Swig.cxx:319
void setCameraViewUp(double x, double y, double z)
Set the view up direction for the camera.
Definition: SALOMEGUI_Swig.cxx:1076
SALOMEGUI_Swig()
Constructor.
Definition: SALOMEGUI_Swig.cxx:142
void setCameraFocalPoint(double x, double y, double z)
Set camera focal point of the active view.
Definition: SALOMEGUI_Swig.cxx:1062
bool hasDesktop()
Check GUI availability.
Definition: SALOMEGUI_Swig.cxx:170
void DisplayAll()
Display all active module's presentable child objects in the current view window.
Definition: SALOMEGUI_Swig.cxx:528
void EraseAll()
Erase all objects from the current view window.
Definition: SALOMEGUI_Swig.cxx:559
void Display(const char *)
Display an object in the current view window.
Definition: SALOMEGUI_Swig.cxx:411
void ViewLeft()
Switch current view window to show the left view.
Definition: SALOMEGUI_Swig.cxx:882
void FitIObjects(const std::list< std::string > &)
Definition: SALOMEGUI_Swig.cxx:713
void DisplayOnly(const char *)
Displays an object in the current view window and erases all other ones.
Definition: SALOMEGUI_Swig.cxx:448
const char * getViewParameters()
Definition: SALOMEGUI_Swig.cxx:957
const char * getActiveStudyName()
Get active study name.
Definition: SALOMEGUI_Swig.cxx:214
void UpdateView()
Update (repaint) current view window.
Definition: SALOMEGUI_Swig.cxx:624
void FitSelection()
Definition: SALOMEGUI_Swig.cxx:685
int SelectedCount()
Get number of selected items.
Definition: SALOMEGUI_Swig.cxx:303
void ViewRight()
Switch current view window to show the right view.
Definition: SALOMEGUI_Swig.cxx:890
const char * getComponentUserName(const char *)
Get title (user name) of the component by its name.
Definition: SALOMEGUI_Swig.cxx:255
void ViewBottom()
Switch current view window to show the bottom view.
Definition: SALOMEGUI_Swig.cxx:874
void ViewBack()
Switch current view window to show the back view.
Definition: SALOMEGUI_Swig.cxx:906
void setCameraPosition(double x, double y, double z)
Set camera position of the active view .
Definition: SALOMEGUI_Swig.cxx:1048
void ClearIObjects()
Clear selection (unselect all objects).
Definition: SALOMEGUI_Swig.cxx:384
void ResetView()
Reset current view window to the default state.
Definition: SALOMEGUI_Swig.cxx:745
void ViewFront()
Switch current view window to show the front view.
Definition: SALOMEGUI_Swig.cxx:898
const char * getSelected(int i)
Get entry of the specified selected item.
Definition: SALOMEGUI_Swig.cxx:308
void RemoveIObject(const char *)
Remove the object from the selection.
Definition: SALOMEGUI_Swig.cxx:346
void FitAll()
Fit current view window to display all its contents.
Definition: SALOMEGUI_Swig.cxx:650
void updateObjBrowser()
Update active study's Object Browser.
Definition: SALOMEGUI_Swig.cxx:178
bool IsInCurrentView(const char *)
Check it the object is displayed in the current view window.
Definition: SALOMEGUI_Swig.cxx:616
void setViewScale(double parallelScale, double x, double y, double z)
Set view scale.
Definition: SALOMEGUI_Swig.cxx:1091
void ViewTop()
Switch current view window to show the top view.
Definition: SALOMEGUI_Swig.cxx:866
const char * getComponentName(const char *)
Get name of the component by its title (user name)
Definition: SALOMEGUI_Swig.cxx:250
void Erase(const char *)
Erase an object in the current view window.
Definition: SALOMEGUI_Swig.cxx:492