1 # -*- coding: utf-8 -*-
3 # Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 This module provides tools to facilitate the use of geom engine and geom
27 GEOM = None # GEOM module is loaded only when needed
29 from salome.kernel.logger import Logger
30 from salome.kernel import termcolor
31 logger = Logger("salome.geom.geomtools", color = termcolor.RED)
33 from salome.kernel.studyedit import getActiveStudyId, getStudyEditor
34 from salome.kernel.services import IDToObject
36 from salome.gui import helper
42 def getGeompy(studyId = None):
44 Return an object behaving exactly like geompy module, except that it is
45 associated with the study `studyId`. If `studyId` is :const:`None`, return
46 a pseudo geompy object for the current study.
48 # We can't use geompy module because it initializes GEOM with
49 # salome.myStudy, which may not exist. So we use this trick to create
50 # a pseudo geompy module.
53 studyId = getActiveStudyId()
54 if not _geompys.has_key(studyId):
56 _geompys[studyId] = salome.lcc.FindOrLoadComponent("FactoryServer",
58 _geompys[studyId].ShapeType = geompyDC.ShapeType
59 _geompys[studyId].GEOM = geompyDC.GEOM
60 _geompys[studyId].kind = geompyDC.kind
61 _geompys[studyId].info = geompyDC.info
62 _geompys[studyId].PackData = geompyDC.PackData
63 _geompys[studyId].ReadTexture = geompyDC.ReadTexture
64 study = salome.myStudyManager.GetStudyByID(studyId)
65 _geompys[studyId].init_geom(study)
66 return _geompys[studyId]
71 DisplayMode=ModeShading
75 This class provides several methods to manipulate geom objects in Salome
76 study. The parameter `studyEditor` defines a
77 :class:`~salome.kernel.studyedit.StudyEditor` object used to access the study. If
78 :const:`None`, the method returns a :class:`~salome.kernel.studyedit.StudyEditor`
79 object on the current study.
83 This instance attribute contains the underlying
84 :class:`~salome.kernel.studyedit.StudyEditor` object. It can be used to access
85 the study but the attribute itself should not be modified.
89 def __init__(self, studyEditor = None):
92 GEOM = __import__("GEOM")
93 if studyEditor is None:
94 studyEditor = helper.getStudyEditor()
95 self.editor = studyEditor
97 def displayShapeByName(self, shapeName, color = None):
99 Display the geometrical shape whose name in the study is `shapeName`.
101 :type shapeName: string
102 :param shapeName: name of the geometrical shape
104 :type color: tuple (triplet)
105 :param color: RGB components of the color of the shape
107 :return: True if the shape was found, False otherwise
109 logger.debug("displayShapeByName in PAL: %s with color %s" %
111 listSO = self.editor.study.FindObjectByName(shapeName, "GEOM")
114 geomObj = self.editor.getOrLoadObject(sObj)
116 shape = geomObj._narrow(GEOM.GEOM_Object)
118 geomgui = salome.ImportComponentGUI("GEOM")
119 geomgui.createAndDisplayGO(entry)
120 geomgui.setDisplayMode(entry, DisplayMode)
121 if color is not None:
122 geomgui.setColor(entry, color[0], color[1], color[2])
126 def getGeomObjectSelected(self):
128 Returns the GEOM object currently selected in the objects browser.
130 sobject, entry = helper.getSObjectSelected()
131 geomObject = self.getGeomObjectFromEntry(entry)
134 def getGeomObjectFromEntry(self,entry):
136 Returns the GEOM object associated to the specified entry,
137 (the entry is the identifier of an item in the active study)
141 geomObject=IDToObject(entry, self.editor.study)
142 return geomObject._narrow(GEOM.GEOM_Object)
145 # ==================================================================
146 # Use cases and demo functions
147 # ==================================================================
151 # 1. Run a SALOME application including GEOM, and create a new study
152 # 2. In the console, enter:
153 # >>> from salome.geom import geomtools
154 # >>> geomtools.TEST_createBox()
155 # 3. Select the object named "box" in the browser
156 # 4. In the console, enter:
157 # >>> geomtools.TEST_getGeomObjectSelected()
159 def TEST_createBox():
161 box = geompy.MakeBoxDXDYDZ(200, 200, 200)
162 geompy.addToStudy( box, 'box' )
163 if salome.sg.hasDesktop():
164 salome.sg.updateObjBrowser(1)
167 def TEST_getGeomObjectSelected():
168 tool = GeomStudyTools()
169 myGeomObject = tool.getGeomObjectSelected()
172 if __name__ == "__main__":
173 TEST_getGeomObjectSelected()