src/GEOM_PY/sketcher.py

   1 # -*- coding: iso-8859-1 -*-
   2 #
   3 # Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   4 #
   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.
   9 #
  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.
  14 #
  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
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21 """
  22 This module provides the user with a simple python API to realize
  23 various sketches from the GEOM text user interface.
  24
  25 Example::
  26
  27     from salome.geom.sketcher import Sketcher
  28
  29     # Create the sketch
  30     mysketcher = Sketcher()
  31     mysketcher.startAtPoint(0,0)
  32     mysketcher.translateToPoint(100,0)
  33     mysketcher.translateWithAngleAndLength(30,100)
  34     mysketcher.intersectYWithAngle(15,100)
  35     mysketcher.close()
  36
  37     # Get the geom object
  38     wire = mysketcher.getGeomWire()
  39
  40     # Put it in the study
  41     from salome.geom import geomBuilder
  42     geompy = geomBuilder.New(salome.myStudy)
  43     geompy.addToStudy( wire, 'mysketch' )
  44
  45 Additionnal examples can be found as unit tests in the source code.
  46 """
  47 from salome.kernel.deprecation import is_called_by_sphinx
  48 geompyEnable = True
  49 if not is_called_by_sphinx():
  50     import salome
  51     salome.salome_init()
  52     import GEOM
  53     from salome.geom import geomBuilder
  54     geompy = geomBuilder.New(salome.myStudy)
  55
  56 class Sketcher:
  57
  58     __sketch = None
  59     __xstart = 0
  60     __ystart = 0
  61
  62     def __init__(self):
  63         self.__sketch = "Sketcher:"
  64
  65     def startAtPoint(self,x=0,y=0):
  66         self.__sketch = "Sketcher:F "+str(x)+" "+str(y)
  67         # the data x and y are registered to process the ending closure.
  68         self.__xstart = x
  69         self.__ystart = y
  70
  71     def translateToPoint(self,x=10,y=0):
  72         '''segment->point->absolute'''
  73         self.__sketch = self.__sketch + ":TT "+str(x)+" "+str(y)
  74
  75     def translateWithVector(self,deltax=10,deltay=0):
  76         '''segment->point->relative'''
  77         self.__sketch = self.__sketch + ":T "+str(deltax)+" "+str(deltay)
  78
  79     #def translateToSelection(self,vertex):
  80     #    '''segment->point->selection'''
  81     #    self.__sketch = self.__sketch + ":T "+str(deltax)+" "+str(deltay)
  82
  83     def translateWithAngleAndLength(self,angle=30,length=100):
  84         '''segment->direction->angle+length'''
  85         self.__sketch = self.__sketch + ":R "+str(angle)+":L "+str(length)
  86
  87     def intersectXWithAngle(self,angle=30,x=100):
  88         '''segment->direction->angle+length'''
  89         self.__sketch = self.__sketch + ":R "+str(angle)+":IX "+str(x)
  90
  91     def intersectYWithAngle(self,angle=30,y=100):
  92         '''segment->direction->angle+length'''
  93         self.__sketch = self.__sketch + ":R "+str(angle)+":IY "+str(y)
  94
  95     def close(self):
  96         '''
  97         add a segment to reach the starting point and get a closed wire.
  98         '''
  99         self.__sketch = self.__sketch + ":WW"
 100
 101     def toString(self):
 102         return self.__sketch
 103
 104     def getGeomWire(self):
 105         if not geompyEnable:
 106             return None
 107         wire = geompy.MakeSketcher(self.__sketch, [0, 0, 0, 0, 0, 1, 1, 0, -0])
 108         return wire
 109 #
 110 # ===============================================================
 111 # Use cases and unit tests
 112 # ===============================================================
 113 #
 114 def TEST_toString():
 115     mysketcher = Sketcher()
 116
 117     mysketcher.startAtPoint(1.234,4.321)
 118     mysketcher.translateToPoint(2.234,5.321)
 119
 120     expectedResult = "Sketcher:F 1.234 4.321:TT 2.234 5.321"
 121     result = mysketcher.toString()
 122     print "sketcher=",mysketcher.toString()
 123     if result == expectedResult:
 124         print "OK"
 125     else:
 126         print "Not OK"
 127
 128 def TEST_usingGeom():
 129     mysketcher = Sketcher()
 130     mysketcher.startAtPoint(0,0)
 131     mysketcher.translateToPoint(100,0)
 132     mysketcher.translateWithAngleAndLength(30,100)
 133     mysketcher.intersectYWithAngle(15,100)
 134     mysketcher.close()
 135     wire = mysketcher.getGeomWire()
 136     if geompyEnable:
 137         geompy.addToStudy( wire, "Sketch" )
 138
 139
 140 if __name__ == "__main__":
 141     #TEST_toString()
 142     TEST_usingGeom()