GEOM_PY.geomtools.GeomStudyTools Class Reference

Public Member Functions
def	__init__
def	displayShapeByName
Data Fields
	editor

---

Detailed Description

This class provides several methods to manipulate geom objects in Salome
study. The parameter `studyEditor` defines a
:class:`~salome.kernel.studyedit.StudyEditor` object used to access the study. If
:const:`None`, the method returns a :class:`~salome.kernel.studyedit.StudyEditor`
object on the current study.

.. attribute:: editor

   This instance attribute contains the underlying
   :class:`~salome.kernel.studyedit.StudyEditor` object. It can be used to access
   the study but the attribute itself should not be modified.

---

Constructor & Destructor Documentation

def GEOM_PY.geomtools.GeomStudyTools.__init__	(		self,
			studyEditor = None
	)

---

Member Function Documentation

def GEOM_PY.geomtools.GeomStudyTools.displayShapeByName	(		self,
			shapeName,
			color = None
	)

Display the geometrical shape whose name in the study is `shapeName`.

:type   shapeName: string
:param  shapeName: name of the geometrical shape

:type   color: tuple (triplet)
:param  color: RGB components of the color of the shape

:return: True if the shape was found, False otherwise

---

Field Documentation

GEOM_PY.geomtools.GeomStudyTools.editor