Salome HOME
0023210: [CEA 1681] Regression with the function GetInPlaceByHistory
[modules/geom.git] / src / GEOM_SWIG / geomBuilder.py
1 #  -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
3 #
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2.1 of the License, or (at your option) any later version.
8 #
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 # Lesser General Public License for more details.
13 #
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17 #
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #
20
21 #  GEOM GEOM_SWIG : binding of C++ implementation with Python
22 #  File   : geomBuilder.py
23 #  Author : Paul RASCLE, EDF
24 #  Module : GEOM
25
26 """
27     \namespace geomBuilder
28     \brief Module geomBuilder
29 """
30
31 ##
32 ## @defgroup geomBuilder geomBuilder Python module
33 ## @{
34 ##
35 ## @details
36 ##
37 ## By default, all functions of geomBuilder Python module do not publish
38 ## resulting geometrical objects. This can be done in the Python script
39 ## by means of \ref geomBuilder.geomBuilder.addToStudy() "addToStudy()"
40 ## or \ref geomBuilder.geomBuilder.addToStudyInFather() "addToStudyInFather()"
41 ## functions.
42 ##
43 ## However, it is possible to publish result data in the study
44 ## automatically. For this, almost each function of
45 ## \ref geomBuilder.geomBuilder "geomBuilder" class has
46 ## an additional @a theName parameter (@c None by default).
47 ## As soon as non-empty string value is passed to this parameter,
48 ## the result object is published in the study automatically.
49 ##
50 ## For example, consider the following Python script:
51 ##
52 ## @code
53 ## import salome
54 ## from salome.geom import geomBuilder
55 ## geompy = geomBuilder.New(salome.myStudy)
56 ## box = geompy.MakeBoxDXDYDZ(100, 100, 100) # box is not published in the study yet
57 ## geompy.addToStudy(box, "box")             # explicit publishing
58 ## @endcode
59 ##
60 ## Last two lines can be replaced by one-line instruction:
61 ##
62 ## @code
63 ## box = geompy.MakeBoxDXDYDZ(100, 100, 100, theName="box") # box is published in the study with "box" name
64 ## @endcode
65 ##
66 ## ... or simply
67 ##
68 ## @code
69 ## box = geompy.MakeBoxDXDYDZ(100, 100, 100, "box") # box is published in the study with "box" name
70 ## @endcode
71 ##
72 ## Note, that some functions produce more than one geometrical objects. For example,
73 ## \ref geomBuilder.geomBuilder.GetNonBlocks() "GetNonBlocks()" function returns two objects:
74 ## group of all non-hexa solids and group of all non-quad faces.
75 ## For such functions it is possible to specify separate names for results.
76 ##
77 ## For example
78 ##
79 ## @code
80 ## # create and publish cylinder
81 ## cyl = geompy.MakeCylinderRH(100, 100, "cylinder")
82 ## # get non blocks from cylinder
83 ## g1, g2 = geompy.GetNonBlocks(cyl, theName="nonblock")
84 ## @endcode
85 ##
86 ## Above example will publish both result compounds (first with non-hexa solids and
87 ## second with non-quad faces) as two items, both named "nonblock".
88 ## However, if second command is invoked as
89 ##
90 ## @code
91 ## g1, g2 = geompy.GetNonBlocks(cyl, theName=("nonhexa", "nonquad"))
92 ## @endcode
93 ##
94 ## ... the first compound will be published with "nonhexa" name, and second will be named "nonquad".
95 ##
96 ## Automatic publication of all results can be also enabled/disabled by means of the function
97 ## \ref geomBuilder.geomBuilder.addToStudyAuto() "addToStudyAuto()". The automatic publishing
98 ## is managed by the numeric parameter passed to this function:
99 ## - if @a maxNbSubShapes = 0, automatic publishing is disabled.
100 ## - if @a maxNbSubShapes = -1 (default), automatic publishing is enabled and
101 ##   maximum number of sub-shapes allowed for publishing is unlimited; any negative
102 ##   value passed as parameter has the same effect.
103 ## - if @a maxNbSubShapes is any positive value, automatic publishing is enabled and
104 ##   maximum number of sub-shapes allowed for publishing is set to specified value.
105 ##
106 ## When automatic publishing is enabled, you even do not need to pass @a theName parameter
107 ## to the functions creating objects, instead default names will be used. However, you
108 ## can always change the behavior, by passing explicit name to the @a theName parameter
109 ## and it will be used instead default one.
110 ## The publishing of the collections of objects will be done according to the above
111 ## mentioned rules (maximum allowed number of sub-shapes).
112 ##
113 ## For example:
114 ##
115 ## @code
116 ## import salome
117 ## from salome.geom import geomBuilder
118 ## geompy = geomBuilder.New(salome.myStudy)
119 ## geompy.addToStudyAuto() # enable automatic publication
120 ## box = geompy.MakeBoxDXDYDZ(100, 100, 100)
121 ## # the box is created and published in the study with default name
122 ## geompy.addToStudyAuto(5) # set max allowed number of sub-shapes to 5
123 ## vertices = geompy.SubShapeAll(box, geomBuilder.ShapeType['VERTEX'])
124 ## # only 5 first vertices will be published, with default names
125 ## print len(vertices)
126 ## # note, that result value still containes all 8 vertices
127 ## geompy.addToStudyAuto(-1) # disable automatic publication
128 ## @endcode
129 ##
130 ## This feature can be used, for example, for debugging purposes.
131 ##
132 ## @note
133 ## - Use automatic publication feature with caution. When it is enabled, any function of
134 ##   \ref geomBuilder.geomBuilder "geomBuilder" class publishes the results in the study,
135 ##   that can lead to the huge size of the study data tree.
136 ##   For example, repeating call of \ref geomBuilder.geomBuilder.SubShapeAll() "SubShapeAll()"
137 ##   command on the same main shape each time will publish all child objects, that will lead
138 ##   to a lot of duplicated items in the study.
139 ## - Sub-shapes are automatically published as child items of the parent main shape in the study if main
140 ##   shape was also published before. Otherwise, sub-shapes are published as top-level objects.
141 ## - Some functions of \ref geomBuilder.geomBuilder "geomBuilder" class do not have
142 ##   \a theName parameter (and, thus, do not support automatic publication).
143 ##   For example, some transformation operations like
144 ##   \ref geomBuilder.geomBuilder.TranslateDXDYDZ() "TranslateDXDYDZ()".
145 ##   Refer to the documentation to check if some function has such possibility.
146 ##
147 ## It is possible to customize the representation of the geometrical
148 ## data in the data tree; this can be done by using folders. A folder can
149 ## be created in the study tree using function
150 ## \ref geomBuilder.geomBuilder.NewFolder() "NewFolder()"
151 ## (by default it is created under the "Geometry" root object).
152 ## As soon as folder is created, any published geometry object
153 ## can be moved into it.
154 ##
155 ## For example:
156 ##
157 ## @code
158 ## import salome
159 ## from salome.geom import geomBuilder
160 ## geompy = geomBuilder.New(salome.myStudy)
161 ## box = geompy.MakeBoxDXDYDZ(100, 100, 100, "Box")
162 ## # the box was created and published in the study
163 ## folder = geompy.NewFolder("Primitives")
164 ## # an empty "Primitives" folder was created under default "Geometry" root object
165 ## geompy.PutToFolder(box, folder)
166 ## # the box was moved into "Primitives" folder
167 ## @endcode
168 ##
169 ## Subfolders are also can be created by specifying another folder as a parent:
170 ##
171 ## @code
172 ## subfolder = geompy.NewFolder("3D", folder)
173 ## # "3D" folder was created under "Primitives" folder
174 ## @endcode
175 ##
176 ## @note
177 ## - Folder container is just a representation layer object that
178 ## deals with already published objects only. So, any geometry object
179 ## should be published in the study (for example, with
180 ## \ref geomBuilder.geomBuilder.PutToFolder() "addToStudy()" function)
181 ## BEFORE moving it into any existing folder.
182 ## - \ref geomBuilder.geomBuilder.PutToFolder() "PutToFolder()" function
183 ## does not change physical position of geometry object in the study tree,
184 ## it only affects on the representation of the data tree.
185 ## - It is impossible to publish geometry object using any folder as father.
186 ##
187 ##  \defgroup l1_publish_data
188 ##  \defgroup l1_geomBuilder_auxiliary
189 ##  \defgroup l1_geomBuilder_purpose
190 ## @}
191
192 ## @defgroup l1_publish_data Publishing results in SALOME study
193
194 ## @defgroup l1_geomBuilder_auxiliary Auxiliary data structures and methods
195
196 ## @defgroup l1_geomBuilder_purpose   All package methods, grouped by their purpose
197 ## @{
198 ##   @defgroup l2_import_export Importing/exporting geometrical objects
199 ##   @defgroup l2_creating      Creating geometrical objects
200 ##   @{
201 ##     @defgroup l3_basic_go      Creating Basic Geometric Objects
202 ##     @{
203 ##       @defgroup l4_curves        Creating Curves
204
205 ##     @}
206 ##     @defgroup l3_3d_primitives Creating 3D Primitives
207 ##     @defgroup l3_complex       Creating Complex Objects
208 ##     @defgroup l3_groups        Working with groups
209 ##     @defgroup l3_blocks        Building by blocks
210 ##     @{
211 ##       @defgroup l4_blocks_measure Check and Improve
212
213 ##     @}
214 ##     @defgroup l3_sketcher      Sketcher
215 ##     @defgroup l3_advanced      Creating Advanced Geometrical Objects
216 ##     @{
217 ##       @defgroup l4_decompose     Decompose objects
218 ##       @defgroup l4_decompose_d   Decompose objects deprecated methods
219 ##       @defgroup l4_access        Access to sub-shapes by their unique IDs inside the main shape
220 ##       @defgroup l4_obtain        Access to sub-shapes by a criteria
221 ##       @defgroup l4_advanced      Advanced objects creation functions
222
223 ##     @}
224
225 ##   @}
226 ##   @defgroup l2_transforming  Transforming geometrical objects
227 ##   @{
228 ##     @defgroup l3_basic_op      Basic Operations
229 ##     @defgroup l3_boolean       Boolean Operations
230 ##     @defgroup l3_transform     Transformation Operations
231 ##     @defgroup l3_transform_d   Transformation Operations deprecated methods
232 ##     @defgroup l3_local         Local Operations (Fillet, Chamfer and other Features)
233 ##     @defgroup l3_blocks_op     Blocks Operations
234 ##     @defgroup l3_healing       Repairing Operations
235 ##     @defgroup l3_restore_ss    Restore presentation parameters and a tree of sub-shapes
236
237 ##   @}
238 ##   @defgroup l2_measure       Using measurement tools
239 ##   @defgroup l2_field         Field on Geometry
240
241 ## @}
242
243 # initialize SALOME session in try/except block
244 # to avoid problems in some cases, e.g. when generating documentation
245 try:
246     import salome
247     salome.salome_init()
248     from salome import *
249 except:
250     pass
251
252 from salome_notebook import *
253
254 import GEOM
255 import math
256 import os
257 import functools
258
259 from salome.geom.gsketcher import Sketcher3D, Sketcher2D, Polyline2D
260
261 # service function
262 def _toListOfNames(_names, _size=-1):
263     l = []
264     import types
265     if type(_names) in [types.ListType, types.TupleType]:
266         for i in _names: l.append(i)
267     elif _names:
268         l.append(_names)
269     if l and len(l) < _size:
270         for i in range(len(l), _size): l.append("%s_%d"%(l[0],i))
271     return l
272
273 # Decorator function to manage transactions for all geometric operations.
274 def ManageTransactions(theOpeName):
275     def MTDecorator(theFunction):
276         # To keep the original function name an documentation.
277         @functools.wraps(theFunction)
278         def OpenCallClose(self, *args, **kwargs):
279             # Open transaction
280             anOperation = getattr(self, theOpeName)
281             anOperation.StartOperation()
282             try:
283                 # Call the function
284                 res = theFunction(self, *args, **kwargs)
285                 # Commit transaction
286                 anOperation.FinishOperation()
287                 return res
288             except:
289                 # Abort transaction
290                 anOperation.AbortOperation()
291                 raise
292         return OpenCallClose
293     return MTDecorator
294
295 ## Raise an Error, containing the Method_name, if Operation is Failed
296 ## @ingroup l1_geomBuilder_auxiliary
297 def RaiseIfFailed (Method_name, Operation):
298     if not Operation.IsDone() and Operation.GetErrorCode() != "NOT_FOUND_ANY":
299         raise RuntimeError, Method_name + " : " + Operation.GetErrorCode()
300
301 ## Return list of variables value from salome notebook
302 ## @ingroup l1_geomBuilder_auxiliary
303 def ParseParameters(*parameters):
304     Result = []
305     StringResult = []
306     for parameter in parameters:
307         if isinstance(parameter, list):
308             lResults = ParseParameters(*parameter)
309             if len(lResults) > 0:
310                 Result.append(lResults[:-1])
311                 StringResult += lResults[-1].split(":")
312                 pass
313             pass
314         else:
315             if isinstance(parameter,str):
316                 if notebook.isVariable(parameter):
317                     Result.append(notebook.get(parameter))
318                 else:
319                     raise RuntimeError, "Variable with name '" + parameter + "' doesn't exist!!!"
320                 pass
321             else:
322                 Result.append(parameter)
323                 pass
324             StringResult.append(str(parameter))
325             pass
326         pass
327     if Result:
328         Result.append(":".join(StringResult))
329     else:
330         Result = ":".join(StringResult)
331     return Result
332
333 ## Return list of variables value from salome notebook
334 ## @ingroup l1_geomBuilder_auxiliary
335 def ParseList(list):
336     Result = []
337     StringResult = ""
338     for parameter in list:
339         if isinstance(parameter,str) and notebook.isVariable(parameter):
340             Result.append(str(notebook.get(parameter)))
341             pass
342         else:
343             Result.append(str(parameter))
344             pass
345
346         StringResult = StringResult + str(parameter)
347         StringResult = StringResult + ":"
348         pass
349     StringResult = StringResult[:len(StringResult)-1]
350     return Result, StringResult
351
352 ## Return list of variables value from salome notebook
353 ## @ingroup l1_geomBuilder_auxiliary
354 def ParseSketcherCommand(command):
355     Result = ""
356     StringResult = ""
357     sections = command.split(":")
358     for section in sections:
359         parameters = section.split(" ")
360         paramIndex = 1
361         for parameter in parameters:
362             if paramIndex > 1 and parameter.find("'") != -1:
363                 parameter = parameter.replace("'","")
364                 if notebook.isVariable(parameter):
365                     Result = Result + str(notebook.get(parameter)) + " "
366                     pass
367                 else:
368                     raise RuntimeError, "Variable with name '" + parameter + "' doesn't exist!!!"
369                     pass
370                 pass
371             else:
372                 Result = Result + str(parameter) + " "
373                 pass
374             if paramIndex > 1:
375                 StringResult = StringResult + parameter
376                 StringResult = StringResult + ":"
377                 pass
378             paramIndex = paramIndex + 1
379             pass
380         Result = Result[:len(Result)-1] + ":"
381         pass
382     Result = Result[:len(Result)-1]
383     return Result, StringResult
384
385 ## Helper function which can be used to pack the passed string to the byte data.
386 ## Only '1' an '0' symbols are valid for the string. The missing bits are replaced by zeroes.
387 ## If the string contains invalid symbol (neither '1' nor '0'), the function raises an exception.
388 ## For example,
389 ## \code
390 ## val = PackData("10001110") # val = 0xAE
391 ## val = PackData("1")        # val = 0x80
392 ## \endcode
393 ## @param data unpacked data - a string containing '1' and '0' symbols
394 ## @return data packed to the byte stream
395 ## @ingroup l1_geomBuilder_auxiliary
396 def PackData(data):
397     """
398     Helper function which can be used to pack the passed string to the byte data.
399     Only '1' an '0' symbols are valid for the string. The missing bits are replaced by zeroes.
400     If the string contains invalid symbol (neither '1' nor '0'), the function raises an exception.
401
402     Parameters:
403         data unpacked data - a string containing '1' and '0' symbols
404
405     Returns:
406         data packed to the byte stream
407
408     Example of usage:
409         val = PackData("10001110") # val = 0xAE
410         val = PackData("1")        # val = 0x80
411     """
412     bytes = len(data)/8
413     if len(data)%8: bytes += 1
414     res = ""
415     for b in range(bytes):
416         d = data[b*8:(b+1)*8]
417         val = 0
418         for i in range(8):
419             val *= 2
420             if i < len(d):
421                 if d[i] == "1": val += 1
422                 elif d[i] != "0":
423                     raise "Invalid symbol %s" % d[i]
424                 pass
425             pass
426         res += chr(val)
427         pass
428     return res
429
430 ## Read bitmap texture from the text file.
431 ## In that file, any non-zero symbol represents '1' opaque pixel of the bitmap.
432 ## A zero symbol ('0') represents transparent pixel of the texture bitmap.
433 ## The function returns width and height of the pixmap in pixels and byte stream representing
434 ## texture bitmap itself.
435 ##
436 ## This function can be used to read the texture to the byte stream in order to pass it to
437 ## the AddTexture() function of geomBuilder class.
438 ## For example,
439 ## \code
440 ## from salome.geom import geomBuilder
441 ## geompy = geomBuilder.New(salome.myStudy)
442 ## texture = geompy.readtexture('mytexture.dat')
443 ## texture = geompy.AddTexture(*texture)
444 ## obj.SetMarkerTexture(texture)
445 ## \endcode
446 ## @param fname texture file name
447 ## @return sequence of tree values: texture's width, height in pixels and its byte stream
448 ## @ingroup l1_geomBuilder_auxiliary
449 def ReadTexture(fname):
450     """
451     Read bitmap texture from the text file.
452     In that file, any non-zero symbol represents '1' opaque pixel of the bitmap.
453     A zero symbol ('0') represents transparent pixel of the texture bitmap.
454     The function returns width and height of the pixmap in pixels and byte stream representing
455     texture bitmap itself.
456     This function can be used to read the texture to the byte stream in order to pass it to
457     the AddTexture() function of geomBuilder class.
458
459     Parameters:
460         fname texture file name
461
462     Returns:
463         sequence of tree values: texture's width, height in pixels and its byte stream
464
465     Example of usage:
466         from salome.geom import geomBuilder
467         geompy = geomBuilder.New(salome.myStudy)
468         texture = geompy.readtexture('mytexture.dat')
469         texture = geompy.AddTexture(*texture)
470         obj.SetMarkerTexture(texture)
471     """
472     try:
473         f = open(fname)
474         lines = [ l.strip() for l in f.readlines()]
475         f.close()
476         maxlen = 0
477         if lines: maxlen = max([len(x) for x in lines])
478         lenbytes = maxlen/8
479         if maxlen%8: lenbytes += 1
480         bytedata=""
481         for line in lines:
482             if len(line)%8:
483                 lenline = (len(line)/8+1)*8
484                 pass
485             else:
486                 lenline = (len(line)/8)*8
487                 pass
488             for i in range(lenline/8):
489                 byte=""
490                 for j in range(8):
491                     if i*8+j < len(line) and line[i*8+j] != "0": byte += "1"
492                     else: byte += "0"
493                     pass
494                 bytedata += PackData(byte)
495                 pass
496             for i in range(lenline/8, lenbytes):
497                 bytedata += PackData("0")
498             pass
499         return lenbytes*8, len(lines), bytedata
500     except:
501         pass
502     return 0, 0, ""
503
504 ## Returns a long value from enumeration type
505 #  Can be used for CORBA enumerator types like GEOM.shape_type
506 #  @param theItem enumeration type
507 #  @ingroup l1_geomBuilder_auxiliary
508 def EnumToLong(theItem):
509     """
510     Returns a long value from enumeration type
511     Can be used for CORBA enumerator types like geomBuilder.ShapeType
512
513     Parameters:
514         theItem enumeration type
515     """
516     ret = theItem
517     if hasattr(theItem, "_v"): ret = theItem._v
518     return ret
519
520 ## Pack an argument into a list
521 def ToList( arg ):
522     if isinstance( arg, list ):
523         return arg
524     if hasattr( arg, "__getitem__" ):
525         return list( arg )
526     return [ arg ]
527
528 ## Information about closed/unclosed state of shell or wire
529 #  @ingroup l1_geomBuilder_auxiliary
530 class info:
531     """
532     Information about closed/unclosed state of shell or wire
533     """
534     UNKNOWN  = 0
535     CLOSED   = 1
536     UNCLOSED = 2
537
538 ## Private class used to bind calls of plugin operations to geomBuilder
539 class PluginOperation:
540   def __init__(self, operation, function):
541     self.operation = operation
542     self.function = function
543     pass
544
545   @ManageTransactions("operation")
546   def __call__(self, *args):
547     res = self.function(self.operation, *args)
548     RaiseIfFailed(self.function.__name__, self.operation)
549     return res
550
551 # Warning: geom is a singleton
552 geom = None
553 engine = None
554 doLcc = False
555 created = False
556
557 class geomBuilder(object, GEOM._objref_GEOM_Gen):
558
559         ## Enumeration ShapeType as a dictionary. \n
560         ## Topological types of shapes (like Open Cascade types). See GEOM::shape_type for details.
561         #  @ingroup l1_geomBuilder_auxiliary
562         ShapeType = {"AUTO":-1, "COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8, "FLAT":9}
563
564         ## Kinds of shape in terms of <VAR>GEOM.GEOM_IKindOfShape.shape_kind</VAR> enumeration
565         #  and a list of parameters, describing the shape.
566         #  List of parameters, describing the shape:
567         #  - COMPOUND:            [nb_solids  nb_faces  nb_edges  nb_vertices]
568         #  - COMPSOLID:           [nb_solids  nb_faces  nb_edges  nb_vertices]
569         #
570         #  - SHELL:       [info.CLOSED / info.UNCLOSED  nb_faces  nb_edges  nb_vertices]
571         #
572         #  - WIRE:        [info.CLOSED / info.UNCLOSED nb_edges  nb_vertices]
573         #
574         #  - SPHERE:       [xc yc zc            R]
575         #  - CYLINDER:     [xb yb zb  dx dy dz  R         H]
576         #  - BOX:          [xc yc zc                      ax ay az]
577         #  - ROTATED_BOX:  [xc yc zc  zx zy zz  xx xy xz  ax ay az]
578         #  - TORUS:        [xc yc zc  dx dy dz  R_1  R_2]
579         #  - CONE:         [xb yb zb  dx dy dz  R_1  R_2  H]
580         #  - POLYHEDRON:                       [nb_faces  nb_edges  nb_vertices]
581         #  - SOLID:                            [nb_faces  nb_edges  nb_vertices]
582         #
583         #  - SPHERE2D:     [xc yc zc            R]
584         #  - CYLINDER2D:   [xb yb zb  dx dy dz  R         H]
585         #  - TORUS2D:      [xc yc zc  dx dy dz  R_1  R_2]
586         #  - CONE2D:       [xc yc zc  dx dy dz  R_1  R_2  H]
587         #  - DISK_CIRCLE:  [xc yc zc  dx dy dz  R]
588         #  - DISK_ELLIPSE: [xc yc zc  dx dy dz  R_1  R_2]
589         #  - POLYGON:      [xo yo zo  dx dy dz            nb_edges  nb_vertices]
590         #  - PLANE:        [xo yo zo  dx dy dz]
591         #  - PLANAR:       [xo yo zo  dx dy dz            nb_edges  nb_vertices]
592         #  - FACE:                                       [nb_edges  nb_vertices]
593         #
594         #  - CIRCLE:       [xc yc zc  dx dy dz  R]
595         #  - ARC_CIRCLE:   [xc yc zc  dx dy dz  R         x1 y1 z1  x2 y2 z2]
596         #  - ELLIPSE:      [xc yc zc  dx dy dz  R_1  R_2]
597         #  - ARC_ELLIPSE:  [xc yc zc  dx dy dz  R_1  R_2  x1 y1 z1  x2 y2 z2]
598         #  - LINE:         [xo yo zo  dx dy dz]
599         #  - SEGMENT:      [x1 y1 z1  x2 y2 z2]
600         #  - EDGE:                                                 [nb_vertices]
601         #
602         #  - VERTEX:       [x  y  z]
603         #
604         #  - LCS:          [x y z  xx xy xz  yx yy yz  zx zy zz]
605         #  @ingroup l1_geomBuilder_auxiliary
606         kind = GEOM.GEOM_IKindOfShape
607
608         def __new__(cls):
609             global engine
610             global geom
611             global doLcc
612             global created
613             #print "==== __new__ ", engine, geom, doLcc, created
614             if geom is None:
615                 # geom engine is either retrieved from engine, or created
616                 geom = engine
617                 # Following test avoids a recursive loop
618                 if doLcc:
619                     if geom is not None:
620                         # geom engine not created: existing engine found
621                         doLcc = False
622                     if doLcc and not created:
623                         doLcc = False
624                         # FindOrLoadComponent called:
625                         # 1. CORBA resolution of server
626                         # 2. the __new__ method is called again
627                         #print "==== FindOrLoadComponent ", engine, geom, doLcc, created
628                         geom = lcc.FindOrLoadComponent( "FactoryServer", "GEOM" )
629                         #print "====1 ",geom
630                 else:
631                     # FindOrLoadComponent not called
632                     if geom is None:
633                         # geomBuilder instance is created from lcc.FindOrLoadComponent
634                         #print "==== super ", engine, geom, doLcc, created
635                         geom = super(geomBuilder,cls).__new__(cls)
636                         #print "====2 ",geom
637                     else:
638                         # geom engine not created: existing engine found
639                         #print "==== existing ", engine, geom, doLcc, created
640                         pass
641                 #print "return geom 1 ", geom
642                 return geom
643
644             #print "return geom 2 ", geom
645             return geom
646
647         def __init__(self):
648             global created
649             #print "-------- geomBuilder __init__ --- ", created, self
650             if not created:
651               created = True
652               GEOM._objref_GEOM_Gen.__init__(self)
653               self.myMaxNbSubShapesAllowed = 0 # auto-publishing is disabled by default
654               self.myBuilder = None
655               self.myStudyId = 0
656               self.father    = None
657
658               self.BasicOp  = None
659               self.CurvesOp = None
660               self.PrimOp   = None
661               self.ShapesOp = None
662               self.HealOp   = None
663               self.InsertOp = None
664               self.BoolOp   = None
665               self.TrsfOp   = None
666               self.LocalOp  = None
667               self.MeasuOp  = None
668               self.BlocksOp = None
669               self.GroupOp  = None
670               self.FieldOp  = None
671             pass
672
673         ## Process object publication in the study, as follows:
674         #  - if @a theName is specified (not None), the object is published in the study
675         #    with this name, not taking into account "auto-publishing" option;
676         #  - if @a theName is NOT specified, the object is published in the study
677         #    (using default name, which can be customized using @a theDefaultName parameter)
678         #    only if auto-publishing is switched on.
679         #
680         #  @param theObj  object, a subject for publishing
681         #  @param theName object name for study
682         #  @param theDefaultName default name for the auto-publishing
683         #
684         #  @sa addToStudyAuto()
685         def _autoPublish(self, theObj, theName, theDefaultName="noname"):
686             # ---
687             def _item_name(_names, _defname, _idx=-1):
688                 if not _names: _names = _defname
689                 if type(_names) in [types.ListType, types.TupleType]:
690                     if _idx >= 0:
691                         if _idx >= len(_names) or not _names[_idx]:
692                             if type(_defname) not in [types.ListType, types.TupleType]:
693                                 _name = "%s_%d"%(_defname, _idx+1)
694                             elif len(_defname) > 0 and _idx >= 0 and _idx < len(_defname):
695                                 _name = _defname[_idx]
696                             else:
697                                 _name = "%noname_%d"%(dn, _idx+1)
698                             pass
699                         else:
700                             _name = _names[_idx]
701                         pass
702                     else:
703                         # must be wrong  usage
704                         _name = _names[0]
705                     pass
706                 else:
707                     if _idx >= 0:
708                         _name = "%s_%d"%(_names, _idx+1)
709                     else:
710                         _name = _names
711                     pass
712                 return _name
713             # ---
714             def _publish( _name, _obj ):
715                 fatherObj = None
716                 if isinstance( _obj, GEOM._objref_GEOM_Field ):
717                     fatherObj = _obj.GetShape()
718                 elif isinstance( _obj, GEOM._objref_GEOM_FieldStep ):
719                     fatherObj = _obj.GetField()
720                 elif not _obj.IsMainShape():
721                     fatherObj = _obj.GetMainShape()
722                     pass
723                 if fatherObj and fatherObj.GetStudyEntry():
724                     self.addToStudyInFather(fatherObj, _obj, _name)
725                 else:
726                     self.addToStudy(_obj, _name)
727                     pass
728                 return
729             # ---
730             if not theObj:
731                 return # null object
732             if not theName and not self.myMaxNbSubShapesAllowed:
733                 return # nothing to do: auto-publishing is disabled
734             if not theName and not theDefaultName:
735                 return # neither theName nor theDefaultName is given
736             import types
737             if type(theObj) in [types.ListType, types.TupleType]:
738                 # list of objects is being published
739                 idx = 0
740                 for obj in theObj:
741                     if not obj: continue # bad object
742                     name = _item_name(theName, theDefaultName, idx)
743                     _publish( name, obj )
744                     idx = idx+1
745                     if not theName and idx == self.myMaxNbSubShapesAllowed: break
746                     pass
747                 pass
748             else:
749                 # single object is published
750                 name = _item_name(theName, theDefaultName)
751                 _publish( name, theObj )
752             pass
753
754         ## @addtogroup l1_geomBuilder_auxiliary
755         ## @{
756         def init_geom(self,theStudy):
757             self.myStudy = theStudy
758             self.myStudyId = self.myStudy._get_StudyId()
759             self.myBuilder = self.myStudy.NewBuilder()
760             self.father = self.myStudy.FindComponent("GEOM")
761             notebook.myStudy = theStudy
762             if self.father is None:
763                 self.father = self.myBuilder.NewComponent("GEOM")
764                 A1 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributeName")
765                 FName = A1._narrow(SALOMEDS.AttributeName)
766                 FName.SetValue("Geometry")
767                 A2 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributePixMap")
768                 aPixmap = A2._narrow(SALOMEDS.AttributePixMap)
769                 aPixmap.SetPixMap("ICON_OBJBROWSER_Geometry")
770                 self.myBuilder.DefineComponentInstance(self.father,self)
771                 pass
772             self.BasicOp  = self.GetIBasicOperations    (self.myStudyId)
773             self.CurvesOp = self.GetICurvesOperations   (self.myStudyId)
774             self.PrimOp   = self.GetI3DPrimOperations   (self.myStudyId)
775             self.ShapesOp = self.GetIShapesOperations   (self.myStudyId)
776             self.HealOp   = self.GetIHealingOperations  (self.myStudyId)
777             self.InsertOp = self.GetIInsertOperations   (self.myStudyId)
778             self.BoolOp   = self.GetIBooleanOperations  (self.myStudyId)
779             self.TrsfOp   = self.GetITransformOperations(self.myStudyId)
780             self.LocalOp  = self.GetILocalOperations    (self.myStudyId)
781             self.MeasuOp  = self.GetIMeasureOperations  (self.myStudyId)
782             self.BlocksOp = self.GetIBlocksOperations   (self.myStudyId)
783             self.GroupOp  = self.GetIGroupOperations    (self.myStudyId)
784             self.FieldOp  = self.GetIFieldOperations    (self.myStudyId)
785
786             # set GEOM as root in the use case tree
787             self.myUseCaseBuilder = self.myStudy.GetUseCaseBuilder()
788             self.myUseCaseBuilder.SetRootCurrent()
789             self.myUseCaseBuilder.Append(self.father)
790
791             # load data from the study file, if necessary
792             self.myBuilder.LoadWith(self.father, self)
793             pass
794
795         def GetPluginOperations(self, studyID, libraryName):
796             op = GEOM._objref_GEOM_Gen.GetPluginOperations(self, studyID, libraryName)
797             return op
798
799         ## Enable / disable results auto-publishing
800         #
801         #  The automatic publishing is managed in the following way:
802         #  - if @a maxNbSubShapes = 0, automatic publishing is disabled.
803         #  - if @a maxNbSubShapes = -1 (default), automatic publishing is enabled and
804         #  maximum number of sub-shapes allowed for publishing is unlimited; any negative
805         #  value passed as parameter has the same effect.
806         #  - if @a maxNbSubShapes is any positive value, automatic publishing is enabled and
807         #  maximum number of sub-shapes allowed for publishing is set to specified value.
808         #
809         #  @param maxNbSubShapes maximum number of sub-shapes allowed for publishing.
810         #  @ingroup l1_publish_data
811         def addToStudyAuto(self, maxNbSubShapes=-1):
812             """
813             Enable / disable results auto-publishing
814
815             The automatic publishing is managed in the following way:
816             - if @a maxNbSubShapes = 0, automatic publishing is disabled;
817             - if @a maxNbSubShapes = -1 (default), automatic publishing is enabled and
818             maximum number of sub-shapes allowed for publishing is unlimited; any negative
819             value passed as parameter has the same effect.
820             - if @a maxNbSubShapes is any positive value, automatic publishing is enabled and
821             maximum number of sub-shapes allowed for publishing is set to this value.
822
823             Parameters:
824                 maxNbSubShapes maximum number of sub-shapes allowed for publishing.
825
826             Example of usage:
827                 geompy.addToStudyAuto()   # enable auto-publishing
828                 geompy.MakeBoxDXDYDZ(100) # box is created and published with default name
829                 geompy.addToStudyAuto(0)  # disable auto-publishing
830             """
831             self.myMaxNbSubShapesAllowed = max(-1, maxNbSubShapes)
832             pass
833
834         ## Dump component to the Python script
835         #  This method overrides IDL function to allow default values for the parameters.
836         def DumpPython(self, theStudy, theIsPublished=True, theIsMultiFile=True):
837             """
838             Dump component to the Python script
839             This method overrides IDL function to allow default values for the parameters.
840             """
841             return GEOM._objref_GEOM_Gen.DumpPython(self, theStudy, theIsPublished, theIsMultiFile)
842
843         ## Get name for sub-shape aSubObj of shape aMainObj
844         #
845         # @ref swig_SubShapeName "Example"
846         @ManageTransactions("ShapesOp")
847         def SubShapeName(self,aSubObj, aMainObj):
848             """
849             Get name for sub-shape aSubObj of shape aMainObj
850             """
851             # Example: see GEOM_TestAll.py
852
853             #aSubId  = orb.object_to_string(aSubObj)
854             #aMainId = orb.object_to_string(aMainObj)
855             #index = gg.getIndexTopology(aSubId, aMainId)
856             #name = gg.getShapeTypeString(aSubId) + "_%d"%(index)
857             index = self.ShapesOp.GetTopologyIndex(aMainObj, aSubObj)
858             name = self.ShapesOp.GetShapeTypeString(aSubObj) + "_%d"%(index)
859             return name
860
861         ## Publish in study aShape with name aName
862         #
863         #  \param aShape the shape to be published
864         #  \param aName  the name for the shape
865         #  \param doRestoreSubShapes if True, finds and publishes also
866         #         sub-shapes of <VAR>aShape</VAR>, corresponding to its arguments
867         #         and published sub-shapes of arguments
868         #  \param theArgs,theFindMethod,theInheritFirstArg see RestoreSubShapes() for
869         #                                                  these arguments description
870         #  \return study entry of the published shape in form of string
871         #
872         #  @ingroup l1_publish_data
873         #  @ref swig_all_addtostudy "Example"
874         def addToStudy(self, aShape, aName, doRestoreSubShapes=False,
875                        theArgs=[], theFindMethod=GEOM.FSM_GetInPlace, theInheritFirstArg=False):
876             """
877             Publish in study aShape with name aName
878
879             Parameters:
880                 aShape the shape to be published
881                 aName  the name for the shape
882                 doRestoreSubShapes if True, finds and publishes also
883                                    sub-shapes of aShape, corresponding to its arguments
884                                    and published sub-shapes of arguments
885                 theArgs,theFindMethod,theInheritFirstArg see geompy.RestoreSubShapes() for
886                                                          these arguments description
887
888             Returns:
889                 study entry of the published shape in form of string
890
891             Example of usage:
892                 id_block1 = geompy.addToStudy(Block1, "Block 1")
893             """
894             # Example: see GEOM_TestAll.py
895             try:
896                 aSObject = self.AddInStudy(self.myStudy, aShape, aName, None)
897                 if aSObject and aName: aSObject.SetAttrString("AttributeName", aName)
898                 if doRestoreSubShapes:
899                     self.RestoreSubShapesSO(self.myStudy, aSObject, theArgs,
900                                             theFindMethod, theInheritFirstArg, True )
901             except:
902                 print "addToStudy() failed"
903                 return ""
904             return aShape.GetStudyEntry()
905
906         ## Publish in study aShape with name aName as sub-object of previously published aFather
907         #  \param aFather previously published object
908         #  \param aShape the shape to be published as sub-object of <VAR>aFather</VAR>
909         #  \param aName  the name for the shape
910         #
911         #  \return study entry of the published shape in form of string
912         #
913         #  @ingroup l1_publish_data
914         #  @ref swig_all_addtostudyInFather "Example"
915         def addToStudyInFather(self, aFather, aShape, aName):
916             """
917             Publish in study aShape with name aName as sub-object of previously published aFather
918
919             Parameters:
920                 aFather previously published object
921                 aShape the shape to be published as sub-object of aFather
922                 aName  the name for the shape
923
924             Returns:
925                 study entry of the published shape in form of string
926             """
927             # Example: see GEOM_TestAll.py
928             try:
929                 aSObject = self.AddInStudy(self.myStudy, aShape, aName, aFather)
930                 if aSObject and aName: aSObject.SetAttrString("AttributeName", aName)
931             except:
932                 print "addToStudyInFather() failed"
933                 return ""
934             return aShape.GetStudyEntry()
935
936         ## Unpublish object in study
937         #
938         #  \param obj the object to be unpublished
939         def hideInStudy(self, obj):
940             """
941             Unpublish object in study
942
943             Parameters:
944                 obj the object to be unpublished
945             """
946             ior = salome.orb.object_to_string(obj)
947             aSObject = self.myStudy.FindObjectIOR(ior)
948             if aSObject is not None:
949                 genericAttribute = self.myBuilder.FindOrCreateAttribute(aSObject, "AttributeDrawable")
950                 drwAttribute = genericAttribute._narrow(SALOMEDS.AttributeDrawable)
951                 drwAttribute.SetDrawable(False)
952                 # hide references if any
953                 vso = self.myStudy.FindDependances(aSObject);
954                 for refObj in vso :
955                     genericAttribute = self.myBuilder.FindOrCreateAttribute(refObj, "AttributeDrawable")
956                     drwAttribute = genericAttribute._narrow(SALOMEDS.AttributeDrawable)
957                     drwAttribute.SetDrawable(False)
958                     pass
959                 pass
960
961         # end of l1_geomBuilder_auxiliary
962         ## @}
963
964         ## @addtogroup l3_restore_ss
965         ## @{
966
967         ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
968         #  To be used from python scripts out of addToStudy() (non-default usage)
969         #  \param theObject published GEOM.GEOM_Object, arguments of which will be published
970         #  \param theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
971         #                   If this list is empty, all operation arguments will be published
972         #  \param theFindMethod method to search sub-shapes, corresponding to arguments and
973         #                       their sub-shapes. Value from enumeration GEOM.find_shape_method.
974         #  \param theInheritFirstArg set properties of the first argument for <VAR>theObject</VAR>.
975         #                            Do not publish sub-shapes in place of arguments, but only
976         #                            in place of sub-shapes of the first argument,
977         #                            because the whole shape corresponds to the first argument.
978         #                            Mainly to be used after transformations, but it also can be
979         #                            usefull after partition with one object shape, and some other
980         #                            operations, where only the first argument has to be considered.
981         #                            If theObject has only one argument shape, this flag is automatically
982         #                            considered as True, not regarding really passed value.
983         #  \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
984         #                      and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
985         #  \return list of published sub-shapes
986         #
987         #  @ref tui_restore_prs_params "Example"
988         def RestoreSubShapes (self, theObject, theArgs=[], theFindMethod=GEOM.FSM_GetInPlace,
989                               theInheritFirstArg=False, theAddPrefix=True):
990             """
991             Publish sub-shapes, standing for arguments and sub-shapes of arguments
992             To be used from python scripts out of geompy.addToStudy (non-default usage)
993
994             Parameters:
995                 theObject published GEOM.GEOM_Object, arguments of which will be published
996                 theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
997                           If this list is empty, all operation arguments will be published
998                 theFindMethod method to search sub-shapes, corresponding to arguments and
999                               their sub-shapes. Value from enumeration GEOM.find_shape_method.
1000                 theInheritFirstArg set properties of the first argument for theObject.
1001                                    Do not publish sub-shapes in place of arguments, but only
1002                                    in place of sub-shapes of the first argument,
1003                                    because the whole shape corresponds to the first argument.
1004                                    Mainly to be used after transformations, but it also can be
1005                                    usefull after partition with one object shape, and some other
1006                                    operations, where only the first argument has to be considered.
1007                                    If theObject has only one argument shape, this flag is automatically
1008                                    considered as True, not regarding really passed value.
1009                 theAddPrefix add prefix "from_" to names of restored sub-shapes,
1010                              and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
1011             Returns:
1012                 list of published sub-shapes
1013             """
1014             # Example: see GEOM_TestAll.py
1015             return self.RestoreSubShapesO(self.myStudy, theObject, theArgs,
1016                                           theFindMethod, theInheritFirstArg, theAddPrefix)
1017
1018         ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
1019         #  To be used from python scripts out of addToStudy() (non-default usage)
1020         #  \param theObject published GEOM.GEOM_Object, arguments of which will be published
1021         #  \param theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
1022         #                   If this list is empty, all operation arguments will be published
1023         #  \param theFindMethod method to search sub-shapes, corresponding to arguments and
1024         #                       their sub-shapes. Value from enumeration GEOM::find_shape_method.
1025         #  \param theInheritFirstArg set properties of the first argument for <VAR>theObject</VAR>.
1026         #                            Do not publish sub-shapes in place of arguments, but only
1027         #                            in place of sub-shapes of the first argument,
1028         #                            because the whole shape corresponds to the first argument.
1029         #                            Mainly to be used after transformations, but it also can be
1030         #                            usefull after partition with one object shape, and some other
1031         #                            operations, where only the first argument has to be considered.
1032         #                            If theObject has only one argument shape, this flag is automatically
1033         #                            considered as True, not regarding really passed value.
1034         #  \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
1035         #                      and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
1036         #  \return list of published sub-shapes
1037         #
1038         #  @ref tui_restore_prs_params "Example"
1039         def RestoreGivenSubShapes (self, theObject, theArgs=[], theFindMethod=GEOM.FSM_GetInPlace,
1040                                    theInheritFirstArg=False, theAddPrefix=True):
1041             """
1042             Publish sub-shapes, standing for arguments and sub-shapes of arguments
1043             To be used from python scripts out of geompy.addToStudy() (non-default usage)
1044
1045             Parameters:
1046                 theObject published GEOM.GEOM_Object, arguments of which will be published
1047                 theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
1048                           If this list is empty, all operation arguments will be published
1049                 theFindMethod method to search sub-shapes, corresponding to arguments and
1050                               their sub-shapes. Value from enumeration GEOM::find_shape_method.
1051                 theInheritFirstArg set properties of the first argument for theObject.
1052                                    Do not publish sub-shapes in place of arguments, but only
1053                                    in place of sub-shapes of the first argument,
1054                                    because the whole shape corresponds to the first argument.
1055                                    Mainly to be used after transformations, but it also can be
1056                                    usefull after partition with one object shape, and some other
1057                                    operations, where only the first argument has to be considered.
1058                                    If theObject has only one argument shape, this flag is automatically
1059                                    considered as True, not regarding really passed value.
1060                 theAddPrefix add prefix "from_" to names of restored sub-shapes,
1061                              and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
1062
1063             Returns:
1064                 list of published sub-shapes
1065             """
1066             # Example: see GEOM_TestAll.py
1067             return self.RestoreGivenSubShapesO(self.myStudy, theObject, theArgs,
1068                                                theFindMethod, theInheritFirstArg, theAddPrefix)
1069
1070         # end of l3_restore_ss
1071         ## @}
1072
1073         ## @addtogroup l3_basic_go
1074         ## @{
1075
1076         ## Create point by three coordinates.
1077         #  @param theX The X coordinate of the point.
1078         #  @param theY The Y coordinate of the point.
1079         #  @param theZ The Z coordinate of the point.
1080         #  @param theName Object name; when specified, this parameter is used
1081         #         for result publication in the study. Otherwise, if automatic
1082         #         publication is switched on, default value is used for result name.
1083         #
1084         #  @return New GEOM.GEOM_Object, containing the created point.
1085         #
1086         #  @ref tui_creation_point "Example"
1087         @ManageTransactions("BasicOp")
1088         def MakeVertex(self, theX, theY, theZ, theName=None):
1089             """
1090             Create point by three coordinates.
1091
1092             Parameters:
1093                 theX The X coordinate of the point.
1094                 theY The Y coordinate of the point.
1095                 theZ The Z coordinate of the point.
1096                 theName Object name; when specified, this parameter is used
1097                         for result publication in the study. Otherwise, if automatic
1098                         publication is switched on, default value is used for result name.
1099
1100             Returns:
1101                 New GEOM.GEOM_Object, containing the created point.
1102             """
1103             # Example: see GEOM_TestAll.py
1104             theX,theY,theZ,Parameters = ParseParameters(theX, theY, theZ)
1105             anObj = self.BasicOp.MakePointXYZ(theX, theY, theZ)
1106             RaiseIfFailed("MakePointXYZ", self.BasicOp)
1107             anObj.SetParameters(Parameters)
1108             self._autoPublish(anObj, theName, "vertex")
1109             return anObj
1110
1111         ## Create a point, distant from the referenced point
1112         #  on the given distances along the coordinate axes.
1113         #  @param theReference The referenced point.
1114         #  @param theX Displacement from the referenced point along OX axis.
1115         #  @param theY Displacement from the referenced point along OY axis.
1116         #  @param theZ Displacement from the referenced point along OZ axis.
1117         #  @param theName Object name; when specified, this parameter is used
1118         #         for result publication in the study. Otherwise, if automatic
1119         #         publication is switched on, default value is used for result name.
1120         #
1121         #  @return New GEOM.GEOM_Object, containing the created point.
1122         #
1123         #  @ref tui_creation_point "Example"
1124         @ManageTransactions("BasicOp")
1125         def MakeVertexWithRef(self, theReference, theX, theY, theZ, theName=None):
1126             """
1127             Create a point, distant from the referenced point
1128             on the given distances along the coordinate axes.
1129
1130             Parameters:
1131                 theReference The referenced point.
1132                 theX Displacement from the referenced point along OX axis.
1133                 theY Displacement from the referenced point along OY axis.
1134                 theZ Displacement from the referenced point along OZ axis.
1135                 theName Object name; when specified, this parameter is used
1136                         for result publication in the study. Otherwise, if automatic
1137                         publication is switched on, default value is used for result name.
1138
1139             Returns:
1140                 New GEOM.GEOM_Object, containing the created point.
1141             """
1142             # Example: see GEOM_TestAll.py
1143             theX,theY,theZ,Parameters = ParseParameters(theX, theY, theZ)
1144             anObj = self.BasicOp.MakePointWithReference(theReference, theX, theY, theZ)
1145             RaiseIfFailed("MakePointWithReference", self.BasicOp)
1146             anObj.SetParameters(Parameters)
1147             self._autoPublish(anObj, theName, "vertex")
1148             return anObj
1149
1150         ## Create a point, corresponding to the given parameter on the given curve.
1151         #  @param theRefCurve The referenced curve.
1152         #  @param theParameter Value of parameter on the referenced curve.
1153         #  @param takeOrientationIntoAccount flag that tells if it is necessary
1154         #         to take the curve's orientation into account for the
1155         #         operation. I.e. if this flag is set, the results for the same
1156         #         parameters (except the value 0.5) is different for forward
1157         #         and reversed curves. If it is not set the result is the same.
1158         #  @param theName Object name; when specified, this parameter is used
1159         #         for result publication in the study. Otherwise, if automatic
1160         #         publication is switched on, default value is used for result name.
1161         #
1162         #  @return New GEOM.GEOM_Object, containing the created point.
1163         #
1164         #  @ref tui_creation_point "Example"
1165         @ManageTransactions("BasicOp")
1166         def MakeVertexOnCurve(self, theRefCurve, theParameter,
1167                               takeOrientationIntoAccount=False, theName=None):
1168             """
1169             Create a point, corresponding to the given parameter on the given curve.
1170
1171             Parameters:
1172                 theRefCurve The referenced curve.
1173                 theParameter Value of parameter on the referenced curve.
1174                 takeOrientationIntoAccount flag that tells if it is necessary
1175                         to take the curve's orientation into account for the
1176                         operation. I.e. if this flag is set, the results for
1177                         the same parameters (except the value 0.5) is different
1178                         for forward and reversed curves. If it is not set
1179                         the result is the same.
1180                 theName Object name; when specified, this parameter is used
1181                         for result publication in the study. Otherwise, if automatic
1182                         publication is switched on, default value is used for result name.
1183
1184             Returns:
1185                 New GEOM.GEOM_Object, containing the created point.
1186
1187             Example of usage:
1188                 p_on_arc = geompy.MakeVertexOnCurve(Arc, 0.25)
1189             """
1190             # Example: see GEOM_TestAll.py
1191             theParameter, takeOrientationIntoAccount, Parameters = ParseParameters(
1192                 theParameter, takeOrientationIntoAccount)
1193             anObj = self.BasicOp.MakePointOnCurve(theRefCurve, theParameter,
1194                                                   takeOrientationIntoAccount)
1195             RaiseIfFailed("MakePointOnCurve", self.BasicOp)
1196             anObj.SetParameters(Parameters)
1197             self._autoPublish(anObj, theName, "vertex")
1198             return anObj
1199
1200         ## Create a point by projection give coordinates on the given curve
1201         #  @param theRefCurve The referenced curve.
1202         #  @param theX X-coordinate in 3D space
1203         #  @param theY Y-coordinate in 3D space
1204         #  @param theZ Z-coordinate in 3D space
1205         #  @param theName Object name; when specified, this parameter is used
1206         #         for result publication in the study. Otherwise, if automatic
1207         #         publication is switched on, default value is used for result name.
1208         #
1209         #  @return New GEOM.GEOM_Object, containing the created point.
1210         #
1211         #  @ref tui_creation_point "Example"
1212         @ManageTransactions("BasicOp")
1213         def MakeVertexOnCurveByCoord(self, theRefCurve, theX, theY, theZ, theName=None):
1214             """
1215             Create a point by projection give coordinates on the given curve
1216
1217             Parameters:
1218                 theRefCurve The referenced curve.
1219                 theX X-coordinate in 3D space
1220                 theY Y-coordinate in 3D space
1221                 theZ Z-coordinate in 3D space
1222                 theName Object name; when specified, this parameter is used
1223                         for result publication in the study. Otherwise, if automatic
1224                         publication is switched on, default value is used for result name.
1225
1226             Returns:
1227                 New GEOM.GEOM_Object, containing the created point.
1228
1229             Example of usage:
1230                 p_on_arc3 = geompy.MakeVertexOnCurveByCoord(Arc, 100, -10, 10)
1231             """
1232             # Example: see GEOM_TestAll.py
1233             theX, theY, theZ, Parameters = ParseParameters(theX, theY, theZ)
1234             anObj = self.BasicOp.MakePointOnCurveByCoord(theRefCurve, theX, theY, theZ)
1235             RaiseIfFailed("MakeVertexOnCurveByCoord", self.BasicOp)
1236             anObj.SetParameters(Parameters)
1237             self._autoPublish(anObj, theName, "vertex")
1238             return anObj
1239
1240         ## Create a point, corresponding to the given length on the given curve.
1241         #  @param theRefCurve The referenced curve.
1242         #  @param theLength Length on the referenced curve. It can be negative.
1243         #  @param theStartPoint Point allowing to choose the direction for the calculation
1244         #                       of the length. If None, start from the first point of theRefCurve.
1245         #  @param theName Object name; when specified, this parameter is used
1246         #         for result publication in the study. Otherwise, if automatic
1247         #         publication is switched on, default value is used for result name.
1248         #
1249         #  @return New GEOM.GEOM_Object, containing the created point.
1250         #
1251         #  @ref tui_creation_point "Example"
1252         @ManageTransactions("BasicOp")
1253         def MakeVertexOnCurveByLength(self, theRefCurve, theLength, theStartPoint = None, theName=None):
1254             """
1255             Create a point, corresponding to the given length on the given curve.
1256
1257             Parameters:
1258                 theRefCurve The referenced curve.
1259                 theLength Length on the referenced curve. It can be negative.
1260                 theStartPoint Point allowing to choose the direction for the calculation
1261                               of the length. If None, start from the first point of theRefCurve.
1262                 theName Object name; when specified, this parameter is used
1263                         for result publication in the study. Otherwise, if automatic
1264                         publication is switched on, default value is used for result name.
1265
1266             Returns:
1267                 New GEOM.GEOM_Object, containing the created point.
1268             """
1269             # Example: see GEOM_TestAll.py
1270             theLength, Parameters = ParseParameters(theLength)
1271             anObj = self.BasicOp.MakePointOnCurveByLength(theRefCurve, theLength, theStartPoint)
1272             RaiseIfFailed("MakePointOnCurveByLength", self.BasicOp)
1273             anObj.SetParameters(Parameters)
1274             self._autoPublish(anObj, theName, "vertex")
1275             return anObj
1276
1277         ## Create a point, corresponding to the given parameters on the
1278         #    given surface.
1279         #  @param theRefSurf The referenced surface.
1280         #  @param theUParameter Value of U-parameter on the referenced surface.
1281         #  @param theVParameter Value of V-parameter on the referenced surface.
1282         #  @param theName Object name; when specified, this parameter is used
1283         #         for result publication in the study. Otherwise, if automatic
1284         #         publication is switched on, default value is used for result name.
1285         #
1286         #  @return New GEOM.GEOM_Object, containing the created point.
1287         #
1288         #  @ref swig_MakeVertexOnSurface "Example"
1289         @ManageTransactions("BasicOp")
1290         def MakeVertexOnSurface(self, theRefSurf, theUParameter, theVParameter, theName=None):
1291             """
1292             Create a point, corresponding to the given parameters on the
1293             given surface.
1294
1295             Parameters:
1296                 theRefSurf The referenced surface.
1297                 theUParameter Value of U-parameter on the referenced surface.
1298                 theVParameter Value of V-parameter on the referenced surface.
1299                 theName Object name; when specified, this parameter is used
1300                         for result publication in the study. Otherwise, if automatic
1301                         publication is switched on, default value is used for result name.
1302
1303             Returns:
1304                 New GEOM.GEOM_Object, containing the created point.
1305
1306             Example of usage:
1307                 p_on_face = geompy.MakeVertexOnSurface(Face, 0.1, 0.8)
1308             """
1309             theUParameter, theVParameter, Parameters = ParseParameters(theUParameter, theVParameter)
1310             # Example: see GEOM_TestAll.py
1311             anObj = self.BasicOp.MakePointOnSurface(theRefSurf, theUParameter, theVParameter)
1312             RaiseIfFailed("MakePointOnSurface", self.BasicOp)
1313             anObj.SetParameters(Parameters);
1314             self._autoPublish(anObj, theName, "vertex")
1315             return anObj
1316
1317         ## Create a point by projection give coordinates on the given surface
1318         #  @param theRefSurf The referenced surface.
1319         #  @param theX X-coordinate in 3D space
1320         #  @param theY Y-coordinate in 3D space
1321         #  @param theZ Z-coordinate in 3D space
1322         #  @param theName Object name; when specified, this parameter is used
1323         #         for result publication in the study. Otherwise, if automatic
1324         #         publication is switched on, default value is used for result name.
1325         #
1326         #  @return New GEOM.GEOM_Object, containing the created point.
1327         #
1328         #  @ref swig_MakeVertexOnSurfaceByCoord "Example"
1329         @ManageTransactions("BasicOp")
1330         def MakeVertexOnSurfaceByCoord(self, theRefSurf, theX, theY, theZ, theName=None):
1331             """
1332             Create a point by projection give coordinates on the given surface
1333
1334             Parameters:
1335                 theRefSurf The referenced surface.
1336                 theX X-coordinate in 3D space
1337                 theY Y-coordinate in 3D space
1338                 theZ Z-coordinate in 3D space
1339                 theName Object name; when specified, this parameter is used
1340                         for result publication in the study. Otherwise, if automatic
1341                         publication is switched on, default value is used for result name.
1342
1343             Returns:
1344                 New GEOM.GEOM_Object, containing the created point.
1345
1346             Example of usage:
1347                 p_on_face2 = geompy.MakeVertexOnSurfaceByCoord(Face, 0., 0., 0.)
1348             """
1349             theX, theY, theZ, Parameters = ParseParameters(theX, theY, theZ)
1350             # Example: see GEOM_TestAll.py
1351             anObj = self.BasicOp.MakePointOnSurfaceByCoord(theRefSurf, theX, theY, theZ)
1352             RaiseIfFailed("MakeVertexOnSurfaceByCoord", self.BasicOp)
1353             anObj.SetParameters(Parameters);
1354             self._autoPublish(anObj, theName, "vertex")
1355             return anObj
1356
1357         ## Create a point, which lays on the given face.
1358         #  The point will lay in arbitrary place of the face.
1359         #  The only condition on it is a non-zero distance to the face boundary.
1360         #  Such point can be used to uniquely identify the face inside any
1361         #  shape in case, when the shape does not contain overlapped faces.
1362         #  @param theFace The referenced face.
1363         #  @param theName Object name; when specified, this parameter is used
1364         #         for result publication in the study. Otherwise, if automatic
1365         #         publication is switched on, default value is used for result name.
1366         #
1367         #  @return New GEOM.GEOM_Object, containing the created point.
1368         #
1369         #  @ref swig_MakeVertexInsideFace "Example"
1370         @ManageTransactions("BasicOp")
1371         def MakeVertexInsideFace (self, theFace, theName=None):
1372             """
1373             Create a point, which lays on the given face.
1374             The point will lay in arbitrary place of the face.
1375             The only condition on it is a non-zero distance to the face boundary.
1376             Such point can be used to uniquely identify the face inside any
1377             shape in case, when the shape does not contain overlapped faces.
1378
1379             Parameters:
1380                 theFace The referenced face.
1381                 theName Object name; when specified, this parameter is used
1382                         for result publication in the study. Otherwise, if automatic
1383                         publication is switched on, default value is used for result name.
1384
1385             Returns:
1386                 New GEOM.GEOM_Object, containing the created point.
1387
1388             Example of usage:
1389                 p_on_face = geompy.MakeVertexInsideFace(Face)
1390             """
1391             # Example: see GEOM_TestAll.py
1392             anObj = self.BasicOp.MakePointOnFace(theFace)
1393             RaiseIfFailed("MakeVertexInsideFace", self.BasicOp)
1394             self._autoPublish(anObj, theName, "vertex")
1395             return anObj
1396
1397         ## Create a point on intersection of two lines.
1398         #  @param theRefLine1, theRefLine2 The referenced lines.
1399         #  @param theName Object name; when specified, this parameter is used
1400         #         for result publication in the study. Otherwise, if automatic
1401         #         publication is switched on, default value is used for result name.
1402         #
1403         #  @return New GEOM.GEOM_Object, containing the created point.
1404         #
1405         #  @ref swig_MakeVertexOnLinesIntersection "Example"
1406         @ManageTransactions("BasicOp")
1407         def MakeVertexOnLinesIntersection(self, theRefLine1, theRefLine2, theName=None):
1408             """
1409             Create a point on intersection of two lines.
1410
1411             Parameters:
1412                 theRefLine1, theRefLine2 The referenced lines.
1413                 theName Object name; when specified, this parameter is used
1414                         for result publication in the study. Otherwise, if automatic
1415                         publication is switched on, default value is used for result name.
1416
1417             Returns:
1418                 New GEOM.GEOM_Object, containing the created point.
1419             """
1420             # Example: see GEOM_TestAll.py
1421             anObj = self.BasicOp.MakePointOnLinesIntersection(theRefLine1, theRefLine2)
1422             RaiseIfFailed("MakePointOnLinesIntersection", self.BasicOp)
1423             self._autoPublish(anObj, theName, "vertex")
1424             return anObj
1425
1426         ## Create a tangent, corresponding to the given parameter on the given curve.
1427         #  @param theRefCurve The referenced curve.
1428         #  @param theParameter Value of parameter on the referenced curve.
1429         #  @param theName Object name; when specified, this parameter is used
1430         #         for result publication in the study. Otherwise, if automatic
1431         #         publication is switched on, default value is used for result name.
1432         #
1433         #  @return New GEOM.GEOM_Object, containing the created tangent.
1434         #
1435         #  @ref swig_MakeTangentOnCurve "Example"
1436         @ManageTransactions("BasicOp")
1437         def MakeTangentOnCurve(self, theRefCurve, theParameter, theName=None):
1438             """
1439             Create a tangent, corresponding to the given parameter on the given curve.
1440
1441             Parameters:
1442                 theRefCurve The referenced curve.
1443                 theParameter Value of parameter on the referenced curve.
1444                 theName Object name; when specified, this parameter is used
1445                         for result publication in the study. Otherwise, if automatic
1446                         publication is switched on, default value is used for result name.
1447
1448             Returns:
1449                 New GEOM.GEOM_Object, containing the created tangent.
1450
1451             Example of usage:
1452                 tan_on_arc = geompy.MakeTangentOnCurve(Arc, 0.7)
1453             """
1454             anObj = self.BasicOp.MakeTangentOnCurve(theRefCurve, theParameter)
1455             RaiseIfFailed("MakeTangentOnCurve", self.BasicOp)
1456             self._autoPublish(anObj, theName, "tangent")
1457             return anObj
1458
1459         ## Create a tangent plane, corresponding to the given parameter on the given face.
1460         #  @param theFace The face for which tangent plane should be built.
1461         #  @param theParameterV vertical value of the center point (0.0 - 1.0).
1462         #  @param theParameterU horisontal value of the center point (0.0 - 1.0).
1463         #  @param theTrimSize the size of plane.
1464         #  @param theName Object name; when specified, this parameter is used
1465         #         for result publication in the study. Otherwise, if automatic
1466         #         publication is switched on, default value is used for result name.
1467         #
1468         #  @return New GEOM.GEOM_Object, containing the created tangent.
1469         #
1470         #  @ref swig_MakeTangentPlaneOnFace "Example"
1471         @ManageTransactions("BasicOp")
1472         def MakeTangentPlaneOnFace(self, theFace, theParameterU, theParameterV, theTrimSize, theName=None):
1473             """
1474             Create a tangent plane, corresponding to the given parameter on the given face.
1475
1476             Parameters:
1477                 theFace The face for which tangent plane should be built.
1478                 theParameterV vertical value of the center point (0.0 - 1.0).
1479                 theParameterU horisontal value of the center point (0.0 - 1.0).
1480                 theTrimSize the size of plane.
1481                 theName Object name; when specified, this parameter is used
1482                         for result publication in the study. Otherwise, if automatic
1483                         publication is switched on, default value is used for result name.
1484
1485            Returns:
1486                 New GEOM.GEOM_Object, containing the created tangent.
1487
1488            Example of usage:
1489                 an_on_face = geompy.MakeTangentPlaneOnFace(tan_extrusion, 0.7, 0.5, 150)
1490             """
1491             anObj = self.BasicOp.MakeTangentPlaneOnFace(theFace, theParameterU, theParameterV, theTrimSize)
1492             RaiseIfFailed("MakeTangentPlaneOnFace", self.BasicOp)
1493             self._autoPublish(anObj, theName, "tangent")
1494             return anObj
1495
1496         ## Create a vector with the given components.
1497         #  @param theDX X component of the vector.
1498         #  @param theDY Y component of the vector.
1499         #  @param theDZ Z component of the vector.
1500         #  @param theName Object name; when specified, this parameter is used
1501         #         for result publication in the study. Otherwise, if automatic
1502         #         publication is switched on, default value is used for result name.
1503         #
1504         #  @return New GEOM.GEOM_Object, containing the created vector.
1505         #
1506         #  @ref tui_creation_vector "Example"
1507         @ManageTransactions("BasicOp")
1508         def MakeVectorDXDYDZ(self, theDX, theDY, theDZ, theName=None):
1509             """
1510             Create a vector with the given components.
1511
1512             Parameters:
1513                 theDX X component of the vector.
1514                 theDY Y component of the vector.
1515                 theDZ Z component of the vector.
1516                 theName Object name; when specified, this parameter is used
1517                         for result publication in the study. Otherwise, if automatic
1518                         publication is switched on, default value is used for result name.
1519
1520             Returns:
1521                 New GEOM.GEOM_Object, containing the created vector.
1522             """
1523             # Example: see GEOM_TestAll.py
1524             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
1525             anObj = self.BasicOp.MakeVectorDXDYDZ(theDX, theDY, theDZ)
1526             RaiseIfFailed("MakeVectorDXDYDZ", self.BasicOp)
1527             anObj.SetParameters(Parameters)
1528             self._autoPublish(anObj, theName, "vector")
1529             return anObj
1530
1531         ## Create a vector between two points.
1532         #  @param thePnt1 Start point for the vector.
1533         #  @param thePnt2 End point for the vector.
1534         #  @param theName Object name; when specified, this parameter is used
1535         #         for result publication in the study. Otherwise, if automatic
1536         #         publication is switched on, default value is used for result name.
1537         #
1538         #  @return New GEOM.GEOM_Object, containing the created vector.
1539         #
1540         #  @ref tui_creation_vector "Example"
1541         @ManageTransactions("BasicOp")
1542         def MakeVector(self, thePnt1, thePnt2, theName=None):
1543             """
1544             Create a vector between two points.
1545
1546             Parameters:
1547                 thePnt1 Start point for the vector.
1548                 thePnt2 End point for the vector.
1549                 theName Object name; when specified, this parameter is used
1550                         for result publication in the study. Otherwise, if automatic
1551                         publication is switched on, default value is used for result name.
1552
1553             Returns:
1554                 New GEOM.GEOM_Object, containing the created vector.
1555             """
1556             # Example: see GEOM_TestAll.py
1557             anObj = self.BasicOp.MakeVectorTwoPnt(thePnt1, thePnt2)
1558             RaiseIfFailed("MakeVectorTwoPnt", self.BasicOp)
1559             self._autoPublish(anObj, theName, "vector")
1560             return anObj
1561
1562         ## Create a line, passing through the given point
1563         #  and parrallel to the given direction
1564         #  @param thePnt Point. The resulting line will pass through it.
1565         #  @param theDir Direction. The resulting line will be parallel to it.
1566         #  @param theName Object name; when specified, this parameter is used
1567         #         for result publication in the study. Otherwise, if automatic
1568         #         publication is switched on, default value is used for result name.
1569         #
1570         #  @return New GEOM.GEOM_Object, containing the created line.
1571         #
1572         #  @ref tui_creation_line "Example"
1573         @ManageTransactions("BasicOp")
1574         def MakeLine(self, thePnt, theDir, theName=None):
1575             """
1576             Create a line, passing through the given point
1577             and parrallel to the given direction
1578
1579             Parameters:
1580                 thePnt Point. The resulting line will pass through it.
1581                 theDir Direction. The resulting line will be parallel to it.
1582                 theName Object name; when specified, this parameter is used
1583                         for result publication in the study. Otherwise, if automatic
1584                         publication is switched on, default value is used for result name.
1585
1586             Returns:
1587                 New GEOM.GEOM_Object, containing the created line.
1588             """
1589             # Example: see GEOM_TestAll.py
1590             anObj = self.BasicOp.MakeLine(thePnt, theDir)
1591             RaiseIfFailed("MakeLine", self.BasicOp)
1592             self._autoPublish(anObj, theName, "line")
1593             return anObj
1594
1595         ## Create a line, passing through the given points
1596         #  @param thePnt1 First of two points, defining the line.
1597         #  @param thePnt2 Second of two points, defining the line.
1598         #  @param theName Object name; when specified, this parameter is used
1599         #         for result publication in the study. Otherwise, if automatic
1600         #         publication is switched on, default value is used for result name.
1601         #
1602         #  @return New GEOM.GEOM_Object, containing the created line.
1603         #
1604         #  @ref tui_creation_line "Example"
1605         @ManageTransactions("BasicOp")
1606         def MakeLineTwoPnt(self, thePnt1, thePnt2, theName=None):
1607             """
1608             Create a line, passing through the given points
1609
1610             Parameters:
1611                 thePnt1 First of two points, defining the line.
1612                 thePnt2 Second of two points, defining the line.
1613                 theName Object name; when specified, this parameter is used
1614                         for result publication in the study. Otherwise, if automatic
1615                         publication is switched on, default value is used for result name.
1616
1617             Returns:
1618                 New GEOM.GEOM_Object, containing the created line.
1619             """
1620             # Example: see GEOM_TestAll.py
1621             anObj = self.BasicOp.MakeLineTwoPnt(thePnt1, thePnt2)
1622             RaiseIfFailed("MakeLineTwoPnt", self.BasicOp)
1623             self._autoPublish(anObj, theName, "line")
1624             return anObj
1625
1626         ## Create a line on two faces intersection.
1627         #  @param theFace1 First of two faces, defining the line.
1628         #  @param theFace2 Second of two faces, defining the line.
1629         #  @param theName Object name; when specified, this parameter is used
1630         #         for result publication in the study. Otherwise, if automatic
1631         #         publication is switched on, default value is used for result name.
1632         #
1633         #  @return New GEOM.GEOM_Object, containing the created line.
1634         #
1635         #  @ref swig_MakeLineTwoFaces "Example"
1636         @ManageTransactions("BasicOp")
1637         def MakeLineTwoFaces(self, theFace1, theFace2, theName=None):
1638             """
1639             Create a line on two faces intersection.
1640
1641             Parameters:
1642                 theFace1 First of two faces, defining the line.
1643                 theFace2 Second of two faces, defining the line.
1644                 theName Object name; when specified, this parameter is used
1645                         for result publication in the study. Otherwise, if automatic
1646                         publication is switched on, default value is used for result name.
1647
1648             Returns:
1649                 New GEOM.GEOM_Object, containing the created line.
1650             """
1651             # Example: see GEOM_TestAll.py
1652             anObj = self.BasicOp.MakeLineTwoFaces(theFace1, theFace2)
1653             RaiseIfFailed("MakeLineTwoFaces", self.BasicOp)
1654             self._autoPublish(anObj, theName, "line")
1655             return anObj
1656
1657         ## Create a plane, passing through the given point
1658         #  and normal to the given vector.
1659         #  @param thePnt Point, the plane has to pass through.
1660         #  @param theVec Vector, defining the plane normal direction.
1661         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1662         #  @param theName Object name; when specified, this parameter is used
1663         #         for result publication in the study. Otherwise, if automatic
1664         #         publication is switched on, default value is used for result name.
1665         #
1666         #  @return New GEOM.GEOM_Object, containing the created plane.
1667         #
1668         #  @ref tui_creation_plane "Example"
1669         @ManageTransactions("BasicOp")
1670         def MakePlane(self, thePnt, theVec, theTrimSize, theName=None):
1671             """
1672             Create a plane, passing through the given point
1673             and normal to the given vector.
1674
1675             Parameters:
1676                 thePnt Point, the plane has to pass through.
1677                 theVec Vector, defining the plane normal direction.
1678                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1679                 theName Object name; when specified, this parameter is used
1680                         for result publication in the study. Otherwise, if automatic
1681                         publication is switched on, default value is used for result name.
1682
1683             Returns:
1684                 New GEOM.GEOM_Object, containing the created plane.
1685             """
1686             # Example: see GEOM_TestAll.py
1687             theTrimSize, Parameters = ParseParameters(theTrimSize);
1688             anObj = self.BasicOp.MakePlanePntVec(thePnt, theVec, theTrimSize)
1689             RaiseIfFailed("MakePlanePntVec", self.BasicOp)
1690             anObj.SetParameters(Parameters)
1691             self._autoPublish(anObj, theName, "plane")
1692             return anObj
1693
1694         ## Create a plane, passing through the three given points
1695         #  @param thePnt1 First of three points, defining the plane.
1696         #  @param thePnt2 Second of three points, defining the plane.
1697         #  @param thePnt3 Fird of three points, defining the plane.
1698         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1699         #  @param theName Object name; when specified, this parameter is used
1700         #         for result publication in the study. Otherwise, if automatic
1701         #         publication is switched on, default value is used for result name.
1702         #
1703         #  @return New GEOM.GEOM_Object, containing the created plane.
1704         #
1705         #  @ref tui_creation_plane "Example"
1706         @ManageTransactions("BasicOp")
1707         def MakePlaneThreePnt(self, thePnt1, thePnt2, thePnt3, theTrimSize, theName=None):
1708             """
1709             Create a plane, passing through the three given points
1710
1711             Parameters:
1712                 thePnt1 First of three points, defining the plane.
1713                 thePnt2 Second of three points, defining the plane.
1714                 thePnt3 Fird of three points, defining the plane.
1715                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1716                 theName Object name; when specified, this parameter is used
1717                         for result publication in the study. Otherwise, if automatic
1718                         publication is switched on, default value is used for result name.
1719
1720             Returns:
1721                 New GEOM.GEOM_Object, containing the created plane.
1722             """
1723             # Example: see GEOM_TestAll.py
1724             theTrimSize, Parameters = ParseParameters(theTrimSize);
1725             anObj = self.BasicOp.MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize)
1726             RaiseIfFailed("MakePlaneThreePnt", self.BasicOp)
1727             anObj.SetParameters(Parameters)
1728             self._autoPublish(anObj, theName, "plane")
1729             return anObj
1730
1731         ## Create a plane, similar to the existing one, but with another size of representing face.
1732         #  @param theFace Referenced plane or LCS(Marker).
1733         #  @param theTrimSize New half size of a side of quadrangle face, representing the plane.
1734         #  @param theName Object name; when specified, this parameter is used
1735         #         for result publication in the study. Otherwise, if automatic
1736         #         publication is switched on, default value is used for result name.
1737         #
1738         #  @return New GEOM.GEOM_Object, containing the created plane.
1739         #
1740         #  @ref tui_creation_plane "Example"
1741         @ManageTransactions("BasicOp")
1742         def MakePlaneFace(self, theFace, theTrimSize, theName=None):
1743             """
1744             Create a plane, similar to the existing one, but with another size of representing face.
1745
1746             Parameters:
1747                 theFace Referenced plane or LCS(Marker).
1748                 theTrimSize New half size of a side of quadrangle face, representing the plane.
1749                 theName Object name; when specified, this parameter is used
1750                         for result publication in the study. Otherwise, if automatic
1751                         publication is switched on, default value is used for result name.
1752
1753             Returns:
1754                 New GEOM.GEOM_Object, containing the created plane.
1755             """
1756             # Example: see GEOM_TestAll.py
1757             theTrimSize, Parameters = ParseParameters(theTrimSize);
1758             anObj = self.BasicOp.MakePlaneFace(theFace, theTrimSize)
1759             RaiseIfFailed("MakePlaneFace", self.BasicOp)
1760             anObj.SetParameters(Parameters)
1761             self._autoPublish(anObj, theName, "plane")
1762             return anObj
1763
1764         ## Create a plane, passing through the 2 vectors
1765         #  with center in a start point of the first vector.
1766         #  @param theVec1 Vector, defining center point and plane direction.
1767         #  @param theVec2 Vector, defining the plane normal direction.
1768         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1769         #  @param theName Object name; when specified, this parameter is used
1770         #         for result publication in the study. Otherwise, if automatic
1771         #         publication is switched on, default value is used for result name.
1772         #
1773         #  @return New GEOM.GEOM_Object, containing the created plane.
1774         #
1775         #  @ref tui_creation_plane "Example"
1776         @ManageTransactions("BasicOp")
1777         def MakePlane2Vec(self, theVec1, theVec2, theTrimSize, theName=None):
1778             """
1779             Create a plane, passing through the 2 vectors
1780             with center in a start point of the first vector.
1781
1782             Parameters:
1783                 theVec1 Vector, defining center point and plane direction.
1784                 theVec2 Vector, defining the plane normal direction.
1785                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1786                 theName Object name; when specified, this parameter is used
1787                         for result publication in the study. Otherwise, if automatic
1788                         publication is switched on, default value is used for result name.
1789
1790             Returns:
1791                 New GEOM.GEOM_Object, containing the created plane.
1792             """
1793             # Example: see GEOM_TestAll.py
1794             theTrimSize, Parameters = ParseParameters(theTrimSize);
1795             anObj = self.BasicOp.MakePlane2Vec(theVec1, theVec2, theTrimSize)
1796             RaiseIfFailed("MakePlane2Vec", self.BasicOp)
1797             anObj.SetParameters(Parameters)
1798             self._autoPublish(anObj, theName, "plane")
1799             return anObj
1800
1801         ## Create a plane, based on a Local coordinate system.
1802         #  @param theLCS  coordinate system, defining plane.
1803         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1804         #  @param theOrientation OXY, OYZ or OZX orientation - (1, 2 or 3)
1805         #  @param theName Object name; when specified, this parameter is used
1806         #         for result publication in the study. Otherwise, if automatic
1807         #         publication is switched on, default value is used for result name.
1808         #
1809         #  @return New GEOM.GEOM_Object, containing the created plane.
1810         #
1811         #  @ref tui_creation_plane "Example"
1812         @ManageTransactions("BasicOp")
1813         def MakePlaneLCS(self, theLCS, theTrimSize, theOrientation, theName=None):
1814             """
1815             Create a plane, based on a Local coordinate system.
1816
1817            Parameters:
1818                 theLCS  coordinate system, defining plane.
1819                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1820                 theOrientation OXY, OYZ or OZX orientation - (1, 2 or 3)
1821                 theName Object name; when specified, this parameter is used
1822                         for result publication in the study. Otherwise, if automatic
1823                         publication is switched on, default value is used for result name.
1824
1825             Returns:
1826                 New GEOM.GEOM_Object, containing the created plane.
1827             """
1828             # Example: see GEOM_TestAll.py
1829             theTrimSize, Parameters = ParseParameters(theTrimSize);
1830             anObj = self.BasicOp.MakePlaneLCS(theLCS, theTrimSize, theOrientation)
1831             RaiseIfFailed("MakePlaneLCS", self.BasicOp)
1832             anObj.SetParameters(Parameters)
1833             self._autoPublish(anObj, theName, "plane")
1834             return anObj
1835
1836         ## Create a local coordinate system.
1837         #  @param OX,OY,OZ Three coordinates of coordinate system origin.
1838         #  @param XDX,XDY,XDZ Three components of OX direction
1839         #  @param YDX,YDY,YDZ Three components of OY direction
1840         #  @param theName Object name; when specified, this parameter is used
1841         #         for result publication in the study. Otherwise, if automatic
1842         #         publication is switched on, default value is used for result name.
1843         #
1844         #  @return New GEOM.GEOM_Object, containing the created coordinate system.
1845         #
1846         #  @ref swig_MakeMarker "Example"
1847         @ManageTransactions("BasicOp")
1848         def MakeMarker(self, OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ, theName=None):
1849             """
1850             Create a local coordinate system.
1851
1852             Parameters:
1853                 OX,OY,OZ Three coordinates of coordinate system origin.
1854                 XDX,XDY,XDZ Three components of OX direction
1855                 YDX,YDY,YDZ Three components of OY direction
1856                 theName Object name; when specified, this parameter is used
1857                         for result publication in the study. Otherwise, if automatic
1858                         publication is switched on, default value is used for result name.
1859
1860             Returns:
1861                 New GEOM.GEOM_Object, containing the created coordinate system.
1862             """
1863             # Example: see GEOM_TestAll.py
1864             OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ, Parameters = ParseParameters(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ);
1865             anObj = self.BasicOp.MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ)
1866             RaiseIfFailed("MakeMarker", self.BasicOp)
1867             anObj.SetParameters(Parameters)
1868             self._autoPublish(anObj, theName, "lcs")
1869             return anObj
1870
1871         ## Create a local coordinate system from shape.
1872         #  @param theShape The initial shape to detect the coordinate system.
1873         #  @param theName Object name; when specified, this parameter is used
1874         #         for result publication in the study. Otherwise, if automatic
1875         #         publication is switched on, default value is used for result name.
1876         #
1877         #  @return New GEOM.GEOM_Object, containing the created coordinate system.
1878         #
1879         #  @ref tui_creation_lcs "Example"
1880         @ManageTransactions("BasicOp")
1881         def MakeMarkerFromShape(self, theShape, theName=None):
1882             """
1883             Create a local coordinate system from shape.
1884
1885             Parameters:
1886                 theShape The initial shape to detect the coordinate system.
1887                 theName Object name; when specified, this parameter is used
1888                         for result publication in the study. Otherwise, if automatic
1889                         publication is switched on, default value is used for result name.
1890
1891             Returns:
1892                 New GEOM.GEOM_Object, containing the created coordinate system.
1893             """
1894             anObj = self.BasicOp.MakeMarkerFromShape(theShape)
1895             RaiseIfFailed("MakeMarkerFromShape", self.BasicOp)
1896             self._autoPublish(anObj, theName, "lcs")
1897             return anObj
1898
1899         ## Create a local coordinate system from point and two vectors.
1900         #  @param theOrigin Point of coordinate system origin.
1901         #  @param theXVec Vector of X direction
1902         #  @param theYVec Vector of Y direction
1903         #  @param theName Object name; when specified, this parameter is used
1904         #         for result publication in the study. Otherwise, if automatic
1905         #         publication is switched on, default value is used for result name.
1906         #
1907         #  @return New GEOM.GEOM_Object, containing the created coordinate system.
1908         #
1909         #  @ref tui_creation_lcs "Example"
1910         @ManageTransactions("BasicOp")
1911         def MakeMarkerPntTwoVec(self, theOrigin, theXVec, theYVec, theName=None):
1912             """
1913             Create a local coordinate system from point and two vectors.
1914
1915             Parameters:
1916                 theOrigin Point of coordinate system origin.
1917                 theXVec Vector of X direction
1918                 theYVec Vector of Y direction
1919                 theName Object name; when specified, this parameter is used
1920                         for result publication in the study. Otherwise, if automatic
1921                         publication is switched on, default value is used for result name.
1922
1923             Returns:
1924                 New GEOM.GEOM_Object, containing the created coordinate system.
1925
1926             """
1927             anObj = self.BasicOp.MakeMarkerPntTwoVec(theOrigin, theXVec, theYVec)
1928             RaiseIfFailed("MakeMarkerPntTwoVec", self.BasicOp)
1929             self._autoPublish(anObj, theName, "lcs")
1930             return anObj
1931
1932         # end of l3_basic_go
1933         ## @}
1934
1935         ## @addtogroup l4_curves
1936         ## @{
1937
1938         ##  Create an arc of circle, passing through three given points.
1939         #  @param thePnt1 Start point of the arc.
1940         #  @param thePnt2 Middle point of the arc.
1941         #  @param thePnt3 End point of the arc.
1942         #  @param theName Object name; when specified, this parameter is used
1943         #         for result publication in the study. Otherwise, if automatic
1944         #         publication is switched on, default value is used for result name.
1945         #
1946         #  @return New GEOM.GEOM_Object, containing the created arc.
1947         #
1948         #  @ref swig_MakeArc "Example"
1949         @ManageTransactions("CurvesOp")
1950         def MakeArc(self, thePnt1, thePnt2, thePnt3, theName=None):
1951             """
1952             Create an arc of circle, passing through three given points.
1953
1954             Parameters:
1955                 thePnt1 Start point of the arc.
1956                 thePnt2 Middle point of the arc.
1957                 thePnt3 End point of the arc.
1958                 theName Object name; when specified, this parameter is used
1959                         for result publication in the study. Otherwise, if automatic
1960                         publication is switched on, default value is used for result name.
1961
1962             Returns:
1963                 New GEOM.GEOM_Object, containing the created arc.
1964             """
1965             # Example: see GEOM_TestAll.py
1966             anObj = self.CurvesOp.MakeArc(thePnt1, thePnt2, thePnt3)
1967             RaiseIfFailed("MakeArc", self.CurvesOp)
1968             self._autoPublish(anObj, theName, "arc")
1969             return anObj
1970
1971         ##  Create an arc of circle from a center and 2 points.
1972         #  @param thePnt1 Center of the arc
1973         #  @param thePnt2 Start point of the arc. (Gives also the radius of the arc)
1974         #  @param thePnt3 End point of the arc (Gives also a direction)
1975         #  @param theSense Orientation of the arc
1976         #  @param theName Object name; when specified, this parameter is used
1977         #         for result publication in the study. Otherwise, if automatic
1978         #         publication is switched on, default value is used for result name.
1979         #
1980         #  @return New GEOM.GEOM_Object, containing the created arc.
1981         #
1982         #  @ref swig_MakeArc "Example"
1983         @ManageTransactions("CurvesOp")
1984         def MakeArcCenter(self, thePnt1, thePnt2, thePnt3, theSense=False, theName=None):
1985             """
1986             Create an arc of circle from a center and 2 points.
1987
1988             Parameters:
1989                 thePnt1 Center of the arc
1990                 thePnt2 Start point of the arc. (Gives also the radius of the arc)
1991                 thePnt3 End point of the arc (Gives also a direction)
1992                 theSense Orientation of the arc
1993                 theName Object name; when specified, this parameter is used
1994                         for result publication in the study. Otherwise, if automatic
1995                         publication is switched on, default value is used for result name.
1996
1997             Returns:
1998                 New GEOM.GEOM_Object, containing the created arc.
1999             """
2000             # Example: see GEOM_TestAll.py
2001             anObj = self.CurvesOp.MakeArcCenter(thePnt1, thePnt2, thePnt3, theSense)
2002             RaiseIfFailed("MakeArcCenter", self.CurvesOp)
2003             self._autoPublish(anObj, theName, "arc")
2004             return anObj
2005
2006         ##  Create an arc of ellipse, of center and two points.
2007         #  @param theCenter Center of the arc.
2008         #  @param thePnt1 defines major radius of the arc by distance from Pnt1 to Pnt2.
2009         #  @param thePnt2 defines plane of ellipse and minor radius as distance from Pnt3 to line from Pnt1 to Pnt2.
2010         #  @param theName Object name; when specified, this parameter is used
2011         #         for result publication in the study. Otherwise, if automatic
2012         #         publication is switched on, default value is used for result name.
2013         #
2014         #  @return New GEOM.GEOM_Object, containing the created arc.
2015         #
2016         #  @ref swig_MakeArc "Example"
2017         @ManageTransactions("CurvesOp")
2018         def MakeArcOfEllipse(self, theCenter, thePnt1, thePnt2, theName=None):
2019             """
2020             Create an arc of ellipse, of center and two points.
2021
2022             Parameters:
2023                 theCenter Center of the arc.
2024                 thePnt1 defines major radius of the arc by distance from Pnt1 to Pnt2.
2025                 thePnt2 defines plane of ellipse and minor radius as distance from Pnt3 to line from Pnt1 to Pnt2.
2026                 theName Object name; when specified, this parameter is used
2027                         for result publication in the study. Otherwise, if automatic
2028                         publication is switched on, default value is used for result name.
2029
2030             Returns:
2031                 New GEOM.GEOM_Object, containing the created arc.
2032             """
2033             # Example: see GEOM_TestAll.py
2034             anObj = self.CurvesOp.MakeArcOfEllipse(theCenter, thePnt1, thePnt2)
2035             RaiseIfFailed("MakeArcOfEllipse", self.CurvesOp)
2036             self._autoPublish(anObj, theName, "arc")
2037             return anObj
2038
2039         ## Create a circle with given center, normal vector and radius.
2040         #  @param thePnt Circle center.
2041         #  @param theVec Vector, normal to the plane of the circle.
2042         #  @param theR Circle radius.
2043         #  @param theName Object name; when specified, this parameter is used
2044         #         for result publication in the study. Otherwise, if automatic
2045         #         publication is switched on, default value is used for result name.
2046         #
2047         #  @return New GEOM.GEOM_Object, containing the created circle.
2048         #
2049         #  @ref tui_creation_circle "Example"
2050         @ManageTransactions("CurvesOp")
2051         def MakeCircle(self, thePnt, theVec, theR, theName=None):
2052             """
2053             Create a circle with given center, normal vector and radius.
2054
2055             Parameters:
2056                 thePnt Circle center.
2057                 theVec Vector, normal to the plane of the circle.
2058                 theR Circle radius.
2059                 theName Object name; when specified, this parameter is used
2060                         for result publication in the study. Otherwise, if automatic
2061                         publication is switched on, default value is used for result name.
2062
2063             Returns:
2064                 New GEOM.GEOM_Object, containing the created circle.
2065             """
2066             # Example: see GEOM_TestAll.py
2067             theR, Parameters = ParseParameters(theR)
2068             anObj = self.CurvesOp.MakeCirclePntVecR(thePnt, theVec, theR)
2069             RaiseIfFailed("MakeCirclePntVecR", self.CurvesOp)
2070             anObj.SetParameters(Parameters)
2071             self._autoPublish(anObj, theName, "circle")
2072             return anObj
2073
2074         ## Create a circle with given radius.
2075         #  Center of the circle will be in the origin of global
2076         #  coordinate system and normal vector will be codirected with Z axis
2077         #  @param theR Circle radius.
2078         #  @param theName Object name; when specified, this parameter is used
2079         #         for result publication in the study. Otherwise, if automatic
2080         #         publication is switched on, default value is used for result name.
2081         #
2082         #  @return New GEOM.GEOM_Object, containing the created circle.
2083         @ManageTransactions("CurvesOp")
2084         def MakeCircleR(self, theR, theName=None):
2085             """
2086             Create a circle with given radius.
2087             Center of the circle will be in the origin of global
2088             coordinate system and normal vector will be codirected with Z axis
2089
2090             Parameters:
2091                 theR Circle radius.
2092                 theName Object name; when specified, this parameter is used
2093                         for result publication in the study. Otherwise, if automatic
2094                         publication is switched on, default value is used for result name.
2095
2096             Returns:
2097                 New GEOM.GEOM_Object, containing the created circle.
2098             """
2099             anObj = self.CurvesOp.MakeCirclePntVecR(None, None, theR)
2100             RaiseIfFailed("MakeCirclePntVecR", self.CurvesOp)
2101             self._autoPublish(anObj, theName, "circle")
2102             return anObj
2103
2104         ## Create a circle, passing through three given points
2105         #  @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2106         #  @param theName Object name; when specified, this parameter is used
2107         #         for result publication in the study. Otherwise, if automatic
2108         #         publication is switched on, default value is used for result name.
2109         #
2110         #  @return New GEOM.GEOM_Object, containing the created circle.
2111         #
2112         #  @ref tui_creation_circle "Example"
2113         @ManageTransactions("CurvesOp")
2114         def MakeCircleThreePnt(self, thePnt1, thePnt2, thePnt3, theName=None):
2115             """
2116             Create a circle, passing through three given points
2117
2118             Parameters:
2119                 thePnt1,thePnt2,thePnt3 Points, defining the circle.
2120                 theName Object name; when specified, this parameter is used
2121                         for result publication in the study. Otherwise, if automatic
2122                         publication is switched on, default value is used for result name.
2123
2124             Returns:
2125                 New GEOM.GEOM_Object, containing the created circle.
2126             """
2127             # Example: see GEOM_TestAll.py
2128             anObj = self.CurvesOp.MakeCircleThreePnt(thePnt1, thePnt2, thePnt3)
2129             RaiseIfFailed("MakeCircleThreePnt", self.CurvesOp)
2130             self._autoPublish(anObj, theName, "circle")
2131             return anObj
2132
2133         ## Create a circle, with given point1 as center,
2134         #  passing through the point2 as radius and laying in the plane,
2135         #  defined by all three given points.
2136         #  @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2137         #  @param theName Object name; when specified, this parameter is used
2138         #         for result publication in the study. Otherwise, if automatic
2139         #         publication is switched on, default value is used for result name.
2140         #
2141         #  @return New GEOM.GEOM_Object, containing the created circle.
2142         #
2143         #  @ref swig_MakeCircle "Example"
2144         @ManageTransactions("CurvesOp")
2145         def MakeCircleCenter2Pnt(self, thePnt1, thePnt2, thePnt3, theName=None):
2146             """
2147             Create a circle, with given point1 as center,
2148             passing through the point2 as radius and laying in the plane,
2149             defined by all three given points.
2150
2151             Parameters:
2152                 thePnt1,thePnt2,thePnt3 Points, defining the circle.
2153                 theName Object name; when specified, this parameter is used
2154                         for result publication in the study. Otherwise, if automatic
2155                         publication is switched on, default value is used for result name.
2156
2157             Returns:
2158                 New GEOM.GEOM_Object, containing the created circle.
2159             """
2160             # Example: see GEOM_example6.py
2161             anObj = self.CurvesOp.MakeCircleCenter2Pnt(thePnt1, thePnt2, thePnt3)
2162             RaiseIfFailed("MakeCircleCenter2Pnt", self.CurvesOp)
2163             self._autoPublish(anObj, theName, "circle")
2164             return anObj
2165
2166         ## Create an ellipse with given center, normal vector and radiuses.
2167         #  @param thePnt Ellipse center.
2168         #  @param theVec Vector, normal to the plane of the ellipse.
2169         #  @param theRMajor Major ellipse radius.
2170         #  @param theRMinor Minor ellipse radius.
2171         #  @param theVecMaj Vector, direction of the ellipse's main axis.
2172         #  @param theName Object name; when specified, this parameter is used
2173         #         for result publication in the study. Otherwise, if automatic
2174         #         publication is switched on, default value is used for result name.
2175         #
2176         #  @return New GEOM.GEOM_Object, containing the created ellipse.
2177         #
2178         #  @ref tui_creation_ellipse "Example"
2179         @ManageTransactions("CurvesOp")
2180         def MakeEllipse(self, thePnt, theVec, theRMajor, theRMinor, theVecMaj=None, theName=None):
2181             """
2182             Create an ellipse with given center, normal vector and radiuses.
2183
2184             Parameters:
2185                 thePnt Ellipse center.
2186                 theVec Vector, normal to the plane of the ellipse.
2187                 theRMajor Major ellipse radius.
2188                 theRMinor Minor ellipse radius.
2189                 theVecMaj Vector, direction of the ellipse's main axis.
2190                 theName Object name; when specified, this parameter is used
2191                         for result publication in the study. Otherwise, if automatic
2192                         publication is switched on, default value is used for result name.
2193
2194             Returns:
2195                 New GEOM.GEOM_Object, containing the created ellipse.
2196             """
2197             # Example: see GEOM_TestAll.py
2198             theRMajor, theRMinor, Parameters = ParseParameters(theRMajor, theRMinor)
2199             if theVecMaj is not None:
2200                 anObj = self.CurvesOp.MakeEllipseVec(thePnt, theVec, theRMajor, theRMinor, theVecMaj)
2201             else:
2202                 anObj = self.CurvesOp.MakeEllipse(thePnt, theVec, theRMajor, theRMinor)
2203                 pass
2204             RaiseIfFailed("MakeEllipse", self.CurvesOp)
2205             anObj.SetParameters(Parameters)
2206             self._autoPublish(anObj, theName, "ellipse")
2207             return anObj
2208
2209         ## Create an ellipse with given radiuses.
2210         #  Center of the ellipse will be in the origin of global
2211         #  coordinate system and normal vector will be codirected with Z axis
2212         #  @param theRMajor Major ellipse radius.
2213         #  @param theRMinor Minor ellipse radius.
2214         #  @param theName Object name; when specified, this parameter is used
2215         #         for result publication in the study. Otherwise, if automatic
2216         #         publication is switched on, default value is used for result name.
2217         #
2218         #  @return New GEOM.GEOM_Object, containing the created ellipse.
2219         @ManageTransactions("CurvesOp")
2220         def MakeEllipseRR(self, theRMajor, theRMinor, theName=None):
2221             """
2222             Create an ellipse with given radiuses.
2223             Center of the ellipse will be in the origin of global
2224             coordinate system and normal vector will be codirected with Z axis
2225
2226             Parameters:
2227                 theRMajor Major ellipse radius.
2228                 theRMinor Minor ellipse radius.
2229                 theName Object name; when specified, this parameter is used
2230                         for result publication in the study. Otherwise, if automatic
2231                         publication is switched on, default value is used for result name.
2232
2233             Returns:
2234             New GEOM.GEOM_Object, containing the created ellipse.
2235             """
2236             anObj = self.CurvesOp.MakeEllipse(None, None, theRMajor, theRMinor)
2237             RaiseIfFailed("MakeEllipse", self.CurvesOp)
2238             self._autoPublish(anObj, theName, "ellipse")
2239             return anObj
2240
2241         ## Create a polyline on the set of points.
2242         #  @param thePoints Sequence of points for the polyline.
2243         #  @param theIsClosed If True, build a closed wire.
2244         #  @param theName Object name; when specified, this parameter is used
2245         #         for result publication in the study. Otherwise, if automatic
2246         #         publication is switched on, default value is used for result name.
2247         #
2248         #  @return New GEOM.GEOM_Object, containing the created polyline.
2249         #
2250         #  @ref tui_creation_curve "Example"
2251         @ManageTransactions("CurvesOp")
2252         def MakePolyline(self, thePoints, theIsClosed=False, theName=None):
2253             """
2254             Create a polyline on the set of points.
2255
2256             Parameters:
2257                 thePoints Sequence of points for the polyline.
2258                 theIsClosed If True, build a closed wire.
2259                 theName Object name; when specified, this parameter is used
2260                         for result publication in the study. Otherwise, if automatic
2261                         publication is switched on, default value is used for result name.
2262
2263             Returns:
2264                 New GEOM.GEOM_Object, containing the created polyline.
2265             """
2266             # Example: see GEOM_TestAll.py
2267             anObj = self.CurvesOp.MakePolyline(thePoints, theIsClosed)
2268             RaiseIfFailed("MakePolyline", self.CurvesOp)
2269             self._autoPublish(anObj, theName, "polyline")
2270             return anObj
2271
2272         ## Create bezier curve on the set of points.
2273         #  @param thePoints Sequence of points for the bezier curve.
2274         #  @param theIsClosed If True, build a closed curve.
2275         #  @param theName Object name; when specified, this parameter is used
2276         #         for result publication in the study. Otherwise, if automatic
2277         #         publication is switched on, default value is used for result name.
2278         #
2279         #  @return New GEOM.GEOM_Object, containing the created bezier curve.
2280         #
2281         #  @ref tui_creation_curve "Example"
2282         @ManageTransactions("CurvesOp")
2283         def MakeBezier(self, thePoints, theIsClosed=False, theName=None):
2284             """
2285             Create bezier curve on the set of points.
2286
2287             Parameters:
2288                 thePoints Sequence of points for the bezier curve.
2289                 theIsClosed If True, build a closed curve.
2290                 theName Object name; when specified, this parameter is used
2291                         for result publication in the study. Otherwise, if automatic
2292                         publication is switched on, default value is used for result name.
2293
2294             Returns:
2295                 New GEOM.GEOM_Object, containing the created bezier curve.
2296             """
2297             # Example: see GEOM_TestAll.py
2298             anObj = self.CurvesOp.MakeSplineBezier(thePoints, theIsClosed)
2299             RaiseIfFailed("MakeSplineBezier", self.CurvesOp)
2300             self._autoPublish(anObj, theName, "bezier")
2301             return anObj
2302
2303         ## Create B-Spline curve on the set of points.
2304         #  @param thePoints Sequence of points for the B-Spline curve.
2305         #  @param theIsClosed If True, build a closed curve.
2306         #  @param theDoReordering If TRUE, the algo does not follow the order of
2307         #                         \a thePoints but searches for the closest vertex.
2308         #  @param theName Object name; when specified, this parameter is used
2309         #         for result publication in the study. Otherwise, if automatic
2310         #         publication is switched on, default value is used for result name.
2311         #
2312         #  @return New GEOM.GEOM_Object, containing the created B-Spline curve.
2313         #
2314         #  @ref tui_creation_curve "Example"
2315         @ManageTransactions("CurvesOp")
2316         def MakeInterpol(self, thePoints, theIsClosed=False, theDoReordering=False, theName=None):
2317             """
2318             Create B-Spline curve on the set of points.
2319
2320             Parameters:
2321                 thePoints Sequence of points for the B-Spline curve.
2322                 theIsClosed If True, build a closed curve.
2323                 theDoReordering If True, the algo does not follow the order of
2324                                 thePoints but searches for the closest vertex.
2325                 theName Object name; when specified, this parameter is used
2326                         for result publication in the study. Otherwise, if automatic
2327                         publication is switched on, default value is used for result name.
2328
2329             Returns:
2330                 New GEOM.GEOM_Object, containing the created B-Spline curve.
2331             """
2332             # Example: see GEOM_TestAll.py
2333             anObj = self.CurvesOp.MakeSplineInterpolation(thePoints, theIsClosed, theDoReordering)
2334             RaiseIfFailed("MakeInterpol", self.CurvesOp)
2335             self._autoPublish(anObj, theName, "bspline")
2336             return anObj
2337
2338         ## Create B-Spline curve on the set of points.
2339         #  @param thePoints Sequence of points for the B-Spline curve.
2340         #  @param theFirstVec Vector object, defining the curve direction at its first point.
2341         #  @param theLastVec Vector object, defining the curve direction at its last point.
2342         #  @param theName Object name; when specified, this parameter is used
2343         #         for result publication in the study. Otherwise, if automatic
2344         #         publication is switched on, default value is used for result name.
2345         #
2346         #  @return New GEOM.GEOM_Object, containing the created B-Spline curve.
2347         #
2348         #  @ref tui_creation_curve "Example"
2349         @ManageTransactions("CurvesOp")
2350         def MakeInterpolWithTangents(self, thePoints, theFirstVec, theLastVec, theName=None):
2351             """
2352             Create B-Spline curve on the set of points.
2353
2354             Parameters:
2355                 thePoints Sequence of points for the B-Spline curve.
2356                 theFirstVec Vector object, defining the curve direction at its first point.
2357                 theLastVec Vector object, defining the curve direction at its last point.
2358                 theName Object name; when specified, this parameter is used
2359                         for result publication in the study. Otherwise, if automatic
2360                         publication is switched on, default value is used for result name.
2361
2362             Returns:
2363                 New GEOM.GEOM_Object, containing the created B-Spline curve.
2364             """
2365             # Example: see GEOM_TestAll.py
2366             anObj = self.CurvesOp.MakeSplineInterpolWithTangents(thePoints, theFirstVec, theLastVec)
2367             RaiseIfFailed("MakeInterpolWithTangents", self.CurvesOp)
2368             self._autoPublish(anObj, theName, "bspline")
2369             return anObj
2370
2371         ## Creates a curve using the parametric definition of the basic points.
2372         #  @param thexExpr parametric equation of the coordinates X.
2373         #  @param theyExpr parametric equation of the coordinates Y.
2374         #  @param thezExpr parametric equation of the coordinates Z.
2375         #  @param theParamMin the minimal value of the parameter.
2376         #  @param theParamMax the maximum value of the parameter.
2377         #  @param theParamStep the number of steps if theNewMethod = True, else step value of the parameter.
2378         #  @param theCurveType the type of the curve,
2379         #         one of GEOM.Polyline, GEOM.Bezier, GEOM.Interpolation.
2380         #  @param theNewMethod flag for switching to the new method if the flag is set to false a deprecated method is used which can lead to a bug.
2381         #  @param theName Object name; when specified, this parameter is used
2382         #         for result publication in the study. Otherwise, if automatic
2383         #         publication is switched on, default value is used for result name.
2384         #
2385         #  @return New GEOM.GEOM_Object, containing the created curve.
2386         #
2387         #  @ref tui_creation_curve "Example"
2388         @ManageTransactions("CurvesOp")
2389         def MakeCurveParametric(self, thexExpr, theyExpr, thezExpr,
2390                                 theParamMin, theParamMax, theParamStep, theCurveType, theNewMethod=False, theName=None ):
2391             """
2392             Creates a curve using the parametric definition of the basic points.
2393
2394             Parameters:
2395                 thexExpr parametric equation of the coordinates X.
2396                 theyExpr parametric equation of the coordinates Y.
2397                 thezExpr parametric equation of the coordinates Z.
2398                 theParamMin the minimal value of the parameter.
2399                 theParamMax the maximum value of the parameter.
2400                 theParamStep the number of steps if theNewMethod = True, else step value of the parameter.
2401                 theCurveType the type of the curve,
2402                              one of GEOM.Polyline, GEOM.Bezier, GEOM.Interpolation.
2403                 theNewMethod flag for switching to the new method if the flag is set to false a deprecated
2404                              method is used which can lead to a bug.
2405                 theName Object name; when specified, this parameter is used
2406                         for result publication in the study. Otherwise, if automatic
2407                         publication is switched on, default value is used for result name.
2408
2409             Returns:
2410                 New GEOM.GEOM_Object, containing the created curve.
2411             """
2412             theParamMin,theParamMax,theParamStep,Parameters = ParseParameters(theParamMin,theParamMax,theParamStep)
2413             if theNewMethod:
2414               anObj = self.CurvesOp.MakeCurveParametricNew(thexExpr,theyExpr,thezExpr,theParamMin,theParamMax,theParamStep,theCurveType)
2415             else:
2416               anObj = self.CurvesOp.MakeCurveParametric(thexExpr,theyExpr,thezExpr,theParamMin,theParamMax,theParamStep,theCurveType)
2417             RaiseIfFailed("MakeCurveParametric", self.CurvesOp)
2418             anObj.SetParameters(Parameters)
2419             self._autoPublish(anObj, theName, "curve")
2420             return anObj
2421
2422         ## Create an isoline curve on a face.
2423         #  @param theFace the face for which an isoline is created.
2424         #  @param IsUIsoline True for U-isoline creation; False for V-isoline
2425         #         creation.
2426         #  @param theParameter the U parameter for U-isoline or V parameter
2427         #         for V-isoline.
2428         #  @param theName Object name; when specified, this parameter is used
2429         #         for result publication in the study. Otherwise, if automatic
2430         #         publication is switched on, default value is used for result name.
2431         #
2432         #  @return New GEOM.GEOM_Object, containing the created isoline edge or
2433         #          a compound of edges.
2434         #
2435         #  @ref tui_creation_curve "Example"
2436         @ManageTransactions("CurvesOp")
2437         def MakeIsoline(self, theFace, IsUIsoline, theParameter, theName=None):
2438             """
2439             Create an isoline curve on a face.
2440
2441             Parameters:
2442                 theFace the face for which an isoline is created.
2443                 IsUIsoline True for U-isoline creation; False for V-isoline
2444                            creation.
2445                 theParameter the U parameter for U-isoline or V parameter
2446                              for V-isoline.
2447                 theName Object name; when specified, this parameter is used
2448                         for result publication in the study. Otherwise, if automatic
2449                         publication is switched on, default value is used for result name.
2450
2451             Returns:
2452                 New GEOM.GEOM_Object, containing the created isoline edge or a
2453                 compound of edges.
2454             """
2455             # Example: see GEOM_TestAll.py
2456             anObj = self.CurvesOp.MakeIsoline(theFace, IsUIsoline, theParameter)
2457             RaiseIfFailed("MakeIsoline", self.CurvesOp)
2458             if IsUIsoline:
2459                 self._autoPublish(anObj, theName, "U-Isoline")
2460             else:
2461                 self._autoPublish(anObj, theName, "V-Isoline")
2462             return anObj
2463
2464         # end of l4_curves
2465         ## @}
2466
2467         ## @addtogroup l3_sketcher
2468         ## @{
2469
2470         ## Create a sketcher (wire or face), following the textual description,
2471         #  passed through <VAR>theCommand</VAR> argument. \n
2472         #  Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2473         #  Format of the description string have to be the following:
2474         #
2475         #  "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2476         #
2477         #  Where:
2478         #  - x1, y1 are coordinates of the first sketcher point (zero by default),
2479         #  - CMD is one of
2480         #     - "R angle" : Set the direction by angle
2481         #     - "D dx dy" : Set the direction by DX & DY
2482         #     .
2483         #       \n
2484         #     - "TT x y" : Create segment by point at X & Y
2485         #     - "T dx dy" : Create segment by point with DX & DY
2486         #     - "L length" : Create segment by direction & Length
2487         #     - "IX x" : Create segment by direction & Intersect. X
2488         #     - "IY y" : Create segment by direction & Intersect. Y
2489         #     .
2490         #       \n
2491         #     - "C radius length" : Create arc by direction, radius and length(in degree)
2492         #     - "AA x y": Create arc by point at X & Y
2493         #     - "A dx dy" : Create arc by point with DX & DY
2494         #     - "UU x y radius flag1": Create arc by point at X & Y with given radiUs
2495         #     - "U dx dy radius flag1" : Create arc by point with DX & DY with given radiUs
2496         #     - "EE x y xc yc flag1 flag2": Create arc by point at X & Y with given cEnter coordinates
2497         #     - "E dx dy dxc dyc radius flag1 flag2" : Create arc by point with DX & DY with given cEnter coordinates
2498         #     .
2499         #       \n
2500         #     - "WW" : Close Wire (to finish)
2501         #     - "WF" : Close Wire and build face (to finish)
2502         #     .
2503         #        \n
2504         #  - Flag1 (= reverse) is 0 or 2 ...
2505         #     - if 0 the drawn arc is the one of lower angle (< Pi)
2506         #     - if 2 the drawn arc ius the one of greater angle (> Pi)
2507         #     .
2508         #        \n
2509         #  - Flag2 (= control tolerance) is 0 or 1 ...
2510         #     - if 0 the specified end point can be at a distance of the arc greater than the tolerance (10^-7)
2511         #     - if 1 the wire is built only if the end point is on the arc
2512         #       with a tolerance of 10^-7 on the distance else the creation fails
2513         #
2514         #  @param theCommand String, defining the sketcher in local
2515         #                    coordinates of the working plane.
2516         #  @param theWorkingPlane Nine double values, defining origin,
2517         #                         OZ and OX directions of the working plane.
2518         #  @param theName Object name; when specified, this parameter is used
2519         #         for result publication in the study. Otherwise, if automatic
2520         #         publication is switched on, default value is used for result name.
2521         #
2522         #  @return New GEOM.GEOM_Object, containing the created wire.
2523         #
2524         #  @ref tui_sketcher_page "Example"
2525         @ManageTransactions("CurvesOp")
2526         def MakeSketcher(self, theCommand, theWorkingPlane = [0,0,0, 0,0,1, 1,0,0], theName=None):
2527             """
2528             Create a sketcher (wire or face), following the textual description, passed
2529             through theCommand argument.
2530             Edges of the resulting wire or face will be arcs of circles and/or linear segments.
2531             Format of the description string have to be the following:
2532                 "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2533             Where:
2534             - x1, y1 are coordinates of the first sketcher point (zero by default),
2535             - CMD is one of
2536                - "R angle" : Set the direction by angle
2537                - "D dx dy" : Set the direction by DX & DY
2538
2539                - "TT x y" : Create segment by point at X & Y
2540                - "T dx dy" : Create segment by point with DX & DY
2541                - "L length" : Create segment by direction & Length
2542                - "IX x" : Create segment by direction & Intersect. X
2543                - "IY y" : Create segment by direction & Intersect. Y
2544
2545                - "C radius length" : Create arc by direction, radius and length(in degree)
2546                - "AA x y": Create arc by point at X & Y
2547                - "A dx dy" : Create arc by point with DX & DY
2548                - "UU x y radius flag1": Create arc by point at X & Y with given radiUs
2549                - "U dx dy radius flag1" : Create arc by point with DX & DY with given radiUs
2550                - "EE x y xc yc flag1 flag2": Create arc by point at X & Y with given cEnter coordinates
2551                - "E dx dy dxc dyc radius flag1 flag2" : Create arc by point with DX & DY with given cEnter coordinates
2552
2553                - "WW" : Close Wire (to finish)
2554                - "WF" : Close Wire and build face (to finish)
2555
2556             - Flag1 (= reverse) is 0 or 2 ...
2557                - if 0 the drawn arc is the one of lower angle (< Pi)
2558                - if 2 the drawn arc ius the one of greater angle (> Pi)
2559
2560             - Flag2 (= control tolerance) is 0 or 1 ...
2561                - if 0 the specified end point can be at a distance of the arc greater than the tolerance (10^-7)
2562                - if 1 the wire is built only if the end point is on the arc
2563                  with a tolerance of 10^-7 on the distance else the creation fails
2564
2565             Parameters:
2566                 theCommand String, defining the sketcher in local
2567                            coordinates of the working plane.
2568                 theWorkingPlane Nine double values, defining origin,
2569                                 OZ and OX directions of the working plane.
2570                 theName Object name; when specified, this parameter is used
2571                         for result publication in the study. Otherwise, if automatic
2572                         publication is switched on, default value is used for result name.
2573
2574             Returns:
2575                 New GEOM.GEOM_Object, containing the created wire.
2576             """
2577             # Example: see GEOM_TestAll.py
2578             theCommand,Parameters = ParseSketcherCommand(theCommand)
2579             anObj = self.CurvesOp.MakeSketcher(theCommand, theWorkingPlane)
2580             RaiseIfFailed("MakeSketcher", self.CurvesOp)
2581             anObj.SetParameters(Parameters)
2582             self._autoPublish(anObj, theName, "wire")
2583             return anObj
2584
2585         ## Create a sketcher (wire or face), following the textual description,
2586         #  passed through <VAR>theCommand</VAR> argument. \n
2587         #  For format of the description string see MakeSketcher() method.\n
2588         #  @param theCommand String, defining the sketcher in local
2589         #                    coordinates of the working plane.
2590         #  @param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2591         #  @param theName Object name; when specified, this parameter is used
2592         #         for result publication in the study. Otherwise, if automatic
2593         #         publication is switched on, default value is used for result name.
2594         #
2595         #  @return New GEOM.GEOM_Object, containing the created wire.
2596         #
2597         #  @ref tui_sketcher_page "Example"
2598         @ManageTransactions("CurvesOp")
2599         def MakeSketcherOnPlane(self, theCommand, theWorkingPlane, theName=None):
2600             """
2601             Create a sketcher (wire or face), following the textual description,
2602             passed through theCommand argument.
2603             For format of the description string see geompy.MakeSketcher() method.
2604
2605             Parameters:
2606                 theCommand String, defining the sketcher in local
2607                            coordinates of the working plane.
2608                 theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2609                 theName Object name; when specified, this parameter is used
2610                         for result publication in the study. Otherwise, if automatic
2611                         publication is switched on, default value is used for result name.
2612
2613             Returns:
2614                 New GEOM.GEOM_Object, containing the created wire.
2615             """
2616             theCommand,Parameters = ParseSketcherCommand(theCommand)
2617             anObj = self.CurvesOp.MakeSketcherOnPlane(theCommand, theWorkingPlane)
2618             RaiseIfFailed("MakeSketcherOnPlane", self.CurvesOp)
2619             anObj.SetParameters(Parameters)
2620             self._autoPublish(anObj, theName, "wire")
2621             return anObj
2622
2623         ## Obtain a 2D sketcher interface
2624         #  @return An instance of @ref gsketcher.Sketcher2D "Sketcher2D" interface
2625         def Sketcher2D (self):
2626             """
2627             Obtain a 2D sketcher interface.
2628
2629             Example of usage:
2630                sk = geompy.Sketcher2D()
2631                sk.addPoint(20, 20)
2632                sk.addSegmentRelative(15, 70)
2633                sk.addSegmentPerpY(50)
2634                sk.addArcRadiusRelative(25, 15, 14.5, 0)
2635                sk.addArcCenterAbsolute(1, 1, 50, 50, 0, 0)
2636                sk.addArcDirectionRadiusLength(20, 20, 101, 162.13)
2637                sk.close()
2638                Sketch_1 = sk.wire(geomObj_1)
2639             """
2640             sk = Sketcher2D (self)
2641             return sk
2642
2643         ## Create a sketcher wire, following the numerical description,
2644         #  passed through <VAR>theCoordinates</VAR> argument. \n
2645         #  @param theCoordinates double values, defining points to create a wire,
2646         #                                                      passing from it.
2647         #  @param theName Object name; when specified, this parameter is used
2648         #         for result publication in the study. Otherwise, if automatic
2649         #         publication is switched on, default value is used for result name.
2650         #
2651         #  @return New GEOM.GEOM_Object, containing the created wire.
2652         #
2653         #  @ref tui_3dsketcher_page "Example"
2654         @ManageTransactions("CurvesOp")
2655         def Make3DSketcher(self, theCoordinates, theName=None):
2656             """
2657             Create a sketcher wire, following the numerical description,
2658             passed through theCoordinates argument.
2659
2660             Parameters:
2661                 theCoordinates double values, defining points to create a wire,
2662                                passing from it.
2663                 theName Object name; when specified, this parameter is used
2664                         for result publication in the study. Otherwise, if automatic
2665                         publication is switched on, default value is used for result name.
2666
2667             Returns:
2668                 New GEOM_Object, containing the created wire.
2669             """
2670             theCoordinates,Parameters = ParseParameters(theCoordinates)
2671             anObj = self.CurvesOp.Make3DSketcher(theCoordinates)
2672             RaiseIfFailed("Make3DSketcher", self.CurvesOp)
2673             anObj.SetParameters(Parameters)
2674             self._autoPublish(anObj, theName, "wire")
2675             return anObj
2676
2677         ## Obtain a 3D sketcher interface
2678         #  @return An instance of @ref gsketcher.Sketcher3D "Sketcher3D" interface
2679         #
2680         #  @ref tui_3dsketcher_page "Example"
2681         def Sketcher3D (self):
2682             """
2683             Obtain a 3D sketcher interface.
2684
2685             Example of usage:
2686                 sk = geompy.Sketcher3D()
2687                 sk.addPointsAbsolute(0,0,0, 70,0,0)
2688                 sk.addPointsRelative(0, 0, 130)
2689                 sk.addPointAnglesLength("OXY", 50, 0, 100)
2690                 sk.addPointAnglesLength("OXZ", 30, 80, 130)
2691                 sk.close()
2692                 a3D_Sketcher_1 = sk.wire()
2693             """
2694             sk = Sketcher3D (self)
2695             return sk
2696
2697         ## Obtain a 2D polyline creation interface
2698         #  @return An instance of @ref gsketcher.Polyline2D "Polyline2D" interface
2699         #
2700         #  @ref tui_3dsketcher_page "Example"
2701         def Polyline2D (self):
2702             """
2703             Obtain a 2D polyline creation interface.
2704
2705             Example of usage:
2706                 pl = geompy.Polyline2D()
2707                 pl.addSection("section 1", GEOM.Polyline, True)
2708                 pl.addPoints(0, 0, 10, 0, 10, 10)
2709                 pl.addSection("section 2", GEOM.Interpolation, False)
2710                 pl.addPoints(20, 0, 30, 0, 30, 10)
2711                 resultObj = pl.result(WorkingPlane)
2712             """
2713             pl = Polyline2D (self)
2714             return pl
2715
2716         # end of l3_sketcher
2717         ## @}
2718
2719         ## @addtogroup l3_3d_primitives
2720         ## @{
2721
2722         ## Create a box by coordinates of two opposite vertices.
2723         #
2724         #  @param x1,y1,z1 double values, defining first point it.
2725         #  @param x2,y2,z2 double values, defining first point it.
2726         #  @param theName Object name; when specified, this parameter is used
2727         #         for result publication in the study. Otherwise, if automatic
2728         #         publication is switched on, default value is used for result name.
2729         #
2730         #  @return New GEOM.GEOM_Object, containing the created box.
2731         #
2732         #  @ref tui_creation_box "Example"
2733         def MakeBox(self, x1, y1, z1, x2, y2, z2, theName=None):
2734             """
2735             Create a box by coordinates of two opposite vertices.
2736
2737             Parameters:
2738                 x1,y1,z1 double values, defining first point.
2739                 x2,y2,z2 double values, defining second point.
2740                 theName Object name; when specified, this parameter is used
2741                         for result publication in the study. Otherwise, if automatic
2742                         publication is switched on, default value is used for result name.
2743
2744             Returns:
2745                 New GEOM.GEOM_Object, containing the created box.
2746             """
2747             # Example: see GEOM_TestAll.py
2748             pnt1 = self.MakeVertex(x1,y1,z1)
2749             pnt2 = self.MakeVertex(x2,y2,z2)
2750             # note: auto-publishing is done in self.MakeBoxTwoPnt()
2751             return self.MakeBoxTwoPnt(pnt1, pnt2, theName)
2752
2753         ## Create a box with specified dimensions along the coordinate axes
2754         #  and with edges, parallel to the coordinate axes.
2755         #  Center of the box will be at point (DX/2, DY/2, DZ/2).
2756         #  @param theDX Length of Box edges, parallel to OX axis.
2757         #  @param theDY Length of Box edges, parallel to OY axis.
2758         #  @param theDZ Length of Box edges, parallel to OZ axis.
2759         #  @param theName Object name; when specified, this parameter is used
2760         #         for result publication in the study. Otherwise, if automatic
2761         #         publication is switched on, default value is used for result name.
2762         #
2763         #  @return New GEOM.GEOM_Object, containing the created box.
2764         #
2765         #  @ref tui_creation_box "Example"
2766         @ManageTransactions("PrimOp")
2767         def MakeBoxDXDYDZ(self, theDX, theDY, theDZ, theName=None):
2768             """
2769             Create a box with specified dimensions along the coordinate axes
2770             and with edges, parallel to the coordinate axes.
2771             Center of the box will be at point (DX/2, DY/2, DZ/2).
2772
2773             Parameters:
2774                 theDX Length of Box edges, parallel to OX axis.
2775                 theDY Length of Box edges, parallel to OY axis.
2776                 theDZ Length of Box edges, parallel to OZ axis.
2777                 theName Object name; when specified, this parameter is used
2778                         for result publication in the study. Otherwise, if automatic
2779                         publication is switched on, default value is used for result name.
2780
2781             Returns:
2782                 New GEOM.GEOM_Object, containing the created box.
2783             """
2784             # Example: see GEOM_TestAll.py
2785             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
2786             anObj = self.PrimOp.MakeBoxDXDYDZ(theDX, theDY, theDZ)
2787             RaiseIfFailed("MakeBoxDXDYDZ", self.PrimOp)
2788             anObj.SetParameters(Parameters)
2789             self._autoPublish(anObj, theName, "box")
2790             return anObj
2791
2792         ## Create a box with two specified opposite vertices,
2793         #  and with edges, parallel to the coordinate axes
2794         #  @param thePnt1 First of two opposite vertices.
2795         #  @param thePnt2 Second of two opposite vertices.
2796         #  @param theName Object name; when specified, this parameter is used
2797         #         for result publication in the study. Otherwise, if automatic
2798         #         publication is switched on, default value is used for result name.
2799         #
2800         #  @return New GEOM.GEOM_Object, containing the created box.
2801         #
2802         #  @ref tui_creation_box "Example"
2803         @ManageTransactions("PrimOp")
2804         def MakeBoxTwoPnt(self, thePnt1, thePnt2, theName=None):
2805             """
2806             Create a box with two specified opposite vertices,
2807             and with edges, parallel to the coordinate axes
2808
2809             Parameters:
2810                 thePnt1 First of two opposite vertices.
2811                 thePnt2 Second of two opposite vertices.
2812                 theName Object name; when specified, this parameter is used
2813                         for result publication in the study. Otherwise, if automatic
2814                         publication is switched on, default value is used for result name.
2815
2816             Returns:
2817                 New GEOM.GEOM_Object, containing the created box.
2818             """
2819             # Example: see GEOM_TestAll.py
2820             anObj = self.PrimOp.MakeBoxTwoPnt(thePnt1, thePnt2)
2821             RaiseIfFailed("MakeBoxTwoPnt", self.PrimOp)
2822             self._autoPublish(anObj, theName, "box")
2823             return anObj
2824
2825         ## Create a face with specified dimensions with edges parallel to coordinate axes.
2826         #  @param theH height of Face.
2827         #  @param theW width of Face.
2828         #  @param theOrientation face orientation: 1-OXY, 2-OYZ, 3-OZX
2829         #  @param theName Object name; when specified, this parameter is used
2830         #         for result publication in the study. Otherwise, if automatic
2831         #         publication is switched on, default value is used for result name.
2832         #
2833         #  @return New GEOM.GEOM_Object, containing the created face.
2834         #
2835         #  @ref tui_creation_face "Example"
2836         @ManageTransactions("PrimOp")
2837         def MakeFaceHW(self, theH, theW, theOrientation, theName=None):
2838             """
2839             Create a face with specified dimensions with edges parallel to coordinate axes.
2840
2841             Parameters:
2842                 theH height of Face.
2843                 theW width of Face.
2844                 theOrientation face orientation: 1-OXY, 2-OYZ, 3-OZX
2845                 theName Object name; when specified, this parameter is used
2846                         for result publication in the study. Otherwise, if automatic
2847                         publication is switched on, default value is used for result name.
2848
2849             Returns:
2850                 New GEOM.GEOM_Object, containing the created face.
2851             """
2852             # Example: see GEOM_TestAll.py
2853             theH,theW,Parameters = ParseParameters(theH, theW)
2854             anObj = self.PrimOp.MakeFaceHW(theH, theW, theOrientation)
2855             RaiseIfFailed("MakeFaceHW", self.PrimOp)
2856             anObj.SetParameters(Parameters)
2857             self._autoPublish(anObj, theName, "rectangle")
2858             return anObj
2859
2860         ## Create a face from another plane and two sizes,
2861         #  vertical size and horisontal size.
2862         #  @param theObj   Normale vector to the creating face or
2863         #  the face object.
2864         #  @param theH     Height (vertical size).
2865         #  @param theW     Width (horisontal size).
2866         #  @param theName Object name; when specified, this parameter is used
2867         #         for result publication in the study. Otherwise, if automatic
2868         #         publication is switched on, default value is used for result name.
2869         #
2870         #  @return New GEOM.GEOM_Object, containing the created face.
2871         #
2872         #  @ref tui_creation_face "Example"
2873         @ManageTransactions("PrimOp")
2874         def MakeFaceObjHW(self, theObj, theH, theW, theName=None):
2875             """
2876             Create a face from another plane and two sizes,
2877             vertical size and horisontal size.
2878
2879             Parameters:
2880                 theObj   Normale vector to the creating face or
2881                          the face object.
2882                 theH     Height (vertical size).
2883                 theW     Width (horisontal size).
2884                 theName Object name; when specified, this parameter is used
2885                         for result publication in the study. Otherwise, if automatic
2886                         publication is switched on, default value is used for result name.
2887
2888             Returns:
2889                 New GEOM_Object, containing the created face.
2890             """
2891             # Example: see GEOM_TestAll.py
2892             theH,theW,Parameters = ParseParameters(theH, theW)
2893             anObj = self.PrimOp.MakeFaceObjHW(theObj, theH, theW)
2894             RaiseIfFailed("MakeFaceObjHW", self.PrimOp)
2895             anObj.SetParameters(Parameters)
2896             self._autoPublish(anObj, theName, "rectangle")
2897             return anObj
2898
2899         ## Create a disk with given center, normal vector and radius.
2900         #  @param thePnt Disk center.
2901         #  @param theVec Vector, normal to the plane of the disk.
2902         #  @param theR Disk radius.
2903         #  @param theName Object name; when specified, this parameter is used
2904         #         for result publication in the study. Otherwise, if automatic
2905         #         publication is switched on, default value is used for result name.
2906         #
2907         #  @return New GEOM.GEOM_Object, containing the created disk.
2908         #
2909         #  @ref tui_creation_disk "Example"
2910         @ManageTransactions("PrimOp")
2911         def MakeDiskPntVecR(self, thePnt, theVec, theR, theName=None):
2912             """
2913             Create a disk with given center, normal vector and radius.
2914
2915             Parameters:
2916                 thePnt Disk center.
2917                 theVec Vector, normal to the plane of the disk.
2918                 theR Disk radius.
2919                 theName Object name; when specified, this parameter is used
2920                         for result publication in the study. Otherwise, if automatic
2921                         publication is switched on, default value is used for result name.
2922
2923             Returns:
2924                 New GEOM.GEOM_Object, containing the created disk.
2925             """
2926             # Example: see GEOM_TestAll.py
2927             theR,Parameters = ParseParameters(theR)
2928             anObj = self.PrimOp.MakeDiskPntVecR(thePnt, theVec, theR)
2929             RaiseIfFailed("MakeDiskPntVecR", self.PrimOp)
2930             anObj.SetParameters(Parameters)
2931             self._autoPublish(anObj, theName, "disk")
2932             return anObj
2933
2934         ## Create a disk, passing through three given points
2935         #  @param thePnt1,thePnt2,thePnt3 Points, defining the disk.
2936         #  @param theName Object name; when specified, this parameter is used
2937         #         for result publication in the study. Otherwise, if automatic
2938         #         publication is switched on, default value is used for result name.
2939         #
2940         #  @return New GEOM.GEOM_Object, containing the created disk.
2941         #
2942         #  @ref tui_creation_disk "Example"
2943         @ManageTransactions("PrimOp")
2944         def MakeDiskThreePnt(self, thePnt1, thePnt2, thePnt3, theName=None):
2945             """
2946             Create a disk, passing through three given points
2947
2948             Parameters:
2949                 thePnt1,thePnt2,thePnt3 Points, defining the disk.
2950                 theName Object name; when specified, this parameter is used
2951                         for result publication in the study. Otherwise, if automatic
2952                         publication is switched on, default value is used for result name.
2953
2954             Returns:
2955                 New GEOM.GEOM_Object, containing the created disk.
2956             """
2957             # Example: see GEOM_TestAll.py
2958             anObj = self.PrimOp.MakeDiskThreePnt(thePnt1, thePnt2, thePnt3)
2959             RaiseIfFailed("MakeDiskThreePnt", self.PrimOp)
2960             self._autoPublish(anObj, theName, "disk")
2961             return anObj
2962
2963         ## Create a disk with specified dimensions along OX-OY coordinate axes.
2964         #  @param theR Radius of Face.
2965         #  @param theOrientation set the orientation belong axis OXY or OYZ or OZX
2966         #  @param theName Object name; when specified, this parameter is used
2967         #         for result publication in the study. Otherwise, if automatic
2968         #         publication is switched on, default value is used for result name.
2969         #
2970         #  @return New GEOM.GEOM_Object, containing the created disk.
2971         #
2972         #  @ref tui_creation_face "Example"
2973         @ManageTransactions("PrimOp")
2974         def MakeDiskR(self, theR, theOrientation, theName=None):
2975             """
2976             Create a disk with specified dimensions along OX-OY coordinate axes.
2977
2978             Parameters:
2979                 theR Radius of Face.
2980                 theOrientation set the orientation belong axis OXY or OYZ or OZX
2981                 theName Object name; when specified, this parameter is used
2982                         for result publication in the study. Otherwise, if automatic
2983                         publication is switched on, default value is used for result name.
2984
2985             Returns:
2986                 New GEOM.GEOM_Object, containing the created disk.
2987
2988             Example of usage:
2989                 Disk3 = geompy.MakeDiskR(100., 1)
2990             """
2991             # Example: see GEOM_TestAll.py
2992             theR,Parameters = ParseParameters(theR)
2993             anObj = self.PrimOp.MakeDiskR(theR, theOrientation)
2994             RaiseIfFailed("MakeDiskR", self.PrimOp)
2995             anObj.SetParameters(Parameters)
2996             self._autoPublish(anObj, theName, "disk")
2997             return anObj
2998
2999         ## Create a cylinder with given base point, axis, radius and height.
3000         #  @param thePnt Central point of cylinder base.
3001         #  @param theAxis Cylinder axis.
3002         #  @param theR Cylinder radius.
3003         #  @param theH Cylinder height.
3004         #  @param theName Object name; when specified, this parameter is used
3005         #         for result publication in the study. Otherwise, if automatic
3006         #         publication is switched on, default value is used for result name.
3007         #
3008         #  @return New GEOM.GEOM_Object, containing the created cylinder.
3009         #
3010         #  @ref tui_creation_cylinder "Example"
3011         @ManageTransactions("PrimOp")
3012         def MakeCylinder(self, thePnt, theAxis, theR, theH, theName=None):
3013             """
3014             Create a cylinder with given base point, axis, radius and height.
3015
3016             Parameters:
3017                 thePnt Central point of cylinder base.
3018                 theAxis Cylinder axis.
3019                 theR Cylinder radius.
3020                 theH Cylinder height.
3021                 theName Object name; when specified, this parameter is used
3022                         for result publication in the study. Otherwise, if automatic
3023                         publication is switched on, default value is used for result name.
3024
3025             Returns:
3026                 New GEOM.GEOM_Object, containing the created cylinder.
3027             """
3028             # Example: see GEOM_TestAll.py
3029             theR,theH,Parameters = ParseParameters(theR, theH)
3030             anObj = self.PrimOp.MakeCylinderPntVecRH(thePnt, theAxis, theR, theH)
3031             RaiseIfFailed("MakeCylinderPntVecRH", self.PrimOp)
3032             anObj.SetParameters(Parameters)
3033             self._autoPublish(anObj, theName, "cylinder")
3034             return anObj
3035             
3036         ## Create a portion of cylinder with given base point, axis, radius, height and angle.
3037         #  @param thePnt Central point of cylinder base.
3038         #  @param theAxis Cylinder axis.
3039         #  @param theR Cylinder radius.
3040         #  @param theH Cylinder height.
3041         #  @param theA Cylinder angle in radians.
3042         #  @param theName Object name; when specified, this parameter is used
3043         #         for result publication in the study. Otherwise, if automatic
3044         #         publication is switched on, default value is used for result name.
3045         #
3046         #  @return New GEOM.GEOM_Object, containing the created cylinder.
3047         #
3048         #  @ref tui_creation_cylinder "Example"
3049         @ManageTransactions("PrimOp")
3050         def MakeCylinderA(self, thePnt, theAxis, theR, theH, theA, theName=None):
3051             """
3052             Create a portion of cylinder with given base point, axis, radius, height and angle.
3053
3054             Parameters:
3055                 thePnt Central point of cylinder base.
3056                 theAxis Cylinder axis.
3057                 theR Cylinder radius.
3058                 theH Cylinder height.
3059                 theA Cylinder angle in radians.
3060                 theName Object name; when specified, this parameter is used
3061                         for result publication in the study. Otherwise, if automatic
3062                         publication is switched on, default value is used for result name.
3063
3064             Returns:
3065                 New GEOM.GEOM_Object, containing the created cylinder.
3066             """
3067             # Example: see GEOM_TestAll.py
3068             flag = False
3069             if isinstance(theA,str):
3070                 flag = True
3071             theR,theH,theA,Parameters = ParseParameters(theR, theH, theA)
3072             if flag:
3073                 theA = theA*math.pi/180.
3074             if theA<=0. or theA>=2*math.pi:
3075               raise ValueError("The angle parameter should be strictly between 0 and 2*pi.")
3076             anObj = self.PrimOp.MakeCylinderPntVecRHA(thePnt, theAxis, theR, theH, theA)
3077             RaiseIfFailed("MakeCylinderPntVecRHA", self.PrimOp)
3078             anObj.SetParameters(Parameters)
3079             self._autoPublish(anObj, theName, "cylinder")
3080             return anObj
3081
3082         ## Create a cylinder with given radius and height at
3083         #  the origin of coordinate system. Axis of the cylinder
3084         #  will be collinear to the OZ axis of the coordinate system.
3085         #  @param theR Cylinder radius.
3086         #  @param theH Cylinder height.
3087         #  @param theName Object name; when specified, this parameter is used
3088         #         for result publication in the study. Otherwise, if automatic
3089         #         publication is switched on, default value is used for result name.
3090         #
3091         #  @return New GEOM.GEOM_Object, containing the created cylinder.
3092         #
3093         #  @ref tui_creation_cylinder "Example"
3094         @ManageTransactions("PrimOp")
3095         def MakeCylinderRH(self, theR, theH, theName=None):
3096             """
3097             Create a cylinder with given radius and height at
3098             the origin of coordinate system. Axis of the cylinder
3099             will be collinear to the OZ axis of the coordinate system.
3100
3101             Parameters:
3102                 theR Cylinder radius.
3103                 theH Cylinder height.
3104                 theName Object name; when specified, this parameter is used
3105                         for result publication in the study. Otherwise, if automatic
3106                         publication is switched on, default value is used for result name.
3107
3108             Returns:
3109                 New GEOM.GEOM_Object, containing the created cylinder.
3110             """
3111             # Example: see GEOM_TestAll.py
3112             theR,theH,Parameters = ParseParameters(theR, theH)
3113             anObj = self.PrimOp.MakeCylinderRH(theR, theH)
3114             RaiseIfFailed("MakeCylinderRH", self.PrimOp)
3115             anObj.SetParameters(Parameters)
3116             self._autoPublish(anObj, theName, "cylinder")
3117             return anObj
3118             
3119         ## Create a portion of cylinder with given radius, height and angle at
3120         #  the origin of coordinate system. Axis of the cylinder
3121         #  will be collinear to the OZ axis of the coordinate system.
3122         #  @param theR Cylinder radius.
3123         #  @param theH Cylinder height.
3124         #  @param theA Cylinder angle in radians.
3125         #  @param theName Object name; when specified, this parameter is used
3126         #         for result publication in the study. Otherwise, if automatic
3127         #         publication is switched on, default value is used for result name.
3128         #
3129         #  @return New GEOM.GEOM_Object, containing the created cylinder.
3130         #
3131         #  @ref tui_creation_cylinder "Example"
3132         @ManageTransactions("PrimOp")
3133         def MakeCylinderRHA(self, theR, theH, theA, theName=None):
3134             """
3135             Create a portion of cylinder with given radius, height and angle at
3136             the origin of coordinate system. Axis of the cylinder
3137             will be collinear to the OZ axis of the coordinate system.
3138
3139             Parameters:
3140                 theR Cylinder radius.
3141                 theH Cylinder height.
3142                 theA Cylinder angle in radians.
3143                 theName Object name; when specified, this parameter is used
3144                         for result publication in the study. Otherwise, if automatic
3145                         publication is switched on, default value is used for result name.
3146
3147             Returns:
3148                 New GEOM.GEOM_Object, containing the created cylinder.
3149             """
3150             # Example: see GEOM_TestAll.py
3151             flag = False
3152             if isinstance(theA,str):
3153                 flag = True
3154             theR,theH,theA,Parameters = ParseParameters(theR, theH, theA)
3155             if flag:
3156                 theA = theA*math.pi/180.
3157             if theA<=0. or theA>=2*math.pi:
3158               raise ValueError("The angle parameter should be strictly between 0 and 2*pi.")
3159             anObj = self.PrimOp.MakeCylinderRHA(theR, theH, theA)
3160             RaiseIfFailed("MakeCylinderRHA", self.PrimOp)
3161             anObj.SetParameters(Parameters)
3162             self._autoPublish(anObj, theName, "cylinder")
3163             return anObj
3164
3165         ## Create a sphere with given center and radius.
3166         #  @param thePnt Sphere center.
3167         #  @param theR Sphere radius.
3168         #  @param theName Object name; when specified, this parameter is used
3169         #         for result publication in the study. Otherwise, if automatic
3170         #         publication is switched on, default value is used for result name.
3171         #
3172         #  @return New GEOM.GEOM_Object, containing the created sphere.
3173         #
3174         #  @ref tui_creation_sphere "Example"
3175         @ManageTransactions("PrimOp")
3176         def MakeSpherePntR(self, thePnt, theR, theName=None):
3177             """
3178             Create a sphere with given center and radius.
3179
3180             Parameters:
3181                 thePnt Sphere center.
3182                 theR Sphere radius.
3183                 theName Object name; when specified, this parameter is used
3184                         for result publication in the study. Otherwise, if automatic
3185                         publication is switched on, default value is used for result name.
3186
3187             Returns:
3188                 New GEOM.GEOM_Object, containing the created sphere.
3189             """
3190             # Example: see GEOM_TestAll.py
3191             theR,Parameters = ParseParameters(theR)
3192             anObj = self.PrimOp.MakeSpherePntR(thePnt, theR)
3193             RaiseIfFailed("MakeSpherePntR", self.PrimOp)
3194             anObj.SetParameters(Parameters)
3195             self._autoPublish(anObj, theName, "sphere")
3196             return anObj
3197
3198         ## Create a sphere with given center and radius.
3199         #  @param x,y,z Coordinates of sphere center.
3200         #  @param theR Sphere radius.
3201         #  @param theName Object name; when specified, this parameter is used
3202         #         for result publication in the study. Otherwise, if automatic
3203         #         publication is switched on, default value is used for result name.
3204         #
3205         #  @return New GEOM.GEOM_Object, containing the created sphere.
3206         #
3207         #  @ref tui_creation_sphere "Example"
3208         def MakeSphere(self, x, y, z, theR, theName=None):
3209             """
3210             Create a sphere with given center and radius.
3211
3212             Parameters:
3213                 x,y,z Coordinates of sphere center.
3214                 theR Sphere radius.
3215                 theName Object name; when specified, this parameter is used
3216                         for result publication in the study. Otherwise, if automatic
3217                         publication is switched on, default value is used for result name.
3218
3219             Returns:
3220                 New GEOM.GEOM_Object, containing the created sphere.
3221             """
3222             # Example: see GEOM_TestAll.py
3223             point = self.MakeVertex(x, y, z)
3224             # note: auto-publishing is done in self.MakeSpherePntR()
3225             anObj = self.MakeSpherePntR(point, theR, theName)
3226             return anObj
3227
3228         ## Create a sphere with given radius at the origin of coordinate system.
3229         #  @param theR Sphere radius.
3230         #  @param theName Object name; when specified, this parameter is used
3231         #         for result publication in the study. Otherwise, if automatic
3232         #         publication is switched on, default value is used for result name.
3233         #
3234         #  @return New GEOM.GEOM_Object, containing the created sphere.
3235         #
3236         #  @ref tui_creation_sphere "Example"
3237         @ManageTransactions("PrimOp")
3238         def MakeSphereR(self, theR, theName=None):
3239             """
3240             Create a sphere with given radius at the origin of coordinate system.
3241
3242             Parameters:
3243                 theR Sphere radius.
3244                 theName Object name; when specified, this parameter is used
3245                         for result publication in the study. Otherwise, if automatic
3246                         publication is switched on, default value is used for result name.
3247
3248             Returns:
3249                 New GEOM.GEOM_Object, containing the created sphere.
3250             """
3251             # Example: see GEOM_TestAll.py
3252             theR,Parameters = ParseParameters(theR)
3253             anObj = self.PrimOp.MakeSphereR(theR)
3254             RaiseIfFailed("MakeSphereR", self.PrimOp)
3255             anObj.SetParameters(Parameters)
3256             self._autoPublish(anObj, theName, "sphere")
3257             return anObj
3258
3259         ## Create a cone with given base point, axis, height and radiuses.
3260         #  @param thePnt Central point of the first cone base.
3261         #  @param theAxis Cone axis.
3262         #  @param theR1 Radius of the first cone base.
3263         #  @param theR2 Radius of the second cone base.
3264         #    \note If both radiuses are non-zero, the cone will be truncated.
3265         #    \note If the radiuses are equal, a cylinder will be created instead.
3266         #  @param theH Cone height.
3267         #  @param theName Object name; when specified, this parameter is used
3268         #         for result publication in the study. Otherwise, if automatic
3269         #         publication is switched on, default value is used for result name.
3270         #
3271         #  @return New GEOM.GEOM_Object, containing the created cone.
3272         #
3273         #  @ref tui_creation_cone "Example"
3274         @ManageTransactions("PrimOp")
3275         def MakeCone(self, thePnt, theAxis, theR1, theR2, theH, theName=None):
3276             """
3277             Create a cone with given base point, axis, height and radiuses.
3278
3279             Parameters:
3280                 thePnt Central point of the first cone base.
3281                 theAxis Cone axis.
3282                 theR1 Radius of the first cone base.
3283                 theR2 Radius of the second cone base.
3284                 theH Cone height.
3285                 theName Object name; when specified, this parameter is used
3286                         for result publication in the study. Otherwise, if automatic
3287                         publication is switched on, default value is used for result name.
3288
3289             Note:
3290                 If both radiuses are non-zero, the cone will be truncated.
3291                 If the radiuses are equal, a cylinder will be created instead.
3292
3293             Returns:
3294                 New GEOM.GEOM_Object, containing the created cone.
3295             """
3296             # Example: see GEOM_TestAll.py
3297             theR1,theR2,theH,Parameters = ParseParameters(theR1,theR2,theH)
3298             anObj = self.PrimOp.MakeConePntVecR1R2H(thePnt, theAxis, theR1, theR2, theH)
3299             RaiseIfFailed("MakeConePntVecR1R2H", self.PrimOp)
3300             anObj.SetParameters(Parameters)
3301             self._autoPublish(anObj, theName, "cone")
3302             return anObj
3303
3304         ## Create a cone with given height and radiuses at
3305         #  the origin of coordinate system. Axis of the cone will
3306         #  be collinear to the OZ axis of the coordinate system.
3307         #  @param theR1 Radius of the first cone base.
3308         #  @param theR2 Radius of the second cone base.
3309         #    \note If both radiuses are non-zero, the cone will be truncated.
3310         #    \note If the radiuses are equal, a cylinder will be created instead.
3311         #  @param theH Cone height.
3312         #  @param theName Object name; when specified, this parameter is used
3313         #         for result publication in the study. Otherwise, if automatic
3314         #         publication is switched on, default value is used for result name.
3315         #
3316         #  @return New GEOM.GEOM_Object, containing the created cone.
3317         #
3318         #  @ref tui_creation_cone "Example"
3319         @ManageTransactions("PrimOp")
3320         def MakeConeR1R2H(self, theR1, theR2, theH, theName=None):
3321             """
3322             Create a cone with given height and radiuses at
3323             the origin of coordinate system. Axis of the cone will
3324             be collinear to the OZ axis of the coordinate system.
3325
3326             Parameters:
3327                 theR1 Radius of the first cone base.
3328                 theR2 Radius of the second cone base.
3329                 theH Cone height.
3330                 theName Object name; when specified, this parameter is used
3331                         for result publication in the study. Otherwise, if automatic
3332                         publication is switched on, default value is used for result name.
3333
3334             Note:
3335                 If both radiuses are non-zero, the cone will be truncated.
3336                 If the radiuses are equal, a cylinder will be created instead.
3337
3338             Returns:
3339                 New GEOM.GEOM_Object, containing the created cone.
3340             """
3341             # Example: see GEOM_TestAll.py
3342             theR1,theR2,theH,Parameters = ParseParameters(theR1,theR2,theH)
3343             anObj = self.PrimOp.MakeConeR1R2H(theR1, theR2, theH)
3344             RaiseIfFailed("MakeConeR1R2H", self.PrimOp)
3345             anObj.SetParameters(Parameters)
3346             self._autoPublish(anObj, theName, "cone")
3347             return anObj
3348
3349         ## Create a torus with given center, normal vector and radiuses.
3350         #  @param thePnt Torus central point.
3351         #  @param theVec Torus axis of symmetry.
3352         #  @param theRMajor Torus major radius.
3353         #  @param theRMinor Torus minor radius.
3354         #  @param theName Object name; when specified, this parameter is used
3355         #         for result publication in the study. Otherwise, if automatic
3356         #         publication is switched on, default value is used for result name.
3357         #
3358         #  @return New GEOM.GEOM_Object, containing the created torus.
3359         #
3360         #  @ref tui_creation_torus "Example"
3361         @ManageTransactions("PrimOp")
3362         def MakeTorus(self, thePnt, theVec, theRMajor, theRMinor, theName=None):
3363             """
3364             Create a torus with given center, normal vector and radiuses.
3365
3366             Parameters:
3367                 thePnt Torus central point.
3368                 theVec Torus axis of symmetry.
3369                 theRMajor Torus major radius.
3370                 theRMinor Torus minor radius.
3371                 theName Object name; when specified, this parameter is used
3372                         for result publication in the study. Otherwise, if automatic
3373                         publication is switched on, default value is used for result name.
3374
3375            Returns:
3376                 New GEOM.GEOM_Object, containing the created torus.
3377             """
3378             # Example: see GEOM_TestAll.py
3379             theRMajor,theRMinor,Parameters = ParseParameters(theRMajor,theRMinor)
3380             anObj = self.PrimOp.MakeTorusPntVecRR(thePnt, theVec, theRMajor, theRMinor)
3381             RaiseIfFailed("MakeTorusPntVecRR", self.PrimOp)
3382             anObj.SetParameters(Parameters)
3383             self._autoPublish(anObj, theName, "torus")
3384             return anObj
3385
3386         ## Create a torus with given radiuses at the origin of coordinate system.
3387         #  @param theRMajor Torus major radius.
3388         #  @param theRMinor Torus minor radius.
3389         #  @param theName Object name; when specified, this parameter is used
3390         #         for result publication in the study. Otherwise, if automatic
3391         #         publication is switched on, default value is used for result name.
3392         #
3393         #  @return New GEOM.GEOM_Object, containing the created torus.
3394         #
3395         #  @ref tui_creation_torus "Example"
3396         @ManageTransactions("PrimOp")
3397         def MakeTorusRR(self, theRMajor, theRMinor, theName=None):
3398             """
3399            Create a torus with given radiuses at the origin of coordinate system.
3400
3401            Parameters:
3402                 theRMajor Torus major radius.
3403                 theRMinor Torus minor radius.
3404                 theName Object name; when specified, this parameter is used
3405                         for result publication in the study. Otherwise, if automatic
3406                         publication is switched on, default value is used for result name.
3407
3408            Returns:
3409                 New GEOM.GEOM_Object, containing the created torus.
3410             """
3411             # Example: see GEOM_TestAll.py
3412             theRMajor,theRMinor,Parameters = ParseParameters(theRMajor,theRMinor)
3413             anObj = self.PrimOp.MakeTorusRR(theRMajor, theRMinor)
3414             RaiseIfFailed("MakeTorusRR", self.PrimOp)
3415             anObj.SetParameters(Parameters)
3416             self._autoPublish(anObj, theName, "torus")
3417             return anObj
3418
3419         # end of l3_3d_primitives
3420         ## @}
3421
3422         ## @addtogroup l3_complex
3423         ## @{
3424
3425         ## Create a shape by extrusion of the base shape along a vector, defined by two points.
3426         #  @param theBase Base shape to be extruded.
3427         #  @param thePoint1 First end of extrusion vector.
3428         #  @param thePoint2 Second end of extrusion vector.
3429         #  @param theScaleFactor Use it to make prism with scaled second base.
3430         #                        Nagative value means not scaled second base.
3431         #  @param theName Object name; when specified, this parameter is used
3432         #         for result publication in the study. Otherwise, if automatic
3433         #         publication is switched on, default value is used for result name.
3434         #
3435         #  @return New GEOM.GEOM_Object, containing the created prism.
3436         #
3437         #  @ref tui_creation_prism "Example"
3438         @ManageTransactions("PrimOp")
3439         def MakePrism(self, theBase, thePoint1, thePoint2, theScaleFactor = -1.0, theName=None):
3440             """
3441             Create a shape by extrusion of the base shape along a vector, defined by two points.
3442
3443             Parameters:
3444                 theBase Base shape to be extruded.
3445                 thePoint1 First end of extrusion vector.
3446                 thePoint2 Second end of extrusion vector.
3447                 theScaleFactor Use it to make prism with scaled second base.
3448                                Nagative value means not scaled second base.
3449                 theName Object name; when specified, this parameter is used
3450                         for result publication in the study. Otherwise, if automatic
3451                         publication is switched on, default value is used for result name.
3452
3453             Returns:
3454                 New GEOM.GEOM_Object, containing the created prism.
3455             """
3456             # Example: see GEOM_TestAll.py
3457             anObj = None
3458             Parameters = ""
3459             if theScaleFactor > 0:
3460                 theScaleFactor,Parameters = ParseParameters(theScaleFactor)
3461                 anObj = self.PrimOp.MakePrismTwoPntWithScaling(theBase, thePoint1, thePoint2, theScaleFactor)
3462             else:
3463                 anObj = self.PrimOp.MakePrismTwoPnt(theBase, thePoint1, thePoint2)
3464             RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
3465             anObj.SetParameters(Parameters)
3466             self._autoPublish(anObj, theName, "prism")
3467             return anObj
3468
3469         ## Create a shape by extrusion of the base shape along a
3470         #  vector, defined by two points, in 2 Ways (forward/backward).
3471         #  @param theBase Base shape to be extruded.
3472         #  @param thePoint1 First end of extrusion vector.
3473         #  @param thePoint2 Second end of extrusion vector.
3474         #  @param theName Object name; when specified, this parameter is used
3475         #         for result publication in the study. Otherwise, if automatic
3476         #         publication is switched on, default value is used for result name.
3477         #
3478         #  @return New GEOM.GEOM_Object, containing the created prism.
3479         #
3480         #  @ref tui_creation_prism "Example"
3481         @ManageTransactions("PrimOp")
3482         def MakePrism2Ways(self, theBase, thePoint1, thePoint2, theName=None):
3483             """
3484             Create a shape by extrusion of the base shape along a
3485             vector, defined by two points, in 2 Ways (forward/backward).
3486
3487             Parameters:
3488                 theBase Base shape to be extruded.
3489                 thePoint1 First end of extrusion vector.
3490                 thePoint2 Second end of extrusion vector.
3491                 theName Object name; when specified, this parameter is used
3492                         for result publication in the study. Otherwise, if automatic
3493                         publication is switched on, default value is used for result name.
3494
3495             Returns:
3496                 New GEOM.GEOM_Object, containing the created prism.
3497             """
3498             # Example: see GEOM_TestAll.py
3499             anObj = self.PrimOp.MakePrismTwoPnt2Ways(theBase, thePoint1, thePoint2)
3500             RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
3501             self._autoPublish(anObj, theName, "prism")
3502             return anObj
3503
3504         ## Create a shape by extrusion of the base shape along the vector,
3505         #  i.e. all the space, transfixed by the base shape during its translation
3506         #  along the vector on the given distance.
3507         #  @param theBase Base shape to be extruded.
3508         #  @param theVec Direction of extrusion.
3509         #  @param theH Prism dimension along theVec.
3510         #  @param theScaleFactor Use it to make prism with scaled second base.
3511         #                        Negative value means not scaled second base.
3512         #  @param theName Object name; when specified, this parameter is used
3513         #         for result publication in the study. Otherwise, if automatic
3514         #         publication is switched on, default value is used for result name.
3515         #
3516         #  @return New GEOM.GEOM_Object, containing the created prism.
3517         #
3518         #  @ref tui_creation_prism "Example"
3519         @ManageTransactions("PrimOp")
3520         def MakePrismVecH(self, theBase, theVec, theH, theScaleFactor = -1.0, theName=None):
3521             """
3522             Create a shape by extrusion of the base shape along the vector,
3523             i.e. all the space, transfixed by the base shape during its translation
3524             along the vector on the given distance.
3525
3526             Parameters:
3527                 theBase Base shape to be extruded.
3528                 theVec Direction of extrusion.
3529                 theH Prism dimension along theVec.
3530                 theScaleFactor Use it to make prism with scaled second base.
3531                                Negative value means not scaled second base.
3532                 theName Object name; when specified, this parameter is used
3533                         for result publication in the study. Otherwise, if automatic
3534                         publication is switched on, default value is used for result name.
3535
3536             Returns:
3537                 New GEOM.GEOM_Object, containing the created prism.
3538             """
3539             # Example: see GEOM_TestAll.py
3540             anObj = None
3541             Parameters = ""
3542             if theScaleFactor > 0:
3543                 theH,theScaleFactor,Parameters = ParseParameters(theH,theScaleFactor)
3544                 anObj = self.PrimOp.MakePrismVecHWithScaling(theBase, theVec, theH, theScaleFactor)
3545             else:
3546                 theH,Parameters = ParseParameters(theH)
3547                 anObj = self.PrimOp.MakePrismVecH(theBase, theVec, theH)
3548             RaiseIfFailed("MakePrismVecH", self.PrimOp)
3549             anObj.SetParameters(Parameters)
3550             self._autoPublish(anObj, theName, "prism")
3551             return anObj
3552
3553         ## Create a shape by extrusion of the base shape along the vector,
3554         #  i.e. all the space, transfixed by the base shape during its translation
3555         #  along the vector on the given distance in 2 Ways (forward/backward).
3556         #  @param theBase Base shape to be extruded.
3557         #  @param theVec Direction of extrusion.
3558         #  @param theH Prism dimension along theVec in forward direction.
3559         #  @param theName Object name; when specified, this parameter is used
3560         #         for result publication in the study. Otherwise, if automatic
3561         #         publication is switched on, default value is used for result name.
3562         #
3563         #  @return New GEOM.GEOM_Object, containing the created prism.
3564         #
3565         #  @ref tui_creation_prism "Example"
3566         @ManageTransactions("PrimOp")
3567         def MakePrismVecH2Ways(self, theBase, theVec, theH, theName=None):
3568             """
3569             Create a shape by extrusion of the base shape along the vector,
3570             i.e. all the space, transfixed by the base shape during its translation
3571             along the vector on the given distance in 2 Ways (forward/backward).
3572
3573             Parameters:
3574                 theBase Base shape to be extruded.
3575                 theVec Direction of extrusion.
3576                 theH Prism dimension along theVec in forward direction.
3577                 theName Object name; when specified, this parameter is used
3578                         for result publication in the study. Otherwise, if automatic
3579                         publication is switched on, default value is used for result name.
3580
3581             Returns:
3582                 New GEOM.GEOM_Object, containing the created prism.
3583             """
3584             # Example: see GEOM_TestAll.py
3585             theH,Parameters = ParseParameters(theH)
3586             anObj = self.PrimOp.MakePrismVecH2Ways(theBase, theVec, theH)
3587             RaiseIfFailed("MakePrismVecH2Ways", self.PrimOp)
3588             anObj.SetParameters(Parameters)
3589             self._autoPublish(anObj, theName, "prism")
3590             return anObj
3591
3592         ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
3593         #  @param theBase Base shape to be extruded.
3594         #  @param theDX, theDY, theDZ Directions of extrusion.
3595         #  @param theScaleFactor Use it to make prism with scaled second base.
3596         #                        Nagative value means not scaled second base.
3597         #  @param theName Object name; when specified, this parameter is used
3598         #         for result publication in the study. Otherwise, if automatic
3599         #         publication is switched on, default value is used for result name.
3600         #
3601         #  @return New GEOM.GEOM_Object, containing the created prism.
3602         #
3603         #  @ref tui_creation_prism "Example"
3604         @ManageTransactions("PrimOp")
3605         def MakePrismDXDYDZ(self, theBase, theDX, theDY, theDZ, theScaleFactor = -1.0, theName=None):
3606             """
3607             Create a shape by extrusion of the base shape along the dx, dy, dz direction
3608
3609             Parameters:
3610                 theBase Base shape to be extruded.
3611                 theDX, theDY, theDZ Directions of extrusion.
3612                 theScaleFactor Use it to make prism with scaled second base.
3613                                Nagative value means not scaled second base.
3614                 theName Object name; when specified, this parameter is used
3615                         for result publication in the study. Otherwise, if automatic
3616                         publication is switched on, default value is used for result name.
3617
3618             Returns:
3619                 New GEOM.GEOM_Object, containing the created prism.
3620             """
3621             # Example: see GEOM_TestAll.py
3622             anObj = None
3623             Parameters = ""
3624             if theScaleFactor > 0:
3625                 theDX,theDY,theDZ,theScaleFactor,Parameters = ParseParameters(theDX, theDY, theDZ, theScaleFactor)
3626                 anObj = self.PrimOp.MakePrismDXDYDZWithScaling(theBase, theDX, theDY, theDZ, theScaleFactor)
3627             else:
3628                 theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
3629                 anObj = self.PrimOp.MakePrismDXDYDZ(theBase, theDX, theDY, theDZ)
3630             RaiseIfFailed("MakePrismDXDYDZ", self.PrimOp)
3631             anObj.SetParameters(Parameters)
3632             self._autoPublish(anObj, theName, "prism")
3633             return anObj
3634
3635         ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
3636         #  i.e. all the space, transfixed by the base shape during its translation
3637         #  along the vector on the given distance in 2 Ways (forward/backward).
3638         #  @param theBase Base shape to be extruded.
3639         #  @param theDX, theDY, theDZ Directions of extrusion.
3640         #  @param theName Object name; when specified, this parameter is used
3641         #         for result publication in the study. Otherwise, if automatic
3642         #         publication is switched on, default value is used for result name.
3643         #
3644         #  @return New GEOM.GEOM_Object, containing the created prism.
3645         #
3646         #  @ref tui_creation_prism "Example"
3647         @ManageTransactions("PrimOp")
3648         def MakePrismDXDYDZ2Ways(self, theBase, theDX, theDY, theDZ, theName=None):
3649             """
3650             Create a shape by extrusion of the base shape along the dx, dy, dz direction
3651             i.e. all the space, transfixed by the base shape during its translation
3652             along the vector on the given distance in 2 Ways (forward/backward).
3653
3654             Parameters:
3655                 theBase Base shape to be extruded.
3656                 theDX, theDY, theDZ Directions of extrusion.
3657                 theName Object name; when specified, this parameter is used
3658                         for result publication in the study. Otherwise, if automatic
3659                         publication is switched on, default value is used for result name.
3660
3661             Returns:
3662                 New GEOM.GEOM_Object, containing the created prism.
3663             """
3664             # Example: see GEOM_TestAll.py
3665             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
3666             anObj = self.PrimOp.MakePrismDXDYDZ2Ways(theBase, theDX, theDY, theDZ)
3667             RaiseIfFailed("MakePrismDXDYDZ2Ways", self.PrimOp)
3668             anObj.SetParameters(Parameters)
3669             self._autoPublish(anObj, theName, "prism")
3670             return anObj
3671
3672         ## Create a shape by revolution of the base shape around the axis
3673         #  on the given angle, i.e. all the space, transfixed by the base
3674         #  shape during its rotation around the axis on the given angle.
3675         #  @param theBase Base shape to be rotated.
3676         #  @param theAxis Rotation axis.
3677         #  @param theAngle Rotation angle in radians.
3678         #  @param theName Object name; when specified, this parameter is used
3679         #         for result publication in the study. Otherwise, if automatic
3680         #         publication is switched on, default value is used for result name.
3681         #
3682         #  @return New GEOM.GEOM_Object, containing the created revolution.
3683         #
3684         #  @ref tui_creation_revolution "Example"
3685         @ManageTransactions("PrimOp")
3686         def MakeRevolution(self, theBase, theAxis, theAngle, theName=None):
3687             """
3688             Create a shape by revolution of the base shape around the axis
3689             on the given angle, i.e. all the space, transfixed by the base
3690             shape during its rotation around the axis on the given angle.
3691
3692             Parameters:
3693                 theBase Base shape to be rotated.
3694                 theAxis Rotation axis.
3695                 theAngle Rotation angle in radians.
3696                 theName Object name; when specified, this parameter is used
3697                         for result publication in the study. Otherwise, if automatic
3698                         publication is switched on, default value is used for result name.
3699
3700             Returns:
3701                 New GEOM.GEOM_Object, containing the created revolution.
3702             """
3703             # Example: see GEOM_TestAll.py
3704             theAngle,Parameters = ParseParameters(theAngle)
3705             anObj = self.PrimOp.MakeRevolutionAxisAngle(theBase, theAxis, theAngle)
3706             RaiseIfFailed("MakeRevolutionAxisAngle", self.PrimOp)
3707             anObj.SetParameters(Parameters)
3708             self._autoPublish(anObj, theName, "revolution")
3709             return anObj
3710
3711         ## Create a shape by revolution of the base shape around the axis
3712         #  on the given angle, i.e. all the space, transfixed by the base
3713         #  shape during its rotation around the axis on the given angle in
3714         #  both directions (forward/backward)
3715         #  @param theBase Base shape to be rotated.
3716         #  @param theAxis Rotation axis.
3717         #  @param theAngle Rotation angle in radians.
3718         #  @param theName Object name; when specified, this parameter is used
3719         #         for result publication in the study. Otherwise, if automatic
3720         #         publication is switched on, default value is used for result name.
3721         #
3722         #  @return New GEOM.GEOM_Object, containing the created revolution.
3723         #
3724         #  @ref tui_creation_revolution "Example"
3725         @ManageTransactions("PrimOp")
3726         def MakeRevolution2Ways(self, theBase, theAxis, theAngle, theName=None):
3727             """
3728             Create a shape by revolution of the base shape around the axis
3729             on the given angle, i.e. all the space, transfixed by the base
3730             shape during its rotation around the axis on the given angle in
3731             both directions (forward/backward).
3732
3733             Parameters:
3734                 theBase Base shape to be rotated.
3735                 theAxis Rotation axis.
3736                 theAngle Rotation angle in radians.
3737                 theName Object name; when specified, this parameter is used
3738                         for result publication in the study. Otherwise, if automatic
3739                         publication is switched on, default value is used for result name.
3740
3741             Returns:
3742                 New GEOM.GEOM_Object, containing the created revolution.
3743             """
3744             theAngle,Parameters = ParseParameters(theAngle)
3745             anObj = self.PrimOp.MakeRevolutionAxisAngle2Ways(theBase, theAxis, theAngle)
3746             RaiseIfFailed("MakeRevolutionAxisAngle2Ways", self.PrimOp)
3747             anObj.SetParameters(Parameters)
3748             self._autoPublish(anObj, theName, "revolution")
3749             return anObj
3750
3751         ## Create a face from a given set of contours.
3752         #  @param theContours either a list or a compound of edges/wires.
3753         #  @param theMinDeg a minimal degree of BSpline surface to create.
3754         #  @param theMaxDeg a maximal degree of BSpline surface to create.
3755         #  @param theTol2D a 2d tolerance to be reached.
3756         #  @param theTol3D a 3d tolerance to be reached.
3757         #  @param theNbIter a number of iteration of approximation algorithm.
3758         #  @param theMethod Kind of method to perform filling operation
3759         #         (see GEOM.filling_oper_method enum).
3760         #  @param isApprox if True, BSpline curves are generated in the process
3761         #                  of surface construction. By default it is False, that means
3762         #                  the surface is created using given curves. The usage of
3763         #                  Approximation makes the algorithm work slower, but allows
3764         #                  building the surface for rather complex cases.
3765         #  @param theName Object name; when specified, this parameter is used
3766         #         for result publication in the study. Otherwise, if automatic
3767         #         publication is switched on, default value is used for result name.
3768         #
3769         #  @return New GEOM.GEOM_Object (face), containing the created filling surface.
3770         #
3771         #  @ref tui_creation_filling "Example"
3772         @ManageTransactions("PrimOp")
3773         def MakeFilling(self, theContours, theMinDeg=2, theMaxDeg=5, theTol2D=0.0001,
3774                         theTol3D=0.0001, theNbIter=0, theMethod=GEOM.FOM_Default, isApprox=0, theName=None):
3775             """
3776             Create a face from a given set of contours.
3777
3778             Parameters:
3779                 theContours either a list or a compound of edges/wires.
3780                 theMinDeg a minimal degree of BSpline surface to create.
3781                 theMaxDeg a maximal degree of BSpline surface to create.
3782                 theTol2D a 2d tolerance to be reached.
3783                 theTol3D a 3d tolerance to be reached.
3784                 theNbIter a number of iteration of approximation algorithm.
3785                 theMethod Kind of method to perform filling operation
3786                           (see GEOM.filling_oper_method enum).
3787                 isApprox if True, BSpline curves are generated in the process
3788                          of surface construction. By default it is False, that means
3789                          the surface is created using given curves. The usage of
3790                          Approximation makes the algorithm work slower, but allows
3791                          building the surface for rather complex cases.
3792                 theName Object name; when specified, this parameter is used
3793                         for result publication in the study. Otherwise, if automatic
3794                         publication is switched on, default value is used for result name.
3795
3796             Returns:
3797                 New GEOM.GEOM_Object (face), containing the created filling surface.
3798
3799             Example of usage:
3800                 filling = geompy.MakeFilling(compound, 2, 5, 0.0001, 0.0001, 5)
3801             """
3802             # Example: see GEOM_TestAll.py
3803             theMinDeg,theMaxDeg,theTol2D,theTol3D,theNbIter,Parameters = ParseParameters(theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter)
3804             anObj = self.PrimOp.MakeFilling(ToList(theContours), theMinDeg, theMaxDeg,
3805                                             theTol2D, theTol3D, theNbIter,
3806                                             theMethod, isApprox)
3807             RaiseIfFailed("MakeFilling", self.PrimOp)
3808             anObj.SetParameters(Parameters)
3809             self._autoPublish(anObj, theName, "filling")
3810             return anObj
3811
3812
3813         ## Create a face from a given set of contours.
3814         #  This method corresponds to MakeFilling() with isApprox=True.
3815         #  @param theContours either a list or a compound of edges/wires.
3816         #  @param theMinDeg a minimal degree of BSpline surface to create.
3817         #  @param theMaxDeg a maximal degree of BSpline surface to create.
3818         #  @param theTol3D a 3d tolerance to be reached.
3819         #  @param theName Object name; when specified, this parameter is used
3820         #         for result publication in the study. Otherwise, if automatic
3821         #         publication is switched on, default value is used for result name.
3822         #
3823         #  @return New GEOM.GEOM_Object (face), containing the created filling surface.
3824         #
3825         #  @ref tui_creation_filling "Example"
3826         @ManageTransactions("PrimOp")
3827         def MakeFillingNew(self, theContours, theMinDeg=2, theMaxDeg=5, theTol3D=0.0001, theName=None):
3828             """
3829             Create a filling from the given compound of contours.
3830             This method corresponds to MakeFilling() with isApprox=True.
3831
3832             Parameters:
3833                 theContours either a list or a compound of edges/wires.
3834                 theMinDeg a minimal degree of BSpline surface to create.
3835                 theMaxDeg a maximal degree of BSpline surface to create.
3836                 theTol3D a 3d tolerance to be reached.
3837                 theName Object name; when specified, this parameter is used
3838                         for result publication in the study. Otherwise, if automatic
3839                         publication is switched on, default value is used for result name.
3840
3841             Returns:
3842                 New GEOM.GEOM_Object (face), containing the created filling surface.
3843
3844             Example of usage:
3845                 filling = geompy.MakeFillingNew(compound, 2, 5, 0.0001)
3846             """
3847             # Example: see GEOM_TestAll.py
3848             theMinDeg,theMaxDeg,theTol3D,Parameters = ParseParameters(theMinDeg, theMaxDeg, theTol3D)
3849             anObj = self.PrimOp.MakeFilling(ToList(theContours), theMinDeg, theMaxDeg,
3850                                             0, theTol3D, 0, GEOM.FOM_Default, True)
3851             RaiseIfFailed("MakeFillingNew", self.PrimOp)
3852             anObj.SetParameters(Parameters)
3853             self._autoPublish(anObj, theName, "filling")
3854             return anObj
3855
3856         ## Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
3857         #  @param theSeqSections - set of specified sections.
3858         #  @param theModeSolid - mode defining building solid or shell
3859         #  @param thePreci - precision 3D used for smoothing
3860         #  @param theRuled - mode defining type of the result surfaces (ruled or smoothed).
3861         #  @param theName Object name; when specified, this parameter is used
3862         #         for result publication in the study. Otherwise, if automatic
3863         #         publication is switched on, default value is used for result name.
3864         #
3865         #  @return New GEOM.GEOM_Object, containing the created shell or solid.
3866         #
3867         #  @ref swig_todo "Example"
3868         @ManageTransactions("PrimOp")
3869         def MakeThruSections(self, theSeqSections, theModeSolid, thePreci, theRuled, theName=None):
3870             """
3871             Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
3872
3873             Parameters:
3874                 theSeqSections - set of specified sections.
3875                 theModeSolid - mode defining building solid or shell
3876                 thePreci - precision 3D used for smoothing
3877                 theRuled - mode defining type of the result surfaces (ruled or smoothed).
3878                 theName Object name; when specified, this parameter is used
3879                         for result publication in the study. Otherwise, if automatic
3880                         publication is switched on, default value is used for result name.
3881
3882             Returns:
3883                 New GEOM.GEOM_Object, containing the created shell or solid.
3884             """
3885             # Example: see GEOM_TestAll.py
3886             anObj = self.PrimOp.MakeThruSections(theSeqSections,theModeSolid,thePreci,theRuled)
3887             RaiseIfFailed("MakeThruSections", self.PrimOp)
3888             self._autoPublish(anObj, theName, "filling")
3889             return anObj
3890
3891         ## Create a shape by extrusion of the base shape along
3892         #  the path shape. The path shape can be a wire or an edge. It is
3893         #  possible to generate groups along with the result by means of
3894         #  setting the flag \a IsGenerateGroups.<BR>
3895         #  If \a thePath is a closed edge or wire and \a IsGenerateGroups is
3896         #  set, an error is occured. If \a thePath is not closed edge/wire,
3897         #  the following groups are returned:
3898         #  - If \a theBase is unclosed edge or wire: "Down", "Up", "Side1",
3899         #    "Side2";
3900         #  - If \a theBase is closed edge or wire, face or shell: "Down", "Up",
3901         #    "Other".
3902         #  .
3903         #  "Down" and "Up" groups contain:
3904         #  - Edges if \a theBase is edge or wire;
3905         #  - Faces if \a theBase is face or shell.<BR>
3906         #  .
3907         #  "Side1" and "Side2" groups contain edges generated from the first
3908         #  and last vertices of \a theBase. The first and last vertices are
3909         #  determined taking into account edge/wire orientation.<BR>
3910         #  "Other" group represents faces generated from the bounding edges of
3911         #  \a theBase.
3912         #
3913         #  @param theBase Base shape to be extruded.
3914         #  @param thePath Path shape to extrude the base shape along it.
3915         #  @param IsGenerateGroups flag that tells if it is necessary to
3916         #         create groups. It is equal to False by default.
3917         #  @param theName Object name; when specified, this parameter is used
3918         #         for result publication in the study. Otherwise, if automatic
3919         #         publication is switched on, default value is used for result name.
3920         #
3921         #  @return New GEOM.GEOM_Object, containing the created pipe if 
3922         #          \a IsGenerateGroups is not set. Otherwise it returns new
3923         #          GEOM.ListOfGO. Its first element is the created pipe, the
3924         #          remaining ones are created groups.
3925         #
3926         #  @ref tui_creation_pipe "Example"
3927         @ManageTransactions("PrimOp")
3928         def MakePipe(self, theBase, thePath,
3929                      IsGenerateGroups=False, theName=None):
3930             """
3931             Create a shape by extrusion of the base shape along
3932             the path shape. The path shape can be a wire or an edge. It is
3933             possible to generate groups along with the result by means of
3934             setting the flag IsGenerateGroups.
3935             If thePath is a closed edge or wire and IsGenerateGroups is
3936             set, an error is occured. If thePath is not closed edge/wire,
3937             the following groups are returned:
3938             - If theBase is unclosed edge or wire: "Down", "Up", "Side1",
3939               "Side2";
3940             - If theBase is closed edge or wire, face or shell: "Down", "Up",
3941               "Other".
3942             "Down" and "Up" groups contain:
3943             - Edges if theBase is edge or wire;
3944             - Faces if theBase is face or shell.
3945             "Side1" and "Side2" groups contain edges generated from the first
3946             and last vertices of theBase. The first and last vertices are
3947             determined taking into account edge/wire orientation.
3948             "Other" group represents faces generated from the bounding edges of
3949             theBase.
3950
3951             Parameters:
3952                 theBase Base shape to be extruded.
3953                 thePath Path shape to extrude the base shape along it.
3954                 IsGenerateGroups flag that tells if it is necessary to
3955                         create groups. It is equal to False by default.
3956                 theName Object name; when specified, this parameter is used
3957                         for result publication in the study. Otherwise, if automatic
3958                         publication is switched on, default value is used for result name.
3959
3960             Returns:
3961                 New GEOM.GEOM_Object, containing the created pipe if 
3962                 IsGenerateGroups is not set. Otherwise it returns new
3963                 GEOM.ListOfGO. Its first element is the created pipe, the
3964                 remaining ones are created groups.
3965             """
3966             # Example: see GEOM_TestAll.py
3967             aList = self.PrimOp.MakePipe(theBase, thePath, IsGenerateGroups)
3968             RaiseIfFailed("MakePipe", self.PrimOp)
3969
3970             if IsGenerateGroups:
3971               self._autoPublish(aList, theName, "pipe")
3972               return aList
3973
3974             self._autoPublish(aList[0], theName, "pipe")
3975             return aList[0]
3976
3977         ## Create a shape by extrusion of the profile shape along
3978         #  the path shape. The path shape can be a wire or an edge.
3979         #  the several profiles can be specified in the several locations of path.
3980         #  It is possible to generate groups along with the result by means of
3981         #  setting the flag \a IsGenerateGroups. For detailed information on
3982         #  groups that can be created please see the method MakePipe().
3983         #  @param theSeqBases - list of  Bases shape to be extruded.
3984         #  @param theLocations - list of locations on the path corresponding
3985         #                        specified list of the Bases shapes. Number of locations
3986         #                        should be equal to number of bases or list of locations can be empty.
3987         #  @param thePath - Path shape to extrude the base shape along it.
3988         #  @param theWithContact - the mode defining that the section is translated to be in
3989         #                          contact with the spine.
3990         #  @param theWithCorrection - defining that the section is rotated to be
3991         #                             orthogonal to the spine tangent in the correspondent point
3992         #  @param IsGenerateGroups - flag that tells if it is necessary to
3993         #                          create groups. It is equal to False by default.
3994         #  @param theName Object name; when specified, this parameter is used
3995         #         for result publication in the study. Otherwise, if automatic
3996         #         publication is switched on, default value is used for result name.
3997         #
3998         #  @return New GEOM.GEOM_Object, containing the created pipe if 
3999         #          \a IsGenerateGroups is not set. Otherwise it returns new
4000         #          GEOM.ListOfGO. Its first element is the created pipe, the
4001         #          remaining ones are created groups.
4002         #
4003         #  @ref tui_creation_pipe_with_diff_sec "Example"
4004         @ManageTransactions("PrimOp")
4005         def MakePipeWithDifferentSections(self, theSeqBases,
4006                                           theLocations, thePath,
4007                                           theWithContact, theWithCorrection,
4008                                           IsGenerateGroups=False, theName=None):
4009             """
4010             Create a shape by extrusion of the profile shape along
4011             the path shape. The path shape can be a wire or an edge.
4012             the several profiles can be specified in the several locations of path.
4013             It is possible to generate groups along with the result by means of
4014             setting the flag IsGenerateGroups. For detailed information on
4015             groups that can be created please see the method geompy.MakePipe().
4016
4017             Parameters:
4018                 theSeqBases - list of  Bases shape to be extruded.
4019                 theLocations - list of locations on the path corresponding
4020                                specified list of the Bases shapes. Number of locations
4021                                should be equal to number of bases or list of locations can be empty.
4022                 thePath - Path shape to extrude the base shape along it.
4023                 theWithContact - the mode defining that the section is translated to be in
4024                                  contact with the spine(0/1)
4025                 theWithCorrection - defining that the section is rotated to be
4026                                     orthogonal to the spine tangent in the correspondent point (0/1)
4027                 IsGenerateGroups - flag that tells if it is necessary to
4028                                  create groups. It is equal to False by default.
4029                 theName Object name; when specified, this parameter is used
4030                         for result publication in the study. Otherwise, if automatic
4031                         publication is switched on, default value is used for result name.
4032
4033             Returns:
4034                 New GEOM.GEOM_Object, containing the created pipe if 
4035                 IsGenerateGroups is not set. Otherwise it returns new
4036                 GEOM.ListOfGO. Its first element is the created pipe, the
4037                 remaining ones are created groups.
4038             """
4039             aList = self.PrimOp.MakePipeWithDifferentSections(theSeqBases,
4040                                                               theLocations, thePath,
4041                                                               theWithContact, theWithCorrection,
4042                                                               False, IsGenerateGroups)
4043             RaiseIfFailed("MakePipeWithDifferentSections", self.PrimOp)
4044
4045             if IsGenerateGroups:
4046               self._autoPublish(aList, theName, "pipe")
4047               return aList
4048
4049             self._autoPublish(aList[0], theName, "pipe")
4050             return aList[0]
4051
4052         ## Create a shape by extrusion of the profile shape along
4053         #  the path shape. This function is a version of
4054         #  MakePipeWithDifferentSections() with the same parameters, except
4055         #  eliminated theWithContact and theWithCorrection. So it is
4056         #  possible to find the description of all parameters is in this
4057         #  method. The difference is that this method performs the operation
4058         #  step by step, i.e. it creates pipes between each pair of neighbor
4059         #  sections and fuses them into a single shape.
4060         #
4061         #  @ref tui_creation_pipe_with_diff_sec "Example"
4062         @ManageTransactions("PrimOp")
4063         def MakePipeWithDifferentSectionsBySteps(self, theSeqBases,
4064                                                  theLocations, thePath,
4065                                                  IsGenerateGroups=False, theName=None):
4066             """
4067             Create a shape by extrusion of the profile shape along
4068             the path shape. This function is a version of
4069             MakePipeWithDifferentSections() with the same parameters, except
4070             eliminated theWithContact and theWithCorrection. So it is
4071             possible to find the description of all parameters is in this
4072             method. The difference is that this method performs the operation
4073             step by step, i.e. it creates pipes between each pair of neighbor
4074             sections and fuses them into a single shape.
4075             """
4076             aList = self.PrimOp.MakePipeWithDifferentSections(theSeqBases,
4077                                                               theLocations, thePath,
4078                                                               False, False,
4079                                                               True, IsGenerateGroups)
4080             RaiseIfFailed("MakePipeWithDifferentSectionsBySteps", self.PrimOp)
4081
4082             if IsGenerateGroups:
4083               self._autoPublish(aList, theName, "pipe")
4084               return aList
4085
4086             self._autoPublish(aList[0], theName, "pipe")
4087             return aList[0]
4088
4089         ## Create a shape by extrusion of the profile shape along
4090         #  the path shape. The path shape can be a wire or an edge.
4091         #  the several profiles can be specified in the several locations of path.
4092         #  It is possible to generate groups along with the result by means of
4093         #  setting the flag \a IsGenerateGroups. For detailed information on
4094         #  groups that can be created please see the method MakePipe().
4095         #  @param theSeqBases - list of  Bases shape to be extruded. Base shape must be
4096         #                       shell or face. If number of faces in neighbour sections
4097         #                       aren't coincided result solid between such sections will
4098         #                       be created using external boundaries of this shells.
4099         #  @param theSeqSubBases - list of corresponding sub-shapes of section shapes.
4100         #                          This list is used for searching correspondences between
4101         #                          faces in the sections. Size of this list must be equal
4102         #                          to size of list of base shapes.
4103         #  @param theLocations - list of locations on the path corresponding
4104         #                        specified list of the Bases shapes. Number of locations
4105         #                        should be equal to number of bases. First and last
4106         #                        locations must be coincided with first and last vertexes
4107         #                        of path correspondingly.
4108         #  @param thePath - Path shape to extrude the base shape along it.
4109         #  @param theWithContact - the mode defining that the section is translated to be in
4110         #                          contact with the spine.
4111         #  @param theWithCorrection - defining that the section is rotated to be
4112         #                             orthogonal to the spine tangent in the correspondent point
4113         #  @param IsGenerateGroups - flag that tells if it is necessary to
4114         #                          create groups. It is equal to False by default.
4115         #  @param theName Object name; when specified, this parameter is used
4116         #         for result publication in the study. Otherwise, if automatic
4117         #         publication is switched on, default value is used for result name.
4118         #
4119         #  @return New GEOM.GEOM_Object, containing the created solids if 
4120         #          \a IsGenerateGroups is not set. Otherwise it returns new
4121         #          GEOM.ListOfGO. Its first element is the created solids, the
4122         #          remaining ones are created groups.
4123         #
4124         #  @ref tui_creation_pipe_with_shell_sec "Example"
4125         @ManageTransactions("PrimOp")
4126         def MakePipeWithShellSections(self, theSeqBases, theSeqSubBases,
4127                                       theLocations, thePath,
4128                                       theWithContact, theWithCorrection,
4129                                       IsGenerateGroups=False, theName=None):
4130             """
4131             Create a shape by extrusion of the profile shape along
4132             the path shape. The path shape can be a wire or an edge.
4133             the several profiles can be specified in the several locations of path.
4134             It is possible to generate groups along with the result by means of
4135             setting the flag IsGenerateGroups. For detailed information on
4136             groups that can be created please see the method geompy.MakePipe().
4137
4138             Parameters:
4139                 theSeqBases - list of  Bases shape to be extruded. Base shape must be
4140                               shell or face. If number of faces in neighbour sections
4141                               aren't coincided result solid between such sections will
4142                               be created using external boundaries of this shells.
4143                 theSeqSubBases - list of corresponding sub-shapes of section shapes.
4144                                  This list is used for searching correspondences between
4145                                  faces in the sections. Size of this list must be equal
4146                                  to size of list of base shapes.
4147                 theLocations - list of locations on the path corresponding
4148                                specified list of the Bases shapes. Number of locations
4149                                should be equal to number of bases. First and last
4150                                locations must be coincided with first and last vertexes
4151                                of path correspondingly.
4152                 thePath - Path shape to extrude the base shape along it.
4153                 theWithContact - the mode defining that the section is translated to be in
4154                                  contact with the spine (0/1)
4155                 theWithCorrection - defining that the section is rotated to be
4156                                     orthogonal to the spine tangent in the correspondent point (0/1)
4157                 IsGenerateGroups - flag that tells if it is necessary to
4158                                  create groups. It is equal to False by default.
4159                 theName Object name; when specified, this parameter is used
4160                         for result publication in the study. Otherwise, if automatic
4161                         publication is switched on, default value is used for result name.
4162
4163             Returns:
4164                 New GEOM.GEOM_Object, containing the created solids if 
4165                 IsGenerateGroups is not set. Otherwise it returns new
4166                 GEOM.ListOfGO. Its first element is the created solids, the
4167                 remaining ones are created groups.
4168             """
4169             aList = self.PrimOp.MakePipeWithShellSections(theSeqBases, theSeqSubBases,
4170                                                           theLocations, thePath,
4171                                                           theWithContact, theWithCorrection,
4172                                                           IsGenerateGroups)
4173             RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
4174
4175             if IsGenerateGroups:
4176               self._autoPublish(aList, theName, "pipe")
4177               return aList
4178
4179             self._autoPublish(aList[0], theName, "pipe")
4180             return aList[0]
4181
4182         ## Create a shape by extrusion of the profile shape along
4183         #  the path shape. This function is used only for debug pipe
4184         #  functionality - it is a version of function MakePipeWithShellSections()
4185         #  which give a possibility to recieve information about
4186         #  creating pipe between each pair of sections step by step.
4187         @ManageTransactions("PrimOp")
4188         def MakePipeWithShellSectionsBySteps(self, theSeqBases, theSeqSubBases,
4189                                              theLocations, thePath,
4190                                              theWithContact, theWithCorrection,
4191                                              IsGenerateGroups=False, theName=None):
4192             """
4193             Create a shape by extrusion of the profile shape along
4194             the path shape. This function is used only for debug pipe
4195             functionality - it is a version of previous function
4196             geompy.MakePipeWithShellSections() which give a possibility to
4197             recieve information about creating pipe between each pair of
4198             sections step by step.
4199             """
4200             res = []
4201             nbsect = len(theSeqBases)
4202             nbsubsect = len(theSeqSubBases)
4203             #print "nbsect = ",nbsect
4204             for i in range(1,nbsect):
4205                 #print "  i = ",i
4206                 tmpSeqBases = [ theSeqBases[i-1], theSeqBases[i] ]
4207                 tmpLocations = [ theLocations[i-1], theLocations[i] ]
4208                 tmpSeqSubBases = []
4209                 if nbsubsect>0: tmpSeqSubBases = [ theSeqSubBases[i-1], theSeqSubBases[i] ]
4210                 aList = self.PrimOp.MakePipeWithShellSections(tmpSeqBases, tmpSeqSubBases,
4211                                                               tmpLocations, thePath,
4212                                                               theWithContact, theWithCorrection,
4213                                                               IsGenerateGroups)
4214                 if self.PrimOp.IsDone() == 0:
4215                     print "Problems with pipe creation between ",i," and ",i+1," sections"
4216                     RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
4217                     break
4218                 else:
4219                     print "Pipe between ",i," and ",i+1," sections is OK"
4220                     res.append(aList[0])
4221                     pass
4222                 pass
4223
4224             resc = self.MakeCompound(res)
4225             #resc = self.MakeSewing(res, 0.001)
4226             #print "resc: ",resc
4227             self._autoPublish(resc, theName, "pipe")
4228             return resc
4229
4230         ## Create solids between given sections.
4231         #  It is possible to generate groups along with the result by means of
4232         #  setting the flag \a IsGenerateGroups. For detailed information on
4233         #  groups that can be created please see the method MakePipe().
4234         #  @param theSeqBases - list of sections (shell or face).
4235         #  @param theLocations - list of corresponding vertexes
4236         #  @param IsGenerateGroups - flag that tells if it is necessary to
4237         #         create groups. It is equal to False by default.
4238         #  @param theName Object name; when specified, this parameter is used
4239         #         for result publication in the study. Otherwise, if automatic
4240         #         publication is switched on, default value is used for result name.
4241         #
4242         #  @return New GEOM.GEOM_Object, containing the created solids if 
4243         #          \a IsGenerateGroups is not set. Otherwise it returns new
4244         #          GEOM.ListOfGO. Its first element is the created solids, the
4245         #          remaining ones are created groups.
4246         #
4247         #  @ref tui_creation_pipe_without_path "Example"
4248         @ManageTransactions("PrimOp")
4249         def MakePipeShellsWithoutPath(self, theSeqBases, theLocations,
4250                                       IsGenerateGroups=False, theName=None):
4251             """
4252             Create solids between given sections.
4253             It is possible to generate groups along with the result by means of
4254             setting the flag IsGenerateGroups. For detailed information on
4255             groups that can be created please see the method geompy.MakePipe().
4256
4257             Parameters:
4258                 theSeqBases - list of sections (shell or face).
4259                 theLocations - list of corresponding vertexes
4260                 IsGenerateGroups - flag that tells if it is necessary to
4261                                  create groups. It is equal to False by default.
4262                 theName Object name; when specified, this parameter is used
4263                         for result publication in the study. Otherwise, if automatic
4264                         publication is switched on, default value is used for result name.
4265
4266             Returns:
4267                 New GEOM.GEOM_Object, containing the created solids if 
4268                 IsGenerateGroups is not set. Otherwise it returns new
4269                 GEOM.ListOfGO. Its first element is the created solids, the
4270                 remaining ones are created groups.
4271             """
4272             aList = self.PrimOp.MakePipeShellsWithoutPath(theSeqBases, theLocations,
4273                                                           IsGenerateGroups)
4274             RaiseIfFailed("MakePipeShellsWithoutPath", self.PrimOp)
4275
4276             if IsGenerateGroups:
4277               self._autoPublish(aList, theName, "pipe")
4278               return aList
4279
4280             self._autoPublish(aList[0], theName, "pipe")
4281             return aList[0]
4282
4283         ## Create a shape by extrusion of the base shape along
4284         #  the path shape with constant bi-normal direction along the given vector.
4285         #  The path shape can be a wire or an edge.
4286         #  It is possible to generate groups along with the result by means of
4287         #  setting the flag \a IsGenerateGroups. For detailed information on
4288         #  groups that can be created please see the method MakePipe().
4289         #  @param theBase Base shape to be extruded.
4290         #  @param thePath Path shape to extrude the base shape along it.
4291         #  @param theVec Vector defines a constant binormal direction to keep the
4292         #                same angle beetween the direction and the sections
4293         #                along the sweep surface.
4294         #  @param IsGenerateGroups flag that tells if it is necessary to
4295         #         create groups. It is equal to False by default.
4296         #  @param theName Object name; when specified, this parameter is used
4297         #         for result publication in the study. Otherwise, if automatic
4298         #         publication is switched on, default value is used for result name.
4299         #
4300         #  @return New GEOM.GEOM_Object, containing the created pipe if 
4301         #          \a IsGenerateGroups is not set. Otherwise it returns new
4302         #          GEOM.ListOfGO. Its first element is the created pipe, the
4303         #          remaining ones are created groups.
4304         #
4305         #  @ref tui_creation_pipe "Example"
4306         @ManageTransactions("PrimOp")
4307         def MakePipeBiNormalAlongVector(self, theBase, thePath, theVec,
4308                                         IsGenerateGroups=False, theName=None):
4309             """
4310             Create a shape by extrusion of the base shape along
4311             the path shape with constant bi-normal direction along the given vector.
4312             The path shape can be a wire or an edge.
4313             It is possible to generate groups along with the result by means of
4314             setting the flag IsGenerateGroups. For detailed information on
4315             groups that can be created please see the method geompy.MakePipe().
4316
4317             Parameters:
4318                 theBase Base shape to be extruded.
4319                 thePath Path shape to extrude the base shape along it.
4320                 theVec Vector defines a constant binormal direction to keep the
4321                        same angle beetween the direction and the sections
4322                        along the sweep surface.
4323                 IsGenerateGroups flag that tells if it is necessary to
4324                                  create groups. It is equal to False by default.
4325                 theName Object name; when specified, this parameter is used
4326                         for result publication in the study. Otherwise, if automatic
4327                         publication is switched on, default value is used for result name.
4328
4329             Returns:
4330                 New GEOM.GEOM_Object, containing the created pipe if 
4331                 IsGenerateGroups is not set. Otherwise it returns new
4332                 GEOM.ListOfGO. Its first element is the created pipe, the
4333                 remaining ones are created groups.
4334             """
4335             # Example: see GEOM_TestAll.py
4336             aList = self.PrimOp.MakePipeBiNormalAlongVector(theBase, thePath,
4337                           theVec, IsGenerateGroups)
4338             RaiseIfFailed("MakePipeBiNormalAlongVector", self.PrimOp)
4339
4340             if IsGenerateGroups:
4341               self._autoPublish(aList, theName, "pipe")
4342               return aList
4343
4344             self._autoPublish(aList[0], theName, "pipe")
4345             return aList[0]
4346
4347         ## Makes a thick solid from a shape. If the input is a surface shape
4348         #  (face or shell) the result is a thick solid. If an input shape is
4349         #  a solid the result is a hollowed solid with removed faces.
4350         #  @param theShape Face or Shell to get thick solid or solid to get
4351         #         hollowed solid.
4352         #  @param theThickness Thickness of the resulting solid
4353         #  @param theFacesIDs the list of face IDs to be removed from the
4354         #         result. It is ignored if \a theShape is a face or a shell.
4355         #         It is empty by default. 
4356         #  @param theInside If true the thickness is applied towards inside
4357         #  @param theName Object name; when specified, this parameter is used
4358         #         for result publication in the study. Otherwise, if automatic
4359         #         publication is switched on, default value is used for result name.
4360         #
4361         #  @return New GEOM.GEOM_Object, containing the created solid
4362         #
4363         #  @ref tui_creation_thickness "Example"
4364         @ManageTransactions("PrimOp")
4365         def MakeThickSolid(self, theShape, theThickness,
4366                            theFacesIDs=[], theInside=False, theName=None):
4367             """
4368             Make a thick solid from a shape. If the input is a surface shape
4369             (face or shell) the result is a thick solid. If an input shape is
4370             a solid the result is a hollowed solid with removed faces.
4371
4372             Parameters:
4373                  theShape Face or Shell to get thick solid or solid to get
4374                           hollowed solid.
4375                  theThickness Thickness of the resulting solid
4376                  theFacesIDs the list of face IDs to be removed from the
4377                           result. It is ignored if theShape is a face or a
4378                           shell. It is empty by default. 
4379                  theInside If true the thickness is applied towards inside
4380                  theName Object name; when specified, this parameter is used
4381                          for result publication in the study. Otherwise, if automatic
4382                          publication is switched on, default value is used for result name.
4383
4384             Returns:
4385                 New GEOM.GEOM_Object, containing the created solid
4386             """
4387             # Example: see GEOM_TestAll.py
4388             theThickness,Parameters = ParseParameters(theThickness)
4389             anObj = self.PrimOp.MakeThickening(theShape, theFacesIDs,
4390                                                theThickness, True, theInside)
4391             RaiseIfFailed("MakeThickSolid", self.PrimOp)
4392             anObj.SetParameters(Parameters)
4393             self._autoPublish(anObj, theName, "thickSolid")
4394             return anObj
4395
4396
4397         ## Modifies a shape to make it a thick solid. If the input is a surface
4398         #  shape (face or shell) the result is a thick solid. If an input shape
4399         #  is a solid the result is a hollowed solid with removed faces.
4400         #  @param theShape Face or Shell to get thick solid or solid to get
4401         #         hollowed solid.
4402         #  @param theThickness Thickness of the resulting solid
4403         #  @param theFacesIDs the list of face IDs to be removed from the
4404         #         result. It is ignored if \a theShape is a face or a shell.
4405         #         It is empty by default. 
4406         #  @param theInside If true the thickness is applied towards inside
4407         #
4408         #  @return The modified shape
4409         #
4410         #  @ref tui_creation_thickness "Example"
4411         @ManageTransactions("PrimOp")
4412         def Thicken(self, theShape, theThickness, theFacesIDs=[], theInside=False):
4413             """
4414             Modifies a shape to make it a thick solid. If the input is a
4415             surface shape (face or shell) the result is a thick solid. If
4416             an input shape is a solid the result is a hollowed solid with
4417             removed faces.
4418
4419             Parameters:
4420                 theShape Face or Shell to get thick solid or solid to get
4421                          hollowed solid.
4422                 theThickness Thickness of the resulting solid
4423                 theFacesIDs the list of face IDs to be removed from the
4424                          result. It is ignored if \a theShape is a face or
4425                          a shell. It is empty by default. 
4426                 theInside If true the thickness is applied towards inside
4427
4428             Returns:
4429                 The modified shape
4430             """
4431             # Example: see GEOM_TestAll.py
4432             theThickness,Parameters = ParseParameters(theThickness)
4433             anObj = self.PrimOp.MakeThickening(theShape, theFacesIDs,
4434                                                theThickness, False, theInside)
4435             RaiseIfFailed("Thicken", self.PrimOp)
4436             anObj.SetParameters(Parameters)
4437             return anObj
4438
4439         ## Build a middle path of a pipe-like shape.
4440         #  The path shape can be a wire or an edge.
4441         #  @param theShape It can be closed or unclosed pipe-like shell
4442         #                  or a pipe-like solid.
4443         #  @param theBase1, theBase2 Two bases of the supposed pipe. This
4444         #                            should be wires or faces of theShape.
4445         #  @param theName Object name; when specified, this parameter is used
4446         #         for result publication in the study. Otherwise, if automatic
4447         #         publication is switched on, default value is used for result name.
4448         #
4449         #  @note It is not assumed that exact or approximate copy of theShape
4450         #        can be obtained by applying existing Pipe operation on the
4451         #        resulting "Path" wire taking theBase1 as the base - it is not
4452         #        always possible; though in some particular cases it might work
4453         #        it is not guaranteed. Thus, RestorePath function should not be
4454         #        considered as an exact reverse operation of the Pipe.
4455         #
4456         #  @return New GEOM.GEOM_Object, containing an edge or wire that represent
4457         #                                source pipe's "path".
4458         #
4459         #  @ref tui_creation_pipe_path "Example"
4460         @ManageTransactions("PrimOp")
4461         def RestorePath (self, theShape, theBase1, theBase2, theName=None):
4462             """
4463             Build a middle path of a pipe-like shape.
4464             The path shape can be a wire or an edge.
4465
4466             Parameters:
4467                 theShape It can be closed or unclosed pipe-like shell
4468                          or a pipe-like solid.
4469                 theBase1, theBase2 Two bases of the supposed pipe. This
4470                                    should be wires or faces of theShape.
4471                 theName Object name; when specified, this parameter is used
4472                         for result publication in the study. Otherwise, if automatic
4473                         publication is switched on, default value is used for result name.
4474
4475             Returns:
4476                 New GEOM_Object, containing an edge or wire that represent
4477                                  source pipe's path.
4478             """
4479             anObj = self.PrimOp.RestorePath(theShape, theBase1, theBase2)
4480             RaiseIfFailed("RestorePath", self.PrimOp)
4481             self._autoPublish(anObj, theName, "path")
4482             return anObj
4483
4484         ## Build a middle path of a pipe-like shape.
4485         #  The path shape can be a wire or an edge.
4486         #  @param theShape It can be closed or unclosed pipe-like shell
4487         #                  or a pipe-like solid.
4488         #  @param listEdges1, listEdges2 Two bases of the supposed pipe. This
4489         #                                should be lists of edges of theShape.
4490         #  @param theName Object name; when specified, this parameter is used
4491         #         for result publication in the study. Otherwise, if automatic
4492         #         publication is switched on, default value is used for result name.
4493         #
4494         #  @note It is not assumed that exact or approximate copy of theShape
4495         #        can be obtained by applying existing Pipe operation on the
4496         #        resulting "Path" wire taking theBase1 as the base - it is not
4497         #        always possible; though in some particular cases it might work
4498         #        it is not guaranteed. Thus, RestorePath function should not be
4499         #        considered as an exact reverse operation of the Pipe.
4500         #
4501         #  @return New GEOM.GEOM_Object, containing an edge or wire that represent
4502         #                                source pipe's "path".
4503         #
4504         #  @ref tui_creation_pipe_path "Example"
4505         @ManageTransactions("PrimOp")
4506         def RestorePathEdges (self, theShape, listEdges1, listEdges2, theName=None):
4507             """
4508             Build a middle path of a pipe-like shape.
4509             The path shape can be a wire or an edge.
4510
4511             Parameters:
4512                 theShape It can be closed or unclosed pipe-like shell
4513                          or a pipe-like solid.
4514                 listEdges1, listEdges2 Two bases of the supposed pipe. This
4515                                        should be lists of edges of theShape.
4516                 theName Object name; when specified, this parameter is used
4517                         for result publication in the study. Otherwise, if automatic
4518                         publication is switched on, default value is used for result name.
4519
4520             Returns:
4521                 New GEOM_Object, containing an edge or wire that represent
4522                                  source pipe's path.
4523             """
4524             anObj = self.PrimOp.RestorePathEdges(theShape, listEdges1, listEdges2)
4525             RaiseIfFailed("RestorePath", self.PrimOp)
4526             self._autoPublish(anObj, theName, "path")
4527             return anObj
4528
4529         # end of l3_complex
4530         ## @}
4531
4532         ## @addtogroup l3_basic_go
4533         ## @{
4534
4535         ## Create a linear edge with specified ends.
4536         #  @param thePnt1 Point for the first end of edge.
4537         #  @param thePnt2 Point for the second end of edge.
4538         #  @param theName Object name; when specified, this parameter is used
4539         #         for result publication in the study. Otherwise, if automatic
4540         #         publication is switched on, default value is used for result name.
4541         #
4542         #  @return New GEOM.GEOM_Object, containing the created edge.
4543         #
4544         #  @ref tui_creation_edge "Example"
4545         @ManageTransactions("ShapesOp")
4546         def MakeEdge(self, thePnt1, thePnt2, theName=None):
4547             """
4548             Create a linear edge with specified ends.
4549
4550             Parameters:
4551                 thePnt1 Point for the first end of edge.
4552                 thePnt2 Point for the second end of edge.
4553                 theName Object name; when specified, this parameter is used
4554                         for result publication in the study. Otherwise, if automatic
4555                         publication is switched on, default value is used for result name.
4556
4557             Returns:
4558                 New GEOM.GEOM_Object, containing the created edge.
4559             """
4560             # Example: see GEOM_TestAll.py
4561             anObj = self.ShapesOp.MakeEdge(thePnt1, thePnt2)
4562             RaiseIfFailed("MakeEdge", self.ShapesOp)
4563             self._autoPublish(anObj, theName, "edge")
4564             return anObj
4565
4566         ## Create a new edge, corresponding to the given length on the given curve.
4567         #  @param theRefCurve The referenced curve (edge).
4568         #  @param theLength Length on the referenced curve. It can be negative.
4569         #  @param theStartPoint Any point can be selected for it, the new edge will begin
4570         #                       at the end of \a theRefCurve, close to the selected point.
4571         #                       If None, start from the first point of \a theRefCurve.
4572         #  @param theName Object name; when specified, this parameter is used
4573         #         for result publication in the study. Otherwise, if automatic
4574         #         publication is switched on, default value is used for result name.
4575         #
4576         #  @return New GEOM.GEOM_Object, containing the created edge.
4577         #
4578         #  @ref tui_creation_edge "Example"
4579         @ManageTransactions("ShapesOp")
4580         def MakeEdgeOnCurveByLength(self, theRefCurve, theLength, theStartPoint = None, theName=None):
4581             """
4582             Create a new edge, corresponding to the given length on the given curve.
4583
4584             Parameters:
4585                 theRefCurve The referenced curve (edge).
4586                 theLength Length on the referenced curve. It can be negative.
4587                 theStartPoint Any point can be selected for it, the new edge will begin
4588                               at the end of theRefCurve, close to the selected point.
4589                               If None, start from the first point of theRefCurve.
4590                 theName Object name; when specified, this parameter is used
4591                         for result publication in the study. Otherwise, if automatic
4592                         publication is switched on, default value is used for result name.
4593
4594             Returns:
4595                 New GEOM.GEOM_Object, containing the created edge.
4596             """
4597             # Example: see GEOM_TestAll.py
4598             theLength, Parameters = ParseParameters(theLength)
4599             anObj = self.ShapesOp.MakeEdgeOnCurveByLength(theRefCurve, theLength, theStartPoint)
4600             RaiseIfFailed("MakeEdgeOnCurveByLength", self.ShapesOp)
4601             anObj.SetParameters(Parameters)
4602             self._autoPublish(anObj, theName, "edge")
4603             return anObj
4604
4605         ## Create an edge from specified wire.
4606         #  @param theWire source Wire
4607         #  @param theLinearTolerance linear tolerance value (default = 1e-07)
4608         #  @param theAngularTolerance angular tolerance value (default = 1e-12)
4609         #  @param theName Object name; when specified, this parameter is used
4610         #         for result publication in the study. Otherwise, if automatic
4611         #         publication is switched on, default value is used for result name.
4612         #
4613         #  @return New GEOM.GEOM_Object, containing the created edge.
4614         #
4615         #  @ref tui_creation_edge "Example"
4616         @ManageTransactions("ShapesOp")
4617         def MakeEdgeWire(self, theWire, theLinearTolerance = 1e-07, theAngularTolerance = 1e-12, theName=None):
4618             """
4619             Create an edge from specified wire.
4620
4621             Parameters:
4622                 theWire source Wire
4623                 theLinearTolerance linear tolerance value (default = 1e-07)
4624                 theAngularTolerance angular tolerance value (default = 1e-12)
4625                 theName Object name; when specified, this parameter is used
4626                         for result publication in the study. Otherwise, if automatic
4627                         publication is switched on, default value is used for result name.
4628
4629             Returns:
4630                 New GEOM.GEOM_Object, containing the created edge.
4631             """
4632             # Example: see GEOM_TestAll.py
4633             anObj = self.ShapesOp.MakeEdgeWire(theWire, theLinearTolerance, theAngularTolerance)
4634             RaiseIfFailed("MakeEdgeWire", self.ShapesOp)
4635             self._autoPublish(anObj, theName, "edge")
4636             return anObj
4637
4638         ## Create a wire from the set of edges and wires.
4639         #  @param theEdgesAndWires List of edges and/or wires.
4640         #  @param theTolerance Maximum distance between vertices, that will be merged.
4641         #                      Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion())
4642         #  @param theName Object name; when specified, this parameter is used
4643         #         for result publication in the study. Otherwise, if automatic
4644         #         publication is switched on, default value is used for result name.
4645         #
4646         #  @return New GEOM.GEOM_Object, containing the created wire.
4647         #
4648         #  @ref tui_creation_wire "Example"
4649         @ManageTransactions("ShapesOp")
4650         def MakeWire(self, theEdgesAndWires, theTolerance = 1e-07, theName=None):
4651             """
4652             Create a wire from the set of edges and wires.
4653
4654             Parameters:
4655                 theEdgesAndWires List of edges and/or wires.
4656                 theTolerance Maximum distance between vertices, that will be merged.
4657                              Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
4658                 theName Object name; when specified, this parameter is used
4659                         for result publication in the study. Otherwise, if automatic
4660                         publication is switched on, default value is used for result name.
4661
4662             Returns:
4663                 New GEOM.GEOM_Object, containing the created wire.
4664             """
4665             # Example: see GEOM_TestAll.py
4666             anObj = self.ShapesOp.MakeWire(theEdgesAndWires, theTolerance)
4667             RaiseIfFailed("MakeWire", self.ShapesOp)
4668             self._autoPublish(anObj, theName, "wire")
4669             return anObj
4670
4671         ## Create a face on the given wire.
4672         #  @param theWire closed Wire or Edge to build the face on.
4673         #  @param isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4674         #                        If the tolerance of the obtained planar face is less
4675         #                        than 1e-06, this face will be returned, otherwise the
4676         #                        algorithm tries to build any suitable face on the given
4677         #                        wire and prints a warning message.
4678         #  @param theName Object name; when specified, this parameter is used
4679         #         for result publication in the study. Otherwise, if automatic
4680         #         publication is switched on, default value is used for result name.
4681         #
4682         #  @return New GEOM.GEOM_Object, containing the created face (compound of faces).
4683         #
4684         #  @ref tui_creation_face "Example"
4685         @ManageTransactions("ShapesOp")
4686         def MakeFace(self, theWire, isPlanarWanted, theName=None):
4687             """
4688             Create a face on the given wire.
4689
4690             Parameters:
4691                 theWire closed Wire or Edge to build the face on.
4692                 isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4693                                If the tolerance of the obtained planar face is less
4694                                than 1e-06, this face will be returned, otherwise the
4695                                algorithm tries to build any suitable face on the given
4696                                wire and prints a warning message.
4697                 theName Object name; when specified, this parameter is used
4698                         for result publication in the study. Otherwise, if automatic
4699                         publication is switched on, default value is used for result name.
4700
4701             Returns:
4702                 New GEOM.GEOM_Object, containing the created face (compound of faces).
4703             """
4704             # Example: see GEOM_TestAll.py
4705             anObj = self.ShapesOp.MakeFace(theWire, isPlanarWanted)
4706             if isPlanarWanted and anObj is not None and self.ShapesOp.GetErrorCode() == "MAKE_FACE_TOLERANCE_TOO_BIG":
4707                 print "WARNING: Cannot build a planar face: required tolerance is too big. Non-planar face is built."
4708             else:
4709                 RaiseIfFailed("MakeFace", self.ShapesOp)
4710             self._autoPublish(anObj, theName, "face")
4711             return anObj
4712
4713         ## Create a face on the given wires set.
4714         #  @param theWires List of closed wires or edges to build the face on.
4715         #  @param isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4716         #                        If the tolerance of the obtained planar face is less
4717         #                        than 1e-06, this face will be returned, otherwise the
4718         #                        algorithm tries to build any suitable face on the given
4719         #                        wire and prints a warning message.
4720         #  @param theName Object name; when specified, this parameter is used
4721         #         for result publication in the study. Otherwise, if automatic
4722         #         publication is switched on, default value is used for result name.
4723         #
4724         #  @return New GEOM.GEOM_Object, containing the created face (compound of faces).
4725         #
4726         #  @ref tui_creation_face "Example"
4727         @ManageTransactions("ShapesOp")
4728         def MakeFaceWires(self, theWires, isPlanarWanted, theName=None):
4729             """
4730             Create a face on the given wires set.
4731
4732             Parameters:
4733                 theWires List of closed wires or edges to build the face on.
4734                 isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4735                                If the tolerance of the obtained planar face is less
4736                                than 1e-06, this face will be returned, otherwise the
4737                                algorithm tries to build any suitable face on the given
4738                                wire and prints a warning message.
4739                 theName Object name; when specified, this parameter is used
4740                         for result publication in the study. Otherwise, if automatic
4741                         publication is switched on, default value is used for result name.
4742
4743             Returns:
4744                 New GEOM.GEOM_Object, containing the created face (compound of faces).
4745             """
4746             # Example: see GEOM_TestAll.py
4747             anObj = self.ShapesOp.MakeFaceWires(ToList(theWires), isPlanarWanted)
4748             if isPlanarWanted and anObj is not None and self.ShapesOp.GetErrorCode() == "MAKE_FACE_TOLERANCE_TOO_BIG":
4749                 print "WARNING: Cannot build a planar face: required tolerance is too big. Non-planar face is built."
4750             else:
4751                 RaiseIfFailed("MakeFaceWires", self.ShapesOp)
4752             self._autoPublish(anObj, theName, "face")
4753             return anObj
4754
4755         ## See MakeFaceWires() method for details.
4756         #
4757         #  @ref tui_creation_face "Example 1"
4758         #  \n @ref swig_MakeFaces  "Example 2"
4759         def MakeFaces(self, theWires, isPlanarWanted, theName=None):
4760             """
4761             See geompy.MakeFaceWires() method for details.
4762             """
4763             # Example: see GEOM_TestOthers.py
4764             # note: auto-publishing is done in self.MakeFaceWires()
4765             anObj = self.MakeFaceWires(theWires, isPlanarWanted, theName)
4766             return anObj
4767
4768         ## Create a face based on a surface from given face bounded
4769         #  by given wire.
4770         #  @param theFace the face whose surface is used to create a new face.
4771         #  @param theWire the wire that will bound a new face.
4772         #  @param theName Object name; when specified, this parameter is used
4773         #         for result publication in the study. Otherwise, if automatic
4774         #         publication is switched on, default value is used for result name.
4775         #
4776         #  @return New GEOM.GEOM_Object, containing the created face.
4777         #
4778         #  @ref tui_creation_face "Example"
4779         @ManageTransactions("ShapesOp")
4780         def MakeFaceFromSurface(self, theFace, theWire, theName=None):
4781             """
4782             Create a face based on a surface from given face bounded
4783             by given wire.
4784
4785             Parameters:
4786                 theFace the face whose surface is used to create a new face.
4787                 theWire the wire that will bound a new face.
4788                 theName Object name; when specified, this parameter is used
4789                         for result publication in the study. Otherwise, if automatic
4790                         publication is switched on, default value is used for result name.
4791
4792             Returns:
4793                 New GEOM.GEOM_Object, containing the created face.
4794             """
4795             # Example: see GEOM_TestAll.py
4796             anObj = self.ShapesOp.MakeFaceFromSurface(theFace, theWire)
4797             RaiseIfFailed("MakeFaceFromSurface", self.ShapesOp)
4798             self._autoPublish(anObj, theName, "face")
4799             return anObj
4800           
4801         ## Create a face from a set of edges with the given constraints.
4802         #  @param theConstraints List of edges and constraint faces (as a sequence of a Edge + Face couples):
4803         #         - edges should form a closed wire;
4804         #         - for each edge, constraint face is optional: if a constraint face is missing
4805         #           for some edge, this means that there no constraint associated with this edge.
4806         #  @param theName Object name; when specified, this parameter is used
4807         #         for result publication in the study. Otherwise, if automatic
4808         #         publication is switched on, default value is used for result name.
4809         # 
4810         # @return New GEOM.GEOM_Object, containing the created face.
4811         # 
4812         # @ref tui_creation_face "Example"
4813         @ManageTransactions("ShapesOp")
4814         def MakeFaceWithConstraints(self, theConstraints, theName=None):
4815             """
4816             Create a face from a set of edges with the given constraints.
4817
4818             Parameters:
4819                 theConstraints List of edges and constraint faces (as a sequence of a Edge + Face couples):
4820                         - edges should form a closed wire;
4821                         - for each edge, constraint face is optional: if a constraint face is missing
4822                           for some edge, this means that there no constraint associated with this edge.
4823                 theName Object name; when specified, this parameter is used
4824                         for result publication in the study. Otherwise, if automatic
4825                         publication is switched on, default value is used for result name.
4826
4827             Returns:
4828                 New GEOM.GEOM_Object, containing the created face.
4829             """
4830             # Example: see GEOM_TestAll.py
4831             anObj = self.ShapesOp.MakeFaceWithConstraints(theConstraints)
4832             if anObj is None:
4833                 RaiseIfFailed("MakeFaceWithConstraints", self.ShapesOp)
4834             self._autoPublish(anObj, theName, "face")
4835             return anObj
4836
4837         ## Create a shell from the set of faces and shells.
4838         #  @param theFacesAndShells List of faces and/or shells.
4839         #  @param theName Object name; when specified, this parameter is used
4840         #         for result publication in the study. Otherwise, if automatic
4841         #         publication is switched on, default value is used for result name.
4842         #
4843         #  @return New GEOM.GEOM_Object, containing the created shell (compound of shells).
4844         #
4845         #  @ref tui_creation_shell "Example"
4846         @ManageTransactions("ShapesOp")
4847         def MakeShell(self, theFacesAndShells, theName=None):
4848             """
4849             Create a shell from the set of faces and shells.
4850
4851             Parameters:
4852                 theFacesAndShells List of faces and/or shells.
4853                 theName Object name; when specified, this parameter is used
4854                         for result publication in the study. Otherwise, if automatic
4855                         publication is switched on, default value is used for result name.
4856
4857             Returns:
4858                 New GEOM.GEOM_Object, containing the created shell (compound of shells).
4859             """
4860             # Example: see GEOM_TestAll.py
4861             anObj = self.ShapesOp.MakeShell( ToList( theFacesAndShells ))
4862             RaiseIfFailed("MakeShell", self.ShapesOp)
4863             self._autoPublish(anObj, theName, "shell")
4864             return anObj
4865
4866         ## Create a solid, bounded by the given shells.
4867         #  @param theShells Sequence of bounding shells.
4868         #  @param theName Object name; when specified, this parameter is used
4869         #         for result publication in the study. Otherwise, if automatic
4870         #         publication is switched on, default value is used for result name.
4871         #
4872         #  @return New GEOM.GEOM_Object, containing the created solid.
4873         #
4874         #  @ref tui_creation_solid "Example"
4875         @ManageTransactions("ShapesOp")
4876         def MakeSolid(self, theShells, theName=None):
4877             """
4878             Create a solid, bounded by the given shells.
4879
4880             Parameters:
4881                 theShells Sequence of bounding shells.
4882                 theName Object name; when specified, this parameter is used
4883                         for result publication in the study. Otherwise, if automatic
4884                         publication is switched on, default value is used for result name.
4885
4886             Returns:
4887                 New GEOM.GEOM_Object, containing the created solid.
4888             """
4889             # Example: see GEOM_TestAll.py
4890             theShells = ToList(theShells)
4891             if len(theShells) == 1:
4892                 descr = self._IsGoodForSolid(theShells[0])
4893                 #if len(descr) > 0:
4894                 #    raise RuntimeError, "MakeSolidShells : " + descr
4895                 if descr == "WRN_SHAPE_UNCLOSED":
4896                     raise RuntimeError, "MakeSolidShells : Unable to create solid from unclosed shape"
4897             anObj = self.ShapesOp.MakeSolidShells(theShells)
4898             RaiseIfFailed("MakeSolidShells", self.ShapesOp)
4899             self._autoPublish(anObj, theName, "solid")
4900             return anObj
4901
4902         ## Create a compound of the given shapes.
4903         #  @param theShapes List of shapes to put in compound.
4904         #  @param theName Object name; when specified, this parameter is used
4905         #         for result publication in the study. Otherwise, if automatic
4906         #         publication is switched on, default value is used for result name.
4907         #
4908         #  @return New GEOM.GEOM_Object, containing the created compound.
4909         #
4910         #  @ref tui_creation_compound "Example"
4911         @ManageTransactions("ShapesOp")
4912         def MakeCompound(self, theShapes, theName=None):
4913             """
4914             Create a compound of the given shapes.
4915
4916             Parameters:
4917                 theShapes List of shapes to put in compound.
4918                 theName Object name; when specified, this parameter is used
4919                         for result publication in the study. Otherwise, if automatic
4920                         publication is switched on, default value is used for result name.
4921
4922             Returns:
4923                 New GEOM.GEOM_Object, containing the created compound.
4924             """
4925             # Example: see GEOM_TestAll.py
4926             anObj = self.ShapesOp.MakeCompound(ToList(theShapes))
4927             RaiseIfFailed("MakeCompound", self.ShapesOp)
4928             self._autoPublish(anObj, theName, "compound")
4929             return anObj
4930         
4931         ## Create a solid (or solids) from the set of faces and/or shells.
4932         #  @param theFacesOrShells List of faces and/or shells.
4933         #  @param isIntersect If TRUE, forces performing intersections
4934         #         between arguments; otherwise (default) intersection is not performed.
4935         #  @param theName Object name; when specified, this parameter is used
4936         #         for result publication in the study. Otherwise, if automatic
4937         #         publication is switched on, default value is used for result name.
4938         #
4939         #  @return New GEOM.GEOM_Object, containing the created solid (or compound of solids).
4940         #
4941         #  @ref tui_creation_solid_from_faces "Example"
4942         @ManageTransactions("ShapesOp")
4943         def MakeSolidFromConnectedFaces(self, theFacesOrShells, isIntersect = False, theName=None):
4944             """
4945             Create a solid (or solids) from the set of connected faces and/or shells.
4946
4947             Parameters:
4948                 theFacesOrShells List of faces and/or shells.
4949                 isIntersect If TRUE, forces performing intersections
4950                         between arguments; otherwise (default) intersection is not performed
4951                 theName Object name; when specified, this parameter is used.
4952                         for result publication in the study. Otherwise, if automatic
4953                         publication is switched on, default value is used for result name.
4954
4955             Returns:
4956                 New GEOM.GEOM_Object, containing the created solid (or compound of solids).
4957             """
4958             # Example: see GEOM_TestAll.py
4959             anObj = self.ShapesOp.MakeSolidFromConnectedFaces(theFacesOrShells, isIntersect)
4960             RaiseIfFailed("MakeSolidFromConnectedFaces", self.ShapesOp)
4961             self._autoPublish(anObj, theName, "solid")
4962             return anObj
4963
4964         # end of l3_basic_go
4965         ## @}
4966
4967         ## @addtogroup l2_measure
4968         ## @{
4969
4970         ## Gives quantity of faces in the given shape.
4971         #  @param theShape Shape to count faces of.
4972         #  @return Quantity of faces.
4973         #
4974         #  @ref swig_NumberOf "Example"
4975         @ManageTransactions("ShapesOp")
4976         def NumberOfFaces(self, theShape):
4977             """
4978             Gives quantity of faces in the given shape.
4979
4980             Parameters:
4981                 theShape Shape to count faces of.
4982
4983             Returns:
4984                 Quantity of faces.
4985             """
4986             # Example: see GEOM_TestOthers.py
4987             nb_faces = self.ShapesOp.NumberOfFaces(theShape)
4988             RaiseIfFailed("NumberOfFaces", self.ShapesOp)
4989             return nb_faces
4990
4991         ## Gives quantity of edges in the given shape.
4992         #  @param theShape Shape to count edges of.
4993         #  @return Quantity of edges.
4994         #
4995         #  @ref swig_NumberOf "Example"
4996         @ManageTransactions("ShapesOp")
4997         def NumberOfEdges(self, theShape):
4998             """
4999             Gives quantity of edges in the given shape.
5000
5001             Parameters:
5002                 theShape Shape to count edges of.
5003
5004             Returns:
5005                 Quantity of edges.
5006             """
5007             # Example: see GEOM_TestOthers.py
5008             nb_edges = self.ShapesOp.NumberOfEdges(theShape)
5009             RaiseIfFailed("NumberOfEdges", self.ShapesOp)
5010             return nb_edges
5011
5012         ## Gives quantity of sub-shapes of type theShapeType in the given shape.
5013         #  @param theShape Shape to count sub-shapes of.
5014         #  @param theShapeType Type of sub-shapes to count (see ShapeType())
5015         #  @return Quantity of sub-shapes of given type.
5016         #
5017         #  @ref swig_NumberOf "Example"
5018         @ManageTransactions("ShapesOp")
5019         def NumberOfSubShapes(self, theShape, theShapeType):
5020             """
5021             Gives quantity of sub-shapes of type theShapeType in the given shape.
5022
5023             Parameters:
5024                 theShape Shape to count sub-shapes of.
5025                 theShapeType Type of sub-shapes to count (see geompy.ShapeType)
5026
5027             Returns:
5028                 Quantity of sub-shapes of given type.
5029             """
5030             # Example: see GEOM_TestOthers.py
5031             nb_ss = self.ShapesOp.NumberOfSubShapes(theShape, theShapeType)
5032             RaiseIfFailed("NumberOfSubShapes", self.ShapesOp)
5033             return nb_ss
5034
5035         ## Gives quantity of solids in the given shape.
5036         #  @param theShape Shape to count solids in.
5037         #  @return Quantity of solids.
5038         #
5039         #  @ref swig_NumberOf "Example"
5040         @ManageTransactions("ShapesOp")
5041         def NumberOfSolids(self, theShape):
5042             """
5043             Gives quantity of solids in the given shape.
5044
5045             Parameters:
5046                 theShape Shape to count solids in.
5047
5048             Returns:
5049                 Quantity of solids.
5050             """
5051             # Example: see GEOM_TestOthers.py
5052             nb_solids = self.ShapesOp.NumberOfSubShapes(theShape, self.ShapeType["SOLID"])
5053             RaiseIfFailed("NumberOfSolids", self.ShapesOp)
5054             return nb_solids
5055
5056         # end of l2_measure
5057         ## @}
5058
5059         ## @addtogroup l3_healing
5060         ## @{
5061
5062         ## Reverses an orientation the given shape.
5063         #  @param theShape Shape to be reversed.
5064         #  @param theName Object name; when specified, this parameter is used
5065         #         for result publication in the study. Otherwise, if automatic
5066         #         publication is switched on, default value is used for result name.
5067         #
5068         #  @return The reversed copy of theShape.
5069         #
5070         #  @ref swig_ChangeOrientation "Example"
5071         @ManageTransactions("ShapesOp")
5072         def ChangeOrientation(self, theShape, theName=None):
5073             """
5074             Reverses an orientation the given shape.
5075
5076             Parameters:
5077                 theShape Shape to be reversed.
5078                 theName Object name; when specified, this parameter is used
5079                         for result publication in the study. Otherwise, if automatic
5080                         publication is switched on, default value is used for result name.
5081
5082             Returns:
5083                 The reversed copy of theShape.
5084             """
5085             # Example: see GEOM_TestAll.py
5086             anObj = self.ShapesOp.ChangeOrientation(theShape)
5087             RaiseIfFailed("ChangeOrientation", self.ShapesOp)
5088             self._autoPublish(anObj, theName, "reversed")
5089             return anObj
5090
5091         ## See ChangeOrientation() method for details.
5092         #
5093         #  @ref swig_OrientationChange "Example"
5094         def OrientationChange(self, theShape, theName=None):
5095             """
5096             See geompy.ChangeOrientation method for details.
5097             """
5098             # Example: see GEOM_TestOthers.py
5099             # note: auto-publishing is done in self.ChangeOrientation()
5100             anObj = self.ChangeOrientation(theShape, theName)
5101             return anObj
5102
5103         # end of l3_healing
5104         ## @}
5105
5106         ## @addtogroup l4_obtain
5107         ## @{
5108
5109         ## Retrieve all free faces from the given shape.
5110         #  Free face is a face, which is not shared between two shells of the shape.
5111         #  @param theShape Shape to find free faces in.
5112         #  @return List of IDs of all free faces, contained in theShape.
5113         #
5114         #  @ref tui_free_faces_page "Example"
5115         @ManageTransactions("ShapesOp")
5116         def GetFreeFacesIDs(self,theShape):
5117             """
5118             Retrieve all free faces from the given shape.
5119             Free face is a face, which is not shared between two shells of the shape.
5120
5121             Parameters:
5122                 theShape Shape to find free faces in.
5123
5124             Returns:
5125                 List of IDs of all free faces, contained in theShape.
5126             """
5127             # Example: see GEOM_TestOthers.py
5128             anIDs = self.ShapesOp.GetFreeFacesIDs(theShape)
5129             RaiseIfFailed("GetFreeFacesIDs", self.ShapesOp)
5130             return anIDs
5131
5132         ## Get all sub-shapes of theShape1 of the given type, shared with theShape2.
5133         #  @param theShape1 Shape to find sub-shapes in.
5134         #  @param theShape2 Shape to find shared sub-shapes with.
5135         #  @param theShapeType Type of sub-shapes to be retrieved.
5136         #  @param theName Object name; when specified, this parameter is used
5137         #         for result publication in the study. Otherwise, if automatic
5138         #         publication is switched on, default value is used for result name.
5139         #
5140         #  @return List of sub-shapes of theShape1, shared with theShape2.
5141         #
5142         #  @ref swig_GetSharedShapes "Example"
5143         @ManageTransactions("ShapesOp")
5144         def GetSharedShapes(self, theShape1, theShape2, theShapeType, theName=None):
5145             """
5146             Get all sub-shapes of theShape1 of the given type, shared with theShape2.
5147
5148             Parameters:
5149                 theShape1 Shape to find sub-shapes in.
5150                 theShape2 Shape to find shared sub-shapes with.
5151                 theShapeType Type of sub-shapes to be retrieved.
5152                 theName Object name; when specified, this parameter is used
5153                         for result publication in the study. Otherwise, if automatic
5154                         publication is switched on, default value is used for result name.
5155
5156             Returns:
5157                 List of sub-shapes of theShape1, shared with theShape2.
5158             """
5159             # Example: see GEOM_TestOthers.py
5160             aList = self.ShapesOp.GetSharedShapes(theShape1, theShape2, theShapeType)
5161             RaiseIfFailed("GetSharedShapes", self.ShapesOp)
5162             self._autoPublish(aList, theName, "shared")
5163             return aList
5164
5165         ## Get sub-shapes, shared by input shapes.
5166         #  @param theShapes Either a list or compound of shapes to find common sub-shapes of.
5167         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType()).
5168         #  @param theMultiShare Specifies what type of shares should be checked:
5169         #         - @c True (default): search sub-shapes from 1st input shape shared with all other input shapes;
5170         #         - @c False: causes to search sub-shapes shared between couples of input shapes.
5171         #  @param theName Object name; when specified, this parameter is used
5172         #         for result publication in the study. Otherwise, if automatic
5173         #         publication is switched on, default value is used for result name.
5174         #
5175         #  @note If @a theShapes contains single compound, the shares between all possible couples of 
5176         #        its top-level shapes are returned; otherwise, only shares between 1st input shape
5177         #        and all rest input shapes are returned.
5178         #
5179         #  @return List of all found sub-shapes.
5180         #
5181         #  Examples:
5182         #  - @ref tui_shared_shapes "Example 1"
5183         #  - @ref swig_GetSharedShapes "Example 2"
5184         @ManageTransactions("ShapesOp")
5185         def GetSharedShapesMulti(self, theShapes, theShapeType, theMultiShare=True, theName=None):
5186             """
5187             Get sub-shapes, shared by input shapes.
5188
5189             Parameters:
5190                 theShapes Either a list or compound of shapes to find common sub-shapes of.
5191                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType).
5192                 theMultiShare Specifies what type of shares should be checked:
5193                   - True (default): search sub-shapes from 1st input shape shared with all other input shapes;
5194                   - False: causes to search sub-shapes shared between couples of input shapes.
5195                 theName Object name; when specified, this parameter is used
5196                         for result publication in the study. Otherwise, if automatic
5197                         publication is switched on, default value is used for result name.
5198
5199             Note: if theShapes contains single compound, the shares between all possible couples of 
5200                   its top-level shapes are returned; otherwise, only shares between 1st input shape
5201                   and all rest input shapes are returned.
5202
5203             Returns:
5204                 List of all found sub-shapes.
5205             """
5206             # Example: see GEOM_TestOthers.py
5207             aList = self.ShapesOp.GetSharedShapesMulti(ToList(theShapes), theShapeType, theMultiShare)
5208             RaiseIfFailed("GetSharedShapesMulti", self.ShapesOp)
5209             self._autoPublish(aList, theName, "shared")
5210             return aList
5211
5212         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
5213         #  situated relatively the specified plane by the certain way,
5214         #  defined through <VAR>theState</VAR> parameter.
5215         #  @param theShape Shape to find sub-shapes of.
5216         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5217         #  @param theAx1 Vector (or line, or linear edge), specifying normal
5218         #                direction and location of the plane to find shapes on.
5219         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5220         #  @param theName Object name; when specified, this parameter is used
5221         #         for result publication in the study. Otherwise, if automatic
5222         #         publication is switched on, default value is used for result name.
5223         #
5224         #  @return List of all found sub-shapes.
5225         #
5226         #  @ref swig_GetShapesOnPlane "Example"
5227         @ManageTransactions("ShapesOp")
5228         def GetShapesOnPlane(self, theShape, theShapeType, theAx1, theState, theName=None):
5229             """
5230             Find in theShape all sub-shapes of type theShapeType,
5231             situated relatively the specified plane by the certain way,
5232             defined through theState parameter.
5233
5234             Parameters:
5235                 theShape Shape to find sub-shapes of.
5236                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5237                 theAx1 Vector (or line, or linear edge), specifying normal
5238                        direction and location of the plane to find shapes on.
5239                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5240                 theName Object name; when specified, this parameter is used
5241                         for result publication in the study. Otherwise, if automatic
5242                         publication is switched on, default value is used for result name.
5243
5244             Returns:
5245                 List of all found sub-shapes.
5246             """
5247             # Example: see GEOM_TestOthers.py
5248             aList = self.ShapesOp.GetShapesOnPlane(theShape, theShapeType, theAx1, theState)
5249             RaiseIfFailed("GetShapesOnPlane", self.ShapesOp)
5250             self._autoPublish(aList, theName, "shapeOnPlane")
5251             return aList
5252
5253         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
5254         #  situated relatively the specified plane by the certain way,
5255         #  defined through <VAR>theState</VAR> parameter.
5256         #  @param theShape Shape to find sub-shapes of.
5257         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5258         #  @param theAx1 Vector (or line, or linear edge), specifying normal
5259         #                direction and location of the plane to find shapes on.
5260         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5261         #
5262         #  @return List of all found sub-shapes indices.
5263         #
5264         #  @ref swig_GetShapesOnPlaneIDs "Example"
5265         @ManageTransactions("ShapesOp")
5266         def GetShapesOnPlaneIDs(self, theShape, theShapeType, theAx1, theState):
5267             """
5268             Find in theShape all sub-shapes of type theShapeType,
5269             situated relatively the specified plane by the certain way,
5270             defined through theState parameter.
5271
5272             Parameters:
5273                 theShape Shape to find sub-shapes of.
5274                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5275                 theAx1 Vector (or line, or linear edge), specifying normal
5276                        direction and location of the plane to find shapes on.
5277                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5278
5279             Returns:
5280                 List of all found sub-shapes indices.
5281             """
5282             # Example: see GEOM_TestOthers.py
5283             aList = self.ShapesOp.GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState)
5284             RaiseIfFailed("GetShapesOnPlaneIDs", self.ShapesOp)
5285             return aList
5286
5287         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
5288         #  situated relatively the specified plane by the certain way,
5289         #  defined through <VAR>theState</VAR> parameter.
5290         #  @param theShape Shape to find sub-shapes of.
5291         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5292         #  @param theAx1 Vector (or line, or linear edge), specifying normal
5293         #                direction of the plane to find shapes on.
5294         #  @param thePnt Point specifying location of the plane to find shapes on.
5295         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5296         #  @param theName Object name; when specified, this parameter is used
5297         #         for result publication in the study. Otherwise, if automatic
5298         #         publication is switched on, default value is used for result name.
5299         #
5300         #  @return List of all found sub-shapes.
5301         #
5302         #  @ref swig_GetShapesOnPlaneWithLocation "Example"
5303         @ManageTransactions("ShapesOp")
5304         def GetShapesOnPlaneWithLocation(self, theShape, theShapeType, theAx1, thePnt, theState, theName=None):
5305             """
5306             Find in theShape all sub-shapes of type theShapeType,
5307             situated relatively the specified plane by the certain way,
5308             defined through theState parameter.
5309
5310             Parameters:
5311                 theShape Shape to find sub-shapes of.
5312                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5313                 theAx1 Vector (or line, or linear edge), specifying normal
5314                        direction and location of the plane to find shapes on.
5315                 thePnt Point specifying location of the plane to find shapes on.
5316                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5317                 theName Object name; when specified, this parameter is used
5318                         for result publication in the study. Otherwise, if automatic
5319                         publication is switched on, default value is used for result name.
5320
5321             Returns:
5322                 List of all found sub-shapes.
5323             """
5324             # Example: see GEOM_TestOthers.py
5325             aList = self.ShapesOp.GetShapesOnPlaneWithLocation(theShape, theShapeType,
5326                                                                theAx1, thePnt, theState)
5327             RaiseIfFailed("GetShapesOnPlaneWithLocation", self.ShapesOp)
5328             self._autoPublish(aList, theName, "shapeOnPlane")
5329             return aList
5330
5331         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
5332         #  situated relatively the specified plane by the certain way,
5333         #  defined through <VAR>theState</VAR> parameter.
5334         #  @param theShape Shape to find sub-shapes of.
5335         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5336         #  @param theAx1 Vector (or line, or linear edge), specifying normal
5337         #                direction of the plane to find shapes on.
5338         #  @param thePnt Point specifying location of the plane to find shapes on.
5339         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5340         #
5341         #  @return List of all found sub-shapes indices.
5342         #
5343         #  @ref swig_GetShapesOnPlaneWithLocationIDs "Example"
5344         @ManageTransactions("ShapesOp")
5345         def GetShapesOnPlaneWithLocationIDs(self, theShape, theShapeType, theAx1, thePnt, theState):
5346             """
5347             Find in theShape all sub-shapes of type theShapeType,
5348             situated relatively the specified plane by the certain way,
5349             defined through theState parameter.
5350
5351             Parameters:
5352                 theShape Shape to find sub-shapes of.
5353                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5354                 theAx1 Vector (or line, or linear edge), specifying normal
5355                        direction and location of the plane to find shapes on.
5356                 thePnt Point specifying location of the plane to find shapes on.
5357                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5358
5359             Returns:
5360                 List of all found sub-shapes indices.
5361             """
5362             # Example: see GEOM_TestOthers.py
5363             aList = self.ShapesOp.GetShapesOnPlaneWithLocationIDs(theShape, theShapeType,
5364                                                                   theAx1, thePnt, theState)
5365             RaiseIfFailed("GetShapesOnPlaneWithLocationIDs", self.ShapesOp)
5366             return aList
5367
5368         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5369         #  the specified cylinder by the certain way, defined through \a theState parameter.
5370         #  @param theShape Shape to find sub-shapes of.
5371         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5372         #  @param theAxis Vector (or line, or linear edge), specifying
5373         #                 axis of the cylinder to find shapes on.
5374         #  @param theRadius Radius of the cylinder to find shapes on.
5375         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5376         #  @param theName Object name; when specified, this parameter is used
5377         #         for result publication in the study. Otherwise, if automatic
5378         #         publication is switched on, default value is used for result name.
5379         #
5380         #  @return List of all found sub-shapes.
5381         #
5382         #  @ref swig_GetShapesOnCylinder "Example"
5383         @ManageTransactions("ShapesOp")
5384         def GetShapesOnCylinder(self, theShape, theShapeType, theAxis, theRadius, theState, theName=None):
5385             """
5386             Find in theShape all sub-shapes of type theShapeType, situated relatively
5387             the specified cylinder by the certain way, defined through theState parameter.
5388
5389             Parameters:
5390                 theShape Shape to find sub-shapes of.
5391                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5392                 theAxis Vector (or line, or linear edge), specifying
5393                         axis of the cylinder to find shapes on.
5394                 theRadius Radius of the cylinder to find shapes on.
5395                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5396                 theName Object name; when specified, this parameter is used
5397                         for result publication in the study. Otherwise, if automatic
5398                         publication is switched on, default value is used for result name.
5399
5400             Returns:
5401                 List of all found sub-shapes.
5402             """
5403             # Example: see GEOM_TestOthers.py
5404             aList = self.ShapesOp.GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState)
5405             RaiseIfFailed("GetShapesOnCylinder", self.ShapesOp)
5406             self._autoPublish(aList, theName, "shapeOnCylinder")
5407             return aList
5408
5409         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5410         #  the specified cylinder by the certain way, defined through \a theState parameter.
5411         #  @param theShape Shape to find sub-shapes of.
5412         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5413         #  @param theAxis Vector (or line, or linear edge), specifying
5414         #                 axis of the cylinder to find shapes on.
5415         #  @param theRadius Radius of the cylinder to find shapes on.
5416         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5417         #
5418         #  @return List of all found sub-shapes indices.
5419         #
5420         #  @ref swig_GetShapesOnCylinderIDs "Example"
5421         @ManageTransactions("ShapesOp")
5422         def GetShapesOnCylinderIDs(self, theShape, theShapeType, theAxis, theRadius, theState):
5423             """
5424             Find in theShape all sub-shapes of type theShapeType, situated relatively
5425             the specified cylinder by the certain way, defined through theState parameter.
5426
5427             Parameters:
5428                 theShape Shape to find sub-shapes of.
5429                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5430                 theAxis Vector (or line, or linear edge), specifying
5431                         axis of the cylinder to find shapes on.
5432                 theRadius Radius of the cylinder to find shapes on.
5433                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5434
5435             Returns:
5436                 List of all found sub-shapes indices.
5437             """
5438             # Example: see GEOM_TestOthers.py
5439             aList = self.ShapesOp.GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState)
5440             RaiseIfFailed("GetShapesOnCylinderIDs", self.ShapesOp)
5441             return aList
5442
5443         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5444         #  the specified cylinder by the certain way, defined through \a theState parameter.
5445         #  @param theShape Shape to find sub-shapes of.
5446         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5447         #  @param theAxis Vector (or line, or linear edge), specifying
5448         #                 axis of the cylinder to find shapes on.
5449         #  @param thePnt Point specifying location of the bottom of the cylinder.
5450         #  @param theRadius Radius of the cylinder to find shapes on.
5451         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5452         #  @param theName Object name; when specified, this parameter is used
5453         #         for result publication in the study. Otherwise, if automatic
5454         #         publication is switched on, default value is used for result name.
5455         #
5456         #  @return List of all found sub-shapes.
5457         #
5458         #  @ref swig_GetShapesOnCylinderWithLocation "Example"
5459         @ManageTransactions("ShapesOp")
5460         def GetShapesOnCylinderWithLocation(self, theShape, theShapeType, theAxis, thePnt, theRadius, theState, theName=None):
5461             """
5462             Find in theShape all sub-shapes of type theShapeType, situated relatively
5463             the specified cylinder by the certain way, defined through theState parameter.
5464
5465             Parameters:
5466                 theShape Shape to find sub-shapes of.
5467                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5468                 theAxis Vector (or line, or linear edge), specifying
5469                         axis of the cylinder to find shapes on.
5470                 theRadius Radius of the cylinder to find shapes on.
5471                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5472                 theName Object name; when specified, this parameter is used
5473                         for result publication in the study. Otherwise, if automatic
5474                         publication is switched on, default value is used for result name.
5475
5476             Returns:
5477                 List of all found sub-shapes.
5478             """
5479             # Example: see GEOM_TestOthers.py
5480             aList = self.ShapesOp.GetShapesOnCylinderWithLocation(theShape, theShapeType, theAxis, thePnt, theRadius, theState)
5481             RaiseIfFailed("GetShapesOnCylinderWithLocation", self.ShapesOp)
5482             self._autoPublish(aList, theName, "shapeOnCylinder")
5483             return aList
5484
5485         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5486         #  the specified cylinder by the certain way, defined through \a theState parameter.
5487         #  @param theShape Shape to find sub-shapes of.
5488         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5489         #  @param theAxis Vector (or line, or linear edge), specifying
5490         #                 axis of the cylinder to find shapes on.
5491         #  @param thePnt Point specifying location of the bottom of the cylinder.
5492         #  @param theRadius Radius of the cylinder to find shapes on.
5493         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5494         #
5495         #  @return List of all found sub-shapes indices
5496         #
5497         #  @ref swig_GetShapesOnCylinderWithLocationIDs "Example"
5498         @ManageTransactions("ShapesOp")
5499         def GetShapesOnCylinderWithLocationIDs(self, theShape, theShapeType, theAxis, thePnt, theRadius, theState):
5500             """
5501             Find in theShape all sub-shapes of type theShapeType, situated relatively
5502             the specified cylinder by the certain way, defined through theState parameter.
5503
5504             Parameters:
5505                 theShape Shape to find sub-shapes of.
5506                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5507                 theAxis Vector (or line, or linear edge), specifying
5508                         axis of the cylinder to find shapes on.
5509                 theRadius Radius of the cylinder to find shapes on.
5510                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5511
5512             Returns:
5513                 List of all found sub-shapes indices.
5514             """
5515             # Example: see GEOM_TestOthers.py
5516             aList = self.ShapesOp.GetShapesOnCylinderWithLocationIDs(theShape, theShapeType, theAxis, thePnt, theRadius, theState)
5517             RaiseIfFailed("GetShapesOnCylinderWithLocationIDs", self.ShapesOp)
5518             return aList
5519
5520         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5521         #  the specified sphere by the certain way, defined through \a theState parameter.
5522         #  @param theShape Shape to find sub-shapes of.
5523         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5524         #  @param theCenter Point, specifying center of the sphere to find shapes on.
5525         #  @param theRadius Radius of the sphere to find shapes on.
5526         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5527         #  @param theName Object name; when specified, this parameter is used
5528         #         for result publication in the study. Otherwise, if automatic
5529         #         publication is switched on, default value is used for result name.
5530         #
5531         #  @return List of all found sub-shapes.
5532         #
5533         #  @ref swig_GetShapesOnSphere "Example"
5534         @ManageTransactions("ShapesOp")
5535         def GetShapesOnSphere(self, theShape, theShapeType, theCenter, theRadius, theState, theName=None):
5536             """
5537             Find in theShape all sub-shapes of type theShapeType, situated relatively
5538             the specified sphere by the certain way, defined through theState parameter.
5539
5540             Parameters:
5541                 theShape Shape to find sub-shapes of.
5542                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5543                 theCenter Point, specifying center of the sphere to find shapes on.
5544                 theRadius Radius of the sphere to find shapes on.
5545                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5546                 theName Object name; when specified, this parameter is used
5547                         for result publication in the study. Otherwise, if automatic
5548                         publication is switched on, default value is used for result name.
5549
5550             Returns:
5551                 List of all found sub-shapes.
5552             """
5553             # Example: see GEOM_TestOthers.py
5554             aList = self.ShapesOp.GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState)
5555             RaiseIfFailed("GetShapesOnSphere", self.ShapesOp)
5556             self._autoPublish(aList, theName, "shapeOnSphere")
5557             return aList
5558
5559         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5560         #  the specified sphere by the certain way, defined through \a theState parameter.
5561         #  @param theShape Shape to find sub-shapes of.
5562         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5563         #  @param theCenter Point, specifying center of the sphere to find shapes on.
5564         #  @param theRadius Radius of the sphere to find shapes on.
5565         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5566         #
5567         #  @return List of all found sub-shapes indices.
5568         #
5569         #  @ref swig_GetShapesOnSphereIDs "Example"
5570         @ManageTransactions("ShapesOp")
5571         def GetShapesOnSphereIDs(self, theShape, theShapeType, theCenter, theRadius, theState):
5572             """
5573             Find in theShape all sub-shapes of type theShapeType, situated relatively
5574             the specified sphere by the certain way, defined through theState parameter.
5575
5576             Parameters:
5577                 theShape Shape to find sub-shapes of.
5578                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5579                 theCenter Point, specifying center of the sphere to find shapes on.
5580                 theRadius Radius of the sphere to find shapes on.
5581                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5582
5583             Returns:
5584                 List of all found sub-shapes indices.
5585             """
5586             # Example: see GEOM_TestOthers.py
5587             aList = self.ShapesOp.GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState)
5588             RaiseIfFailed("GetShapesOnSphereIDs", self.ShapesOp)
5589             return aList
5590
5591         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5592         #  the specified quadrangle by the certain way, defined through \a theState parameter.
5593         #  @param theShape Shape to find sub-shapes of.
5594         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5595         #  @param theTopLeftPoint Point, specifying top left corner of a quadrangle
5596         #  @param theTopRigthPoint Point, specifying top right corner of a quadrangle
5597         #  @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5598         #  @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5599         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5600         #  @param theName Object name; when specified, this parameter is used
5601         #         for result publication in the study. Otherwise, if automatic
5602         #         publication is switched on, default value is used for result name.
5603         #
5604         #  @return List of all found sub-shapes.
5605         #
5606         #  @ref swig_GetShapesOnQuadrangle "Example"
5607         @ManageTransactions("ShapesOp")
5608         def GetShapesOnQuadrangle(self, theShape, theShapeType,
5609                                   theTopLeftPoint, theTopRigthPoint,
5610                                   theBottomLeftPoint, theBottomRigthPoint, theState, theName=None):
5611             """
5612             Find in theShape all sub-shapes of type theShapeType, situated relatively
5613             the specified quadrangle by the certain way, defined through theState parameter.
5614
5615             Parameters:
5616                 theShape Shape to find sub-shapes of.
5617                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5618                 theTopLeftPoint Point, specifying top left corner of a quadrangle
5619                 theTopRigthPoint Point, specifying top right corner of a quadrangle
5620                 theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5621                 theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5622                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5623                 theName Object name; when specified, this parameter is used
5624                         for result publication in the study. Otherwise, if automatic
5625                         publication is switched on, default value is used for result name.
5626
5627             Returns:
5628                 List of all found sub-shapes.
5629             """
5630             # Example: see GEOM_TestOthers.py
5631             aList = self.ShapesOp.GetShapesOnQuadrangle(theShape, theShapeType,
5632                                                         theTopLeftPoint, theTopRigthPoint,
5633                                                         theBottomLeftPoint, theBottomRigthPoint, theState)
5634             RaiseIfFailed("GetShapesOnQuadrangle", self.ShapesOp)
5635             self._autoPublish(aList, theName, "shapeOnQuadrangle")
5636             return aList
5637
5638         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5639         #  the specified quadrangle by the certain way, defined through \a theState parameter.
5640         #  @param theShape Shape to find sub-shapes of.
5641         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5642         #  @param theTopLeftPoint Point, specifying top left corner of a quadrangle
5643         #  @param theTopRigthPoint Point, specifying top right corner of a quadrangle
5644         #  @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5645         #  @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5646         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5647         #
5648         #  @return List of all found sub-shapes indices.
5649         #
5650         #  @ref swig_GetShapesOnQuadrangleIDs "Example"
5651         @ManageTransactions("ShapesOp")
5652         def GetShapesOnQuadrangleIDs(self, theShape, theShapeType,
5653                                      theTopLeftPoint, theTopRigthPoint,
5654                                      theBottomLeftPoint, theBottomRigthPoint, theState):
5655             """
5656             Find in theShape all sub-shapes of type theShapeType, situated relatively
5657             the specified quadrangle by the certain way, defined through theState parameter.
5658
5659             Parameters:
5660                 theShape Shape to find sub-shapes of.
5661                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5662                 theTopLeftPoint Point, specifying top left corner of a quadrangle
5663                 theTopRigthPoint Point, specifying top right corner of a quadrangle
5664                 theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5665                 theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5666                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5667
5668             Returns:
5669                 List of all found sub-shapes indices.
5670             """
5671
5672             # Example: see GEOM_TestOthers.py
5673             aList = self.ShapesOp.GetShapesOnQuadrangleIDs(theShape, theShapeType,
5674                                                            theTopLeftPoint, theTopRigthPoint,
5675                                                            theBottomLeftPoint, theBottomRigthPoint, theState)
5676             RaiseIfFailed("GetShapesOnQuadrangleIDs", self.ShapesOp)
5677             return aList
5678
5679         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5680         #  the specified \a theBox by the certain way, defined through \a theState parameter.
5681         #  @param theBox Shape for relative comparing.
5682         #  @param theShape Shape to find sub-shapes of.
5683         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5684         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5685         #  @param theName Object name; when specified, this parameter is used
5686         #         for result publication in the study. Otherwise, if automatic
5687         #         publication is switched on, default value is used for result name.
5688         #
5689         #  @return List of all found sub-shapes.
5690         #
5691         #  @ref swig_GetShapesOnBox "Example"
5692         @ManageTransactions("ShapesOp")
5693         def GetShapesOnBox(self, theBox, theShape, theShapeType, theState, theName=None):
5694             """
5695             Find in theShape all sub-shapes of type theShapeType, situated relatively
5696             the specified theBox by the certain way, defined through theState parameter.
5697
5698             Parameters:
5699                 theBox Shape for relative comparing.
5700                 theShape Shape to find sub-shapes of.
5701                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5702                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5703                 theName Object name; when specified, this parameter is used
5704                         for result publication in the study. Otherwise, if automatic
5705                         publication is switched on, default value is used for result name.
5706
5707             Returns:
5708                 List of all found sub-shapes.
5709             """
5710             # Example: see GEOM_TestOthers.py
5711             aList = self.ShapesOp.GetShapesOnBox(theBox, theShape, theShapeType, theState)
5712             RaiseIfFailed("GetShapesOnBox", self.ShapesOp)
5713             self._autoPublish(aList, theName, "shapeOnBox")
5714             return aList
5715
5716         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5717         #  the specified \a theBox by the certain way, defined through \a theState parameter.
5718         #  @param theBox Shape for relative comparing.
5719         #  @param theShape Shape to find sub-shapes of.
5720         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5721         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5722         #
5723         #  @return List of all found sub-shapes indices.
5724         #
5725         #  @ref swig_GetShapesOnBoxIDs "Example"
5726         @ManageTransactions("ShapesOp")
5727         def GetShapesOnBoxIDs(self, theBox, theShape, theShapeType, theState):
5728             """
5729             Find in theShape all sub-shapes of type theShapeType, situated relatively
5730             the specified theBox by the certain way, defined through theState parameter.
5731
5732             Parameters:
5733                 theBox Shape for relative comparing.
5734                 theShape Shape to find sub-shapes of.
5735                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5736                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5737
5738             Returns:
5739                 List of all found sub-shapes indices.
5740             """
5741             # Example: see GEOM_TestOthers.py
5742             aList = self.ShapesOp.GetShapesOnBoxIDs(theBox, theShape, theShapeType, theState)
5743             RaiseIfFailed("GetShapesOnBoxIDs", self.ShapesOp)
5744             return aList
5745
5746         ## Find in \a theShape all sub-shapes of type \a theShapeType,
5747         #  situated relatively the specified \a theCheckShape by the
5748         #  certain way, defined through \a theState parameter.
5749         #  @param theCheckShape Shape for relative comparing. It must be a solid.
5750         #  @param theShape Shape to find sub-shapes of.
5751         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5752         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5753         #  @param theName Object name; when specified, this parameter is used
5754         #         for result publication in the study. Otherwise, if automatic
5755         #         publication is switched on, default value is used for result name.
5756         #
5757         #  @return List of all found sub-shapes.
5758         #
5759         #  @ref swig_GetShapesOnShape "Example"
5760         @ManageTransactions("ShapesOp")
5761         def GetShapesOnShape(self, theCheckShape, theShape, theShapeType, theState, theName=None):
5762             """
5763             Find in theShape all sub-shapes of type theShapeType,
5764             situated relatively the specified theCheckShape by the
5765             certain way, defined through theState parameter.
5766
5767             Parameters:
5768                 theCheckShape Shape for relative comparing. It must be a solid.
5769                 theShape Shape to find sub-shapes of.
5770                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5771                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5772                 theName Object name; when specified, this parameter is used
5773                         for result publication in the study. Otherwise, if automatic
5774                         publication is switched on, default value is used for result name.
5775
5776             Returns:
5777                 List of all found sub-shapes.
5778             """
5779             # Example: see GEOM_TestOthers.py
5780             aList = self.ShapesOp.GetShapesOnShape(theCheckShape, theShape,
5781                                                    theShapeType, theState)
5782             RaiseIfFailed("GetShapesOnShape", self.ShapesOp)
5783             self._autoPublish(aList, theName, "shapeOnShape")
5784             return aList
5785
5786         ## Find in \a theShape all sub-shapes of type \a theShapeType,
5787         #  situated relatively the specified \a theCheckShape by the
5788         #  certain way, defined through \a theState parameter.
5789         #  @param theCheckShape Shape for relative comparing. It must be a solid.
5790         #  @param theShape Shape to find sub-shapes of.
5791         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5792         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5793         #  @param theName Object name; when specified, this parameter is used
5794         #         for result publication in the study. Otherwise, if automatic
5795         #         publication is switched on, default value is used for result name.
5796         #
5797         #  @return All found sub-shapes as compound.
5798         #
5799         #  @ref swig_GetShapesOnShapeAsCompound "Example"
5800         @ManageTransactions("ShapesOp")
5801         def GetShapesOnShapeAsCompound(self, theCheckShape, theShape, theShapeType, theState, theName=None):
5802             """
5803             Find in theShape all sub-shapes of type theShapeType,
5804             situated relatively the specified theCheckShape by the
5805             certain way, defined through theState parameter.
5806
5807             Parameters:
5808                 theCheckShape Shape for relative comparing. It must be a solid.
5809                 theShape Shape to find sub-shapes of.
5810                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5811                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5812                 theName Object name; when specified, this parameter is used
5813                         for result publication in the study. Otherwise, if automatic
5814                         publication is switched on, default value is used for result name.
5815
5816             Returns:
5817                 All found sub-shapes as compound.
5818             """
5819             # Example: see GEOM_TestOthers.py
5820             anObj = self.ShapesOp.GetShapesOnShapeAsCompound(theCheckShape, theShape,
5821                                                              theShapeType, theState)
5822             RaiseIfFailed("GetShapesOnShapeAsCompound", self.ShapesOp)
5823             self._autoPublish(anObj, theName, "shapeOnShape")
5824             return anObj
5825
5826         ## Find in \a theShape all sub-shapes of type \a theShapeType,
5827         #  situated relatively the specified \a theCheckShape by the
5828         #  certain way, defined through \a theState parameter.
5829         #  @param theCheckShape Shape for relative comparing. It must be a solid.
5830         #  @param theShape Shape to find sub-shapes of.
5831         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5832         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5833         #
5834         #  @return List of all found sub-shapes indices.
5835         #
5836         #  @ref swig_GetShapesOnShapeIDs "Example"
5837         @ManageTransactions("ShapesOp")
5838         def GetShapesOnShapeIDs(self, theCheckShape, theShape, theShapeType, theState):
5839             """
5840             Find in theShape all sub-shapes of type theShapeType,
5841             situated relatively the specified theCheckShape by the
5842             certain way, defined through theState parameter.
5843
5844             Parameters:
5845                 theCheckShape Shape for relative comparing. It must be a solid.
5846                 theShape Shape to find sub-shapes of.
5847                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5848                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5849
5850             Returns:
5851                 List of all found sub-shapes indices.
5852             """
5853             # Example: see GEOM_TestOthers.py
5854             aList = self.ShapesOp.GetShapesOnShapeIDs(theCheckShape, theShape,
5855                                                       theShapeType, theState)
5856             RaiseIfFailed("GetShapesOnShapeIDs", self.ShapesOp)
5857             return aList
5858
5859         ## Get sub-shape(s) of theShapeWhere, which are
5860         #  coincident with \a theShapeWhat or could be a part of it.
5861         #  @param theShapeWhere Shape to find sub-shapes of.
5862         #  @param theShapeWhat Shape, specifying what to find.
5863         #  @param isNewImplementation implementation of GetInPlace functionality
5864         #             (default = False, old alghorithm based on shape properties)
5865         #  @param theName Object name; when specified, this parameter is used
5866         #         for result publication in the study. Otherwise, if automatic
5867         #         publication is switched on, default value is used for result name.
5868         #
5869         #  @return Compound which includes all found sub-shapes if they have different types; 
5870         #          or group of all found shapes of the equal type; or a single found sub-shape.
5871         #
5872         #  @note This function has a restriction on argument shapes.
5873         #        If \a theShapeWhere has curved parts with significantly
5874         #        outstanding centres (i.e. the mass centre of a part is closer to
5875         #        \a theShapeWhat than to the part), such parts will not be found.
5876         #        @image html get_in_place_lost_part.png
5877         #
5878         #  @ref swig_GetInPlace "Example"
5879         @ManageTransactions("ShapesOp")
5880         def GetInPlace(self, theShapeWhere, theShapeWhat, isNewImplementation = False, theName=None):
5881             """
5882             Get sub-shape(s) of theShapeWhere, which are
5883             coincident with  theShapeWhat or could be a part of it.
5884
5885             Parameters:
5886                 theShapeWhere Shape to find sub-shapes of.
5887                 theShapeWhat Shape, specifying what to find.
5888                 isNewImplementation Implementation of GetInPlace functionality
5889                                     (default = False, old alghorithm based on shape properties)
5890                 theName Object name; when specified, this parameter is used
5891                         for result publication in the study. Otherwise, if automatic
5892                         publication is switched on, default value is used for result name.
5893
5894             Returns:
5895                 Compound which includes all found sub-shapes if they have different types; 
5896                 or group of all found shapes of the equal type; or a single found sub-shape.
5897
5898
5899             Note:
5900                 This function has a restriction on argument shapes.
5901                 If theShapeWhere has curved parts with significantly
5902                 outstanding centres (i.e. the mass centre of a part is closer to
5903                 theShapeWhat than to the part), such parts will not be found.
5904             """
5905             # Example: see GEOM_TestOthers.py
5906             anObj = None
5907             if isNewImplementation:
5908                 anObj = self.ShapesOp.GetInPlace(theShapeWhere, theShapeWhat)
5909             else:
5910                 anObj = self.ShapesOp.GetInPlaceOld(theShapeWhere, theShapeWhat)
5911                 pass
5912             RaiseIfFailed("GetInPlace", self.ShapesOp)
5913             self._autoPublish(anObj, theName, "inplace")
5914             return anObj
5915
5916         ## Get sub-shape(s) of \a theShapeWhere, which are
5917         #  coincident with \a theShapeWhat or could be a part of it.
5918         #
5919         #  Implementation of this method is based on a saved history of an operation,
5920         #  produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
5921         #  arguments (an argument shape or a sub-shape of an argument shape).
5922         #  The operation could be the Partition or one of boolean operations,
5923         #  performed on simple shapes (not on compounds).
5924         #
5925         #  @param theShapeWhere Shape to find sub-shapes of.
5926         #  @param theShapeWhat Shape, specifying what to find (must be in the
5927         #                      building history of the ShapeWhere).
5928         #  @param theName Object name; when specified, this parameter is used
5929         #         for result publication in the study. Otherwise, if automatic
5930         #         publication is switched on, default value is used for result name.
5931         #
5932         #  @return Compound which includes all found sub-shapes if they have different types; 
5933         #          or group of all found shapes of the equal type; or a single found sub-shape.
5934         #
5935         #  @ref swig_GetInPlace "Example"
5936         @ManageTransactions("ShapesOp")
5937         def GetInPlaceByHistory(self, theShapeWhere, theShapeWhat, theName=None):
5938             """
5939             Implementation of this method is based on a saved history of an operation,
5940             produced theShapeWhere. The theShapeWhat must be among this operation's
5941             arguments (an argument shape or a sub-shape of an argument shape).
5942             The operation could be the Partition or one of boolean operations,
5943             performed on simple shapes (not on compounds).
5944
5945             Parameters:
5946                 theShapeWhere Shape to find sub-shapes of.
5947                 theShapeWhat Shape, specifying what to find (must be in the
5948                                 building history of the ShapeWhere).
5949                 theName Object name; when specified, this parameter is used
5950                         for result publication in the study. Otherwise, if automatic
5951                         publication is switched on, default value is used for result name.
5952
5953             Returns:
5954                 Compound which includes all found sub-shapes if they have different types; 
5955                 or group of all found shapes of the equal type; or a single found sub-shape.
5956             """
5957             # Example: see GEOM_TestOthers.py
5958             anObj = self.ShapesOp.GetInPlaceByHistory(theShapeWhere, theShapeWhat)
5959             RaiseIfFailed("GetInPlaceByHistory", self.ShapesOp)
5960             self._autoPublish(anObj, theName, "inplace")
5961             return anObj
5962
5963         ## Get sub-shape of theShapeWhere, which is
5964         #  equal to \a theShapeWhat.
5965         #  @param theShapeWhere Shape to find sub-shape of.
5966         #  @param theShapeWhat Shape, specifying what to find.
5967         #  @param theName Object name; when specified, this parameter is used
5968         #         for result publication in the study. Otherwise, if automatic
5969         #         publication is switched on, default value is used for result name.
5970         #
5971         #  @return New GEOM.GEOM_Object for found sub-shape.
5972         #
5973         #  @ref swig_GetSame "Example"
5974         @ManageTransactions("ShapesOp")
5975         def GetSame(self, theShapeWhere, theShapeWhat, theName=None):
5976             """
5977             Get sub-shape of theShapeWhere, which is
5978             equal to theShapeWhat.
5979
5980             Parameters:
5981                 theShapeWhere Shape to find sub-shape of.
5982                 theShapeWhat Shape, specifying what to find.
5983                 theName Object name; when specified, this parameter is used
5984                         for result publication in the study. Otherwise, if automatic
5985                         publication is switched on, default value is used for result name.
5986
5987             Returns:
5988                 New GEOM.GEOM_Object for found sub-shape.
5989             """
5990             anObj = self.ShapesOp.GetSame(theShapeWhere, theShapeWhat)
5991             RaiseIfFailed("GetSame", self.ShapesOp)
5992             self._autoPublish(anObj, theName, "sameShape")
5993             return anObj
5994
5995
5996         ## Get sub-shape indices of theShapeWhere, which is
5997         #  equal to \a theShapeWhat.
5998         #  @param theShapeWhere Shape to find sub-shape of.
5999         #  @param theShapeWhat Shape, specifying what to find.
6000         #  @return List of all found sub-shapes indices.
6001         #
6002         #  @ref swig_GetSame "Example"
6003         @ManageTransactions("ShapesOp")
6004         def GetSameIDs(self, theShapeWhere, theShapeWhat):
6005             """
6006             Get sub-shape indices of theShapeWhere, which is
6007             equal to theShapeWhat.
6008
6009             Parameters:
6010                 theShapeWhere Shape to find sub-shape of.
6011                 theShapeWhat Shape, specifying what to find.
6012
6013             Returns:
6014                 List of all found sub-shapes indices.
6015             """
6016             anObj = self.ShapesOp.GetSameIDs(theShapeWhere, theShapeWhat)
6017             RaiseIfFailed("GetSameIDs", self.ShapesOp)
6018             return anObj
6019
6020         ## Resize the input edge with the new Min and Max parameters.
6021         #  The input edge parameters range is [0, 1]. If theMin parameter is
6022         #  negative, the input edge is extended, otherwise it is shrinked by
6023         #  theMin parameter. If theMax is greater than 1, the edge is extended,
6024         #  otherwise it is shrinked by theMax parameter.
6025         #  @param theEdge the input edge to be resized.
6026         #  @param theMin the minimal parameter value.
6027         #  @param theMax the maximal parameter value.
6028         #  @param theName Object name; when specified, this parameter is used
6029         #         for result publication in the study. Otherwise, if automatic
6030         #         publication is switched on, default value is used for result name.
6031         #  @return New GEOM.GEOM_Object, containing the created edge.
6032         #
6033         #  @ref tui_extend "Example"
6034         @ManageTransactions("ShapesOp")
6035         def ExtendEdge(self, theEdge, theMin, theMax, theName=None):
6036             """
6037             Resize the input edge with the new Min and Max parameters.
6038             The input edge parameters range is [0, 1]. If theMin parameter is
6039             negative, the input edge is extended, otherwise it is shrinked by
6040             theMin parameter. If theMax is greater than 1, the edge is extended,
6041             otherwise it is shrinked by theMax parameter.
6042
6043             Parameters:
6044                 theEdge the input edge to be resized.
6045                 theMin the minimal parameter value.
6046                 theMax the maximal parameter value.
6047                 theName Object name; when specified, this parameter is used
6048                         for result publication in the study. Otherwise, if automatic
6049                         publication is switched on, default value is used for result name.
6050
6051             Returns:
6052                 New GEOM.GEOM_Object, containing the created edge.
6053             """
6054             theMin, theMax, Parameters = ParseParameters(theMin, theMax)
6055             anObj = self.ShapesOp.ExtendEdge(theEdge, theMin, theMax)
6056             RaiseIfFailed("ExtendEdge", self.ShapesOp)
6057             anObj.SetParameters(Parameters)
6058             self._autoPublish(anObj, theName, "edge")
6059             return anObj
6060
6061         ## Resize the input face with the new UMin, UMax, VMin and VMax
6062         #  parameters. The input face U and V parameters range is [0, 1]. If
6063         #  theUMin parameter is negative, the input face is extended, otherwise
6064         #  it is shrinked along U direction by theUMin parameter. If theUMax is
6065         #  greater than 1, the face is extended, otherwise it is shrinked along
6066         #  U direction by theUMax parameter. So as for theVMin, theVMax and
6067         #  V direction of the input face.
6068         #  @param theFace the input face to be resized.
6069         #  @param theUMin the minimal U parameter value.
6070         #  @param theUMax the maximal U parameter value.
6071         #  @param theVMin the minimal V parameter value.
6072         #  @param theVMax the maximal V parameter value.
6073         #  @param theName Object name; when specified, this parameter is used
6074         #         for result publication in the study. Otherwise, if automatic
6075         #         publication is switched on, default value is used for result name.
6076         #  @return New GEOM.GEOM_Object, containing the created face.
6077         #
6078         #  @ref tui_extend "Example"
6079         @ManageTransactions("ShapesOp")
6080         def ExtendFace(self, theFace, theUMin, theUMax,
6081                        theVMin, theVMax, theName=None):
6082             """
6083             Resize the input face with the new UMin, UMax, VMin and VMax
6084             parameters. The input face U and V parameters range is [0, 1]. If
6085             theUMin parameter is negative, the input face is extended, otherwise
6086             it is shrinked along U direction by theUMin parameter. If theUMax is
6087             greater than 1, the face is extended, otherwise it is shrinked along
6088             U direction by theUMax parameter. So as for theVMin, theVMax and
6089             V direction of the input face.
6090
6091             Parameters:
6092                 theFace the input face to be resized.
6093                 theUMin the minimal U parameter value.
6094                 theUMax the maximal U parameter value.
6095                 theVMin the minimal V parameter value.
6096                 theVMax the maximal V parameter value.
6097                 theName Object name; when specified, this parameter is used
6098                         for result publication in the study. Otherwise, if automatic
6099                         publication is switched on, default value is used for result name.
6100
6101             Returns:
6102                 New GEOM.GEOM_Object, containing the created face.
6103             """
6104             theUMin, theUMax, theVMin, theVMax, Parameters = ParseParameters(theUMin, theUMax, theVMin, theVMax)
6105             anObj = self.ShapesOp.ExtendFace(theFace, theUMin, theUMax,
6106                                              theVMin, theVMax)
6107             RaiseIfFailed("ExtendFace", self.ShapesOp)
6108             anObj.SetParameters(Parameters)
6109             self._autoPublish(anObj, theName, "face")
6110             return anObj
6111
6112         ## This function takes some face as input parameter and creates new
6113         #  GEOM_Object, i.e. topological shape by extracting underlying surface
6114         #  of the source face and limiting it by the Umin, Umax, Vmin, Vmax
6115         #  parameters of the source face (in the parametrical space).
6116         #  @param theFace the input face.
6117         #  @param theName Object name; when specified, this parameter is used
6118         #         for result publication in the study. Otherwise, if automatic
6119         #         publication is switched on, default value is used for result name.
6120         #  @return New GEOM.GEOM_Object, containing the created face.
6121         #
6122         #  @ref tui_creation_surface "Example"
6123         @ManageTransactions("ShapesOp")
6124         def MakeSurfaceFromFace(self, theFace, theName=None):
6125             """
6126             This function takes some face as input parameter and creates new
6127             GEOM_Object, i.e. topological shape by extracting underlying surface
6128             of the source face and limiting it by the Umin, Umax, Vmin, Vmax
6129             parameters of the source face (in the parametrical space).
6130
6131             Parameters:
6132                 theFace the input face.
6133                 theName Object name; when specified, this parameter is used
6134                         for result publication in the study. Otherwise, if automatic
6135                         publication is switched on, default value is used for result name.
6136
6137             Returns:
6138                 New GEOM.GEOM_Object, containing the created face.
6139             """
6140             anObj = self.ShapesOp.MakeSurfaceFromFace(theFace)
6141             RaiseIfFailed("MakeSurfaceFromFace", self.ShapesOp)
6142             self._autoPublish(anObj, theName, "surface")
6143             return anObj
6144
6145         # end of l4_obtain
6146         ## @}
6147
6148         ## @addtogroup l4_access
6149         ## @{
6150
6151         ## Obtain a composite sub-shape of <VAR>aShape</VAR>, composed from sub-shapes
6152         #  of aShape, selected by their unique IDs inside <VAR>aShape</VAR>
6153         #  @param aShape Shape to get sub-shape of.
6154         #  @param ListOfID List of sub-shapes indices.
6155         #  @param theName Object name; when specified, this parameter is used
6156         #         for result publication in the study. Otherwise, if automatic
6157         #         publication is switched on, default value is used for result name.
6158         #
6159         #  @return Found sub-shape.
6160         #
6161         #  @ref swig_all_decompose "Example"
6162         def GetSubShape(self, aShape, ListOfID, theName=None):
6163             """
6164             Obtain a composite sub-shape of aShape, composed from sub-shapes
6165             of aShape, selected by their unique IDs inside aShape
6166
6167             Parameters:
6168                 aShape Shape to get sub-shape of.
6169                 ListOfID List of sub-shapes indices.
6170                 theName Object name; when specified, this parameter is used
6171                         for result publication in the study. Otherwise, if automatic
6172                         publication is switched on, default value is used for result name.
6173
6174             Returns:
6175                 Found sub-shape.
6176             """
6177             # Example: see GEOM_TestAll.py
6178             anObj = self.AddSubShape(aShape,ListOfID)
6179             self._autoPublish(anObj, theName, "subshape")
6180             return anObj
6181
6182         ## Obtain unique ID of sub-shape <VAR>aSubShape</VAR> inside <VAR>aShape</VAR>
6183         #  of aShape, selected by their unique IDs inside <VAR>aShape</VAR>
6184         #  @param aShape Shape to get sub-shape of.
6185         #  @param aSubShape Sub-shapes of aShape.
6186         #  @return ID of found sub-shape.
6187         #
6188         #  @ref swig_all_decompose "Example"
6189         @ManageTransactions("LocalOp")
6190         def GetSubShapeID(self, aShape, aSubShape):
6191             """
6192             Obtain unique ID of sub-shape aSubShape inside aShape
6193             of aShape, selected by their unique IDs inside aShape
6194
6195             Parameters:
6196                aShape Shape to get sub-shape of.
6197                aSubShape Sub-shapes of aShape.
6198
6199             Returns:
6200                ID of found sub-shape.
6201             """
6202             # Example: see GEOM_TestAll.py
6203             anID = self.LocalOp.GetSubShapeIndex(aShape, aSubShape)
6204             RaiseIfFailed("GetSubShapeIndex", self.LocalOp)
6205             return anID
6206
6207         ## Obtain unique IDs of sub-shapes <VAR>aSubShapes</VAR> inside <VAR>aShape</VAR>
6208         #  This function is provided for performance purpose. The complexity is O(n) with n
6209         #  the number of subobjects of aShape
6210         #  @param aShape Shape to get sub-shape of.
6211         #  @param aSubShapes Sub-shapes of aShape.
6212         #  @return list of IDs of found sub-shapes.
6213         #
6214         #  @ref swig_all_decompose "Example"
6215         @ManageTransactions("ShapesOp")
6216         def GetSubShapesIDs(self, aShape, aSubShapes):
6217             """
6218             Obtain a list of IDs of sub-shapes aSubShapes inside aShape
6219             This function is provided for performance purpose. The complexity is O(n) with n
6220             the number of subobjects of aShape
6221
6222             Parameters:
6223                aShape Shape to get sub-shape of.
6224                aSubShapes Sub-shapes of aShape.
6225
6226             Returns:
6227                List of IDs of found sub-shape.
6228             """
6229             # Example: see GEOM_TestAll.py
6230             anIDs = self.ShapesOp.GetSubShapesIndices(aShape, aSubShapes)
6231             RaiseIfFailed("GetSubShapesIndices", self.ShapesOp)
6232             return anIDs
6233
6234         # end of l4_access
6235         ## @}
6236
6237         ## @addtogroup l4_decompose
6238         ## @{
6239
6240         ## Get all sub-shapes and groups of \a theShape,
6241         #  that were created already by any other methods.
6242         #  @param theShape Any shape.
6243         #  @param theGroupsOnly If this parameter is TRUE, only groups will be
6244         #                       returned, else all found sub-shapes and groups.
6245         #  @return List of existing sub-objects of \a theShape.
6246         #
6247         #  @ref swig_all_decompose "Example"
6248         @ManageTransactions("ShapesOp")
6249         def GetExistingSubObjects(self, theShape, theGroupsOnly = False):
6250             """
6251             Get all sub-shapes and groups of theShape,
6252             that were created already by any other methods.
6253
6254             Parameters:
6255                 theShape Any shape.
6256                 theGroupsOnly If this parameter is TRUE, only groups will be
6257                                  returned, else all found sub-shapes and groups.
6258
6259             Returns:
6260                 List of existing sub-objects of theShape.
6261             """
6262             # Example: see GEOM_TestAll.py
6263             ListObj = self.ShapesOp.GetExistingSubObjects(theShape, theGroupsOnly)
6264             RaiseIfFailed("GetExistingSubObjects", self.ShapesOp)
6265             return ListObj
6266
6267         ## Get all groups of \a theShape,
6268         #  that were created already by any other methods.
6269         #  @param theShape Any shape.
6270         #  @return List of existing groups of \a theShape.
6271         #
6272         #  @ref swig_all_decompose "Example"
6273         @ManageTransactions("ShapesOp")
6274         def GetGroups(self, theShape):
6275             """
6276             Get all groups of theShape,
6277             that were created already by any other methods.
6278
6279             Parameters:
6280                 theShape Any shape.
6281
6282             Returns:
6283                 List of existing groups of theShape.
6284             """
6285             # Example: see GEOM_TestAll.py
6286             ListObj = self.ShapesOp.GetExistingSubObjects(theShape, True)
6287             RaiseIfFailed("GetExistingSubObjects", self.ShapesOp)
6288             return ListObj
6289
6290         ## Explode a shape on sub-shapes of a given type.
6291         #  If the shape itself matches the type, it is also returned.
6292         #  @param aShape Shape to be exploded.
6293         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6294         #  @param theName Object name; when specified, this parameter is used
6295         #         for result publication in the study. Otherwise, if automatic
6296         #         publication is switched on, default value is used for result name.
6297         #
6298         #  @return List of sub-shapes of type theShapeType, contained in theShape.
6299         #
6300         #  @ref swig_all_decompose "Example"
6301         @ManageTransactions("ShapesOp")
6302         def SubShapeAll(self, aShape, aType, theName=None):
6303             """
6304             Explode a shape on sub-shapes of a given type.
6305             If the shape itself matches the type, it is also returned.
6306
6307             Parameters:
6308                 aShape Shape to be exploded.
6309                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6310                 theName Object name; when specified, this parameter is used
6311                         for result publication in the study. Otherwise, if automatic
6312                         publication is switched on, default value is used for result name.
6313
6314             Returns:
6315                 List of sub-shapes of type theShapeType, contained in theShape.
6316             """
6317             # Example: see GEOM_TestAll.py
6318             ListObj = self.ShapesOp.MakeAllSubShapes(aShape, EnumToLong( aType ), False)
6319             RaiseIfFailed("SubShapeAll", self.ShapesOp)
6320             self._autoPublish(ListObj, theName, "subshape")
6321             return ListObj
6322
6323         ## Explode a shape on sub-shapes of a given type.
6324         #  @param aShape Shape to be exploded.
6325         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6326         #  @return List of IDs of sub-shapes.
6327         #
6328         #  @ref swig_all_decompose "Example"
6329         @ManageTransactions("ShapesOp")
6330         def SubShapeAllIDs(self, aShape, aType):
6331             """
6332             Explode a shape on sub-shapes of a given type.
6333
6334             Parameters:
6335                 aShape Shape to be exploded (see geompy.ShapeType)
6336                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6337
6338             Returns:
6339                 List of IDs of sub-shapes.
6340             """
6341             ListObj = self.ShapesOp.GetAllSubShapesIDs(aShape, EnumToLong( aType ), False)
6342             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
6343             return ListObj
6344
6345         ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
6346         #  selected by their indices in list of all sub-shapes of type <VAR>aType</VAR>.
6347         #  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6348         #  @param aShape Shape to get sub-shape of.
6349         #  @param ListOfInd List of sub-shapes indices.
6350         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6351         #  @param theName Object name; when specified, this parameter is used
6352         #         for result publication in the study. Otherwise, if automatic
6353         #         publication is switched on, default value is used for result name.
6354         #
6355         #  @return A compound of sub-shapes of aShape.
6356         #
6357         #  @ref swig_all_decompose "Example"
6358         def SubShape(self, aShape, aType, ListOfInd, theName=None):
6359             """
6360             Obtain a compound of sub-shapes of aShape,
6361             selected by their indices in list of all sub-shapes of type aType.
6362             Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6363
6364             Parameters:
6365                 aShape Shape to get sub-shape of.
6366                 ListOfID List of sub-shapes indices.
6367                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6368                 theName Object name; when specified, this parameter is used
6369                         for result publication in the study. Otherwise, if automatic
6370                         publication is switched on, default value is used for result name.
6371
6372             Returns:
6373                 A compound of sub-shapes of aShape.
6374             """
6375             # Example: see GEOM_TestAll.py
6376             ListOfIDs = []
6377             AllShapeIDsList = self.SubShapeAllIDs(aShape, EnumToLong( aType ))
6378             for ind in ListOfInd:
6379                 ListOfIDs.append(AllShapeIDsList[ind - 1])
6380             # note: auto-publishing is done in self.GetSubShape()
6381             anObj = self.GetSubShape(aShape, ListOfIDs, theName)
6382             return anObj
6383
6384         ## Explode a shape on sub-shapes of a given type.
6385         #  Sub-shapes will be sorted taking into account their gravity centers,
6386         #  to provide stable order of sub-shapes.
6387         #  If the shape itself matches the type, it is also returned.
6388         #  @param aShape Shape to be exploded.
6389         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6390         #  @param theName Object name; when specified, this parameter is used
6391         #         for result publication in the study. Otherwise, if automatic
6392         #         publication is switched on, default value is used for result name.
6393         #
6394         #  @return List of sub-shapes of type theShapeType, contained in theShape.
6395         #
6396         #  @ref swig_SubShapeAllSorted "Example"
6397         @ManageTransactions("ShapesOp")
6398         def SubShapeAllSortedCentres(self, aShape, aType, theName=None):
6399             """
6400             Explode a shape on sub-shapes of a given type.
6401             Sub-shapes will be sorted taking into account their gravity centers,
6402             to provide stable order of sub-shapes.
6403             If the shape itself matches the type, it is also returned.
6404
6405             Parameters:
6406                 aShape Shape to be exploded.
6407                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6408                 theName Object name; when specified, this parameter is used
6409                         for result publication in the study. Otherwise, if automatic
6410                         publication is switched on, default value is used for result name.
6411
6412             Returns:
6413                 List of sub-shapes of type theShapeType, contained in theShape.
6414             """
6415             # Example: see GEOM_TestAll.py
6416             ListObj = self.ShapesOp.MakeAllSubShapes(aShape, EnumToLong( aType ), True)
6417             RaiseIfFailed("SubShapeAllSortedCentres", self.ShapesOp)
6418             self._autoPublish(ListObj, theName, "subshape")
6419             return ListObj
6420
6421         ## Explode a shape on sub-shapes of a given type.
6422         #  Sub-shapes will be sorted taking into account their gravity centers,
6423         #  to provide stable order of sub-shapes.
6424         #  @param aShape Shape to be exploded.
6425         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6426         #  @return List of IDs of sub-shapes.
6427         #
6428         #  @ref swig_all_decompose "Example"
6429         @ManageTransactions("ShapesOp")
6430         def SubShapeAllSortedCentresIDs(self, aShape, aType):
6431             """
6432             Explode a shape on sub-shapes of a given type.
6433             Sub-shapes will be sorted taking into account their gravity centers,
6434             to provide stable order of sub-shapes.
6435
6436             Parameters:
6437                 aShape Shape to be exploded.
6438                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6439
6440             Returns:
6441                 List of IDs of sub-shapes.
6442             """
6443             ListIDs = self.ShapesOp.GetAllSubShapesIDs(aShape, EnumToLong( aType ), True)
6444             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
6445             return ListIDs
6446
6447         ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
6448         #  selected by they indices in sorted list of all sub-shapes of type <VAR>aType</VAR>.
6449         #  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6450         #  @param aShape Shape to get sub-shape of.
6451         #  @param ListOfInd List of sub-shapes indices.
6452         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6453         #  @param theName Object name; when specified, this parameter is used
6454         #         for result publication in the study. Otherwise, if automatic
6455         #         publication is switched on, default value is used for result name.
6456         #
6457         #  @return A compound of sub-shapes of aShape.
6458         #
6459         #  @ref swig_all_decompose "Example"
6460         def SubShapeSortedCentres(self, aShape, aType, ListOfInd, theName=None):
6461             """
6462             Obtain a compound of sub-shapes of aShape,
6463             selected by they indices in sorted list of all sub-shapes of type aType.
6464             Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6465
6466             Parameters:
6467                 aShape Shape to get sub-shape of.
6468                 ListOfID List of sub-shapes indices.
6469                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6470                 theName Object name; when specified, this parameter is used
6471                         for result publication in the study. Otherwise, if automatic
6472                         publication is switched on, default value is used for result name.
6473
6474             Returns:
6475                 A compound of sub-shapes of aShape.
6476             """
6477             # Example: see GEOM_TestAll.py
6478             ListOfIDs = []
6479             AllShapeIDsList = self.SubShapeAllSortedCentresIDs(aShape, EnumToLong( aType ))
6480             for ind in ListOfInd:
6481                 ListOfIDs.append(AllShapeIDsList[ind - 1])
6482             # note: auto-publishing is done in self.GetSubShape()
6483             anObj = self.GetSubShape(aShape, ListOfIDs, theName)
6484             return anObj
6485
6486         ## Extract shapes (excluding the main shape) of given type.
6487         #  @param aShape The shape.
6488         #  @param aType  The shape type (see ShapeType())
6489         #  @param isSorted Boolean flag to switch sorting on/off.
6490         #  @param theName Object name; when specified, this parameter is used
6491         #         for result publication in the study. Otherwise, if automatic
6492         #         publication is switched on, default value is used for result name.
6493         #
6494         #  @return List of sub-shapes of type aType, contained in aShape.
6495         #
6496         #  @ref swig_FilletChamfer "Example"
6497         @ManageTransactions("ShapesOp")
6498         def ExtractShapes(self, aShape, aType, isSorted = False, theName=None):
6499             """
6500             Extract shapes (excluding the main shape) of given type.
6501
6502             Parameters:
6503                 aShape The shape.
6504                 aType  The shape type (see geompy.ShapeType)
6505                 isSorted Boolean flag to switch sorting on/off.
6506                 theName Object name; when specified, this parameter is used
6507                         for result publication in the study. Otherwise, if automatic
6508                         publication is switched on, default value is used for result name.
6509
6510             Returns:
6511                 List of sub-shapes of type aType, contained in aShape.
6512             """
6513             # Example: see GEOM_TestAll.py
6514             ListObj = self.ShapesOp.ExtractSubShapes(aShape, EnumToLong( aType ), isSorted)
6515             RaiseIfFailed("ExtractSubShapes", self.ShapesOp)
6516             self._autoPublish(ListObj, theName, "subshape")
6517             return ListObj
6518
6519         ## Get a set of sub-shapes defined by their unique IDs inside <VAR>aShape</VAR>
6520         #  @param aShape Main shape.
6521         #  @param anIDs List of unique IDs of sub-shapes inside <VAR>aShape</VAR>.
6522         #  @param theName Object name; when specified, this parameter is used
6523         #         for result publication in the study. Otherwise, if automatic
6524         #         publication is switched on, default value is used for result name.
6525         #  @return List of GEOM.GEOM_Object, corresponding to found sub-shapes.
6526         #
6527         #  @ref swig_all_decompose "Example"
6528         @ManageTransactions("ShapesOp")
6529         def SubShapes(self, aShape, anIDs, theName=None):
6530             """
6531             Get a set of sub-shapes defined by their unique IDs inside theMainShape
6532
6533             Parameters:
6534                 aShape Main shape.
6535                 anIDs List of unique IDs of sub-shapes inside theMainShape.
6536                 theName Object name; when specified, this parameter is used
6537                         for result publication in the study. Otherwise, if automatic
6538                         publication is switched on, default value is used for result name.
6539
6540             Returns:
6541                 List of GEOM.GEOM_Object, corresponding to found sub-shapes.
6542             """
6543             # Example: see GEOM_TestAll.py
6544             ListObj = self.ShapesOp.MakeSubShapes(aShape, anIDs)
6545             RaiseIfFailed("SubShapes", self.ShapesOp)
6546             self._autoPublish(ListObj, theName, "subshape")
6547             return ListObj
6548
6549         ## Explode a shape into edges sorted in a row from a starting point.
6550         #  @param theShape the shape to be exploded on edges.
6551         #  @param theStartPoint the starting point.
6552         #  @param theName Object name; when specified, this parameter is used
6553         #         for result publication in the study. Otherwise, if automatic
6554         #         publication is switched on, default value is used for result name.
6555         #  @return List of GEOM.GEOM_Object that is actually an ordered list
6556         #          of edges sorted in a row from a starting point.
6557         #
6558         #  @ref swig_GetSubShapeEdgeSorted "Example"
6559         @ManageTransactions("ShapesOp")
6560         def GetSubShapeEdgeSorted(self, theShape, theStartPoint, theName=None):
6561             """
6562             Explode a shape into edges sorted in a row from a starting point.
6563
6564             Parameters:
6565                 theShape the shape to be exploded on edges.
6566                 theStartPoint the starting point.
6567                 theName Object name; when specified, this parameter is used
6568                         for result publication in the study. Otherwise, if automatic
6569                         publication is switched on, default value is used for result name.
6570
6571             Returns:
6572                 List of GEOM.GEOM_Object that is actually an ordered list
6573                 of edges sorted in a row from a starting point.
6574             """
6575             # Example: see GEOM_TestAll.py
6576             ListObj = self.ShapesOp.GetSubShapeEdgeSorted(theShape, theStartPoint)
6577             RaiseIfFailed("GetSubShapeEdgeSorted", self.ShapesOp)
6578             self._autoPublish(ListObj, theName, "SortedEdges")
6579             return ListObj
6580
6581         ##
6582         # Return the list of subshapes that satisfies a certain tolerance
6583         # criterion. The user defines the type of shapes to be returned, the
6584         # condition and the tolerance value. The operation is defined for
6585         # faces, edges and vertices only. E.g. for theShapeType FACE,
6586         # theCondition GEOM::CC_GT and theTolerance 1.e-7 this method returns
6587         # all faces of theShape that have tolerances greater then 1.e7.
6588         #
6589         #  @param theShape the shape to be exploded
6590         #  @param theShapeType the type of sub-shapes to be returned (see
6591         #         ShapeType()). Can have the values FACE, EDGE and VERTEX only.
6592         #  @param theCondition the condition type (see GEOM::comparison_condition).
6593         #  @param theTolerance the tolerance filter.
6594         #  @param theName Object name; when specified, this parameter is used
6595         #         for result publication in the study. Otherwise, if automatic
6596         #         publication is switched on, default value is used for result name.
6597         #  @return the list of shapes that satisfy the conditions.
6598         #
6599         #  @ref swig_GetSubShapesWithTolerance "Example"
6600         @ManageTransactions("ShapesOp")
6601         def GetSubShapesWithTolerance(self, theShape, theShapeType,
6602                                       theCondition, theTolerance, theName=None):
6603             """
6604             Return the list of subshapes that satisfies a certain tolerance
6605             criterion. The user defines the type of shapes to be returned, the
6606             condition and the tolerance value. The operation is defined for
6607             faces, edges and vertices only. E.g. for theShapeType FACE,
6608             theCondition GEOM::CC_GT and theTolerance 1.e-7 this method returns
6609             all faces of theShape that have tolerances greater then 1.e7.
6610             
6611             Parameters:
6612                 theShape the shape to be exploded
6613                 theShapeType the type of sub-shapes to be returned (see
6614                              ShapeType()). Can have the values FACE,
6615                              EDGE and VERTEX only.
6616                 theCondition the condition type (see GEOM::comparison_condition).
6617                 theTolerance the tolerance filter.
6618                 theName Object name; when specified, this parameter is used
6619                         for result publication in the study. Otherwise, if automatic
6620                         publication is switched on, default value is used for result name.
6621
6622             Returns:
6623                 The list of shapes that satisfy the conditions.
6624             """
6625             # Example: see GEOM_TestAll.py
6626             ListObj = self.ShapesOp.GetSubShapesWithTolerance(theShape, EnumToLong(theShapeType),
6627                                                               theCondition, theTolerance)
6628             RaiseIfFailed("GetSubShapesWithTolerance", self.ShapesOp)
6629             self._autoPublish(ListObj, theName, "SubShapeWithTolerance")
6630             return ListObj
6631
6632         ## Check if the object is a sub-object of another GEOM object.
6633         #  @param aSubObject Checked sub-object (or its parent object, in case if
6634         #         \a theSubObjectIndex is non-zero).
6635         #  @param anObject An object that is checked for ownership (or its parent object,
6636         #         in case if \a theObjectIndex is non-zero).
6637         #  @param aSubObjectIndex When non-zero, specifies a sub-shape index that
6638         #         identifies a sub-object within its parent specified via \a theSubObject.
6639         #  @param anObjectIndex When non-zero, specifies a sub-shape index that
6640         #         identifies an object within its parent specified via \a theObject.
6641         #  @return TRUE, if the given object contains sub-object.
6642         @ManageTransactions("ShapesOp")
6643         def IsSubShapeBelongsTo(self, aSubObject, anObject, aSubObjectIndex = 0, anObjectIndex = 0):
6644             """
6645             Check if the object is a sub-object of another GEOM object.
6646             
6647             Parameters:
6648                 aSubObject Checked sub-object (or its parent object, in case if
6649                     \a theSubObjectIndex is non-zero).
6650                 anObject An object that is checked for ownership (or its parent object,
6651                     in case if \a theObjectIndex is non-zero).
6652                 aSubObjectIndex When non-zero, specifies a sub-shape index that
6653                     identifies a sub-object within its parent specified via \a theSubObject.
6654                 anObjectIndex When non-zero, specifies a sub-shape index that
6655                     identifies an object within its parent specified via \a theObject.
6656
6657             Returns
6658                 TRUE, if the given object contains sub-object.
6659             """
6660             IsOk = self.ShapesOp.IsSubShapeBelongsTo(aSubObject, aSubObjectIndex, anObject, anObjectIndex)
6661             RaiseIfFailed("IsSubShapeBelongsTo", self.ShapesOp)
6662             return IsOk
6663
6664         # end of l4_decompose
6665         ## @}
6666
6667         ## @addtogroup l4_decompose_d
6668         ## @{
6669
6670         ## Deprecated method
6671         #  It works like SubShapeAllSortedCentres(), but wrongly
6672         #  defines centres of faces, shells and solids.
6673         @ManageTransactions("ShapesOp")
6674         def SubShapeAllSorted(self, aShape, aType, theName=None):
6675             """
6676             Deprecated method
6677             It works like geompy.SubShapeAllSortedCentres, but wrongly
6678             defines centres of faces, shells and solids.
6679             """
6680             ListObj = self.ShapesOp.MakeExplode(aShape, EnumToLong( aType ), True)
6681             RaiseIfFailed("MakeExplode", self.ShapesOp)
6682             self._autoPublish(ListObj, theName, "subshape")
6683             return ListObj
6684
6685         ## Deprecated method
6686         #  It works like SubShapeAllSortedCentresIDs(), but wrongly
6687         #  defines centres of faces, shells and solids.
6688         @ManageTransactions("ShapesOp")
6689         def SubShapeAllSortedIDs(self, aShape, aType):
6690             """
6691             Deprecated method
6692             It works like geompy.SubShapeAllSortedCentresIDs, but wrongly
6693             defines centres of faces, shells and solids.
6694             """
6695             ListIDs = self.ShapesOp.SubShapeAllIDs(aShape, EnumToLong( aType ), True)
6696             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
6697             return ListIDs
6698
6699         ## Deprecated method
6700         #  It works like SubShapeSortedCentres(), but has a bug
6701         #  (wrongly defines centres of faces, shells and solids).
6702         def SubShapeSorted(self, aShape, aType, ListOfInd, theName=None):
6703             """
6704             Deprecated method
6705             It works like geompy.SubShapeSortedCentres, but has a bug
6706             (wrongly defines centres of faces, shells and solids).
6707             """
6708             ListOfIDs = []
6709             AllShapeIDsList = self.SubShapeAllSortedIDs(aShape, EnumToLong( aType ))
6710             for ind in ListOfInd:
6711                 ListOfIDs.append(AllShapeIDsList[ind - 1])
6712             # note: auto-publishing is done in self.GetSubShape()
6713             anObj = self.GetSubShape(aShape, ListOfIDs, theName)
6714             return anObj
6715
6716         # end of l4_decompose_d
6717         ## @}
6718
6719         ## @addtogroup l3_healing
6720         ## @{
6721
6722         ## Apply a sequence of Shape Healing operators to the given object.
6723         #  @param theShape Shape to be processed.
6724         #  @param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
6725         #  @param theParameters List of names of parameters
6726         #                    ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
6727         #  @param theValues List of values of parameters, in the same order
6728         #                    as parameters are listed in <VAR>theParameters</VAR> list.
6729         #  @param theName Object name; when specified, this parameter is used
6730         #         for result publication in the study. Otherwise, if automatic
6731         #         publication is switched on, default value is used for result name.
6732         #
6733         #  <b> Operators and Parameters: </b> \n
6734         #
6735         #  * \b FixShape - corrects invalid shapes. \n
6736         #  - \b FixShape.Tolerance3d - work tolerance for detection of the problems and correction of them. \n
6737         #  - \b FixShape.MaxTolerance3d - maximal possible tolerance of the shape after correction. \n
6738         #
6739         #  * \b FixFaceSize - removes small faces, such as spots and strips.\n
6740         #  - \b FixFaceSize.Tolerance - defines minimum possible face size. \n
6741         #  - \b DropSmallEdges - removes edges, which merge with neighbouring edges. \n
6742         #  - \b DropSmallEdges.Tolerance3d - defines minimum possible distance between two parallel edges.\n
6743         #  - \b DropSmallSolids - either removes small solids or merges them with neighboring ones. \n
6744         #  - \b DropSmallSolids.WidthFactorThreshold - defines maximum value of <em>2V/S</em> of a solid which is considered small, where \a V is volume and \a S is surface area of the solid. \n
6745         #  - \b DropSmallSolids.VolumeThreshold - defines maximum volume of a solid which is considered small. If the both tolerances are privided a solid is considered small if it meets the both criteria. \n
6746         #  - \b DropSmallSolids.MergeSolids - if "1", small solids are removed; if "0" small solids are merged to adjacent non-small solids or left untouched if cannot be merged. \n
6747         #
6748         #  * \b SplitAngle - splits faces based on conical surfaces, surfaces of revolution and cylindrical
6749         #    surfaces in segments using a certain angle. \n
6750         #  - \b SplitAngle.Angle - the central angle of the resulting segments (i.e. we obtain two segments
6751         #    if Angle=180, four if Angle=90, etc). \n
6752         #  - \b SplitAngle.MaxTolerance - maximum possible tolerance among the resulting segments.\n
6753         #
6754         #  * \b SplitClosedFaces - splits closed faces in segments.
6755         #    The number of segments depends on the number of splitting points.\n
6756         #  - \b SplitClosedFaces.NbSplitPoints - the number of splitting points.\n
6757         #
6758         #  * \b SplitContinuity - splits shapes to reduce continuities of curves and surfaces.\n
6759         #  - \b SplitContinuity.Tolerance3d - 3D tolerance for correction of geometry.\n
6760         #  - \b SplitContinuity.SurfaceContinuity - required continuity for surfaces.\n
6761         #  - \b SplitContinuity.CurveContinuity - required continuity for curves.\n
6762         #   This and the previous parameters can take the following values:\n
6763         #   \b Parametric \b Continuity \n
6764         #   \b C0 (Positional Continuity): curves are joined (the end positions of curves or surfaces
6765         #   are coincidental. The curves or surfaces may still meet at an angle, giving rise to a sharp corner or edge).\n
6766         #   \b C1 (Tangential Continuity): first derivatives are equal (the end vectors of curves or surfaces are parallel,
6767         #    ruling out sharp edges).\n
6768         #   \b C2 (Curvature Continuity): first and second derivatives are equal (the end vectors of curves or surfaces
6769         #       are of the same magnitude).\n
6770         #   \b CN N-th derivatives are equal (both the direction and the magnitude of the Nth derivatives of curves
6771         #    or surfaces (d/du C(u)) are the same at junction. \n
6772         #   \b Geometric \b Continuity \n
6773         #   \b G1: first derivatives are proportional at junction.\n
6774         #   The curve tangents thus have the same direction, but not necessarily the same magnitude.
6775         #      i.e., C1'(1) = (a,b,c) and C2'(0) = (k*a, k*b, k*c).\n
6776         #   \b G2: first and second derivatives are proportional at junction.
6777         #   As the names imply, geometric continuity requires the geometry to be continuous, while parametric
6778         #    continuity requires that the underlying parameterization was continuous as well.
6779         #   Parametric continuity of order n implies geometric continuity of order n, but not vice-versa.\n
6780         #
6781         #  * \b BsplineRestriction - converts curves and surfaces to Bsplines and processes them with the following parameters:\n
6782         #  - \b BSplineRestriction.SurfaceMode - approximation of surfaces if restriction is necessary.\n
6783         #  - \b BSplineRestriction.Curve3dMode - conversion of any 3D curve to BSpline and approximation.\n
6784         #  - \b BSplineRestriction.Curve2dMode - conversion of any 2D curve to BSpline and approximation.\n
6785         #  - \b BSplineRestriction.Tolerance3d - defines the possibility of surfaces and 3D curves approximation
6786         #       with the specified parameters.\n
6787         #  - \b BSplineRestriction.Tolerance2d - defines the possibility of surfaces and 2D curves approximation
6788         #       with the specified parameters.\n
6789         #  - \b BSplineRestriction.RequiredDegree - required degree of the resulting BSplines.\n
6790         #  - \b BSplineRestriction.RequiredNbSegments - required maximum number of segments of resultant BSplines.\n
6791         #  - \b BSplineRestriction.Continuity3d - continuity of the resulting surfaces and 3D curves.\n
6792         #  - \b BSplineRestriction.Continuity2d - continuity of the resulting 2D curves.\n
6793         #
6794         #  * \b ToBezier - converts curves and surfaces of any type to Bezier curves and surfaces.\n
6795         #  - \b ToBezier.SurfaceMode - if checked in, allows conversion of surfaces.\n
6796         #  - \b ToBezier.Curve3dMode - if checked in, allows conversion of 3D curves.\n
6797         #  - \b ToBezier.Curve2dMode - if checked in, allows conversion of 2D curves.\n
6798         #  - \b ToBezier.MaxTolerance - defines tolerance for detection and correction of problems.\n
6799         #
6800         #  * \b SameParameter - fixes edges of 2D and 3D curves not having the same parameter.\n
6801         #  - \b SameParameter.Tolerance3d - defines tolerance for fixing of edges.\n
6802         #
6803         #
6804         #  @return New GEOM.GEOM_Object, containing processed shape.
6805         #
6806         #  \n @ref tui_shape_processing "Example"
6807         @ManageTransactions("HealOp")
6808         def ProcessShape(self, theShape, theOperators, theParameters, theValues, theName=None):
6809             """
6810             Apply a sequence of Shape Healing operators to the given object.
6811
6812             Parameters:
6813                 theShape Shape to be processed.
6814                 theValues List of values of parameters, in the same order
6815                           as parameters are listed in theParameters list.
6816                 theOperators List of names of operators ('FixShape', 'SplitClosedFaces', etc.).
6817                 theParameters List of names of parameters
6818                               ('FixShape.Tolerance3d', 'SplitClosedFaces.NbSplitPoints', etc.).
6819                 theName Object name; when specified, this parameter is used
6820                         for result publication in the study. Otherwise, if automatic
6821                         publication is switched on, default value is used for result name.
6822
6823                 Operators and Parameters:
6824
6825                  * FixShape - corrects invalid shapes.
6826                      * FixShape.Tolerance3d - work tolerance for detection of the problems and correction of them.
6827                      * FixShape.MaxTolerance3d - maximal possible tolerance of the shape after correction.
6828                  * FixFaceSize - removes small faces, such as spots and strips.
6829                      * FixFaceSize.Tolerance - defines minimum possible face size.
6830                  * DropSmallEdges - removes edges, which merge with neighbouring edges.
6831                      * DropSmallEdges.Tolerance3d - defines minimum possible distance between two parallel edges.
6832                  * DropSmallSolids - either removes small solids or merges them with neighboring ones.
6833                      * DropSmallSolids.WidthFactorThreshold - defines maximum value of 2V/S of a solid which is considered small, where V is volume and S is surface area of the solid.
6834                      * DropSmallSolids.VolumeThreshold - defines maximum volume of a solid which is considered small. If the both tolerances are privided a solid is considered small if it meets the both criteria.
6835                      * DropSmallSolids.MergeSolids - if '1', small solids are removed; if '0' small solids are merged to adjacent non-small solids or left untouched if cannot be merged.
6836
6837                  * SplitAngle - splits faces based on conical surfaces, surfaces of revolution and cylindrical surfaces
6838                                 in segments using a certain angle.
6839                      * SplitAngle.Angle - the central angle of the resulting segments (i.e. we obtain two segments
6840                                           if Angle=180, four if Angle=90, etc).
6841                      * SplitAngle.MaxTolerance - maximum possible tolerance among the resulting segments.
6842                  * SplitClosedFaces - splits closed faces in segments. The number of segments depends on the number of
6843                                       splitting points.
6844                      * SplitClosedFaces.NbSplitPoints - the number of splitting points.
6845                  * SplitContinuity - splits shapes to reduce continuities of curves and surfaces.
6846                      * SplitContinuity.Tolerance3d - 3D tolerance for correction of geometry.
6847                      * SplitContinuity.SurfaceContinuity - required continuity for surfaces.
6848                      * SplitContinuity.CurveContinuity - required continuity for curves.
6849                        This and the previous parameters can take the following values:
6850
6851                        Parametric Continuity:
6852                        C0 (Positional Continuity): curves are joined (the end positions of curves or surfaces are
6853                                                    coincidental. The curves or surfaces may still meet at an angle,
6854                                                    giving rise to a sharp corner or edge).
6855                        C1 (Tangential Continuity): first derivatives are equal (the end vectors of curves or surfaces
6856                                                    are parallel, ruling out sharp edges).
6857                        C2 (Curvature Continuity): first and second derivatives are equal (the end vectors of curves
6858                                                   or surfaces are of the same magnitude).
6859                        CN N-th derivatives are equal (both the direction and the magnitude of the Nth derivatives of
6860                           curves or surfaces (d/du C(u)) are the same at junction.
6861
6862                        Geometric Continuity:
6863                        G1: first derivatives are proportional at junction.
6864                            The curve tangents thus have the same direction, but not necessarily the same magnitude.
6865                            i.e., C1'(1) = (a,b,c) and C2'(0) = (k*a, k*b, k*c).
6866                        G2: first and second derivatives are proportional at junction. As the names imply,
6867                            geometric continuity requires the geometry to be continuous, while parametric continuity requires
6868                            that the underlying parameterization was continuous as well. Parametric continuity of order n implies
6869                            geometric continuity of order n, but not vice-versa.
6870                  * BsplineRestriction - converts curves and surfaces to Bsplines and processes them with the following parameters:
6871                      * BSplineRestriction.SurfaceMode - approximation of surfaces if restriction is necessary.
6872                      * BSplineRestriction.Curve3dMode - conversion of any 3D curve to BSpline and approximation.
6873                      * BSplineRestriction.Curve2dMode - conversion of any 2D curve to BSpline and approximation.
6874                      * BSplineRestriction.Tolerance3d - defines the possibility of surfaces and 3D curves approximation with
6875                                                         the specified parameters.
6876                      * BSplineRestriction.Tolerance2d - defines the possibility of surfaces and 2D curves approximation with
6877                                                         the specified parameters.
6878                      * BSplineRestriction.RequiredDegree - required degree of the resulting BSplines.
6879                      * BSplineRestriction.RequiredNbSegments - required maximum number of segments of resultant BSplines.
6880                      * BSplineRestriction.Continuity3d - continuity of the resulting surfaces and 3D curves.
6881                      * BSplineRestriction.Continuity2d - continuity of the resulting 2D curves.
6882                  * ToBezier - converts curves and surfaces of any type to Bezier curves and surfaces.
6883                      * ToBezier.SurfaceMode - if checked in, allows conversion of surfaces.
6884                      * ToBezier.Curve3dMode - if checked in, allows conversion of 3D curves.
6885                      * ToBezier.Curve2dMode - if checked in, allows conversion of 2D curves.
6886                      * ToBezier.MaxTolerance - defines tolerance for detection and correction of problems.
6887                  * SameParameter - fixes edges of 2D and 3D curves not having the same parameter.
6888                      * SameParameter.Tolerance3d - defines tolerance for fixing of edges.
6889
6890             Returns:
6891                 New GEOM.GEOM_Object, containing processed shape.
6892
6893             Note: For more information look through SALOME Geometry User's Guide->
6894                   -> Introduction to Geometry-> Repairing Operations-> Shape Processing
6895             """
6896             # Example: see GEOM_TestHealing.py
6897             theValues,Parameters = ParseList(theValues)
6898             anObj = self.HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
6899             # To avoid script failure in case of good argument shape
6900             if self.HealOp.GetErrorCode() == "ShHealOper_NotError_msg":
6901                 return theShape
6902             RaiseIfFailed("ProcessShape", self.HealOp)
6903             for string in (theOperators + theParameters):
6904                 Parameters = ":" + Parameters
6905                 pass
6906             anObj.SetParameters(Parameters)
6907             self._autoPublish(anObj, theName, "healed")
6908             return anObj
6909
6910         ## Remove faces from the given object (shape).
6911         #  @param theObject Shape to be processed.
6912         #  @param theFaces Indices of faces to be removed, if EMPTY then the method
6913         #                  removes ALL faces of the given object.
6914         #  @param theName Object name; when specified, this parameter is used
6915         #         for result publication in the study. Otherwise, if automatic
6916         #         publication is switched on, default value is used for result name.
6917         #
6918         #  @return New GEOM.GEOM_Object, containing processed shape.
6919         #
6920         #  @ref tui_suppress_faces "Example"
6921         @ManageTransactions("HealOp")
6922         def SuppressFaces(self, theObject, theFaces, theName=None):
6923             """
6924             Remove faces from the given object (shape).
6925
6926             Parameters:
6927                 theObject Shape to be processed.
6928                 theFaces Indices of faces to be removed, if EMPTY then the method
6929                          removes ALL faces of the given object.
6930                 theName Object name; when specified, this parameter is used
6931                         for result publication in the study. Otherwise, if automatic
6932                         publication is switched on, default value is used for result name.
6933
6934             Returns:
6935                 New GEOM.GEOM_Object, containing processed shape.
6936             """
6937             # Example: see GEOM_TestHealing.py
6938             anObj = self.HealOp.SuppressFaces(theObject, theFaces)
6939             RaiseIfFailed("SuppressFaces", self.HealOp)
6940             self._autoPublish(anObj, theName, "suppressFaces")
6941             return anObj
6942
6943         ## Sewing of faces into a single shell.
6944         #  @param ListShape Shapes to be processed.
6945         #  @param theTolerance Required tolerance value.
6946         #  @param AllowNonManifold Flag that allows non-manifold sewing.
6947         #  @param theName Object name; when specified, this parameter is used
6948         #         for result publication in the study. Otherwise, if automatic
6949         #         publication is switched on, default value is used for result name.
6950         #
6951         #  @return New GEOM.GEOM_Object, containing a result shell.
6952         #
6953         #  @ref tui_sewing "Example"
6954         def MakeSewing(self, ListShape, theTolerance, AllowNonManifold=False, theName=None):
6955             """
6956             Sewing of faces into a single shell.
6957
6958             Parameters:
6959                 ListShape Shapes to be processed.
6960                 theTolerance Required tolerance value.
6961                 AllowNonManifold Flag that allows non-manifold sewing.
6962                 theName Object name; when specified, this parameter is used
6963                         for result publication in the study. Otherwise, if automatic
6964                         publication is switched on, default value is used for result name.
6965
6966             Returns:
6967                 New GEOM.GEOM_Object, containing containing a result shell.
6968             """
6969             # Example: see GEOM_TestHealing.py
6970             # note: auto-publishing is done in self.Sew()
6971             anObj = self.Sew(ListShape, theTolerance, AllowNonManifold, theName)
6972             return anObj
6973
6974         ## Sewing of faces into a single shell.
6975         #  @param ListShape Shapes to be processed.
6976         #  @param theTolerance Required tolerance value.
6977         #  @param AllowNonManifold Flag that allows non-manifold sewing.
6978         #  @param theName Object name; when specified, this parameter is used
6979         #         for result publication in the study. Otherwise, if automatic
6980         #         publication is switched on, default value is used for result name.
6981         #
6982         #  @return New GEOM.GEOM_Object, containing a result shell.
6983         @ManageTransactions("HealOp")
6984         def Sew(self, ListShape, theTolerance, AllowNonManifold=False, theName=None):
6985             """
6986             Sewing of faces into a single shell.
6987
6988             Parameters:
6989                 ListShape Shapes to be processed.
6990                 theTolerance Required tolerance value.
6991                 AllowNonManifold Flag that allows non-manifold sewing.
6992                 theName Object name; when specified, this parameter is used
6993                         for result publication in the study. Otherwise, if automatic
6994                         publication is switched on, default value is used for result name.
6995
6996             Returns:
6997                 New GEOM.GEOM_Object, containing a result shell.
6998             """
6999             # Example: see MakeSewing() above
7000             theTolerance,Parameters = ParseParameters(theTolerance)
7001             if AllowNonManifold:
7002                 anObj = self.HealOp.SewAllowNonManifold( ToList( ListShape ), theTolerance)
7003             else:
7004                 anObj = self.HealOp.Sew( ToList( ListShape ), theTolerance)
7005             # To avoid script failure in case of good argument shape
7006             # (Fix of test cases geom/bugs11/L7,L8)
7007             if self.HealOp.GetErrorCode() == "ShHealOper_NotError_msg":
7008                 return anObj
7009             RaiseIfFailed("Sew", self.HealOp)
7010             anObj.SetParameters(Parameters)
7011             self._autoPublish(anObj, theName, "sewed")
7012             return anObj
7013
7014         ## Rebuild the topology of theSolids by removing
7015         #  the faces that are shared by several solids.
7016         #  @param theSolids A compound or a list of solids to be processed.
7017         #  @param theName Object name; when specified, this parameter is used
7018         #         for result publication in the study. Otherwise, if automatic
7019         #         publication is switched on, default value is used for result name.
7020         #
7021         #  @return New GEOM.GEOM_Object, containing processed shape.
7022         #
7023         #  @ref tui_remove_webs "Example"
7024         @ManageTransactions("HealOp")
7025         def RemoveInternalFaces (self, theSolids, theName=None):
7026             """
7027             Rebuild the topology of theSolids by removing
7028             the faces that are shared by several solids.
7029
7030             Parameters:
7031                 theSolids A compound or a list of solids to be processed.
7032                 theName Object name; when specified, this parameter is used
7033                         for result publication in the study. Otherwise, if automatic
7034                         publication is switched on, default value is used for result name.
7035
7036             Returns:
7037                 New GEOM.GEOM_Object, containing processed shape.
7038             """
7039             # Example: see GEOM_TestHealing.py
7040             anObj = self.HealOp.RemoveInternalFaces(ToList(theSolids))
7041             RaiseIfFailed("RemoveInternalFaces", self.HealOp)
7042             self._autoPublish(anObj, theName, "removeWebs")
7043             return anObj
7044
7045         ## Remove internal wires and edges from the given object (face).
7046         #  @param theObject Shape to be processed.
7047         #  @param theWires Indices of wires to be removed, if EMPTY then the method
7048         #                  removes ALL internal wires of the given object.
7049         #  @param theName Object name; when specified, this parameter is used
7050         #         for result publication in the study. Otherwise, if automatic
7051         #         publication is switched on, default value is used for result name.
7052         #
7053         #  @return New GEOM.GEOM_Object, containing processed shape.
7054         #
7055         #  @ref tui_suppress_internal_wires "Example"
7056         @ManageTransactions("HealOp")
7057         def SuppressInternalWires(self, theObject, theWires, theName=None):
7058             """
7059             Remove internal wires and edges from the given object (face).
7060
7061             Parameters:
7062                 theObject Shape to be processed.
7063                 theWires Indices of wires to be removed, if EMPTY then the method
7064                          removes ALL internal wires of the given object.
7065                 theName Object name; when specified, this parameter is used
7066                         for result publication in the study. Otherwise, if automatic
7067                         publication is switched on, default value is used for result name.
7068
7069             Returns:
7070                 New GEOM.GEOM_Object, containing processed shape.
7071             """
7072             # Example: see GEOM_TestHealing.py
7073             anObj = self.HealOp.RemoveIntWires(theObject, theWires)
7074             RaiseIfFailed("RemoveIntWires", self.HealOp)
7075             self._autoPublish(anObj, theName, "suppressWires")
7076             return anObj
7077
7078         ## Remove internal closed contours (holes) from the given object.
7079         #  @param theObject Shape to be processed.
7080         #  @param theWires Indices of wires to be removed, if EMPTY then the method
7081         #                  removes ALL internal holes of the given object
7082         #  @param theName Object name; when specified, this parameter is used
7083         #         for result publication in the study. Otherwise, if automatic
7084         #         publication is switched on, default value is used for result name.
7085         #
7086         #  @return New GEOM.GEOM_Object, containing processed shape.
7087         #
7088         #  @ref tui_suppress_holes "Example"
7089         @ManageTransactions("HealOp")
7090         def SuppressHoles(self, theObject, theWires, theName=None):
7091             """
7092             Remove internal closed contours (holes) from the given object.
7093
7094             Parameters:
7095                 theObject Shape to be processed.
7096                 theWires Indices of wires to be removed, if EMPTY then the method
7097                          removes ALL internal holes of the given object
7098                 theName Object name; when specified, this parameter is used
7099                         for result publication in the study. Otherwise, if automatic
7100                         publication is switched on, default value is used for result name.
7101
7102             Returns:
7103                 New GEOM.GEOM_Object, containing processed shape.
7104             """
7105             # Example: see GEOM_TestHealing.py
7106             anObj = self.HealOp.FillHoles(theObject, theWires)
7107             RaiseIfFailed("FillHoles", self.HealOp)
7108             self._autoPublish(anObj, theName, "suppressHoles")
7109             return anObj
7110
7111         ## Close an open wire.
7112         #  @param theObject Shape to be processed.
7113         #  @param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
7114         #                  if [ ], then <VAR>theObject</VAR> itself is a wire.
7115         #  @param isCommonVertex If True  : closure by creation of a common vertex,
7116         #                        If False : closure by creation of an edge between ends.
7117         #  @param theName Object name; when specified, this parameter is used
7118         #         for result publication in the study. Otherwise, if automatic
7119         #         publication is switched on, default value is used for result name.
7120         #
7121         #  @return New GEOM.GEOM_Object, containing processed shape.
7122         #
7123         #  @ref tui_close_contour "Example"
7124         @ManageTransactions("HealOp")
7125         def CloseContour(self,theObject, theWires, isCommonVertex, theName=None):
7126             """
7127             Close an open wire.
7128
7129             Parameters:
7130                 theObject Shape to be processed.
7131                 theWires Indexes of edge(s) and wire(s) to be closed within theObject's shape,
7132                          if [ ], then theObject itself is a wire.
7133                 isCommonVertex If True  : closure by creation of a common vertex,
7134                                If False : closure by creation of an edge between ends.
7135                 theName Object name; when specified, this parameter is used
7136                         for result publication in the study. Otherwise, if automatic
7137                         publication is switched on, default value is used for result name.
7138
7139             Returns:
7140                 New GEOM.GEOM_Object, containing processed shape.
7141             """
7142             # Example: see GEOM_TestHealing.py
7143             anObj = self.HealOp.CloseContour(theObject, theWires, isCommonVertex)
7144             RaiseIfFailed("CloseContour", self.HealOp)
7145             self._autoPublish(anObj, theName, "closeContour")
7146             return anObj
7147
7148         ## Addition of a point to a given edge object.
7149         #  @param theObject Shape to be processed.
7150         #  @param theEdgeIndex Index of edge to be divided within theObject's shape,
7151         #                      if -1, then theObject itself is the edge.
7152         #  @param theValue Value of parameter on edge or length parameter,
7153         #                  depending on \a isByParameter.
7154         #  @param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1], \n
7155         #                       if FALSE : \a theValue is treated as a length parameter [0..1]
7156         #  @param theName Object name; when specified, this parameter is used
7157         #         for result publication in the study. Otherwise, if automatic
7158         #         publication is switched on, default value is used for result name.
7159         #
7160         #  @return New GEOM.GEOM_Object, containing processed shape.
7161         #
7162         #  @ref tui_add_point_on_edge "Example"
7163         @ManageTransactions("HealOp")
7164         def DivideEdge(self, theObject, theEdgeIndex, theValue, isByParameter, theName=None):
7165             """
7166             Addition of a point to a given edge object.
7167
7168             Parameters:
7169                 theObject Shape to be processed.
7170                 theEdgeIndex Index of edge to be divided within theObject's shape,
7171                              if -1, then theObject itself is the edge.
7172                 theValue Value of parameter on edge or length parameter,
7173                          depending on isByParameter.
7174                 isByParameter If TRUE :  theValue is treated as a curve parameter [0..1],
7175                               if FALSE : theValue is treated as a length parameter [0..1]
7176                 theName Object name; when specified, this parameter is used
7177                         for result publication in the study. Otherwise, if automatic
7178                         publication is switched on, default value is used for result name.
7179
7180             Returns:
7181                 New GEOM.GEOM_Object, containing processed shape.
7182             """
7183             # Example: see GEOM_TestHealing.py
7184             theEdgeIndex,theValue,isByParameter,Parameters = ParseParameters(theEdgeIndex,theValue,isByParameter)
7185             anObj = self.HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
7186             RaiseIfFailed("DivideEdge", self.HealOp)
7187             anObj.SetParameters(Parameters)
7188             self._autoPublish(anObj, theName, "divideEdge")
7189             return anObj
7190
7191         ## Addition of points to a given edge of \a theObject by projecting
7192         #  other points to the given edge.
7193         #  @param theObject Shape to be processed.
7194         #  @param theEdgeIndex Index of edge to be divided within theObject's shape,
7195         #                      if -1, then theObject itself is the edge.
7196         #  @param thePoints List of points to project to theEdgeIndex-th edge.
7197         #  @param theName Object name; when specified, this parameter is used
7198         #         for result publication in the study. Otherwise, if automatic
7199         #         publication is switched on, default value is used for result name.
7200         #
7201         #  @return New GEOM.GEOM_Object, containing processed shape.
7202         #
7203         #  @ref tui_add_point_on_edge "Example"
7204         @ManageTransactions("HealOp")
7205         def DivideEdgeByPoint(self, theObject, theEdgeIndex, thePoints, theName=None):
7206             """
7207             Addition of points to a given edge of \a theObject by projecting
7208             other points to the given edge.
7209
7210             Parameters:
7211                 theObject Shape to be processed.
7212                 theEdgeIndex The edge or its index to be divided within theObject's shape,
7213                              if -1, then theObject itself is the edge.
7214                 thePoints List of points to project to theEdgeIndex-th edge.
7215                 theName Object name; when specified, this parameter is used
7216                         for result publication in the study. Otherwise, if automatic
7217                         publication is switched on, default value is used for result name.
7218
7219             Returns:
7220                 New GEOM.GEOM_Object, containing processed shape.
7221             """
7222             # Example: see GEOM_TestHealing.py
7223             if isinstance( theEdgeIndex, GEOM._objref_GEOM_Object ):
7224                 theEdgeIndex = self.GetSubShapeID( theObject, theEdgeIndex )
7225             anObj = self.HealOp.DivideEdgeByPoint(theObject, theEdgeIndex, ToList( thePoints ))
7226             RaiseIfFailed("DivideEdgeByPoint", self.HealOp)
7227             self._autoPublish(anObj, theName, "divideEdge")
7228             return anObj
7229
7230         ## Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
7231         #  @param theWire Wire to minimize the number of C1 continuous edges in.
7232         #  @param theVertices A list of vertices to suppress. If the list
7233         #                     is empty, all vertices in a wire will be assumed.
7234         #  @param theName Object name; when specified, this parameter is used
7235         #         for result publication in the study. Otherwise, if automatic
7236         #         publication is switched on, default value is used for result name.
7237         #
7238         #  @return New GEOM.GEOM_Object with modified wire.
7239         #
7240         #  @ref tui_fuse_collinear_edges "Example"
7241         @ManageTransactions("HealOp")
7242         def FuseCollinearEdgesWithinWire(self, theWire, theVertices = [], theName=None):
7243             """
7244             Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
7245
7246             Parameters:
7247                 theWire Wire to minimize the number of C1 continuous edges in.
7248                 theVertices A list of vertices to suppress. If the list
7249                             is empty, all vertices in a wire will be assumed.
7250                 theName Object name; when specified, this parameter is used
7251                         for result publication in the study. Otherwise, if automatic
7252                         publication is switched on, default value is used for result name.
7253
7254             Returns:
7255                 New GEOM.GEOM_Object with modified wire.
7256             """
7257             anObj = self.HealOp.FuseCollinearEdgesWithinWire(theWire, theVertices)
7258             RaiseIfFailed("FuseCollinearEdgesWithinWire", self.HealOp)
7259             self._autoPublish(anObj, theName, "fuseEdges")
7260             return anObj
7261
7262         ## Change orientation of the given object. Updates given shape.
7263         #  @param theObject Shape to be processed.
7264         #  @return Updated <var>theObject</var>
7265         #
7266         #  @ref swig_todo "Example"
7267         @ManageTransactions("HealOp")
7268         def ChangeOrientationShell(self,theObject):
7269             """
7270             Change orientation of the given object. Updates given shape.
7271
7272             Parameters:
7273                 theObject Shape to be processed.
7274
7275             Returns:
7276                 Updated theObject
7277             """
7278             theObject = self.HealOp.ChangeOrientation(theObject)
7279             RaiseIfFailed("ChangeOrientation", self.HealOp)
7280             pass
7281
7282         ## Change orientation of the given object.
7283         #  @param theObject Shape to be processed.
7284         #  @param theName Object name; when specified, this parameter is used
7285         #         for result publication in the study. Otherwise, if automatic
7286         #         publication is switched on, default value is used for result name.
7287         #
7288         #  @return New GEOM.GEOM_Object, containing processed shape.
7289         #
7290         #  @ref swig_todo "Example"
7291         @ManageTransactions("HealOp")
7292         def ChangeOrientationShellCopy(self, theObject, theName=None):
7293             """
7294             Change orientation of the given object.
7295
7296             Parameters:
7297                 theObject Shape to be processed.
7298                 theName Object name; when specified, this parameter is used
7299                         for result publication in the study. Otherwise, if automatic
7300                         publication is switched on, default value is used for result name.
7301
7302             Returns:
7303                 New GEOM.GEOM_Object, containing processed shape.
7304             """
7305             anObj = self.HealOp.ChangeOrientationCopy(theObject)
7306             RaiseIfFailed("ChangeOrientationCopy", self.HealOp)
7307             self._autoPublish(anObj, theName, "reversed")
7308             return anObj
7309
7310         ## Try to limit tolerance of the given object by value \a theTolerance.
7311         #  @param theObject Shape to be processed.
7312         #  @param theTolerance Required tolerance value.
7313         #  @param theName Object name; when specified, this parameter is used
7314         #         for result publication in the study. Otherwise, if automatic
7315         #         publication is switched on, default value is used for result name.
7316         #
7317         #  @return New GEOM.GEOM_Object, containing processed shape.
7318         #
7319         #  @ref tui_limit_tolerance "Example"
7320         @ManageTransactions("HealOp")
7321         def LimitTolerance(self, theObject, theTolerance = 1e-07, theName=None):
7322             """
7323             Try to limit tolerance of the given object by value theTolerance.
7324
7325             Parameters:
7326                 theObject Shape to be processed.
7327                 theTolerance Required tolerance value.
7328                 theName Object name; when specified, this parameter is used
7329                         for result publication in the study. Otherwise, if automatic
7330                         publication is switched on, default value is used for result name.
7331
7332             Returns:
7333                 New GEOM.GEOM_Object, containing processed shape.
7334             """
7335             anObj = self.HealOp.LimitTolerance(theObject, theTolerance)
7336             RaiseIfFailed("LimitTolerance", self.HealOp)
7337             self._autoPublish(anObj, theName, "limitTolerance")
7338             return anObj
7339
7340         ## Get a list of wires (wrapped in GEOM.GEOM_Object-s),
7341         #  that constitute a free boundary of the given shape.
7342         #  @param theObject Shape to get free boundary of.
7343         #  @param theName Object name; when specified, this parameter is used
7344         #         for result publication in the study. Otherwise, if automatic
7345         #         publication is switched on, default value is used for result name.
7346         #
7347         #  @return [\a status, \a theClosedWires, \a theOpenWires]
7348         #  \n \a status: FALSE, if an error(s) occured during the method execution.
7349         #  \n \a theClosedWires: Closed wires on the free boundary of the given shape.
7350         #  \n \a theOpenWires: Open wires on the free boundary of the given shape.
7351         #
7352         #  @ref tui_free_boundaries_page "Example"
7353         @ManageTransactions("HealOp")
7354         def GetFreeBoundary(self, theObject, theName=None):
7355             """
7356             Get a list of wires (wrapped in GEOM.GEOM_Object-s),
7357             that constitute a free boundary of the given shape.
7358
7359             Parameters:
7360                 theObject Shape to get free boundary of.
7361                 theName Object name; when specified, this parameter is used
7362                         for result publication in the study. Otherwise, if automatic
7363                         publication is switched on, default value is used for result name.
7364
7365             Returns:
7366                 [status, theClosedWires, theOpenWires]
7367                  status: FALSE, if an error(s) occured during the method execution.
7368                  theClosedWires: Closed wires on the free boundary of the given shape.
7369                  theOpenWires: Open wires on the free boundary of the given shape.
7370             """
7371             # Example: see GEOM_TestHealing.py
7372             anObj = self.HealOp.GetFreeBoundary( ToList( theObject ))
7373             RaiseIfFailed("GetFreeBoundary", self.HealOp)
7374             self._autoPublish(anObj[1], theName, "closedWire")
7375             self._autoPublish(anObj[2], theName, "openWire")
7376             return anObj
7377
7378         ## Replace coincident faces in \a theShapes by one face.
7379         #  @param theShapes Initial shapes, either a list or compound of shapes.
7380         #  @param theTolerance Maximum distance between faces, which can be considered as coincident.
7381         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
7382         #                         otherwise all initial shapes.
7383         #  @param theName Object name; when specified, this parameter is used
7384         #         for result publication in the study. Otherwise, if automatic
7385         #         publication is switched on, default value is used for result name.
7386         #
7387         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7388         #
7389         #  @ref tui_glue_faces "Example"
7390         @ManageTransactions("ShapesOp")
7391         def MakeGlueFaces(self, theShapes, theTolerance, doKeepNonSolids=True, theName=None):
7392             """
7393             Replace coincident faces in theShapes by one face.
7394
7395             Parameters:
7396                 theShapes Initial shapes, either a list or compound of shapes.
7397                 theTolerance Maximum distance between faces, which can be considered as coincident.
7398                 doKeepNonSolids If FALSE, only solids will present in the result,
7399                                 otherwise all initial shapes.
7400                 theName Object name; when specified, this parameter is used
7401                         for result publication in the study. Otherwise, if automatic
7402                         publication is switched on, default value is used for result name.
7403
7404             Returns:
7405                 New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7406             """
7407             # Example: see GEOM_Spanner.py
7408             theTolerance,Parameters = ParseParameters(theTolerance)
7409             anObj = self.ShapesOp.MakeGlueFaces(ToList(theShapes), theTolerance, doKeepNonSolids)
7410             if anObj is None:
7411                 raise RuntimeError, "MakeGlueFaces : " + self.ShapesOp.GetErrorCode()
7412             anObj.SetParameters(Parameters)
7413             self._autoPublish(anObj, theName, "glueFaces")
7414             return anObj
7415
7416         ## Find coincident faces in \a theShapes for possible gluing.
7417         #  @param theShapes Initial shapes, either a list or compound of shapes.
7418         #  @param theTolerance Maximum distance between faces,
7419         #                      which can be considered as coincident.
7420         #  @param theName Object name; when specified, this parameter is used
7421         #         for result publication in the study. Otherwise, if automatic
7422         #         publication is switched on, default value is used for result name.
7423         #
7424         #  @return GEOM.ListOfGO
7425         #
7426         #  @ref tui_glue_faces "Example"
7427         @ManageTransactions("ShapesOp")
7428         def GetGlueFaces(self, theShapes, theTolerance, theName=None):
7429             """
7430             Find coincident faces in theShapes for possible gluing.
7431
7432             Parameters:
7433                 theShapes Initial shapes, either a list or compound of shapes.
7434                 theTolerance Maximum distance between faces,
7435                              which can be considered as coincident.
7436                 theName Object name; when specified, this parameter is used
7437                         for result publication in the study. Otherwise, if automatic
7438                         publication is switched on, default value is used for result name.
7439
7440             Returns:
7441                 GEOM.ListOfGO
7442             """
7443             anObj = self.ShapesOp.GetGlueFaces(ToList(theShapes), theTolerance)
7444             RaiseIfFailed("GetGlueFaces", self.ShapesOp)
7445             self._autoPublish(anObj, theName, "facesToGlue")
7446             return anObj
7447
7448         ## Replace coincident faces in \a theShapes by one face
7449         #  in compliance with given list of faces
7450         #  @param theShapes Initial shapes, either a list or compound of shapes.
7451         #  @param theTolerance Maximum distance between faces,
7452         #                      which can be considered as coincident.
7453         #  @param theFaces List of faces for gluing.
7454         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
7455         #                         otherwise all initial shapes.
7456         #  @param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
7457         #                        will be glued, otherwise only the edges,
7458         #                        belonging to <VAR>theFaces</VAR>.
7459         #  @param theName Object name; when specified, this parameter is used
7460         #         for result publication in the study. Otherwise, if automatic
7461         #         publication is switched on, default value is used for result name.
7462         #
7463         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7464         #
7465         #  @ref tui_glue_faces "Example"
7466         @ManageTransactions("ShapesOp")
7467         def MakeGlueFacesByList(self, theShapes, theTolerance, theFaces,
7468                                 doKeepNonSolids=True, doGlueAllEdges=True, theName=None):
7469             """
7470             Replace coincident faces in theShapes by one face
7471             in compliance with given list of faces
7472
7473             Parameters:
7474                 theShapes theShapes Initial shapes, either a list or compound of shapes.
7475                 theTolerance Maximum distance between faces,
7476                              which can be considered as coincident.
7477                 theFaces List of faces for gluing.
7478                 doKeepNonSolids If FALSE, only solids will present in the result,
7479                                 otherwise all initial shapes.
7480                 doGlueAllEdges If TRUE, all coincident edges of theShape
7481                                will be glued, otherwise only the edges,
7482                                belonging to theFaces.
7483                 theName Object name; when specified, this parameter is used
7484                         for result publication in the study. Otherwise, if automatic
7485                         publication is switched on, default value is used for result name.
7486
7487             Returns:
7488                 New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7489             """
7490             anObj = self.ShapesOp.MakeGlueFacesByList(ToList(theShapes), theTolerance, ToList(theFaces),
7491                                                       doKeepNonSolids, doGlueAllEdges)
7492             if anObj is None:
7493                 raise RuntimeError, "MakeGlueFacesByList : " + self.ShapesOp.GetErrorCode()
7494             self._autoPublish(anObj, theName, "glueFaces")
7495             return anObj
7496
7497         ## Replace coincident edges in \a theShapes by one edge.
7498         #  @param theShapes Initial shapes, either a list or compound of shapes.
7499         #  @param theTolerance Maximum distance between edges, which can be considered as coincident.
7500         #  @param theName Object name; when specified, this parameter is used
7501         #         for result publication in the study. Otherwise, if automatic
7502         #         publication is switched on, default value is used for result name.
7503         #
7504         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7505         #
7506         #  @ref tui_glue_edges "Example"
7507         @ManageTransactions("ShapesOp")
7508         def MakeGlueEdges(self, theShapes, theTolerance, theName=None):
7509             """
7510             Replace coincident edges in theShapes by one edge.
7511
7512             Parameters:
7513                 theShapes Initial shapes, either a list or compound of shapes.
7514                 theTolerance Maximum distance between edges, which can be considered as coincident.
7515                 theName Object name; when specified, this parameter is used
7516                         for result publication in the study. Otherwise, if automatic
7517                         publication is switched on, default value is used for result name.
7518
7519             Returns:
7520                 New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7521             """
7522             theTolerance,Parameters = ParseParameters(theTolerance)
7523             anObj = self.ShapesOp.MakeGlueEdges(ToList(theShapes), theTolerance)
7524             if anObj is None:
7525                 raise RuntimeError, "MakeGlueEdges : " + self.ShapesOp.GetErrorCode()
7526             anObj.SetParameters(Parameters)
7527             self._autoPublish(anObj, theName, "glueEdges")
7528             return anObj
7529
7530         ## Find coincident edges in \a theShapes for possible gluing.
7531         #  @param theShapes Initial shapes, either a list or compound of shapes.
7532         #  @param theTolerance Maximum distance between edges,
7533         #                      which can be considered as coincident.
7534         #  @param theName Object name; when specified, this parameter is used
7535         #         for result publication in the study. Otherwise, if automatic
7536         #         publication is switched on, default value is used for result name.
7537         #
7538         #  @return GEOM.ListOfGO
7539         #
7540         #  @ref tui_glue_edges "Example"
7541         @ManageTransactions("ShapesOp")
7542         def GetGlueEdges(self, theShapes, theTolerance, theName=None):
7543             """
7544             Find coincident edges in theShapes for possible gluing.
7545
7546             Parameters:
7547                 theShapes Initial shapes, either a list or compound of shapes.
7548                 theTolerance Maximum distance between edges,
7549                              which can be considered as coincident.
7550                 theName Object name; when specified, this parameter is used
7551                         for result publication in the study. Otherwise, if automatic
7552                         publication is switched on, default value is used for result name.
7553
7554             Returns:
7555                 GEOM.ListOfGO
7556             """
7557             anObj = self.ShapesOp.GetGlueEdges(ToList(theShapes), theTolerance)
7558             RaiseIfFailed("GetGlueEdges", self.ShapesOp)
7559             self._autoPublish(anObj, theName, "edgesToGlue")
7560             return anObj
7561
7562         ## Replace coincident edges in theShapes by one edge
7563         #  in compliance with given list of edges.
7564         #  @param theShapes Initial shapes, either a list or compound of shapes.
7565         #  @param theTolerance Maximum distance between edges,
7566         #                      which can be considered as coincident.
7567         #  @param theEdges List of edges for gluing.
7568         #  @param theName Object name; when specified, this parameter is used
7569         #         for result publication in the study. Otherwise, if automatic
7570         #         publication is switched on, default value is used for result name.
7571         #
7572         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7573         #
7574         #  @ref tui_glue_edges "Example"
7575         @ManageTransactions("ShapesOp")
7576         def MakeGlueEdgesByList(self, theShapes, theTolerance, theEdges, theName=None):
7577             """
7578             Replace coincident edges in theShapes by one edge
7579             in compliance with given list of edges.
7580
7581             Parameters:
7582                 theShapes Initial shapes, either a list or compound of shapes.
7583                 theTolerance Maximum distance between edges,
7584                              which can be considered as coincident.
7585                 theEdges List of edges for gluing.
7586                 theName Object name; when specified, this parameter is used
7587                         for result publication in the study. Otherwise, if automatic
7588                         publication is switched on, default value is used for result name.
7589
7590             Returns:
7591                 New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7592             """
7593             anObj = self.ShapesOp.MakeGlueEdgesByList(ToList(theShapes), theTolerance, theEdges)
7594             if anObj is None:
7595                 raise RuntimeError, "MakeGlueEdgesByList : " + self.ShapesOp.GetErrorCode()
7596             self._autoPublish(anObj, theName, "glueEdges")
7597             return anObj
7598
7599         # end of l3_healing
7600         ## @}
7601
7602         ## @addtogroup l3_boolean Boolean Operations
7603         ## @{
7604
7605         # -----------------------------------------------------------------------------
7606         # Boolean (Common, Cut, Fuse, Section)
7607         # -----------------------------------------------------------------------------
7608
7609         ## Perform one of boolean operations on two given shapes.
7610         #  @param theShape1 First argument for boolean operation.
7611         #  @param theShape2 Second argument for boolean operation.
7612         #  @param theOperation Indicates the operation to be done:\n
7613         #                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
7614         #  @param checkSelfInte The flag that tells if the arguments should
7615         #         be checked for self-intersection prior to the operation.
7616         #  @param theName Object name; when specified, this parameter is used
7617         #         for result publication in the study. Otherwise, if automatic
7618         #         publication is switched on, default value is used for result name.
7619         #
7620         #  @note This algorithm doesn't find all types of self-intersections.
7621         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7622         #        vertex/face and edge/face intersections. Face/face
7623         #        intersections detection is switched off as it is a
7624         #        time-consuming operation that gives an impact on performance.
7625         #        To find all self-intersections please use
7626         #        CheckSelfIntersections() method.
7627         #
7628         #  @return New GEOM.GEOM_Object, containing the result shape.
7629         #
7630         #  @ref tui_fuse "Example"
7631         @ManageTransactions("BoolOp")
7632         def MakeBoolean(self, theShape1, theShape2, theOperation, checkSelfInte=False, theName=None):
7633             """
7634             Perform one of boolean operations on two given shapes.
7635
7636             Parameters:
7637                 theShape1 First argument for boolean operation.
7638                 theShape2 Second argument for boolean operation.
7639                 theOperation Indicates the operation to be done:
7640                              1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
7641                 checkSelfInte The flag that tells if the arguments should
7642                               be checked for self-intersection prior to
7643                               the operation.
7644                 theName Object name; when specified, this parameter is used
7645                         for result publication in the study. Otherwise, if automatic
7646                         publication is switched on, default value is used for result name.
7647
7648             Note:
7649                     This algorithm doesn't find all types of self-intersections.
7650                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7651                     vertex/face and edge/face intersections. Face/face
7652                     intersections detection is switched off as it is a
7653                     time-consuming operation that gives an impact on performance.
7654                     To find all self-intersections please use
7655                     CheckSelfIntersections() method.
7656
7657             Returns:
7658                 New GEOM.GEOM_Object, containing the result shape.
7659             """
7660             # Example: see GEOM_TestAll.py
7661             anObj = self.BoolOp.MakeBoolean(theShape1, theShape2, theOperation, checkSelfInte)
7662             RaiseIfFailed("MakeBoolean", self.BoolOp)
7663             def_names = { 1: "common", 2: "cut", 3: "fuse", 4: "section" }
7664             self._autoPublish(anObj, theName, def_names[theOperation])
7665             return anObj
7666
7667         ## Perform Common boolean operation on two given shapes.
7668         #  @param theShape1 First argument for boolean operation.
7669         #  @param theShape2 Second argument for boolean operation.
7670         #  @param checkSelfInte The flag that tells if the arguments should
7671         #         be checked for self-intersection prior to the operation.
7672         #  @param theName Object name; when specified, this parameter is used
7673         #         for result publication in the study. Otherwise, if automatic
7674         #         publication is switched on, default value is used for result name.
7675         #
7676         #  @note This algorithm doesn't find all types of self-intersections.
7677         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7678         #        vertex/face and edge/face intersections. Face/face
7679         #        intersections detection is switched off as it is a
7680         #        time-consuming operation that gives an impact on performance.
7681         #        To find all self-intersections please use
7682         #        CheckSelfIntersections() method.
7683         #
7684         #  @return New GEOM.GEOM_Object, containing the result shape.
7685         #
7686         #  @ref tui_common "Example 1"
7687         #  \n @ref swig_MakeCommon "Example 2"
7688         def MakeCommon(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7689             """
7690             Perform Common boolean operation on two given shapes.
7691
7692             Parameters:
7693                 theShape1 First argument for boolean operation.
7694                 theShape2 Second argument for boolean operation.
7695                 checkSelfInte The flag that tells if the arguments should
7696                               be checked for self-intersection prior to
7697                               the operation.
7698                 theName Object name; when specified, this parameter is used
7699                         for result publication in the study. Otherwise, if automatic
7700                         publication is switched on, default value is used for result name.
7701
7702             Note:
7703                     This algorithm doesn't find all types of self-intersections.
7704                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7705                     vertex/face and edge/face intersections. Face/face
7706                     intersections detection is switched off as it is a
7707                     time-consuming operation that gives an impact on performance.
7708                     To find all self-intersections please use
7709                     CheckSelfIntersections() method.
7710
7711             Returns:
7712                 New GEOM.GEOM_Object, containing the result shape.
7713             """
7714             # Example: see GEOM_TestOthers.py
7715             # note: auto-publishing is done in self.MakeBoolean()
7716             return self.MakeBoolean(theShape1, theShape2, 1, checkSelfInte, theName)
7717
7718         ## Perform Cut boolean operation on two given shapes.
7719         #  @param theShape1 First argument for boolean operation.
7720         #  @param theShape2 Second argument for boolean operation.
7721         #  @param checkSelfInte The flag that tells if the arguments should
7722         #         be checked for self-intersection prior to the operation.
7723         #  @param theName Object name; when specified, this parameter is used
7724         #         for result publication in the study. Otherwise, if automatic
7725         #         publication is switched on, default value is used for result name.
7726         #
7727         #  @note This algorithm doesn't find all types of self-intersections.
7728         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7729         #        vertex/face and edge/face intersections. Face/face
7730         #        intersections detection is switched off as it is a
7731         #        time-consuming operation that gives an impact on performance.
7732         #        To find all self-intersections please use
7733         #        CheckSelfIntersections() method.
7734         #
7735         #  @return New GEOM.GEOM_Object, containing the result shape.
7736         #
7737         #  @ref tui_cut "Example 1"
7738         #  \n @ref swig_MakeCommon "Example 2"
7739         def MakeCut(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7740             """
7741             Perform Cut boolean operation on two given shapes.
7742
7743             Parameters:
7744                 theShape1 First argument for boolean operation.
7745                 theShape2 Second argument for boolean operation.
7746                 checkSelfInte The flag that tells if the arguments should
7747                               be checked for self-intersection prior to
7748                               the operation.
7749                 theName Object name; when specified, this parameter is used
7750                         for result publication in the study. Otherwise, if automatic
7751                         publication is switched on, default value is used for result name.
7752
7753             Note:
7754                     This algorithm doesn't find all types of self-intersections.
7755                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7756                     vertex/face and edge/face intersections. Face/face
7757                     intersections detection is switched off as it is a
7758                     time-consuming operation that gives an impact on performance.
7759                     To find all self-intersections please use
7760                     CheckSelfIntersections() method.
7761
7762             Returns:
7763                 New GEOM.GEOM_Object, containing the result shape.
7764
7765             """
7766             # Example: see GEOM_TestOthers.py
7767             # note: auto-publishing is done in self.MakeBoolean()
7768             return self.MakeBoolean(theShape1, theShape2, 2, checkSelfInte, theName)
7769
7770         ## Perform Fuse boolean operation on two given shapes.
7771         #  @param theShape1 First argument for boolean operation.
7772         #  @param theShape2 Second argument for boolean operation.
7773         #  @param checkSelfInte The flag that tells if the arguments should
7774         #         be checked for self-intersection prior to the operation.
7775         #  @param rmExtraEdges The flag that tells if Remove Extra Edges
7776         #         operation should be performed during the operation.
7777         #  @param theName Object name; when specified, this parameter is used
7778         #         for result publication in the study. Otherwise, if automatic
7779         #         publication is switched on, default value is used for result name.
7780         #
7781         #  @note This algorithm doesn't find all types of self-intersections.
7782         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7783         #        vertex/face and edge/face intersections. Face/face
7784         #        intersections detection is switched off as it is a
7785         #        time-consuming operation that gives an impact on performance.
7786         #        To find all self-intersections please use
7787         #        CheckSelfIntersections() method.
7788         #
7789         #  @return New GEOM.GEOM_Object, containing the result shape.
7790         #
7791         #  @ref tui_fuse "Example 1"
7792         #  \n @ref swig_MakeCommon "Example 2"
7793         @ManageTransactions("BoolOp")
7794         def MakeFuse(self, theShape1, theShape2, checkSelfInte=False,
7795                      rmExtraEdges=False, theName=None):
7796             """
7797             Perform Fuse boolean operation on two given shapes.
7798
7799             Parameters:
7800                 theShape1 First argument for boolean operation.
7801                 theShape2 Second argument for boolean operation.
7802                 checkSelfInte The flag that tells if the arguments should
7803                               be checked for self-intersection prior to
7804                               the operation.
7805                 rmExtraEdges The flag that tells if Remove Extra Edges
7806                              operation should be performed during the operation.
7807                 theName Object name; when specified, this parameter is used
7808                         for result publication in the study. Otherwise, if automatic
7809                         publication is switched on, default value is used for result name.
7810
7811             Note:
7812                     This algorithm doesn't find all types of self-intersections.
7813                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7814                     vertex/face and edge/face intersections. Face/face
7815                     intersections detection is switched off as it is a
7816                     time-consuming operation that gives an impact on performance.
7817                     To find all self-intersections please use
7818                     CheckSelfIntersections() method.
7819
7820             Returns:
7821                 New GEOM.GEOM_Object, containing the result shape.
7822
7823             """
7824             # Example: see GEOM_TestOthers.py
7825             anObj = self.BoolOp.MakeFuse(theShape1, theShape2,
7826                                          checkSelfInte, rmExtraEdges)
7827             RaiseIfFailed("MakeFuse", self.BoolOp)
7828             self._autoPublish(anObj, theName, "fuse")
7829             return anObj
7830
7831         ## Perform Section boolean operation on two given shapes.
7832         #  @param theShape1 First argument for boolean operation.
7833         #  @param theShape2 Second argument for boolean operation.
7834         #  @param checkSelfInte The flag that tells if the arguments should
7835         #         be checked for self-intersection prior to the operation.
7836         #         If a self-intersection detected the operation fails.
7837         #  @param theName Object name; when specified, this parameter is used
7838         #         for result publication in the study. Otherwise, if automatic
7839         #         publication is switched on, default value is used for result name.
7840         #  @return New GEOM.GEOM_Object, containing the result shape.
7841         #
7842         #  @ref tui_section "Example 1"
7843         #  \n @ref swig_MakeCommon "Example 2"
7844         def MakeSection(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7845             """
7846             Perform Section boolean operation on two given shapes.
7847
7848             Parameters:
7849                 theShape1 First argument for boolean operation.
7850                 theShape2 Second argument for boolean operation.
7851                 checkSelfInte The flag that tells if the arguments should
7852                               be checked for self-intersection prior to the operation.
7853                               If a self-intersection detected the operation fails.
7854                 theName Object name; when specified, this parameter is used
7855                         for result publication in the study. Otherwise, if automatic
7856                         publication is switched on, default value is used for result name.
7857             Returns:
7858                 New GEOM.GEOM_Object, containing the result shape.
7859
7860             """
7861             # Example: see GEOM_TestOthers.py
7862             # note: auto-publishing is done in self.MakeBoolean()
7863             return self.MakeBoolean(theShape1, theShape2, 4, checkSelfInte, theName)
7864
7865         ## Perform Fuse boolean operation on the list of shapes.
7866         #  @param theShapesList Shapes to be fused.
7867         #  @param checkSelfInte The flag that tells if the arguments should
7868         #         be checked for self-intersection prior to the operation.
7869         #  @param rmExtraEdges The flag that tells if Remove Extra Edges
7870         #         operation should be performed during the operation.
7871         #  @param theName Object name; when specified, this parameter is used
7872         #         for result publication in the study. Otherwise, if automatic
7873         #         publication is switched on, default value is used for result name.
7874         #
7875         #  @note This algorithm doesn't find all types of self-intersections.
7876         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7877         #        vertex/face and edge/face intersections. Face/face
7878         #        intersections detection is switched off as it is a
7879         #        time-consuming operation that gives an impact on performance.
7880         #        To find all self-intersections please use
7881         #        CheckSelfIntersections() method.
7882         #
7883         #  @return New GEOM.GEOM_Object, containing the result shape.
7884         #
7885         #  @ref tui_fuse "Example 1"
7886         #  \n @ref swig_MakeCommon "Example 2"
7887         @ManageTransactions("BoolOp")
7888         def MakeFuseList(self, theShapesList, checkSelfInte=False,
7889                          rmExtraEdges=False, theName=None):
7890             """
7891             Perform Fuse boolean operation on the list of shapes.
7892
7893             Parameters:
7894                 theShapesList Shapes to be fused.
7895                 checkSelfInte The flag that tells if the arguments should
7896                               be checked for self-intersection prior to
7897                               the operation.
7898                 rmExtraEdges The flag that tells if Remove Extra Edges
7899                              operation should be performed during the operation.
7900                 theName Object name; when specified, this parameter is used
7901                         for result publication in the study. Otherwise, if automatic
7902                         publication is switched on, default value is used for result name.
7903
7904             Note:
7905                     This algorithm doesn't find all types of self-intersections.
7906                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7907                     vertex/face and edge/face intersections. Face/face
7908                     intersections detection is switched off as it is a
7909                     time-consuming operation that gives an impact on performance.
7910                     To find all self-intersections please use
7911                     CheckSelfIntersections() method.
7912
7913             Returns:
7914                 New GEOM.GEOM_Object, containing the result shape.
7915
7916             """
7917             # Example: see GEOM_TestOthers.py
7918             anObj = self.BoolOp.MakeFuseList(theShapesList, checkSelfInte,
7919                                              rmExtraEdges)
7920             RaiseIfFailed("MakeFuseList", self.BoolOp)
7921             self._autoPublish(anObj, theName, "fuse")
7922             return anObj
7923
7924         ## Perform Common boolean operation on the list of shapes.
7925         #  @param theShapesList Shapes for Common operation.
7926         #  @param checkSelfInte The flag that tells if the arguments should
7927         #         be checked for self-intersection prior to the operation.
7928         #  @param theName Object name; when specified, this parameter is used
7929         #         for result publication in the study. Otherwise, if automatic
7930         #         publication is switched on, default value is used for result name.
7931         #
7932         #  @note This algorithm doesn't find all types of self-intersections.
7933         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7934         #        vertex/face and edge/face intersections. Face/face
7935         #        intersections detection is switched off as it is a
7936         #        time-consuming operation that gives an impact on performance.
7937         #        To find all self-intersections please use
7938         #        CheckSelfIntersections() method.
7939         #
7940         #  @return New GEOM.GEOM_Object, containing the result shape.
7941         #
7942         #  @ref tui_common "Example 1"
7943         #  \n @ref swig_MakeCommon "Example 2"
7944         @ManageTransactions("BoolOp")
7945         def MakeCommonList(self, theShapesList, checkSelfInte=False, theName=None):
7946             """
7947             Perform Common boolean operation on the list of shapes.
7948
7949             Parameters:
7950                 theShapesList Shapes for Common operation.
7951                 checkSelfInte The flag that tells if the arguments should
7952                               be checked for self-intersection prior to
7953                               the operation.
7954                 theName Object name; when specified, this parameter is used
7955                         for result publication in the study. Otherwise, if automatic
7956                         publication is switched on, default value is used for result name.
7957
7958             Note:
7959                     This algorithm doesn't find all types of self-intersections.
7960                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7961                     vertex/face and edge/face intersections. Face/face
7962                     intersections detection is switched off as it is a
7963                     time-consuming operation that gives an impact on performance.
7964                     To find all self-intersections please use
7965                     CheckSelfIntersections() method.
7966
7967             Returns:
7968                 New GEOM.GEOM_Object, containing the result shape.
7969
7970             """
7971             # Example: see GEOM_TestOthers.py
7972             anObj = self.BoolOp.MakeCommonList(theShapesList, checkSelfInte)
7973             RaiseIfFailed("MakeCommonList", self.BoolOp)
7974             self._autoPublish(anObj, theName, "common")
7975             return anObj
7976
7977         ## Perform Cut boolean operation on one object and the list of tools.
7978         #  @param theMainShape The object of the operation.
7979         #  @param theShapesList The list of tools of the operation.
7980         #  @param checkSelfInte The flag that tells if the arguments should
7981         #         be checked for self-intersection prior to the operation.
7982         #  @param theName Object name; when specified, this parameter is used
7983         #         for result publication in the study. Otherwise, if automatic
7984         #         publication is switched on, default value is used for result name.
7985         #
7986         #  @note This algorithm doesn't find all types of self-intersections.
7987         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7988         #        vertex/face and edge/face intersections. Face/face
7989         #        intersections detection is switched off as it is a
7990         #        time-consuming operation that gives an impact on performance.
7991         #        To find all self-intersections please use
7992         #        CheckSelfIntersections() method.
7993         #
7994         #  @return New GEOM.GEOM_Object, containing the result shape.
7995         #
7996         #  @ref tui_cut "Example 1"
7997         #  \n @ref swig_MakeCommon "Example 2"
7998         @ManageTransactions("BoolOp")
7999         def MakeCutList(self, theMainShape, theShapesList, checkSelfInte=False, theName=None):
8000             """
8001             Perform Cut boolean operation on one object and the list of tools.
8002
8003             Parameters:
8004                 theMainShape The object of the operation.
8005                 theShapesList The list of tools of the operation.
8006                 checkSelfInte The flag that tells if the arguments should
8007                               be checked for self-intersection prior to
8008                               the operation.
8009                 theName Object name; when specified, this parameter is used
8010                         for result publication in the study. Otherwise, if automatic
8011                         publication is switched on, default value is used for result name.
8012
8013             Note:
8014                     This algorithm doesn't find all types of self-intersections.
8015                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
8016                     vertex/face and edge/face intersections. Face/face
8017                     intersections detection is switched off as it is a
8018                     time-consuming operation that gives an impact on performance.
8019                     To find all self-intersections please use
8020                     CheckSelfIntersections() method.
8021
8022             Returns:
8023                 New GEOM.GEOM_Object, containing the result shape.
8024
8025             """
8026             # Example: see GEOM_TestOthers.py
8027             anObj = self.BoolOp.MakeCutList(theMainShape, theShapesList, checkSelfInte)
8028             RaiseIfFailed("MakeCutList", self.BoolOp)
8029             self._autoPublish(anObj, theName, "cut")
8030             return anObj
8031
8032         # end of l3_boolean
8033         ## @}
8034
8035         ## @addtogroup l3_basic_op
8036         ## @{
8037
8038         ## Perform partition operation.
8039         #  @param ListShapes Shapes to be intersected.
8040         #  @param ListTools Shapes to intersect theShapes.
8041         #  @param Limit Type of resulting shapes (see ShapeType()).\n
8042         #         If this parameter is set to -1 ("Auto"), most appropriate shape limit
8043         #         type will be detected automatically.
8044         #  @param KeepNonlimitShapes if this parameter == 0, then only shapes of
8045         #                             target type (equal to Limit) are kept in the result,
8046         #                             else standalone shapes of lower dimension
8047         #                             are kept also (if they exist).
8048         #
8049         #  @param theName Object name; when specified, this parameter is used
8050         #         for result publication in the study. Otherwise, if automatic
8051         #         publication is switched on, default value is used for result name.
8052         #
8053         #  @note Each compound from ListShapes and ListTools will be exploded
8054         #        in order to avoid possible intersection between shapes from this compound.
8055         #
8056         #  After implementation new version of PartitionAlgo (October 2006)
8057         #  other parameters are ignored by current functionality. They are kept
8058         #  in this function only for support old versions.
8059         #      @param ListKeepInside Shapes, outside which the results will be deleted.
8060         #         Each shape from theKeepInside must belong to theShapes also.
8061         #      @param ListRemoveInside Shapes, inside which the results will be deleted.
8062         #         Each shape from theRemoveInside must belong to theShapes also.
8063         #      @param RemoveWebs If TRUE, perform Glue 3D algorithm.
8064         #      @param ListMaterials Material indices for each shape. Make sence,
8065         #         only if theRemoveWebs is TRUE.
8066         #
8067         #  @return New GEOM.GEOM_Object, containing the result shapes.
8068         #
8069         #  @ref tui_partition "Example"
8070         @ManageTransactions("BoolOp")
8071         def MakePartition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
8072                           Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
8073                           KeepNonlimitShapes=0, theName=None):
8074             """
8075             Perform partition operation.
8076
8077             Parameters:
8078                 ListShapes Shapes to be intersected.
8079                 ListTools Shapes to intersect theShapes.
8080                 Limit Type of resulting shapes (see geompy.ShapeType)
8081                       If this parameter is set to -1 ("Auto"), most appropriate shape limit
8082                       type will be detected automatically.
8083                 KeepNonlimitShapes if this parameter == 0, then only shapes of
8084                                     target type (equal to Limit) are kept in the result,
8085                                     else standalone shapes of lower dimension
8086                                     are kept also (if they exist).
8087
8088                 theName Object name; when specified, this parameter is used
8089                         for result publication in the study. Otherwise, if automatic
8090                         publication is switched on, default value is used for result name.
8091             Note:
8092                     Each compound from ListShapes and ListTools will be exploded
8093                     in order to avoid possible intersection between shapes from
8094                     this compound.
8095
8096             After implementation new version of PartitionAlgo (October 2006) other
8097             parameters are ignored by current functionality. They are kept in this
8098             function only for support old versions.
8099
8100             Ignored parameters:
8101                 ListKeepInside Shapes, outside which the results will be deleted.
8102                                Each shape from theKeepInside must belong to theShapes also.
8103                 ListRemoveInside Shapes, inside which the results will be deleted.
8104                                  Each shape from theRemoveInside must belong to theShapes also.
8105                 RemoveWebs If TRUE, perform Glue 3D algorithm.
8106                 ListMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
8107
8108             Returns:
8109                 New GEOM.GEOM_Object, containing the result shapes.
8110             """
8111             # Example: see GEOM_TestAll.py
8112             if Limit == self.ShapeType["AUTO"]:
8113                 # automatic detection of the most appropriate shape limit type
8114                 lim = GEOM.SHAPE
8115                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
8116                 Limit = EnumToLong(lim)
8117                 pass
8118             anObj = self.BoolOp.MakePartition(ListShapes, ListTools,
8119                                               ListKeepInside, ListRemoveInside,
8120                                               Limit, RemoveWebs, ListMaterials,
8121                                               KeepNonlimitShapes);
8122             RaiseIfFailed("MakePartition", self.BoolOp)
8123             self._autoPublish(anObj, theName, "partition")
8124             return anObj
8125
8126         ## Perform partition operation.
8127         #  This method may be useful if it is needed to make a partition for
8128         #  compound contains nonintersected shapes. Performance will be better
8129         #  since intersection between shapes from compound is not performed.
8130         #
8131         #  Description of all parameters as in previous method MakePartition().
8132         #  One additional parameter is provided:
8133         #  @param checkSelfInte The flag that tells if the arguments should
8134         #         be checked for self-intersection prior to the operation.
8135         #
8136         #  @note This algorithm doesn't find all types of self-intersections.
8137         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
8138         #        vertex/face and edge/face intersections. Face/face
8139         #        intersections detection is switched off as it is a
8140         #        time-consuming operation that gives an impact on performance.
8141         #        To find all self-intersections please use
8142         #        CheckSelfIntersections() method.
8143         #
8144         #  @note Passed compounds (via ListShapes or via ListTools)
8145         #           have to consist of nonintersecting shapes.
8146         #
8147         #  @return New GEOM.GEOM_Object, containing the result shapes.
8148         #
8149         #  @ref swig_todo "Example"
8150         @ManageTransactions("BoolOp")
8151         def MakePartitionNonSelfIntersectedShape(self, ListShapes, ListTools=[],
8152                                                  ListKeepInside=[], ListRemoveInside=[],
8153                                                  Limit=ShapeType["AUTO"], RemoveWebs=0,
8154                                                  ListMaterials=[], KeepNonlimitShapes=0,
8155                                                  checkSelfInte=False, theName=None):
8156             """
8157             Perform partition operation.
8158             This method may be useful if it is needed to make a partition for
8159             compound contains nonintersected shapes. Performance will be better
8160             since intersection between shapes from compound is not performed.
8161
8162             Parameters:
8163                 Description of all parameters as in method geompy.MakePartition.
8164                 One additional parameter is provided:
8165                 checkSelfInte The flag that tells if the arguments should
8166                               be checked for self-intersection prior to
8167                               the operation.
8168
8169             Note:
8170                     This algorithm doesn't find all types of self-intersections.
8171                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
8172                     vertex/face and edge/face intersections. Face/face
8173                     intersections detection is switched off as it is a
8174                     time-consuming operation that gives an impact on performance.
8175                     To find all self-intersections please use
8176                     CheckSelfIntersections() method.
8177
8178             NOTE:
8179                 Passed compounds (via ListShapes or via ListTools)
8180                 have to consist of nonintersecting shapes.
8181
8182             Returns:
8183                 New GEOM.GEOM_Object, containing the result shapes.
8184             """
8185             if Limit == self.ShapeType["AUTO"]:
8186                 # automatic detection of the most appropriate shape limit type
8187                 lim = GEOM.SHAPE
8188                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
8189                 Limit = EnumToLong(lim)
8190                 pass
8191             anObj = self.BoolOp.MakePartitionNonSelfIntersectedShape(ListShapes, ListTools,
8192                                                                      ListKeepInside, ListRemoveInside,
8193                                                                      Limit, RemoveWebs, ListMaterials,
8194                                                                      KeepNonlimitShapes, checkSelfInte);
8195             RaiseIfFailed("MakePartitionNonSelfIntersectedShape", self.BoolOp)
8196             self._autoPublish(anObj, theName, "partition")
8197             return anObj
8198
8199         ## See method MakePartition() for more information.
8200         #
8201         #  @ref tui_partition "Example 1"
8202         #  \n @ref swig_Partition "Example 2"
8203         def Partition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
8204                       Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
8205                       KeepNonlimitShapes=0, theName=None):
8206             """
8207             See method geompy.MakePartition for more information.
8208             """
8209             # Example: see GEOM_TestOthers.py
8210             # note: auto-publishing is done in self.MakePartition()
8211             anObj = self.MakePartition(ListShapes, ListTools,
8212                                        ListKeepInside, ListRemoveInside,
8213                                        Limit, RemoveWebs, ListMaterials,
8214                                        KeepNonlimitShapes, theName);
8215             return anObj
8216
8217         ## Perform partition of the Shape with the Plane
8218         #  @param theShape Shape to be intersected.
8219         #  @param thePlane Tool shape, to intersect theShape.
8220         #  @param theName Object name; when specified, this parameter is used
8221         #         for result publication in the study. Otherwise, if automatic
8222         #         publication is switched on, default value is used for result name.
8223         #
8224         #  @return New GEOM.GEOM_Object, containing the result shape.
8225         #
8226         #  @note This operation is a shortcut to the more general @ref MakePartition
8227         #  operation, where @a theShape specifies single "object" (shape being partitioned)
8228         #  and @a thePlane specifies single "tool" (intersector shape). Other parameters of
8229         #  @ref MakePartition operation have default values:
8230         #  - @a Limit: GEOM::SHAPE (shape limit corresponds to the type of @a theShape)
8231         #  - @a KeepNonlimitShapes: 0
8232         #  - @a KeepInside, @a RemoveInside, @a RemoveWebs,
8233         #    @a Materials (obsolete parameters): empty
8234         #
8235         #  @note I.e. the following two operations are equivalent:
8236         #  @code
8237         #  Result = geompy.MakeHalfPartition(Object, Plane)
8238         #  Result = geompy.MakePartition([Object], [Plane])
8239         #  @endcode
8240         #
8241         #  @sa MakePartition, MakePartitionNonSelfIntersectedShape
8242         #
8243         #  @ref tui_partition "Example"
8244         @ManageTransactions("BoolOp")
8245         def MakeHalfPartition(self, theShape, thePlane, theName=None):
8246             """
8247             Perform partition of the Shape with the Plane
8248
8249             Parameters:
8250                 theShape Shape to be intersected.
8251                 thePlane Tool shape, to intersect theShape.
8252                 theName Object name; when specified, this parameter is used
8253                         for result publication in the study. Otherwise, if automatic
8254                         publication is switched on, default value is used for result name.
8255
8256             Returns:
8257                 New GEOM.GEOM_Object, containing the result shape.
8258          
8259             Note: This operation is a shortcut to the more general MakePartition
8260             operation, where theShape specifies single "object" (shape being partitioned)
8261             and thePlane specifies single "tool" (intersector shape). Other parameters of
8262             MakePartition operation have default values:
8263             - Limit: GEOM::SHAPE (shape limit corresponds to the type of theShape)
8264             - KeepNonlimitShapes: 0
8265             - KeepInside, RemoveInside, RemoveWebs, Materials (obsolete parameters): empty
8266          
8267             I.e. the following two operations are equivalent:
8268               Result = geompy.MakeHalfPartition(Object, Plane)
8269               Result = geompy.MakePartition([Object], [Plane])
8270             """
8271             # Example: see GEOM_TestAll.py
8272             anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane)
8273             RaiseIfFailed("MakeHalfPartition", self.BoolOp)
8274             self._autoPublish(anObj, theName, "partition")
8275             return anObj
8276
8277         # end of l3_basic_op
8278         ## @}
8279
8280         ## @addtogroup l3_transform
8281         ## @{
8282
8283         ## Translate the given object along the vector, specified
8284         #  by its end points.
8285         #  @param theObject The object to be translated.
8286         #  @param thePoint1 Start point of translation vector.
8287         #  @param thePoint2 End point of translation vector.
8288         #  @param theCopy Flag used to translate object itself or create a copy.
8289         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8290         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8291         @ManageTransactions("TrsfOp")
8292         def TranslateTwoPoints(self, theObject, thePoint1, thePoint2, theCopy=False):
8293             """
8294             Translate the given object along the vector, specified by its end points.
8295
8296             Parameters:
8297                 theObject The object to be translated.
8298                 thePoint1 Start point of translation vector.
8299                 thePoint2 End point of translation vector.
8300                 theCopy Flag used to translate object itself or create a copy.
8301
8302             Returns:
8303                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8304                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8305             """
8306             if theCopy:
8307                 anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
8308             else:
8309                 anObj = self.TrsfOp.TranslateTwoPoints(theObject, thePoint1, thePoint2)
8310             RaiseIfFailed("TranslateTwoPoints", self.TrsfOp)
8311             return anObj
8312
8313         ## Translate the given object along the vector, specified
8314         #  by its end points, creating its copy before the translation.
8315         #  @param theObject The object to be translated.
8316         #  @param thePoint1 Start point of translation vector.
8317         #  @param thePoint2 End point of translation vector.
8318         #  @param theName Object name; when specified, this parameter is used
8319         #         for result publication in the study. Otherwise, if automatic
8320         #         publication is switched on, default value is used for result name.
8321         #
8322         #  @return New GEOM.GEOM_Object, containing the translated object.
8323         #
8324         #  @ref tui_translation "Example 1"
8325         #  \n @ref swig_MakeTranslationTwoPoints "Example 2"
8326         @ManageTransactions("TrsfOp")
8327         def MakeTranslationTwoPoints(self, theObject, thePoint1, thePoint2, theName=None):
8328             """
8329             Translate the given object along the vector, specified
8330             by its end points, creating its copy before the translation.
8331
8332             Parameters:
8333                 theObject The object to be translated.
8334                 thePoint1 Start point of translation vector.
8335                 thePoint2 End point of translation vector.
8336                 theName Object name; when specified, this parameter is used
8337                         for result publication in the study. Otherwise, if automatic
8338                         publication is switched on, default value is used for result name.
8339
8340             Returns:
8341                 New GEOM.GEOM_Object, containing the translated object.
8342             """
8343             # Example: see GEOM_TestAll.py
8344             anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
8345             RaiseIfFailed("TranslateTwoPointsCopy", self.TrsfOp)
8346             self._autoPublish(anObj, theName, "translated")
8347             return anObj
8348
8349         ## Translate the given object along the vector, specified by its components.
8350         #  @param theObject The object to be translated.
8351         #  @param theDX,theDY,theDZ Components of translation vector.
8352         #  @param theCopy Flag used to translate object itself or create a copy.
8353         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8354         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8355         #
8356         #  @ref tui_translation "Example"
8357         @ManageTransactions("TrsfOp")
8358         def TranslateDXDYDZ(self, theObject, theDX, theDY, theDZ, theCopy=False):
8359             """
8360             Translate the given object along the vector, specified by its components.
8361
8362             Parameters:
8363                 theObject The object to be translated.
8364                 theDX,theDY,theDZ Components of translation vector.
8365                 theCopy Flag used to translate object itself or create a copy.
8366
8367             Returns:
8368                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8369                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8370             """
8371             # Example: see GEOM_TestAll.py
8372             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
8373             if theCopy:
8374                 anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
8375             else:
8376                 anObj = self.TrsfOp.TranslateDXDYDZ(theObject, theDX, theDY, theDZ)
8377             anObj.SetParameters(Parameters)
8378             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
8379             return anObj
8380
8381         ## Translate the given object along the vector, specified
8382         #  by its components, creating its copy before the translation.
8383         #  @param theObject The object to be translated.
8384         #  @param theDX,theDY,theDZ Components of translation vector.
8385         #  @param theName Object name; when specified, this parameter is used
8386         #         for result publication in the study. Otherwise, if automatic
8387         #         publication is switched on, default value is used for result name.
8388         #
8389         #  @return New GEOM.GEOM_Object, containing the translated object.
8390         #
8391         #  @ref tui_translation "Example"
8392         @ManageTransactions("TrsfOp")
8393         def MakeTranslation(self,theObject, theDX, theDY, theDZ, theName=None):
8394             """
8395             Translate the given object along the vector, specified
8396             by its components, creating its copy before the translation.
8397
8398             Parameters:
8399                 theObject The object to be translated.
8400                 theDX,theDY,theDZ Components of translation vector.
8401                 theName Object name; when specified, this parameter is used
8402                         for result publication in the study. Otherwise, if automatic
8403                         publication is switched on, default value is used for result name.
8404
8405             Returns:
8406                 New GEOM.GEOM_Object, containing the translated object.
8407             """
8408             # Example: see GEOM_TestAll.py
8409             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
8410             anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
8411             anObj.SetParameters(Parameters)
8412             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
8413             self._autoPublish(anObj, theName, "translated")
8414             return anObj
8415
8416         ## Translate the given object along the given vector.
8417         #  @param theObject The object to be translated.
8418         #  @param theVector The translation vector.
8419         #  @param theCopy Flag used to translate object itself or create a copy.
8420         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8421         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8422         @ManageTransactions("TrsfOp")
8423         def TranslateVector(self, theObject, theVector, theCopy=False):
8424             """
8425             Translate the given object along the given vector.
8426
8427             Parameters:
8428                 theObject The object to be translated.
8429                 theVector The translation vector.
8430                 theCopy Flag used to translate object itself or create a copy.
8431
8432             Returns:
8433                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8434                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8435             """
8436             if theCopy:
8437                 anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
8438             else:
8439                 anObj = self.TrsfOp.TranslateVector(theObject, theVector)
8440             RaiseIfFailed("TranslateVector", self.TrsfOp)
8441             return anObj
8442
8443         ## Translate the given object along the given vector,
8444         #  creating its copy before the translation.
8445         #  @param theObject The object to be translated.
8446         #  @param theVector The translation vector.
8447         #  @param theName Object name; when specified, this parameter is used
8448         #         for result publication in the study. Otherwise, if automatic
8449         #         publication is switched on, default value is used for result name.
8450         #
8451         #  @return New GEOM.GEOM_Object, containing the translated object.
8452         #
8453         #  @ref tui_translation "Example"
8454         @ManageTransactions("TrsfOp")
8455         def MakeTranslationVector(self, theObject, theVector, theName=None):
8456             """
8457             Translate the given object along the given vector,
8458             creating its copy before the translation.
8459
8460             Parameters:
8461                 theObject The object to be translated.
8462                 theVector The translation vector.
8463                 theName Object name; when specified, this parameter is used
8464                         for result publication in the study. Otherwise, if automatic
8465                         publication is switched on, default value is used for result name.
8466
8467             Returns:
8468                 New GEOM.GEOM_Object, containing the translated object.
8469             """
8470             # Example: see GEOM_TestAll.py
8471             anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
8472             RaiseIfFailed("TranslateVectorCopy", self.TrsfOp)
8473             self._autoPublish(anObj, theName, "translated")
8474             return anObj
8475
8476         ## Translate the given object along the given vector on given distance.
8477         #  @param theObject The object to be translated.
8478         #  @param theVector The translation vector.
8479         #  @param theDistance The translation distance.
8480         #  @param theCopy Flag used to translate object itself or create a copy.
8481         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8482         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8483         #
8484         #  @ref tui_translation "Example"
8485         @ManageTransactions("TrsfOp")
8486         def TranslateVectorDistance(self, theObject, theVector, theDistance, theCopy=False):
8487             """
8488             Translate the given object along the given vector on given distance.
8489
8490             Parameters:
8491                 theObject The object to be translated.
8492                 theVector The translation vector.
8493                 theDistance The translation distance.
8494                 theCopy Flag used to translate object itself or create a copy.
8495
8496             Returns:
8497                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8498                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8499             """
8500             # Example: see GEOM_TestAll.py
8501             theDistance,Parameters = ParseParameters(theDistance)
8502             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, theCopy)
8503             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
8504             anObj.SetParameters(Parameters)
8505             return anObj
8506
8507         ## Translate the given object along the given vector on given distance,
8508         #  creating its copy before the translation.
8509         #  @param theObject The object to be translated.
8510         #  @param theVector The translation vector.
8511         #  @param theDistance The translation distance.
8512         #  @param theName Object name; when specified, this parameter is used
8513         #         for result publication in the study. Otherwise, if automatic
8514         #         publication is switched on, default value is used for result name.
8515         #
8516         #  @return New GEOM.GEOM_Object, containing the translated object.
8517         #
8518         #  @ref tui_translation "Example"
8519         @ManageTransactions("TrsfOp")
8520         def MakeTranslationVectorDistance(self, theObject, theVector, theDistance, theName=None):
8521             """
8522             Translate the given object along the given vector on given distance,
8523             creating its copy before the translation.
8524
8525             Parameters:
8526                 theObject The object to be translated.
8527                 theVector The translation vector.
8528                 theDistance The translation distance.
8529                 theName Object name; when specified, this parameter is used
8530                         for result publication in the study. Otherwise, if automatic
8531                         publication is switched on, default value is used for result name.
8532
8533             Returns:
8534                 New GEOM.GEOM_Object, containing the translated object.
8535             """
8536             # Example: see GEOM_TestAll.py
8537             theDistance,Parameters = ParseParameters(theDistance)
8538             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, 1)
8539             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
8540             anObj.SetParameters(Parameters)
8541             self._autoPublish(anObj, theName, "translated")
8542             return anObj
8543
8544         ## Rotate the given object around the given axis on the given angle.
8545         #  @param theObject The object to be rotated.
8546         #  @param theAxis Rotation axis.
8547         #  @param theAngle Rotation angle in radians.
8548         #  @param theCopy Flag used to rotate object itself or create a copy.
8549         #
8550         #  @return Rotated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8551         #  new GEOM.GEOM_Object, containing the rotated object if @a theCopy flag is @c True.
8552         #
8553         #  @ref tui_rotation "Example"
8554         @ManageTransactions("TrsfOp")
8555         def Rotate(self, theObject, theAxis, theAngle, theCopy=False):
8556             """
8557             Rotate the given object around the given axis on the given angle.
8558
8559             Parameters:
8560                 theObject The object to be rotated.
8561                 theAxis Rotation axis.
8562                 theAngle Rotation angle in radians.
8563                 theCopy Flag used to rotate object itself or create a copy.
8564
8565             Returns:
8566                 Rotated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8567                 new GEOM.GEOM_Object, containing the rotated object if theCopy flag is True.
8568             """
8569             # Example: see GEOM_TestAll.py
8570             flag = False
8571             if isinstance(theAngle,str):
8572                 flag = True
8573             theAngle, Parameters = ParseParameters(theAngle)
8574             if flag:
8575                 theAngle = theAngle*math.pi/180.0
8576             if theCopy:
8577                 anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
8578             else:
8579                 anObj = self.TrsfOp.Rotate(theObject, theAxis, theAngle)
8580             RaiseIfFailed("Rotate", self.TrsfOp)
8581             anObj.SetParameters(Parameters)
8582             return anObj
8583
8584         ## Rotate the given object around the given axis
8585         #  on the given angle, creating its copy before the rotation.
8586         #  @param theObject The object to be rotated.
8587         #  @param theAxis Rotation axis.
8588         #  @param theAngle Rotation angle in radians.
8589         #  @param theName Object name; when specified, this parameter is used
8590         #         for result publication in the study. Otherwise, if automatic
8591         #         publication is switched on, default value is used for result name.
8592         #
8593         #  @return New GEOM.GEOM_Object, containing the rotated object.
8594         #
8595         #  @ref tui_rotation "Example"
8596         @ManageTransactions("TrsfOp")
8597         def MakeRotation(self, theObject, theAxis, theAngle, theName=None):
8598             """
8599             Rotate the given object around the given axis
8600             on the given angle, creating its copy before the rotatation.
8601
8602             Parameters:
8603                 theObject The object to be rotated.
8604                 theAxis Rotation axis.
8605                 theAngle Rotation angle in radians.
8606                 theName Object name; when specified, this parameter is used
8607                         for result publication in the study. Otherwise, if automatic
8608                         publication is switched on, default value is used for result name.
8609
8610             Returns:
8611                 New GEOM.GEOM_Object, containing the rotated object.
8612             """
8613             # Example: see GEOM_TestAll.py
8614             flag = False
8615             if isinstance(theAngle,str):
8616                 flag = True
8617             theAngle, Parameters = ParseParameters(theAngle)
8618             if flag:
8619                 theAngle = theAngle*math.pi/180.0
8620             anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
8621             RaiseIfFailed("RotateCopy", self.TrsfOp)
8622             anObj.SetParameters(Parameters)
8623             self._autoPublish(anObj, theName, "rotated")
8624             return anObj
8625
8626         ## Rotate given object around vector perpendicular to plane
8627         #  containing three points.
8628         #  @param theObject The object to be rotated.
8629         #  @param theCentPoint central point the axis is the vector perpendicular to the plane
8630         #  containing the three points.
8631         #  @param thePoint1,thePoint2 points in a perpendicular plane of the axis.
8632         #  @param theCopy Flag used to rotate object itself or create a copy.
8633         #  @return Rotated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8634         #  new GEOM.GEOM_Object, containing the rotated object if @a theCopy flag is @c True.
8635         @ManageTransactions("TrsfOp")
8636         def RotateThreePoints(self, theObject, theCentPoint, thePoint1, thePoint2, theCopy=False):
8637             """
8638             Rotate given object around vector perpendicular to plane
8639             containing three points.
8640
8641             Parameters:
8642                 theObject The object to be rotated.
8643                 theCentPoint central point  the axis is the vector perpendicular to the plane
8644                              containing the three points.
8645                 thePoint1,thePoint2 points in a perpendicular plane of the axis.
8646                 theCopy Flag used to rotate object itself or create a copy.
8647
8648             Returns:
8649                 Rotated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8650                 new GEOM.GEOM_Object, containing the rotated object if theCopy flag is True.
8651             """
8652             if theCopy:
8653                 anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
8654             else:
8655                 anObj = self.TrsfOp.RotateThreePoints(theObject, theCentPoint, thePoint1, thePoint2)
8656             RaiseIfFailed("RotateThreePoints", self.TrsfOp)
8657             return anObj
8658
8659         ## Rotate given object around vector perpendicular to plane
8660         #  containing three points, creating its copy before the rotatation.
8661         #  @param theObject The object to be rotated.
8662         #  @param theCentPoint central point the axis is the vector perpendicular to the plane
8663         #  containing the three points.
8664         #  @param thePoint1,thePoint2 in a perpendicular plane of the axis.
8665         #  @param theName Object name; when specified, this parameter is used
8666         #         for result publication in the study. Otherwise, if automatic
8667         #         publication is switched on, default value is used for result name.
8668         #
8669         #  @return New GEOM.GEOM_Object, containing the rotated object.
8670         #
8671         #  @ref tui_rotation "Example"
8672         @ManageTransactions("TrsfOp")
8673         def MakeRotationThreePoints(self, theObject, theCentPoint, thePoint1, thePoint2, theName=None):
8674             """
8675             Rotate given object around vector perpendicular to plane
8676             containing three points, creating its copy before the rotatation.
8677
8678             Parameters:
8679                 theObject The object to be rotated.
8680                 theCentPoint central point  the axis is the vector perpendicular to the plane
8681                              containing the three points.
8682                 thePoint1,thePoint2  in a perpendicular plane of the axis.
8683                 theName Object name; when specified, this parameter is used
8684                         for result publication in the study. Otherwise, if automatic
8685                         publication is switched on, default value is used for result name.
8686
8687             Returns:
8688                 New GEOM.GEOM_Object, containing the rotated object.
8689             """
8690             # Example: see GEOM_TestAll.py
8691             anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
8692             RaiseIfFailed("RotateThreePointsCopy", self.TrsfOp)
8693             self._autoPublish(anObj, theName, "rotated")
8694             return anObj
8695
8696         ## Scale the given object by the specified factor.
8697         #  @param theObject The object to be scaled.
8698         #  @param thePoint Center point for scaling.
8699         #                  Passing None for it means scaling relatively the origin of global CS.
8700         #  @param theFactor Scaling factor value.
8701         #  @param theCopy Flag used to scale object itself or create a copy.
8702         #  @return Scaled @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8703         #  new GEOM.GEOM_Object, containing the scaled object if @a theCopy flag is @c True.
8704         @ManageTransactions("TrsfOp")
8705         def Scale(self, theObject, thePoint, theFactor, theCopy=False):
8706             """
8707             Scale the given object by the specified factor.
8708
8709             Parameters:
8710                 theObject The object to be scaled.
8711                 thePoint Center point for scaling.
8712                          Passing None for it means scaling relatively the origin of global CS.
8713                 theFactor Scaling factor value.
8714                 theCopy Flag used to scale object itself or create a copy.
8715
8716             Returns:
8717                 Scaled theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8718                 new GEOM.GEOM_Object, containing the scaled object if theCopy flag is True.
8719             """
8720             # Example: see GEOM_TestAll.py
8721             theFactor, Parameters = ParseParameters(theFactor)
8722             if theCopy:
8723                 anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
8724             else:
8725                 anObj = self.TrsfOp.ScaleShape(theObject, thePoint, theFactor)
8726             RaiseIfFailed("Scale", self.TrsfOp)
8727             anObj.SetParameters(Parameters)
8728             return anObj
8729
8730         ## Scale the given object by the factor, creating its copy before the scaling.
8731         #  @param theObject The object to be scaled.
8732         #  @param thePoint Center point for scaling.
8733         #                  Passing None for it means scaling relatively the origin of global CS.
8734         #  @param theFactor Scaling factor value.
8735         #  @param theName Object name; when specified, this parameter is used
8736         #         for result publication in the study. Otherwise, if automatic
8737         #         publication is switched on, default value is used for result name.
8738         #
8739         #  @return New GEOM.GEOM_Object, containing the scaled shape.
8740         #
8741         #  @ref tui_scale "Example"
8742         @ManageTransactions("TrsfOp")
8743         def MakeScaleTransform(self, theObject, thePoint, theFactor, theName=None):
8744             """
8745             Scale the given object by the factor, creating its copy before the scaling.
8746
8747             Parameters:
8748                 theObject The object to be scaled.
8749                 thePoint Center point for scaling.
8750                          Passing None for it means scaling relatively the origin of global CS.
8751                 theFactor Scaling factor value.
8752                 theName Object name; when specified, this parameter is used
8753                         for result publication in the study. Otherwise, if automatic
8754                         publication is switched on, default value is used for result name.
8755
8756             Returns:
8757                 New GEOM.GEOM_Object, containing the scaled shape.
8758             """
8759             # Example: see GEOM_TestAll.py
8760             theFactor, Parameters = ParseParameters(theFactor)
8761             anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
8762             RaiseIfFailed("ScaleShapeCopy", self.TrsfOp)
8763             anObj.SetParameters(Parameters)
8764             self._autoPublish(anObj, theName, "scaled")
8765             return anObj
8766
8767         ## Scale the given object by different factors along coordinate axes.
8768         #  @param theObject The object to be scaled.
8769         #  @param thePoint Center point for scaling.
8770         #                  Passing None for it means scaling relatively the origin of global CS.
8771         #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8772         #  @param theCopy Flag used to scale object itself or create a copy.
8773         #  @return Scaled @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8774         #  new GEOM.GEOM_Object, containing the scaled object if @a theCopy flag is @c True.
8775         @ManageTransactions("TrsfOp")
8776         def ScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ, theCopy=False):
8777             """
8778             Scale the given object by different factors along coordinate axes.
8779
8780             Parameters:
8781                 theObject The object to be scaled.
8782                 thePoint Center point for scaling.
8783                             Passing None for it means scaling relatively the origin of global CS.
8784                 theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8785                 theCopy Flag used to scale object itself or create a copy.
8786
8787             Returns:
8788                 Scaled theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8789                 new GEOM.GEOM_Object, containing the scaled object if theCopy flag is True.
8790             """
8791             # Example: see GEOM_TestAll.py
8792             theFactorX, theFactorY, theFactorZ, Parameters = ParseParameters(theFactorX, theFactorY, theFactorZ)
8793             if theCopy:
8794                 anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
8795                                                             theFactorX, theFactorY, theFactorZ)
8796             else:
8797                 anObj = self.TrsfOp.ScaleShapeAlongAxes(theObject, thePoint,
8798                                                         theFactorX, theFactorY, theFactorZ)
8799             RaiseIfFailed("ScaleAlongAxes", self.TrsfOp)
8800             anObj.SetParameters(Parameters)
8801             return anObj
8802
8803         ## Scale the given object by different factors along coordinate axes,
8804         #  creating its copy before the scaling.
8805         #  @param theObject The object to be scaled.
8806         #  @param thePoint Center point for scaling.
8807         #                  Passing None for it means scaling relatively the origin of global CS.
8808         #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8809         #  @param theName Object name; when specified, this parameter is used
8810         #         for result publication in the study. Otherwise, if automatic
8811         #         publication is switched on, default value is used for result name.
8812         #
8813         #  @return New GEOM.GEOM_Object, containing the scaled shape.
8814         #
8815         #  @ref swig_scale "Example"
8816         @ManageTransactions("TrsfOp")
8817         def MakeScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ, theName=None):
8818             """
8819             Scale the given object by different factors along coordinate axes,
8820             creating its copy before the scaling.
8821
8822             Parameters:
8823                 theObject The object to be scaled.
8824                 thePoint Center point for scaling.
8825                             Passing None for it means scaling relatively the origin of global CS.
8826                 theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8827                 theName Object name; when specified, this parameter is used
8828                         for result publication in the study. Otherwise, if automatic
8829                         publication is switched on, default value is used for result name.
8830
8831             Returns:
8832                 New GEOM.GEOM_Object, containing the scaled shape.
8833             """
8834             # Example: see GEOM_TestAll.py
8835             theFactorX, theFactorY, theFactorZ, Parameters = ParseParameters(theFactorX, theFactorY, theFactorZ)
8836             anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
8837                                                         theFactorX, theFactorY, theFactorZ)
8838             RaiseIfFailed("MakeScaleAlongAxes", self.TrsfOp)
8839             anObj.SetParameters(Parameters)
8840             self._autoPublish(anObj, theName, "scaled")
8841             return anObj
8842
8843         ## Mirror an object relatively the given plane.
8844         #  @param theObject The object to be mirrored.
8845         #  @param thePlane Plane of symmetry.
8846         #  @param theCopy Flag used to mirror object itself or create a copy.
8847         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8848         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8849         @ManageTransactions("TrsfOp")
8850         def MirrorByPlane(self, theObject, thePlane, theCopy=False):
8851             """
8852             Mirror an object relatively the given plane.
8853
8854             Parameters:
8855                 theObject The object to be mirrored.
8856                 thePlane Plane of symmetry.
8857                 theCopy Flag used to mirror object itself or create a copy.
8858
8859             Returns:
8860                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8861                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8862             """
8863             if theCopy:
8864                 anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
8865             else:
8866                 anObj = self.TrsfOp.MirrorPlane(theObject, thePlane)
8867             RaiseIfFailed("MirrorByPlane", self.TrsfOp)
8868             return anObj
8869
8870         ## Create an object, symmetrical
8871         #  to the given one relatively the given plane.
8872         #  @param theObject The object to be mirrored.
8873         #  @param thePlane Plane of symmetry.
8874         #  @param theName Object name; when specified, this parameter is used
8875         #         for result publication in the study. Otherwise, if automatic
8876         #         publication is switched on, default value is used for result name.
8877         #
8878         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8879         #
8880         #  @ref tui_mirror "Example"
8881         @ManageTransactions("TrsfOp")
8882         def MakeMirrorByPlane(self, theObject, thePlane, theName=None):
8883             """
8884             Create an object, symmetrical to the given one relatively the given plane.
8885
8886             Parameters:
8887                 theObject The object to be mirrored.
8888                 thePlane Plane of symmetry.
8889                 theName Object name; when specified, this parameter is used
8890                         for result publication in the study. Otherwise, if automatic
8891                         publication is switched on, default value is used for result name.
8892
8893             Returns:
8894                 New GEOM.GEOM_Object, containing the mirrored shape.
8895             """
8896             # Example: see GEOM_TestAll.py
8897             anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
8898             RaiseIfFailed("MirrorPlaneCopy", self.TrsfOp)
8899             self._autoPublish(anObj, theName, "mirrored")
8900             return anObj
8901
8902         ## Mirror an object relatively the given axis.
8903         #  @param theObject The object to be mirrored.
8904         #  @param theAxis Axis of symmetry.
8905         #  @param theCopy Flag used to mirror object itself or create a copy.
8906         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8907         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8908         @ManageTransactions("TrsfOp")
8909         def MirrorByAxis(self, theObject, theAxis, theCopy=False):
8910             """
8911             Mirror an object relatively the given axis.
8912
8913             Parameters:
8914                 theObject The object to be mirrored.
8915                 theAxis Axis of symmetry.
8916                 theCopy Flag used to mirror object itself or create a copy.
8917
8918             Returns:
8919                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8920                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8921             """
8922             if theCopy:
8923                 anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
8924             else:
8925                 anObj = self.TrsfOp.MirrorAxis(theObject, theAxis)
8926             RaiseIfFailed("MirrorByAxis", self.TrsfOp)
8927             return anObj
8928
8929         ## Create an object, symmetrical
8930         #  to the given one relatively the given axis.
8931         #  @param theObject The object to be mirrored.
8932         #  @param theAxis Axis of symmetry.
8933         #  @param theName Object name; when specified, this parameter is used
8934         #         for result publication in the study. Otherwise, if automatic
8935         #         publication is switched on, default value is used for result name.
8936         #
8937         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8938         #
8939         #  @ref tui_mirror "Example"
8940         @ManageTransactions("TrsfOp")
8941         def MakeMirrorByAxis(self, theObject, theAxis, theName=None):
8942             """
8943             Create an object, symmetrical to the given one relatively the given axis.
8944
8945             Parameters:
8946                 theObject The object to be mirrored.
8947                 theAxis Axis of symmetry.
8948                 theName Object name; when specified, this parameter is used
8949                         for result publication in the study. Otherwise, if automatic
8950                         publication is switched on, default value is used for result name.
8951
8952             Returns:
8953                 New GEOM.GEOM_Object, containing the mirrored shape.
8954             """
8955             # Example: see GEOM_TestAll.py
8956             anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
8957             RaiseIfFailed("MirrorAxisCopy", self.TrsfOp)
8958             self._autoPublish(anObj, theName, "mirrored")
8959             return anObj
8960
8961         ## Mirror an object relatively the given point.
8962         #  @param theObject The object to be mirrored.
8963         #  @param thePoint Point of symmetry.
8964         #  @param theCopy Flag used to mirror object itself or create a copy.
8965         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8966         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8967         @ManageTransactions("TrsfOp")
8968         def MirrorByPoint(self, theObject, thePoint, theCopy=False):
8969             """
8970             Mirror an object relatively the given point.
8971
8972             Parameters:
8973                 theObject The object to be mirrored.
8974                 thePoint Point of symmetry.
8975                 theCopy Flag used to mirror object itself or create a copy.
8976
8977             Returns:
8978                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8979                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8980             """
8981             # Example: see GEOM_TestAll.py
8982             if theCopy:
8983                 anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
8984             else:
8985                 anObj = self.TrsfOp.MirrorPoint(theObject, thePoint)
8986             RaiseIfFailed("MirrorByPoint", self.TrsfOp)
8987             return anObj
8988
8989         ## Create an object, symmetrical
8990         #  to the given one relatively the given point.
8991         #  @param theObject The object to be mirrored.
8992         #  @param thePoint Point of symmetry.
8993         #  @param theName Object name; when specified, this parameter is used
8994         #         for result publication in the study. Otherwise, if automatic
8995         #         publication is switched on, default value is used for result name.
8996         #
8997         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8998         #
8999         #  @ref tui_mirror "Example"
9000         @ManageTransactions("TrsfOp")
9001         def MakeMirrorByPoint(self, theObject, thePoint, theName=None):
9002             """
9003             Create an object, symmetrical
9004             to the given one relatively the given point.
9005
9006             Parameters:
9007                 theObject The object to be mirrored.
9008                 thePoint Point of symmetry.
9009                 theName Object name; when specified, this parameter is used
9010                         for result publication in the study. Otherwise, if automatic
9011                         publication is switched on, default value is used for result name.
9012
9013             Returns:
9014                 New GEOM.GEOM_Object, containing the mirrored shape.
9015             """
9016             # Example: see GEOM_TestAll.py
9017             anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
9018             RaiseIfFailed("MirrorPointCopy", self.TrsfOp)
9019             self._autoPublish(anObj, theName, "mirrored")
9020             return anObj
9021
9022         ## Modify the location of the given object.
9023         #  @param theObject The object to be displaced.
9024         #  @param theStartLCS Coordinate system to perform displacement from it.\n
9025         #                     If \a theStartLCS is NULL, displacement
9026         #                     will be performed from global CS.\n
9027         #                     If \a theObject itself is used as \a theStartLCS,
9028         #                     its location will be changed to \a theEndLCS.
9029         #  @param theEndLCS Coordinate system to perform displacement to it.
9030         #  @param theCopy Flag used to displace object itself or create a copy.
9031         #  @return Displaced @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
9032         #  new GEOM.GEOM_Object, containing the displaced object if @a theCopy flag is @c True.
9033         @ManageTransactions("TrsfOp")
9034         def Position(self, theObject, theStartLCS, theEndLCS, theCopy=False):
9035             """
9036             Modify the Location of the given object by LCS, creating its copy before the setting.
9037
9038             Parameters:
9039                 theObject The object to be displaced.
9040                 theStartLCS Coordinate system to perform displacement from it.
9041                             If theStartLCS is NULL, displacement
9042                             will be performed from global CS.
9043                             If theObject itself is used as theStartLCS,
9044                             its location will be changed to theEndLCS.
9045                 theEndLCS Coordinate system to perform displacement to it.
9046                 theCopy Flag used to displace object itself or create a copy.
9047
9048             Returns:
9049                 Displaced theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
9050                 new GEOM.GEOM_Object, containing the displaced object if theCopy flag is True.
9051             """
9052             # Example: see GEOM_TestAll.py
9053             if theCopy:
9054                 anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
9055             else:
9056                 anObj = self.TrsfOp.PositionShape(theObject, theStartLCS, theEndLCS)
9057             RaiseIfFailed("Displace", self.TrsfOp)
9058             return anObj
9059
9060         ## Modify the Location of the given object by LCS,
9061         #  creating its copy before the setting.
9062         #  @param theObject The object to be displaced.
9063         #  @param theStartLCS Coordinate system to perform displacement from it.\n
9064         #                     If \a theStartLCS is NULL, displacement
9065         #                     will be performed from global CS.\n
9066         #                     If \a theObject itself is used as \a theStartLCS,
9067         #                     its location will be changed to \a theEndLCS.
9068         #  @param theEndLCS Coordinate system to perform displacement to it.
9069         #  @param theName Object name; when specified, this parameter is used
9070         #         for result publication in the study. Otherwise, if automatic
9071         #         publication is switched on, default value is used for result name.
9072         #
9073         #  @return New GEOM.GEOM_Object, containing the displaced shape.
9074         #
9075         #  @ref tui_modify_location "Example"
9076         @ManageTransactions("TrsfOp")
9077         def MakePosition(self, theObject, theStartLCS, theEndLCS, theName=None):
9078             """
9079             Modify the Location of the given object by LCS, creating its copy before the setting.
9080
9081             Parameters:
9082                 theObject The object to be displaced.
9083                 theStartLCS Coordinate system to perform displacement from it.
9084                             If theStartLCS is NULL, displacement
9085                             will be performed from global CS.
9086                             If theObject itself is used as theStartLCS,
9087                             its location will be changed to theEndLCS.
9088                 theEndLCS Coordinate system to perform displacement to it.
9089                 theName Object name; when specified, this parameter is used
9090                         for result publication in the study. Otherwise, if automatic
9091                         publication is switched on, default value is used for result name.
9092
9093             Returns:
9094                 New GEOM.GEOM_Object, containing the displaced shape.
9095
9096             Example of usage:
9097                 # create local coordinate systems
9098                 cs1 = geompy.MakeMarker( 0, 0, 0, 1,0,0, 0,1,0)
9099                 cs2 = geompy.MakeMarker(30,40,40, 1,0,0, 0,1,0)
9100                 # modify the location of the given object
9101                 position = geompy.MakePosition(cylinder, cs1, cs2)
9102             """
9103             # Example: see GEOM_TestAll.py
9104             anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
9105             RaiseIfFailed("PositionShapeCopy", self.TrsfOp)
9106             self._autoPublish(anObj, theName, "displaced")
9107             return anObj
9108
9109         ## Modify the Location of the given object by Path.
9110         #  @param  theObject The object to be displaced.
9111         #  @param  thePath Wire or Edge along that the object will be translated.
9112         #  @param  theDistance progress of Path (0 = start location, 1 = end of path location).
9113         #  @param  theCopy is to create a copy objects if true.
9114         #  @param  theReverse  0 - for usual direction, 1 - to reverse path direction.
9115         #  @return Displaced @a theObject (GEOM.GEOM_Object) if @a theCopy is @c False or
9116         #          new GEOM.GEOM_Object, containing the displaced shape if @a theCopy is @c True.
9117         #
9118         #  @ref tui_modify_location "Example"
9119         @ManageTransactions("TrsfOp")
9120         def PositionAlongPath(self,theObject, thePath, theDistance, theCopy, theReverse):
9121             """
9122             Modify the Location of the given object by Path.
9123
9124             Parameters:
9125                  theObject The object to be displaced.
9126                  thePath Wire or Edge along that the object will be translated.
9127                  theDistance progress of Path (0 = start location, 1 = end of path location).
9128                  theCopy is to create a copy objects if true.
9129                  theReverse  0 - for usual direction, 1 - to reverse path direction.
9130
9131             Returns:
9132                  Displaced theObject (GEOM.GEOM_Object) if theCopy is False or
9133                  new GEOM.GEOM_Object, containing the displaced shape if theCopy is True.
9134
9135             Example of usage:
9136                 position = geompy.PositionAlongPath(cylinder, circle, 0.75, 1, 1)
9137             """
9138             # Example: see GEOM_TestAll.py
9139             anObj = self.TrsfOp.PositionAlongPath(theObject, thePath, theDistance, theCopy, theReverse)
9140             RaiseIfFailed("PositionAlongPath", self.TrsfOp)
9141             return anObj
9142
9143         ## Modify the Location of the given object by Path, creating its copy before the operation.
9144         #  @param theObject The object to be displaced.
9145         #  @param thePath Wire or Edge along that the object will be translated.
9146         #  @param theDistance progress of Path (0 = start location, 1 = end of path location).
9147         #  @param theReverse  0 - for usual direction, 1 - to reverse path direction.
9148         #  @param theName Object name; when specified, this parameter is used
9149         #         for result publication in the study. Otherwise, if automatic
9150         #         publication is switched on, default value is used for result name.
9151         #
9152         #  @return New GEOM.GEOM_Object, containing the displaced shape.
9153         @ManageTransactions("TrsfOp")
9154         def MakePositionAlongPath(self, theObject, thePath, theDistance, theReverse, theName=None):
9155             """
9156             Modify the Location of the given object by Path, creating its copy before the operation.
9157
9158             Parameters:
9159                  theObject The object to be displaced.
9160                  thePath Wire or Edge along that the object will be translated.
9161                  theDistance progress of Path (0 = start location, 1 = end of path location).
9162                  theReverse  0 - for usual direction, 1 - to reverse path direction.
9163                  theName Object name; when specified, this parameter is used
9164                          for result publication in the study. Otherwise, if automatic
9165                          publication is switched on, default value is used for result name.
9166
9167             Returns:
9168                 New GEOM.GEOM_Object, containing the displaced shape.
9169             """
9170             # Example: see GEOM_TestAll.py
9171             anObj = self.TrsfOp.PositionAlongPath(theObject, thePath, theDistance, 1, theReverse)
9172             RaiseIfFailed("PositionAlongPath", self.TrsfOp)
9173             self._autoPublish(anObj, theName, "displaced")
9174             return anObj
9175
9176         ## Offset given shape.
9177         #  @param theObject The base object for the offset.
9178         #  @param theOffset Offset value.
9179         #  @param theCopy Flag used to offset object itself or create a copy.
9180         #  @return Modified @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
9181         #  new GEOM.GEOM_Object, containing the result of offset operation if @a theCopy flag is @c True.
9182         @ManageTransactions("TrsfOp")
9183         def Offset(self, theObject, theOffset, theCopy=False):
9184             """
9185             Offset given shape.
9186
9187             Parameters:
9188                 theObject The base object for the offset.
9189                 theOffset Offset value.
9190                 theCopy Flag used to offset object itself or create a copy.
9191
9192             Returns:
9193                 Modified theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
9194                 new GEOM.GEOM_Object, containing the result of offset operation if theCopy flag is True.
9195             """
9196             theOffset, Parameters = ParseParameters(theOffset)
9197             if theCopy:
9198                 anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
9199             else:
9200                 anObj = self.TrsfOp.OffsetShape(theObject, theOffset)
9201             RaiseIfFailed("Offset", self.TrsfOp)
9202             anObj.SetParameters(Parameters)
9203             return anObj
9204
9205         ## Create new object as offset of the given one.
9206         #  @param theObject The base object for the offset.
9207         #  @param theOffset Offset value.
9208         #  @param theName Object name; when specified, this parameter is used
9209         #         for result publication in the study. Otherwise, if automatic
9210         #         publication is switched on, default value is used for result name.
9211         #
9212         #  @return New GEOM.GEOM_Object, containing the offset object.
9213         #
9214         #  @ref tui_offset "Example"
9215         @ManageTransactions("TrsfOp")
9216         def MakeOffset(self, theObject, theOffset, theName=None):
9217             """
9218             Create new object as offset of the given one.
9219
9220             Parameters:
9221                 theObject The base object for the offset.
9222                 theOffset Offset value.
9223                 theName Object name; when specified, this parameter is used
9224                         for result publication in the study. Otherwise, if automatic
9225                         publication is switched on, default value is used for result name.
9226
9227             Returns:
9228                 New GEOM.GEOM_Object, containing the offset object.
9229
9230             Example of usage:
9231                  box = geompy.MakeBox(20, 20, 20, 200, 200, 200)
9232                  # create a new object as offset of the given object
9233                  offset = geompy.MakeOffset(box, 70.)
9234             """
9235             # Example: see GEOM_TestAll.py
9236             theOffset, Parameters = ParseParameters(theOffset)
9237             anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
9238             RaiseIfFailed("OffsetShapeCopy", self.TrsfOp)
9239             anObj.SetParameters(Parameters)
9240             self._autoPublish(anObj, theName, "offset")
9241             return anObj
9242
9243         ## Create new object as projection of the given one on another.
9244         #  @param theSource The source object for the projection. It can be a point, edge or wire.
9245         #         Edge and wire are acceptable if @a theTarget is a face.
9246         #  @param theTarget The target object. It can be planar or cylindrical face, edge or wire.
9247         #  @param theName Object name; when specified, this parameter is used
9248         #         for result publication in the study. Otherwise, if automatic
9249         #         publication is switched on, default value is used for result name.
9250         #
9251         #  @return New GEOM.GEOM_Object, containing the projection.
9252         #
9253         #  @ref tui_projection "Example"
9254         @ManageTransactions("TrsfOp")
9255         def MakeProjection(self, theSource, theTarget, theName=None):
9256             """
9257             Create new object as projection of the given one on another.
9258
9259             Parameters:
9260                 theSource The source object for the projection. It can be a point, edge or wire.
9261                           Edge and wire are acceptable if theTarget is a face.
9262                 theTarget The target object. It can be planar or cylindrical face, edge or wire.
9263                 theName Object name; when specified, this parameter is used
9264                         for result publication in the study. Otherwise, if automatic
9265                         publication is switched on, default value is used for result name.
9266
9267             Returns:
9268                 New GEOM.GEOM_Object, containing the projection.
9269             """
9270             # Example: see GEOM_TestAll.py
9271             anObj = self.TrsfOp.ProjectShapeCopy(theSource, theTarget)
9272             RaiseIfFailed("ProjectShapeCopy", self.TrsfOp)
9273             self._autoPublish(anObj, theName, "projection")
9274             return anObj
9275
9276         ## Create a projection of the given point on a wire or an edge.
9277         #  If there are no solutions or there are 2 or more solutions It throws an
9278         #  exception.
9279         #  @param thePoint the point to be projected.
9280         #  @param theWire the wire. The edge is accepted as well.
9281         #  @param theName Object name; when specified, this parameter is used
9282         #         for result publication in the study. Otherwise, if automatic
9283         #         publication is switched on, default value is used for result name.
9284         #
9285         #  @return [\a u, \a PointOnEdge, \a EdgeInWireIndex]
9286         #  \n \a u: The parameter of projection point on edge.
9287         #  \n \a PointOnEdge: The projection point.
9288         #  \n \a EdgeInWireIndex: The index of an edge in a wire.
9289         #
9290         #  @ref tui_projection "Example"
9291         @ManageTransactions("TrsfOp")
9292         def MakeProjectionOnWire(self, thePoint, theWire, theName=None):
9293             """
9294             Create a projection of the given point on a wire or an edge.
9295             If there are no solutions or there are 2 or more solutions It throws an
9296             exception.
9297
9298             Parameters:
9299                 thePoint the point to be projected.
9300                 theWire the wire. The edge is accepted as well.
9301                 theName Object name; when specified, this parameter is used
9302                         for result publication in the study. Otherwise, if automatic
9303                         publication is switched on, default value is used for result name.
9304
9305             Returns:
9306                 [u, PointOnEdge, EdgeInWireIndex]
9307                  u: The parameter of projection point on edge.
9308                  PointOnEdge: The projection point.
9309                  EdgeInWireIndex: The index of an edge in a wire.
9310             """
9311             # Example: see GEOM_TestAll.py
9312             anObj = self.TrsfOp.ProjectPointOnWire(thePoint, theWire)
9313             RaiseIfFailed("ProjectPointOnWire", self.TrsfOp)
9314             self._autoPublish(anObj[1], theName, "projection")
9315             return anObj
9316
9317         # -----------------------------------------------------------------------------
9318         # Patterns
9319         # -----------------------------------------------------------------------------
9320
9321         ## Translate the given object along the given vector a given number times
9322         #  @param theObject The object to be translated.
9323         #  @param theVector Direction of the translation. DX if None.
9324         #  @param theStep Distance to translate on.
9325         #  @param theNbTimes Quantity of translations to be done.
9326         #  @param theName Object name; when specified, this parameter is used
9327         #         for result publication in the study. Otherwise, if automatic
9328         #         publication is switched on, default value is used for result name.
9329         #
9330         #  @return New GEOM.GEOM_Object, containing compound of all
9331         #          the shapes, obtained after each translation.
9332         #
9333         #  @ref tui_multi_translation "Example"
9334         @ManageTransactions("TrsfOp")
9335         def MakeMultiTranslation1D(self, theObject, theVector, theStep, theNbTimes, theName=None):
9336             """
9337             Translate the given object along the given vector a given number times
9338
9339             Parameters:
9340                 theObject The object to be translated.
9341                 theVector Direction of the translation. DX if None.
9342                 theStep Distance to translate on.
9343                 theNbTimes Quantity of translations to be done.
9344                 theName Object name; when specified, this parameter is used
9345                         for result publication in the study. Otherwise, if automatic
9346                         publication is switched on, default value is used for result name.
9347
9348             Returns:
9349                 New GEOM.GEOM_Object, containing compound of all
9350                 the shapes, obtained after each translation.
9351
9352             Example of usage:
9353                 r1d = geompy.MakeMultiTranslation1D(prism, vect, 20, 4)
9354             """
9355             # Example: see GEOM_TestAll.py
9356             theStep, theNbTimes, Parameters = ParseParameters(theStep, theNbTimes)
9357             anObj = self.TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
9358             RaiseIfFailed("MultiTranslate1D", self.TrsfOp)
9359             anObj.SetParameters(Parameters)
9360             self._autoPublish(anObj, theName, "multitranslation")
9361             return anObj
9362
9363         ## Conseqently apply two specified translations to theObject specified number of times.
9364         #  @param theObject The object to be translated.
9365         #  @param theVector1 Direction of the first translation. DX if None.
9366         #  @param theStep1 Step of the first translation.
9367         #  @param theNbTimes1 Quantity of translations to be done along theVector1.
9368         #  @param theVector2 Direction of the second translation. DY if None.
9369         #  @param theStep2 Step of the second translation.
9370         #  @param theNbTimes2 Quantity of translations to be done along theVector2.
9371         #  @param theName Object name; when specified, this parameter is used
9372         #         for result publication in the study. Otherwise, if automatic
9373         #         publication is switched on, default value is used for result name.
9374         #
9375         #  @return New GEOM.GEOM_Object, containing compound of all
9376         #          the shapes, obtained after each translation.
9377         #
9378         #  @ref tui_multi_translation "Example"
9379         @ManageTransactions("TrsfOp")
9380         def MakeMultiTranslation2D(self, theObject, theVector1, theStep1, theNbTimes1,
9381                                    theVector2, theStep2, theNbTimes2, theName=None):
9382             """
9383             Conseqently apply two specified translations to theObject specified number of times.
9384
9385             Parameters:
9386                 theObject The object to be translated.
9387                 theVector1 Direction of the first translation. DX if None.
9388                 theStep1 Step of the first translation.
9389                 theNbTimes1 Quantity of translations to be done along theVector1.
9390                 theVector2 Direction of the second translation. DY if None.
9391                 theStep2 Step of the second translation.
9392                 theNbTimes2 Quantity of translations to be done along theVector2.
9393                 theName Object name; when specified, this parameter is used
9394                         for result publication in the study. Otherwise, if automatic
9395                         publication is switched on, default value is used for result name.
9396
9397             Returns:
9398                 New GEOM.GEOM_Object, containing compound of all
9399                 the shapes, obtained after each translation.
9400
9401             Example of usage:
9402                 tr2d = geompy.MakeMultiTranslation2D(prism, vect1, 20, 4, vect2, 80, 3)
9403             """
9404             # Example: see GEOM_TestAll.py
9405             theStep1,theNbTimes1,theStep2,theNbTimes2, Parameters = ParseParameters(theStep1,theNbTimes1,theStep2,theNbTimes2)
9406             anObj = self.TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
9407                                                  theVector2, theStep2, theNbTimes2)
9408             RaiseIfFailed("MultiTranslate2D", self.TrsfOp)
9409             anObj.SetParameters(Parameters)
9410             self._autoPublish(anObj, theName, "multitranslation")
9411             return anObj
9412
9413         ## Rotate the given object around the given axis a given number times.
9414         #  Rotation angle will be 2*PI/theNbTimes.
9415         #  @param theObject The object to be rotated.
9416         #  @param theAxis The rotation axis. DZ if None.
9417         #  @param theNbTimes Quantity of rotations to be done.
9418         #  @param theName Object name; when specified, this parameter is used
9419         #         for result publication in the study. Otherwise, if automatic
9420         #         publication is switched on, default value is used for result name.
9421         #
9422         #  @return New GEOM.GEOM_Object, containing compound of all the
9423         #          shapes, obtained after each rotation.
9424         #
9425         #  @ref tui_multi_rotation "Example"
9426         @ManageTransactions("TrsfOp")
9427         def MultiRotate1DNbTimes (self, theObject, theAxis, theNbTimes, theName=None):
9428             """
9429             Rotate the given object around the given axis a given number times.
9430             Rotation angle will be 2*PI/theNbTimes.
9431
9432             Parameters:
9433                 theObject The object to be rotated.
9434                 theAxis The rotation axis. DZ if None.
9435                 theNbTimes Quantity of rotations to be done.
9436                 theName Object name; when specified, this parameter is used
9437                         for result publication in the study. Otherwise, if automatic
9438                         publication is switched on, default value is used for result name.
9439
9440             Returns:
9441                 New GEOM.GEOM_Object, containing compound of all the
9442                 shapes, obtained after each rotation.
9443
9444             Example of usage:
9445                 rot1d = geompy.MultiRotate1DNbTimes(prism, vect, 4)
9446             """
9447             # Example: see GEOM_TestAll.py
9448             theNbTimes, Parameters = ParseParameters(theNbTimes)
9449             anObj = self.TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
9450             RaiseIfFailed("MultiRotate1DNbTimes", self.TrsfOp)
9451             anObj.SetParameters(Parameters)
9452             self._autoPublish(anObj, theName, "multirotation")
9453             return anObj
9454
9455         ## Rotate the given object around the given axis
9456         #  a given number times on the given angle.
9457         #  @param theObject The object to be rotated.
9458         #  @param theAxis The rotation axis. DZ if None.
9459         #  @param theAngleStep Rotation angle in radians.
9460         #  @param theNbTimes Quantity of rotations to be done.
9461         #  @param theName Object name; when specified, this parameter is used
9462         #         for result publication in the study. Otherwise, if automatic
9463         #         publication is switched on, default value is used for result name.
9464         #
9465         #  @return New GEOM.GEOM_Object, containing compound of all the
9466         #          shapes, obtained after each rotation.
9467         #
9468         #  @ref tui_multi_rotation "Example"
9469         @ManageTransactions("TrsfOp")
9470         def MultiRotate1DByStep(self, theObject, theAxis, theAngleStep, theNbTimes, theName=None):
9471             """
9472             Rotate the given object around the given axis
9473             a given number times on the given angle.
9474
9475             Parameters:
9476                 theObject The object to be rotated.
9477                 theAxis The rotation axis. DZ if None.
9478                 theAngleStep Rotation angle in radians.
9479                 theNbTimes Quantity of rotations to be done.
9480                 theName Object name; when specified, this parameter is used
9481                         for result publication in the study. Otherwise, if automatic
9482                         publication is switched on, default value is used for result name.
9483
9484             Returns:
9485                 New GEOM.GEOM_Object, containing compound of all the
9486                 shapes, obtained after each rotation.
9487
9488             Example of usage:
9489                 rot1d = geompy.MultiRotate1DByStep(prism, vect, math.pi/4, 4)
9490             """
9491             # Example: see GEOM_TestAll.py
9492             theAngleStep, theNbTimes, Parameters = ParseParameters(theAngleStep, theNbTimes)
9493             anObj = self.TrsfOp.MultiRotate1DByStep(theObject, theAxis, theAngleStep, theNbTimes)
9494             RaiseIfFailed("MultiRotate1DByStep", self.TrsfOp)
9495             anObj.SetParameters(Parameters)
9496             self._autoPublish(anObj, theName, "multirotation")
9497             return anObj
9498
9499         ## Rotate the given object around the given axis a given
9500         #  number times and multi-translate each rotation result.
9501         #  Rotation angle will be 2*PI/theNbTimes1.
9502         #  Translation direction passes through center of gravity
9503         #  of rotated shape and its projection on the rotation axis.
9504         #  @param theObject The object to be rotated.
9505         #  @param theAxis Rotation axis. DZ if None.
9506         #  @param theNbTimes1 Quantity of rotations to be done.
9507         #  @param theRadialStep Translation distance.
9508         #  @param theNbTimes2 Quantity of translations to be done.
9509         #  @param theName Object name; when specified, this parameter is used
9510         #         for result publication in the study. Otherwise, if automatic
9511         #         publication is switched on, default value is used for result name.
9512         #
9513         #  @return New GEOM.GEOM_Object, containing compound of all the
9514         #          shapes, obtained after each transformation.
9515         #
9516         #  @ref tui_multi_rotation "Example"
9517         @ManageTransactions("TrsfOp")
9518         def MultiRotate2DNbTimes(self, theObject, theAxis, theNbTimes1, theRadialStep, theNbTimes2, theName=None):
9519             """
9520             Rotate the given object around the
9521             given axis on the given angle a given number
9522             times and multi-translate each rotation result.
9523             Translation direction passes through center of gravity
9524             of rotated shape and its projection on the rotation axis.
9525
9526             Parameters:
9527                 theObject The object to be rotated.
9528                 theAxis Rotation axis. DZ if None.
9529                 theNbTimes1 Quantity of rotations to be done.
9530                 theRadialStep Translation distance.
9531                 theNbTimes2 Quantity of translations to be done.
9532                 theName Object name; when specified, this parameter is used
9533                         for result publication in the study. Otherwise, if automatic
9534                         publication is switched on, default value is used for result name.
9535
9536             Returns:
9537                 New GEOM.GEOM_Object, containing compound of all the
9538                 shapes, obtained after each transformation.
9539
9540             Example of usage:
9541                 rot2d = geompy.MultiRotate2D(prism, vect, 60, 4, 50, 5)
9542             """
9543             # Example: see GEOM_TestAll.py
9544             theNbTimes1, theRadialStep, theNbTimes2, Parameters = ParseParameters(theNbTimes1, theRadialStep, theNbTimes2)
9545             anObj = self.TrsfOp.MultiRotate2DNbTimes(theObject, theAxis, theNbTimes1, theRadialStep, theNbTimes2)
9546             RaiseIfFailed("MultiRotate2DNbTimes", self.TrsfOp)
9547             anObj.SetParameters(Parameters)
9548             self._autoPublish(anObj, theName, "multirotation")
9549             return anObj
9550
9551         ## Rotate the given object around the
9552         #  given axis on the given angle a given number
9553         #  times and multi-translate each rotation result.
9554         #  Translation direction passes through center of gravity
9555         #  of rotated shape and its projection on the rotation axis.
9556         #  @param theObject The object to be rotated.
9557         #  @param theAxis Rotation axis. DZ if None.
9558         #  @param theAngleStep Rotation angle in radians.
9559         #  @param theNbTimes1 Quantity of rotations to be done.
9560         #  @param theRadialStep Translation distance.
9561         #  @param theNbTimes2 Quantity of translations to be done.
9562         #  @param theName Object name; when specified, this parameter is used
9563         #         for result publication in the study. Otherwise, if automatic
9564         #         publication is switched on, default value is used for result name.
9565         #
9566         #  @return New GEOM.GEOM_Object, containing compound of all the
9567         #          shapes, obtained after each transformation.
9568         #
9569         #  @ref tui_multi_rotation "Example"
9570         @ManageTransactions("TrsfOp")
9571         def MultiRotate2DByStep (self, theObject, theAxis, theAngleStep, theNbTimes1, theRadialStep, theNbTimes2, theName=None):
9572             """
9573             Rotate the given object around the
9574             given axis on the given angle a given number
9575             times and multi-translate each rotation result.
9576             Translation direction passes through center of gravity
9577             of rotated shape and its projection on the rotation axis.
9578
9579             Parameters:
9580                 theObject The object to be rotated.
9581                 theAxis Rotation axis. DZ if None.
9582                 theAngleStep Rotation angle in radians.
9583                 theNbTimes1 Quantity of rotations to be done.
9584                 theRadialStep Translation distance.
9585                 theNbTimes2 Quantity of translations to be done.
9586                 theName Object name; when specified, this parameter is used
9587                         for result publication in the study. Otherwise, if automatic
9588                         publication is switched on, default value is used for result name.
9589
9590             Returns:
9591                 New GEOM.GEOM_Object, containing compound of all the
9592                 shapes, obtained after each transformation.
9593
9594             Example of usage:
9595                 rot2d = geompy.MultiRotate2D(prism, vect, math.pi/3, 4, 50, 5)
9596             """
9597             # Example: see GEOM_TestAll.py
9598             theAngleStep, theNbTimes1, theRadialStep, theNbTimes2, Parameters = ParseParameters(theAngleStep, theNbTimes1, theRadialStep, theNbTimes2)
9599             anObj = self.TrsfOp.MultiRotate2DByStep(theObject, theAxis, theAngleStep, theNbTimes1, theRadialStep, theNbTimes2)
9600             RaiseIfFailed("MultiRotate2DByStep", self.TrsfOp)
9601             anObj.SetParameters(Parameters)
9602             self._autoPublish(anObj, theName, "multirotation")
9603             return anObj
9604
9605         ## The same, as MultiRotate1DNbTimes(), but axis is given by direction and point
9606         #
9607         #  @ref swig_MakeMultiRotation "Example"
9608         def MakeMultiRotation1DNbTimes(self, aShape, aDir, aPoint, aNbTimes, theName=None):
9609             """
9610             The same, as geompy.MultiRotate1DNbTimes, but axis is given by direction and point
9611
9612             Example of usage:
9613                 pz = geompy.MakeVertex(0, 0, 100)
9614                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9615                 MultiRot1D = geompy.MakeMultiRotation1DNbTimes(prism, vy, pz, 6)
9616             """
9617             # Example: see GEOM_TestOthers.py
9618             aVec = self.MakeLine(aPoint,aDir)
9619             # note: auto-publishing is done in self.MultiRotate1D()
9620             anObj = self.MultiRotate1DNbTimes(aShape, aVec, aNbTimes, theName)
9621             return anObj
9622
9623         ## The same, as MultiRotate1DByStep(), but axis is given by direction and point
9624         #
9625         #  @ref swig_MakeMultiRotation "Example"
9626         def MakeMultiRotation1DByStep(self, aShape, aDir, aPoint, anAngle, aNbTimes, theName=None):
9627             """
9628             The same, as geompy.MultiRotate1D, but axis is given by direction and point
9629
9630             Example of usage:
9631                 pz = geompy.MakeVertex(0, 0, 100)
9632                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9633                 MultiRot1D = geompy.MakeMultiRotation1DByStep(prism, vy, pz, math.pi/3, 6)
9634             """
9635             # Example: see GEOM_TestOthers.py
9636             aVec = self.MakeLine(aPoint,aDir)
9637             # note: auto-publishing is done in self.MultiRotate1D()
9638             anObj = self.MultiRotate1DByStep(aShape, aVec, anAngle, aNbTimes, theName)
9639             return anObj
9640
9641         ## The same, as MultiRotate2DNbTimes(), but axis is given by direction and point
9642         #
9643         #  @ref swig_MakeMultiRotation "Example"
9644         def MakeMultiRotation2DNbTimes(self, aShape, aDir, aPoint, nbtimes1, aStep, nbtimes2, theName=None):
9645             """
9646             The same, as MultiRotate2DNbTimes(), but axis is given by direction and point
9647
9648             Example of usage:
9649                 pz = geompy.MakeVertex(0, 0, 100)
9650                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9651                 MultiRot2D = geompy.MakeMultiRotation2DNbTimes(f12, vy, pz, 6, 30, 3)
9652             """
9653             # Example: see GEOM_TestOthers.py
9654             aVec = self.MakeLine(aPoint,aDir)
9655             # note: auto-publishing is done in self.MultiRotate2DNbTimes()
9656             anObj = self.MultiRotate2DNbTimes(aShape, aVec, nbtimes1, aStep, nbtimes2, theName)
9657             return anObj
9658
9659         ## The same, as MultiRotate2DByStep(), but axis is given by direction and point
9660         #
9661         #  @ref swig_MakeMultiRotation "Example"
9662         def MakeMultiRotation2DByStep(self, aShape, aDir, aPoint, anAngle, nbtimes1, aStep, nbtimes2, theName=None):
9663             """
9664             The same, as MultiRotate2DByStep(), but axis is given by direction and point
9665
9666             Example of usage:
9667                 pz = geompy.MakeVertex(0, 0, 100)
9668                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9669                 MultiRot2D = geompy.MakeMultiRotation2DByStep(f12, vy, pz, math.pi/4, 6, 30, 3)
9670             """
9671             # Example: see GEOM_TestOthers.py
9672             aVec = self.MakeLine(aPoint,aDir)
9673             # note: auto-publishing is done in self.MultiRotate2D()
9674             anObj = self.MultiRotate2DByStep(aShape, aVec, anAngle, nbtimes1, aStep, nbtimes2, theName)
9675             return anObj
9676
9677         ##
9678         #  Compute a wire or a face that represents a projection of the source
9679         #  shape onto cylinder. The cylinder's coordinate system is the same
9680         #  as the global coordinate system.
9681         #
9682         #  @param theObject The object to be projected. It can be either
9683         #         a planar wire or a face.
9684         #  @param theRadius The radius of the cylinder.
9685         #  @param theStartAngle The starting angle in radians from
9686         #         the cylinder's X axis around Z axis. The angle from which
9687         #         the projection is started.
9688         #  @param theAngleLength The projection length angle in radians.
9689         #         The angle in which to project the total length of the wire.
9690         #         If it is negative the projection is not scaled and natural
9691         #         wire length is kept for the projection.
9692         #  @param theAngleRotation The desired angle in radians between
9693         #         the tangent vector to the first curve at the first point of
9694         #         the theObject's projection in 2D space and U-direction of
9695         #         cylinder's 2D space.
9696         #  @param theName Object name; when specified, this parameter is used
9697         #         for result publication in the study. Otherwise, if automatic
9698         #         publication is switched on, default value is used for result name.
9699         #
9700         #  @return New GEOM.GEOM_Object, containing the result shape. The result
9701         #         represents a wire or a face that represents a projection of
9702         #         the source shape onto a cylinder.
9703         #
9704         #  @ref tui_projection "Example"
9705         def MakeProjectionOnCylinder (self, theObject, theRadius,
9706                                       theStartAngle=0.0, theAngleLength=-1.0,
9707                                       theAngleRotation=0.0,
9708                                       theName=None):
9709             """
9710             Compute a wire or a face that represents a projection of the source
9711             shape onto cylinder. The cylinder's coordinate system is the same
9712             as the global coordinate system.
9713
9714             Parameters:
9715                 theObject The object to be projected. It can be either
9716                         a planar wire or a face.
9717                 theRadius The radius of the cylinder.
9718                 theStartAngle The starting angle in radians from the cylinder's X axis
9719                         around Z axis. The angle from which the projection is started.
9720                 theAngleLength The projection length angle in radians. The angle in which
9721                         to project the total length of the wire. If it is negative the
9722                         projection is not scaled and natural wire length is kept for
9723                         the projection.
9724                 theAngleRotation The desired angle in radians between
9725                         the tangent vector to the first curve at the first
9726                         point of the theObject's projection in 2D space and
9727                         U-direction of cylinder's 2D space.
9728                 theName Object name; when specified, this parameter is used
9729                         for result publication in the study. Otherwise, if automatic
9730                         publication is switched on, default value is used for result name.
9731
9732             Returns:
9733                 New GEOM.GEOM_Object, containing the result shape. The result
9734                 represents a wire or a face that represents a projection of
9735                 the source shape onto a cylinder.
9736             """
9737             # Example: see GEOM_TestAll.py
9738             flagStartAngle = False
9739             if isinstance(theStartAngle,str):
9740                 flagStartAngle = True
9741             flagAngleLength = False
9742             if isinstance(theAngleLength,str):
9743                 flagAngleLength = True
9744             flagAngleRotation = False
9745             if isinstance(theAngleRotation,str):
9746                 flagAngleRotation = True
9747             theRadius, theStartAngle, theAngleLength, theAngleRotation, Parameters = ParseParameters(
9748               theRadius, theStartAngle, theAngleLength, theAngleRotation)
9749             if flagStartAngle:
9750                 theStartAngle = theStartAngle*math.pi/180.
9751             if flagAngleLength:
9752                 theAngleLength = theAngleLength*math.pi/180.
9753             if flagAngleRotation:
9754                 theAngleRotation = theAngleRotation*math.pi/180.
9755             anObj = self.TrsfOp.MakeProjectionOnCylinder(theObject, theRadius,
9756                 theStartAngle, theAngleLength, theAngleRotation)
9757             RaiseIfFailed("MakeProjectionOnCylinder", self.TrsfOp)
9758             anObj.SetParameters(Parameters)
9759             self._autoPublish(anObj, theName, "projection")
9760             return anObj
9761
9762         # end of l3_transform
9763         ## @}
9764
9765         ## @addtogroup l3_transform_d
9766         ## @{
9767
9768         ## Deprecated method. Use MultiRotate1DNbTimes instead.
9769         def MultiRotate1D(self, theObject, theAxis, theNbTimes, theName=None):
9770             """
9771             Deprecated method. Use MultiRotate1DNbTimes instead.
9772             """
9773             print "The method MultiRotate1D is DEPRECATED. Use MultiRotate1DNbTimes instead."
9774             return self.MultiRotate1DNbTimes(theObject, theAxis, theNbTimes, theName)
9775
9776         ## The same, as MultiRotate2DByStep(), but theAngle is in degrees.
9777         #  This method is DEPRECATED. Use MultiRotate2DByStep() instead.
9778         @ManageTransactions("TrsfOp")
9779         def MultiRotate2D(self, theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2, theName=None):
9780             """
9781             The same, as MultiRotate2DByStep(), but theAngle is in degrees.
9782             This method is DEPRECATED. Use MultiRotate2DByStep() instead.
9783
9784             Example of usage:
9785                 rot2d = geompy.MultiRotate2D(prism, vect, 60, 4, 50, 5)
9786             """
9787             print "The method MultiRotate2D is DEPRECATED. Use MultiRotate2DByStep instead."
9788             theAngle, theNbTimes1, theStep, theNbTimes2, Parameters = ParseParameters(theAngle, theNbTimes1, theStep, theNbTimes2)
9789             anObj = self.TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
9790             RaiseIfFailed("MultiRotate2D", self.TrsfOp)
9791             anObj.SetParameters(Parameters)
9792             self._autoPublish(anObj, theName, "multirotation")
9793             return anObj
9794
9795         ## The same, as MultiRotate1D(), but axis is given by direction and point
9796         #  This method is DEPRECATED. Use MakeMultiRotation1DNbTimes instead.
9797         def MakeMultiRotation1D(self, aShape, aDir, aPoint, aNbTimes, theName=None):
9798             """
9799             The same, as geompy.MultiRotate1D, but axis is given by direction and point.
9800             This method is DEPRECATED. Use MakeMultiRotation1DNbTimes instead.
9801
9802             Example of usage:
9803                 pz = geompy.MakeVertex(0, 0, 100)
9804                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9805                 MultiRot1D = geompy.MakeMultiRotation1D(prism, vy, pz, 6)
9806             """
9807             print "The method MakeMultiRotation1D is DEPRECATED. Use MakeMultiRotation1DNbTimes instead."
9808             aVec = self.MakeLine(aPoint,aDir)
9809             # note: auto-publishing is done in self.MultiRotate1D()
9810             anObj = self.MultiRotate1D(aShape, aVec, aNbTimes, theName)
9811             return anObj
9812
9813         ## The same, as MultiRotate2D(), but axis is given by direction and point
9814         #  This method is DEPRECATED. Use MakeMultiRotation2DByStep instead.
9815         def MakeMultiRotation2D(self, aShape, aDir, aPoint, anAngle, nbtimes1, aStep, nbtimes2, theName=None):
9816             """
9817             The same, as MultiRotate2D(), but axis is given by direction and point
9818             This method is DEPRECATED. Use MakeMultiRotation2DByStep instead.
9819
9820             Example of usage:
9821                 pz = geompy.MakeVertex(0, 0, 100)
9822                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9823                 MultiRot2D = geompy.MakeMultiRotation2D(f12, vy, pz, 45, 6, 30, 3)
9824             """
9825             print "The method MakeMultiRotation2D is DEPRECATED. Use MakeMultiRotation2DByStep instead."
9826             aVec = self.MakeLine(aPoint,aDir)
9827             # note: auto-publishing is done in self.MultiRotate2D()
9828             anObj = self.MultiRotate2D(aShape, aVec, anAngle, nbtimes1, aStep, nbtimes2, theName)
9829             return anObj
9830
9831         # end of l3_transform_d
9832         ## @}
9833
9834         ## @addtogroup l3_local
9835         ## @{
9836
9837         ## Perform a fillet on all edges of the given shape.
9838         #  @param theShape Shape, to perform fillet on.
9839         #  @param theR Fillet radius.
9840         #  @param theName Object name; when specified, this parameter is used
9841         #         for result publication in the study. Otherwise, if automatic
9842         #         publication is switched on, default value is used for result name.
9843         #
9844         #  @return New GEOM.GEOM_Object, containing the result shape.
9845         #
9846         #  @ref tui_fillet "Example 1"
9847         #  \n @ref swig_MakeFilletAll "Example 2"
9848         @ManageTransactions("LocalOp")
9849         def MakeFilletAll(self, theShape, theR, theName=None):
9850             """
9851             Perform a fillet on all edges of the given shape.
9852
9853             Parameters:
9854                 theShape Shape, to perform fillet on.
9855                 theR Fillet radius.
9856                 theName Object name; when specified, this parameter is used
9857                         for result publication in the study. Otherwise, if automatic
9858                         publication is switched on, default value is used for result name.
9859
9860             Returns:
9861                 New GEOM.GEOM_Object, containing the result shape.
9862
9863             Example of usage:
9864                filletall = geompy.MakeFilletAll(prism, 10.)
9865             """
9866             # Example: see GEOM_TestOthers.py
9867             theR,Parameters = ParseParameters(theR)
9868             anObj = self.LocalOp.MakeFilletAll(theShape, theR)
9869             RaiseIfFailed("MakeFilletAll", self.LocalOp)
9870             anObj.SetParameters(Parameters)
9871             self._autoPublish(anObj, theName, "fillet")
9872             return anObj
9873
9874         ## Perform a fillet on the specified edges/faces of the given shape
9875         #  @param theShape Shape, to perform fillet on.
9876         #  @param theR Fillet radius.
9877         #  @param theShapeType Type of shapes in <VAR>theListShapes</VAR> (see ShapeType())
9878         #  @param theListShapes Global indices of edges/faces to perform fillet on.
9879         #  @param theName Object name; when specified, this parameter is used
9880         #         for result publication in the study. Otherwise, if automatic
9881         #         publication is switched on, default value is used for result name.
9882         #
9883         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9884         #
9885         #  @return New GEOM.GEOM_Object, containing the result shape.
9886         #
9887         #  @ref tui_fillet "Example"
9888         @ManageTransactions("LocalOp")
9889         def MakeFillet(self, theShape, theR, theShapeType, theListShapes, theName=None):
9890             """
9891             Perform a fillet on the specified edges/faces of the given shape
9892
9893             Parameters:
9894                 theShape Shape, to perform fillet on.
9895                 theR Fillet radius.
9896                 theShapeType Type of shapes in theListShapes (see geompy.ShapeTypes)
9897                 theListShapes Global indices of edges/faces to perform fillet on.
9898                 theName Object name; when specified, this parameter is used
9899                         for result publication in the study. Otherwise, if automatic
9900                         publication is switched on, default value is used for result name.
9901
9902             Note:
9903                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9904
9905             Returns:
9906                 New GEOM.GEOM_Object, containing the result shape.
9907
9908             Example of usage:
9909                 # get the list of IDs (IDList) for the fillet
9910                 prism_edges = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["EDGE"])
9911                 IDlist_e = []
9912                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[0]))
9913                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[1]))
9914                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[2]))
9915                 # make a fillet on the specified edges of the given shape
9916                 fillet = geompy.MakeFillet(prism, 10., geompy.ShapeType["EDGE"], IDlist_e)
9917             """
9918             # Example: see GEOM_TestAll.py
9919             theR,Parameters = ParseParameters(theR)
9920             anObj = None
9921             if theShapeType == self.ShapeType["EDGE"]:
9922                 anObj = self.LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
9923                 RaiseIfFailed("MakeFilletEdges", self.LocalOp)
9924             else:
9925                 anObj = self.LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
9926                 RaiseIfFailed("MakeFilletFaces", self.LocalOp)
9927             anObj.SetParameters(Parameters)
9928             self._autoPublish(anObj, theName, "fillet")
9929             return anObj
9930
9931         ## The same that MakeFillet() but with two Fillet Radius R1 and R2
9932         @ManageTransactions("LocalOp")
9933         def MakeFilletR1R2(self, theShape, theR1, theR2, theShapeType, theListShapes, theName=None):
9934             """
9935             The same that geompy.MakeFillet but with two Fillet Radius R1 and R2
9936
9937             Example of usage:
9938                 # get the list of IDs (IDList) for the fillet
9939                 prism_edges = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["EDGE"])
9940                 IDlist_e = []
9941                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[0]))
9942                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[1]))
9943                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[2]))
9944                 # make a fillet on the specified edges of the given shape
9945                 fillet = geompy.MakeFillet(prism, 10., 15., geompy.ShapeType["EDGE"], IDlist_e)
9946             """
9947             theR1,theR2,Parameters = ParseParameters(theR1,theR2)
9948             anObj = None
9949             if theShapeType == self.ShapeType["EDGE"]:
9950                 anObj = self.LocalOp.MakeFilletEdgesR1R2(theShape, theR1, theR2, theListShapes)
9951                 RaiseIfFailed("MakeFilletEdgesR1R2", self.LocalOp)
9952             else:
9953                 anObj = self.LocalOp.MakeFilletFacesR1R2(theShape, theR1, theR2, theListShapes)
9954                 RaiseIfFailed("MakeFilletFacesR1R2", self.LocalOp)
9955             anObj.SetParameters(Parameters)
9956             self._autoPublish(anObj, theName, "fillet")
9957             return anObj
9958
9959         ## Perform a fillet on the specified edges of the given shape
9960         #  @param theShape  Wire Shape to perform fillet on.
9961         #  @param theR  Fillet radius.
9962         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
9963         #    \note Global index of sub-shape can be obtained, using method GetSubShapeID()
9964         #    \note The list of vertices could be empty,
9965         #          in this case fillet will done done at all vertices in wire
9966         #  @param doIgnoreSecantVertices If FALSE, fillet radius is always limited
9967         #         by the length of the edges, nearest to the fillet vertex.
9968         #         But sometimes the next edge is C1 continuous with the one, nearest to
9969         #         the fillet point, and such two (or more) edges can be united to allow
9970         #         bigger radius. Set this flag to TRUE to allow collinear edges union,
9971         #         thus ignoring the secant vertex (vertices).
9972         #  @param theName Object name; when specified, this parameter is used
9973         #         for result publication in the study. Otherwise, if automatic
9974         #         publication is switched on, default value is used for result name.
9975         #
9976         #  @return New GEOM.GEOM_Object, containing the result shape.
9977         #
9978         #  @ref tui_fillet2d "Example"
9979         @ManageTransactions("LocalOp")
9980         def MakeFillet1D(self, theShape, theR, theListOfVertexes, doIgnoreSecantVertices = True, theName=None):
9981             """
9982             Perform a fillet on the specified edges of the given shape
9983
9984             Parameters:
9985                 theShape  Wire Shape to perform fillet on.
9986                 theR  Fillet radius.
9987                 theListOfVertexes Global indices of vertexes to perform fillet on.
9988                 doIgnoreSecantVertices If FALSE, fillet radius is always limited
9989                     by the length of the edges, nearest to the fillet vertex.
9990                     But sometimes the next edge is C1 continuous with the one, nearest to
9991                     the fillet point, and such two (or more) edges can be united to allow
9992                     bigger radius. Set this flag to TRUE to allow collinear edges union,
9993                     thus ignoring the secant vertex (vertices).
9994                 theName Object name; when specified, this parameter is used
9995                         for result publication in the study. Otherwise, if automatic
9996                         publication is switched on, default value is used for result name.
9997             Note:
9998                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9999
10000                 The list of vertices could be empty,in this case fillet will done done at all vertices in wire
10001
10002             Returns:
10003                 New GEOM.GEOM_Object, containing the result shape.
10004
10005             Example of usage:
10006                 # create wire
10007                 Wire_1 = geompy.MakeWire([Edge_12, Edge_7, Edge_11, Edge_6, Edge_1,Edge_4])
10008                 # make fillet at given wire vertices with giver radius
10009                 Fillet_1D_1 = geompy.MakeFillet1D(Wire_1, 55, [3, 4, 6, 8, 10])
10010             """
10011             # Example: see GEOM_TestAll.py
10012             theR,doIgnoreSecantVertices,Parameters = ParseParameters(theR,doIgnoreSecantVertices)
10013             anObj = self.LocalOp.MakeFillet1D(theShape, theR, theListOfVertexes, doIgnoreSecantVertices)
10014             RaiseIfFailed("MakeFillet1D", self.LocalOp)
10015             anObj.SetParameters(Parameters)
10016             self._autoPublish(anObj, theName, "fillet")
10017             return anObj
10018
10019         ## Perform a fillet at the specified vertices of the given face/shell.
10020         #  @param theShape Face or Shell shape to perform fillet on.
10021         #  @param theR Fillet radius.
10022         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
10023         #  @param theName Object name; when specified, this parameter is used
10024         #         for result publication in the study. Otherwise, if automatic
10025         #         publication is switched on, default value is used for result name.
10026         #
10027         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
10028         #
10029         #  @return New GEOM.GEOM_Object, containing the result shape.
10030         #
10031         #  @ref tui_fillet2d "Example"
10032         @ManageTransactions("LocalOp")
10033         def MakeFillet2D(self, theShape, theR, theListOfVertexes, theName=None):
10034             """
10035             Perform a fillet at the specified vertices of the given face/shell.
10036
10037             Parameters:
10038                 theShape  Face or Shell shape to perform fillet on.
10039                 theR  Fillet radius.
10040                 theListOfVertexes Global indices of vertexes to perform fillet on.
10041                 theName Object name; when specified, this parameter is used
10042                         for result publication in the study. Otherwise, if automatic
10043                         publication is switched on, default value is used for result name.
10044             Note:
10045                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
10046
10047             Returns:
10048                 New GEOM.GEOM_Object, containing the result shape.
10049
10050             Example of usage:
10051                 face = geompy.MakeFaceHW(100, 100, 1)
10052                 fillet2d = geompy.MakeFillet2D(face, 30, [7, 9])
10053             """
10054             # Example: see GEOM_TestAll.py
10055             theR,Parameters = ParseParameters(theR)
10056             anObj = self.LocalOp.MakeFillet2D(theShape, theR, theListOfVertexes)
10057             RaiseIfFailed("MakeFillet2D", self.LocalOp)
10058             anObj.SetParameters(Parameters)
10059             self._autoPublish(anObj, theName, "fillet")
10060             return anObj
10061
10062         ## Perform a symmetric chamfer on all edges of the given shape.
10063         #  @param theShape Shape, to perform chamfer on.
10064         #  @param theD Chamfer size along each face.
10065         #  @param theName Object name; when specified, this parameter is used
10066         #         for result publication in the study. Otherwise, if automatic
10067         #         publication is switched on, default value is used for result name.
10068         #
10069         #  @return New GEOM.GEOM_Object, containing the result shape.
10070         #
10071         #  @ref tui_chamfer "Example 1"
10072         #  \n @ref swig_MakeChamferAll "Example 2"
10073         @ManageTransactions("LocalOp")
10074         def MakeChamferAll(self, theShape, theD, theName=None):
10075             """
10076             Perform a symmetric chamfer on all edges of the given shape.
10077
10078             Parameters:
10079                 theShape Shape, to perform chamfer on.
10080                 theD Chamfer size along each face.
10081                 theName Object name; when specified, this parameter is used
10082                         for result publication in the study. Otherwise, if automatic
10083                         publication is switched on, default value is used for result name.
10084
10085             Returns:
10086                 New GEOM.GEOM_Object, containing the result shape.
10087
10088             Example of usage:
10089                 chamfer_all = geompy.MakeChamferAll(prism, 10.)
10090             """
10091             # Example: see GEOM_TestOthers.py
10092             theD,Parameters = ParseParameters(theD)
10093             anObj = self.LocalOp.MakeChamferAll(theShape, theD)
10094             RaiseIfFailed("MakeChamferAll", self.LocalOp)
10095             anObj.SetParameters(Parameters)
10096             self._autoPublish(anObj, theName, "chamfer")
10097             return anObj
10098
10099         ## Perform a chamfer on edges, common to the specified faces,
10100         #  with distance D1 on the Face1
10101         #  @param theShape Shape, to perform chamfer on.
10102         #  @param theD1 Chamfer size along \a theFace1.
10103         #  @param theD2 Chamfer size along \a theFace2.
10104         #  @param theFace1,theFace2 Global indices of two faces of \a theShape.
10105         #  @param theName Object name; when specified, this parameter is used
10106         #         for result publication in the study. Otherwise, if automatic
10107         #         publication is switched on, default value is used for result name.
10108         #
10109         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
10110         #
10111         #  @return New GEOM.GEOM_Object, containing the result shape.
10112         #
10113         #  @ref tui_chamfer "Example"
10114         @ManageTransactions("LocalOp")
10115         def MakeChamferEdge(self, theShape, theD1, theD2, theFace1, theFace2, theName=None):
10116             """
10117             Perform a chamfer on edges, common to the specified faces,
10118             with distance D1 on the Face1
10119
10120             Parameters:
10121                 theShape Shape, to perform chamfer on.
10122                 theD1 Chamfer size along theFace1.
10123                 theD2 Chamfer size along theFace2.
10124                 theFace1,theFace2 Global indices of two faces of theShape.
10125                 theName Object name; when specified, this parameter is used
10126                         for result publication in the study. Otherwise, if automatic
10127                         publication is switched on, default value is used for result name.
10128
10129             Note:
10130                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
10131
10132             Returns:
10133                 New GEOM.GEOM_Object, containing the result shape.
10134
10135             Example of usage:
10136                 prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
10137                 f_ind_1 = geompy.GetSubShapeID(prism, prism_faces[0])
10138                 f_ind_2 = geompy.GetSubShapeID(prism, prism_faces[1])
10139                 chamfer_e = geompy.MakeChamferEdge(prism, 10., 10., f_ind_1, f_ind_2)
10140             """
10141             # Example: see GEOM_TestAll.py
10142             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
10143             anObj = self.LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
10144             RaiseIfFailed("MakeChamferEdge", self.LocalOp)
10145             anObj.SetParameters(Parameters)
10146             self._autoPublish(anObj, theName, "chamfer")
10147             return anObj
10148
10149         ## Perform a chamfer on edges
10150         #  @param theShape Shape, to perform chamfer on.
10151         #  @param theD Chamfer length
10152         #  @param theAngle Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
10153         #  @param theFace1,theFace2 Global indices of two faces of \a theShape.
10154         #  @param theName Object name; when specified, this parameter is used
10155         #         for result publication in the study. Otherwise, if automatic
10156         #         publication is switched on, default value is used for result name.
10157         #
10158         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
10159         #
10160         #  @return New GEOM.GEOM_Object, containing the result shape.
10161         @ManageTransactions("LocalOp")
10162         def MakeChamferEdgeAD(self, theShape, theD, theAngle, theFace1, theFace2, theName=None):
10163             """
10164             Perform a chamfer on edges
10165
10166             Parameters:
10167                 theShape Shape, to perform chamfer on.
10168                 theD1 Chamfer size along theFace1.
10169                 theAngle Angle of chamfer (angle in radians or a name of variable which defines angle in degrees).
10170                 theFace1,theFace2 Global indices of two faces of theShape.
10171                 theName Object name; when specified, this parameter is used
10172                         for result publication in the study. Otherwise, if automatic
10173                         publication is switched on, default value is used for result name.
10174
10175             Note:
10176                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
10177
10178             Returns:
10179                 New GEOM.GEOM_Object, containing the result shape.
10180
10181             Example of usage:
10182                 prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
10183                 f_ind_1 = geompy.GetSubShapeID(prism, prism_faces[0])
10184                 f_ind_2 = geompy.GetSubShapeID(prism, prism_faces[1])
10185                 ang = 30
10186                 chamfer_e = geompy.MakeChamferEdge(prism, 10., ang, f_ind_1, f_ind_2)
10187             """
10188             flag = False
10189             if isinstance(theAngle,str):
10190                 flag = True
10191             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
10192             if flag:
10193                 theAngle = theAngle*math.pi/180.0
10194             anObj = self.LocalOp.MakeChamferEdgeAD(theShape, theD, theAngle, theFace1, theFace2)
10195             RaiseIfFailed("MakeChamferEdgeAD", self.LocalOp)
10196             anObj.SetParameters(Parameters)
10197             self._autoPublish(anObj, theName, "chamfer")
10198             return anObj
10199
10200         ## Perform a chamfer on all edges of the specified faces,
10201         #  with distance D1 on the first specified face (if several for one edge)
10202         #  @param theShape Shape, to perform chamfer on.
10203         #  @param theD1 Chamfer size along face from \a theFaces. If both faces,
10204         #               connected to the edge, are in \a theFaces, \a theD1
10205         #               will be get along face, which is nearer to \a theFaces beginning.
10206         #  @param theD2 Chamfer size along another of two faces, connected to the edge.
10207         #  @param theFaces Sequence of global indices of faces of \a theShape.
10208         #  @param theName Object name; when specified, this parameter is used
10209         #         for result publication in the study. Otherwise, if automatic
10210         #         publication is switched on, default value is used for result name.
10211         #
10212         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
10213         #
10214         #  @return New GEOM.GEOM_Object, containing the result shape.
10215         #
10216         #  @ref tui_chamfer "Example"
10217         @ManageTransactions("LocalOp")
10218         def MakeChamferFaces(self, theShape, theD1, theD2, theFaces, theName=None):
10219             """
10220             Perform a chamfer on all edges of the specified faces,
10221             with distance D1 on the first specified face (if several for one edge)
10222
10223             Parameters:
10224                 theShape Shape, to perform chamfer on.
10225                 theD1 Chamfer size along face from  theFaces. If both faces,
10226                       connected to the edge, are in theFaces, theD1
10227                       will be get along face, which is nearer to theFaces beginning.
10228                 theD2 Chamfer size along another of two faces, connected to the edge.
10229                 theFaces Sequence of global indices of faces of theShape.
10230                 theName Object name; when specified, this parameter is used
10231                         for result publication in the study. Otherwise, if automatic
10232                         publication is switched on, default value is used for result name.
10233
10234             Note: Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
10235
10236             Returns:
10237                 New GEOM.GEOM_Object, containing the result shape.
10238             """
10239             # Example: see GEOM_TestAll.py
10240             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
10241             anObj = self.LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
10242             RaiseIfFailed("MakeChamferFaces", self.LocalOp)
10243             anObj.SetParameters(Parameters)
10244             self._autoPublish(anObj, theName, "chamfer")
10245             return anObj
10246
10247         ## The Same that MakeChamferFaces() but with params theD is chamfer lenght and
10248         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
10249         #
10250         #  @ref swig_FilletChamfer "Example"
10251         @ManageTransactions("LocalOp")
10252         def MakeChamferFacesAD(self, theShape, theD, theAngle, theFaces, theName=None):
10253             """
10254             The Same that geompy.MakeChamferFaces but with params theD is chamfer lenght and
10255             theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
10256             """
10257             flag = False
10258             if isinstance(theAngle,str):
10259                 flag = True
10260             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
10261             if flag:
10262                 theAngle = theAngle*math.pi/180.0
10263             anObj = self.LocalOp.MakeChamferFacesAD(theShape, theD, theAngle, theFaces)
10264             RaiseIfFailed("MakeChamferFacesAD", self.LocalOp)
10265             anObj.SetParameters(Parameters)
10266             self._autoPublish(anObj, theName, "chamfer")
10267             return anObj
10268
10269         ## Perform a chamfer on edges,
10270         #  with distance D1 on the first specified face (if several for one edge)
10271         #  @param theShape Shape, to perform chamfer on.
10272         #  @param theD1,theD2 Chamfer size
10273         #  @param theEdges Sequence of edges of \a theShape.
10274         #  @param theName Object name; when specified, this parameter is used
10275         #         for result publication in the study. Otherwise, if automatic
10276         #         publication is switched on, default value is used for result name.
10277         #
10278         #  @return New GEOM.GEOM_Object, containing the result shape.
10279         #
10280         #  @ref swig_FilletChamfer "Example"
10281         @ManageTransactions("LocalOp")
10282         def MakeChamferEdges(self, theShape, theD1, theD2, theEdges, theName=None):
10283             """
10284             Perform a chamfer on edges,
10285             with distance D1 on the first specified face (if several for one edge)
10286
10287             Parameters:
10288                 theShape Shape, to perform chamfer on.
10289                 theD1,theD2 Chamfer size
10290                 theEdges Sequence of edges of theShape.
10291                 theName Object name; when specified, this parameter is used
10292                         for result publication in the study. Otherwise, if automatic
10293                         publication is switched on, default value is used for result name.
10294
10295             Returns:
10296                 New GEOM.GEOM_Object, containing the result shape.
10297             """
10298             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
10299             anObj = self.LocalOp.MakeChamferEdges(theShape, theD1, theD2, theEdges)
10300             RaiseIfFailed("MakeChamferEdges", self.LocalOp)
10301             anObj.SetParameters(Parameters)
10302             self._autoPublish(anObj, theName, "chamfer")
10303             return anObj
10304
10305         ## The Same that MakeChamferEdges() but with params theD is chamfer lenght and
10306         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
10307         @ManageTransactions("LocalOp")
10308         def MakeChamferEdgesAD(self, theShape, theD, theAngle, theEdges, theName=None):
10309             """
10310             The Same that geompy.MakeChamferEdges but with params theD is chamfer lenght and
10311             theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
10312             """
10313             flag = False
10314             if isinstance(theAngle,str):
10315                 flag = True
10316             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
10317             if flag:
10318                 theAngle = theAngle*math.pi/180.0
10319             anObj = self.LocalOp.MakeChamferEdgesAD(theShape, theD, theAngle, theEdges)
10320             RaiseIfFailed("MakeChamferEdgesAD", self.LocalOp)
10321             anObj.SetParameters(Parameters)
10322             self._autoPublish(anObj, theName, "chamfer")
10323             return anObj
10324
10325         ## @sa MakeChamferEdge(), MakeChamferFaces()
10326         #
10327         #  @ref swig_MakeChamfer "Example"
10328         def MakeChamfer(self, aShape, d1, d2, aShapeType, ListShape, theName=None):
10329             """
10330             See geompy.MakeChamferEdge() and geompy.MakeChamferFaces() functions for more information.
10331             """
10332             # Example: see GEOM_TestOthers.py
10333             anObj = None
10334             # note: auto-publishing is done in self.MakeChamferEdge() or self.MakeChamferFaces()
10335             if aShapeType == self.ShapeType["EDGE"]:
10336                 anObj = self.MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1],theName)
10337             else:
10338                 anObj = self.MakeChamferFaces(aShape,d1,d2,ListShape,theName)
10339             return anObj
10340
10341         ## Remove material from a solid by extrusion of the base shape on the given distance.
10342         #  @param theInit Shape to remove material from. It must be a solid or
10343         #  a compound made of a single solid.
10344         #  @param theBase Closed edge or wire defining the base shape to be extruded.
10345         #  @param theH Prism dimension along the normal to theBase
10346         #  @param theAngle Draft angle in degrees.
10347         #  @param theInvert If true material changes the direction
10348         #  @param theName Object name; when specified, this parameter is used
10349         #         for result publication in the study. Otherwise, if automatic
10350         #         publication is switched on, default value is used for result name.
10351         #
10352         #  @return New GEOM.GEOM_Object, containing the initial shape with removed material
10353         #
10354         #  @ref tui_creation_prism "Example"
10355         @ManageTransactions("PrimOp")
10356         def MakeExtrudedCut(self, theInit, theBase, theH, theAngle, theInvert=False, theName=None):
10357             """
10358             Add material to a solid by extrusion of the base shape on the given distance.
10359
10360             Parameters:
10361                 theInit Shape to remove material from. It must be a solid or a compound made of a single solid.
10362                 theBase Closed edge or wire defining the base shape to be extruded.
10363                 theH Prism dimension along the normal  to theBase
10364                 theAngle Draft angle in degrees.
10365                 theInvert If true material changes the direction.
10366                 theName Object name; when specified, this parameter is used
10367                         for result publication in the study. Otherwise, if automatic
10368                         publication is switched on, default value is used for result name.
10369
10370             Returns:
10371                 New GEOM.GEOM_Object,  containing the initial shape with removed material.
10372             """
10373             # Example: see GEOM_TestAll.py
10374             theH,theAngle,Parameters = ParseParameters(theH,theAngle)
10375             anObj = self.PrimOp.MakeDraftPrism(theInit, theBase, theH, theAngle, False, theInvert)
10376             RaiseIfFailed("MakeExtrudedBoss", self.PrimOp)
10377             anObj.SetParameters(Parameters)
10378             self._autoPublish(anObj, theName, "extrudedCut")
10379             return anObj
10380
10381         ## Add material to a solid by extrusion of the base shape on the given distance.
10382         #  @param theInit Shape to add material to. It must be a solid or
10383         #  a compound made of a single solid.
10384         #  @param theBase Closed edge or wire defining the base shape to be extruded.
10385         #  @param theH Prism dimension along the normal to theBase
10386         #  @param theAngle Draft angle in degrees.
10387         #  @param theInvert If true material changes the direction
10388         #  @param theName Object name; when specified, this parameter is used
10389         #         for result publication in the study. Otherwise, if automatic
10390         #         publication is switched on, default value is used for result name.
10391         #
10392         #  @return New GEOM.GEOM_Object, containing the initial shape with added material
10393         #
10394         #  @ref tui_creation_prism "Example"
10395         @ManageTransactions("PrimOp")
10396         def MakeExtrudedBoss(self, theInit, theBase, theH, theAngle, theInvert=False, theName=None):
10397             """
10398             Add material to a solid by extrusion of the base shape on the given distance.
10399
10400             Parameters:
10401                 theInit Shape to add material to. It must be a solid or a compound made of a single solid.
10402                 theBase Closed edge or wire defining the base shape to be extruded.
10403                 theH Prism dimension along the normal  to theBase
10404                 theAngle Draft angle in degrees.
10405                 theInvert If true material changes the direction.
10406                 theName Object name; when specified, this parameter is used
10407                         for result publication in the study. Otherwise, if automatic
10408                         publication is switched on, default value is used for result name.
10409
10410             Returns:
10411                 New GEOM.GEOM_Object,  containing the initial shape with added material.
10412             """
10413             # Example: see GEOM_TestAll.py
10414             theH,theAngle,Parameters = ParseParameters(theH,theAngle)
10415             anObj = self.PrimOp.MakeDraftPrism(theInit, theBase, theH, theAngle, True, theInvert)
10416             RaiseIfFailed("MakeExtrudedBoss", self.PrimOp)
10417             anObj.SetParameters(Parameters)
10418             self._autoPublish(anObj, theName, "extrudedBoss")
10419             return anObj
10420
10421         # end of l3_local
10422         ## @}
10423
10424         ## @addtogroup l3_basic_op
10425         ## @{
10426
10427         ## Perform an Archimde operation on the given shape with given parameters.
10428         #  The object presenting the resulting face is returned.
10429         #  @param theShape Shape to be put in water.
10430         #  @param theWeight Weight of the shape.
10431         #  @param theWaterDensity Density of the water.
10432         #  @param theMeshDeflection Deflection of the mesh, using to compute the section.
10433         #  @param theName Object name; when specified, this parameter is used
10434         #         for result publication in the study. Otherwise, if automatic
10435         #         publication is switched on, default value is used for result name.
10436         #
10437         #  @return New GEOM.GEOM_Object, containing a section of \a theShape
10438         #          by a plane, corresponding to water level.
10439         #
10440         #  @ref tui_archimede "Example"
10441         @ManageTransactions("LocalOp")
10442         def Archimede(self, theShape, theWeight, theWaterDensity, theMeshDeflection, theName=None):
10443             """
10444             Perform an Archimde operation on the given shape with given parameters.
10445             The object presenting the resulting face is returned.
10446
10447             Parameters:
10448                 theShape Shape to be put in water.
10449                 theWeight Weight of the shape.
10450                 theWaterDensity Density of the water.
10451                 theMeshDeflection Deflection of the mesh, using to compute the section.
10452                 theName Object name; when specified, this parameter is used
10453                         for result publication in the study. Otherwise, if automatic
10454                         publication is switched on, default value is used for result name.
10455
10456             Returns:
10457                 New GEOM.GEOM_Object, containing a section of theShape
10458                 by a plane, corresponding to water level.
10459             """
10460             # Example: see GEOM_TestAll.py
10461             theWeight,theWaterDensity,theMeshDeflection,Parameters = ParseParameters(
10462               theWeight,theWaterDensity,theMeshDeflection)
10463             anObj = self.LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
10464             RaiseIfFailed("MakeArchimede", self.LocalOp)
10465             anObj.SetParameters(Parameters)
10466             self._autoPublish(anObj, theName, "archimede")
10467             return anObj
10468
10469         # end of l3_basic_op
10470         ## @}
10471
10472         ## @addtogroup l2_measure
10473         ## @{
10474
10475         ## Get point coordinates
10476         #  @return [x, y, z]
10477         #
10478         #  @ref tui_point_coordinates_page "Example"
10479         @ManageTransactions("MeasuOp")
10480         def PointCoordinates(self,Point):
10481             """
10482             Get point coordinates
10483
10484             Returns:
10485                 [x, y, z]
10486             """
10487             # Example: see GEOM_TestMeasures.py
10488             aTuple = self.MeasuOp.PointCoordinates(Point)
10489             RaiseIfFailed("PointCoordinates", self.MeasuOp)
10490             return aTuple
10491
10492         ## Get vector coordinates
10493         #  @return [x, y, z]
10494         #
10495         #  @ref tui_measurement_tools_page "Example"
10496         def VectorCoordinates(self,Vector):
10497             """
10498             Get vector coordinates
10499
10500             Returns:
10501                 [x, y, z]
10502             """
10503
10504             p1=self.GetFirstVertex(Vector)
10505             p2=self.GetLastVertex(Vector)
10506
10507             X1=self.PointCoordinates(p1)
10508             X2=self.PointCoordinates(p2)
10509
10510             return (X2[0]-X1[0],X2[1]-X1[1],X2[2]-X1[2])
10511
10512
10513         ## Compute cross product
10514         #  @return vector w=u^v
10515         #
10516         #  @ref tui_measurement_tools_page "Example"
10517         def CrossProduct(self, Vector1, Vector2):
10518             """
10519             Compute cross product
10520
10521             Returns: vector w=u^v
10522             """
10523             u=self.VectorCoordinates(Vector1)
10524             v=self.VectorCoordinates(Vector2)
10525             w=self.MakeVectorDXDYDZ(u[1]*v[2]-u[2]*v[1], u[2]*v[0]-u[0]*v[2], u[0]*v[1]-u[1]*v[0])
10526
10527             return w
10528
10529         ## Compute cross product
10530         #  @return dot product  p=u.v
10531         #
10532         #  @ref tui_measurement_tools_page "Example"
10533         def DotProduct(self, Vector1, Vector2):
10534             """
10535             Compute cross product
10536
10537             Returns: dot product  p=u.v
10538             """
10539             u=self.VectorCoordinates(Vector1)
10540             v=self.VectorCoordinates(Vector2)
10541             p=u[0]*v[0]+u[1]*v[1]+u[2]*v[2]
10542
10543             return p
10544
10545
10546         ## Get summarized length of all wires,
10547         #  area of surface and volume of the given shape.
10548         #  @param theShape Shape to define properties of.
10549         #  @return [theLength, theSurfArea, theVolume]\n
10550         #  theLength:   Summarized length of all wires of the given shape.\n
10551         #  theSurfArea: Area of surface of the given shape.\n
10552         #  theVolume:   Volume of the given shape.
10553         #
10554         #  @ref tui_basic_properties_page "Example"
10555         @ManageTransactions("MeasuOp")
10556         def BasicProperties(self,theShape):
10557             """
10558             Get summarized length of all wires,
10559             area of surface and volume of the given shape.
10560
10561             Parameters:
10562                 theShape Shape to define properties of.
10563
10564             Returns:
10565                 [theLength, theSurfArea, theVolume]
10566                  theLength:   Summarized length of all wires of the given shape.
10567                  theSurfArea: Area of surface of the given shape.
10568                  theVolume:   Volume of the given shape.
10569             """
10570             # Example: see GEOM_TestMeasures.py
10571             aTuple = self.MeasuOp.GetBasicProperties(theShape)
10572             RaiseIfFailed("GetBasicProperties", self.MeasuOp)
10573             return aTuple
10574
10575         ## Get parameters of bounding box of the given shape
10576         #  @param theShape Shape to obtain bounding box of.
10577         #  @param precise TRUE for precise computation; FALSE for fast one.
10578         #  @return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
10579         #  Xmin,Xmax: Limits of shape along OX axis.
10580         #  Ymin,Ymax: Limits of shape along OY axis.
10581         #  Zmin,Zmax: Limits of shape along OZ axis.
10582         #
10583         #  @ref tui_bounding_box_page "Example"
10584         @ManageTransactions("MeasuOp")
10585         def BoundingBox (self, theShape, precise=False):
10586             """
10587             Get parameters of bounding box of the given shape
10588
10589             Parameters:
10590                 theShape Shape to obtain bounding box of.
10591                 precise TRUE for precise computation; FALSE for fast one.
10592
10593             Returns:
10594                 [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
10595                  Xmin,Xmax: Limits of shape along OX axis.
10596                  Ymin,Ymax: Limits of shape along OY axis.
10597                  Zmin,Zmax: Limits of shape along OZ axis.
10598             """
10599             # Example: see GEOM_TestMeasures.py
10600             aTuple = self.MeasuOp.GetBoundingBox(theShape, precise)
10601             RaiseIfFailed("GetBoundingBox", self.MeasuOp)
10602             return aTuple
10603
10604         ## Get bounding box of the given shape
10605         #  @param theShape Shape to obtain bounding box of.
10606         #  @param precise TRUE for precise computation; FALSE for fast one.
10607         #  @param theName Object name; when specified, this parameter is used
10608         #         for result publication in the study. Otherwise, if automatic
10609         #         publication is switched on, default value is used for result name.
10610         #
10611         #  @return New GEOM.GEOM_Object, containing the created box.
10612         #
10613         #  @ref tui_bounding_box_page "Example"
10614         @ManageTransactions("MeasuOp")
10615         def MakeBoundingBox (self, theShape, precise=False, theName=None):
10616             """
10617             Get bounding box of the given shape
10618
10619             Parameters:
10620                 theShape Shape to obtain bounding box of.
10621                 precise TRUE for precise computation; FALSE for fast one.
10622                 theName Object name; when specified, this parameter is used
10623                         for result publication in the study. Otherwise, if automatic
10624                         publication is switched on, default value is used for result name.
10625
10626             Returns:
10627                 New GEOM.GEOM_Object, containing the created box.
10628             """
10629             # Example: see GEOM_TestMeasures.py
10630             anObj = self.MeasuOp.MakeBoundingBox(theShape, precise)
10631             RaiseIfFailed("MakeBoundingBox", self.MeasuOp)
10632             self._autoPublish(anObj, theName, "bndbox")
10633             return anObj
10634
10635         ## Get inertia matrix and moments of inertia of theShape.
10636         #  @param theShape Shape to calculate inertia of.
10637         #  @return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
10638         #  I(1-3)(1-3): Components of the inertia matrix of the given shape.
10639         #  Ix,Iy,Iz:    Moments of inertia of the given shape.
10640         #
10641         #  @ref tui_inertia_page "Example"
10642         @ManageTransactions("MeasuOp")
10643         def Inertia(self,theShape):
10644             """
10645             Get inertia matrix and moments of inertia of theShape.
10646
10647             Parameters:
10648                 theShape Shape to calculate inertia of.
10649
10650             Returns:
10651                 [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
10652                  I(1-3)(1-3): Components of the inertia matrix of the given shape.
10653                  Ix,Iy,Iz:    Moments of inertia of the given shape.
10654             """
10655             # Example: see GEOM_TestMeasures.py
10656             aTuple = self.MeasuOp.GetInertia(theShape)
10657             RaiseIfFailed("GetInertia", self.MeasuOp)
10658             return aTuple
10659
10660         ## Get if coords are included in the shape (ST_IN or ST_ON)
10661         #  @param theShape Shape
10662         #  @param coords list of points coordinates [x1, y1, z1, x2, y2, z2, ...]
10663         #  @param tolerance to be used (default is 1.0e-7)
10664         #  @return list_of_boolean = [res1, res2, ...]
10665         @ManageTransactions("MeasuOp")
10666         def AreCoordsInside(self, theShape, coords, tolerance=1.e-7):
10667             """
10668             Get if coords are included in the shape (ST_IN or ST_ON)
10669
10670             Parameters:
10671                 theShape Shape
10672                 coords list of points coordinates [x1, y1, z1, x2, y2, z2, ...]
10673                 tolerance to be used (default is 1.0e-7)
10674
10675             Returns:
10676                 list_of_boolean = [res1, res2, ...]
10677             """
10678             return self.MeasuOp.AreCoordsInside(theShape, coords, tolerance)
10679
10680         ## Get minimal distance between the given shapes.
10681         #  @param theShape1,theShape2 Shapes to find minimal distance between.
10682         #  @return Value of the minimal distance between the given shapes.
10683         #
10684         #  @ref tui_min_distance_page "Example"
10685         @ManageTransactions("MeasuOp")
10686         def MinDistance(self, theShape1, theShape2):
10687             """
10688             Get minimal distance between the given shapes.
10689
10690             Parameters:
10691                 theShape1,theShape2 Shapes to find minimal distance between.
10692
10693             Returns:
10694                 Value of the minimal distance between the given shapes.
10695             """
10696             # Example: see GEOM_TestMeasures.py
10697             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
10698             RaiseIfFailed("GetMinDistance", self.MeasuOp)
10699             return aTuple[0]
10700
10701         ## Get minimal distance between the given shapes.
10702         #  @param theShape1,theShape2 Shapes to find minimal distance between.
10703         #  @return Value of the minimal distance between the given shapes, in form of list
10704         #          [Distance, DX, DY, DZ].
10705         #
10706         #  @ref tui_min_distance_page "Example"
10707         @ManageTransactions("MeasuOp")
10708         def MinDistanceComponents(self, theShape1, theShape2):
10709             """
10710             Get minimal distance between the given shapes.
10711
10712             Parameters:
10713                 theShape1,theShape2 Shapes to find minimal distance between.
10714
10715             Returns:
10716                 Value of the minimal distance between the given shapes, in form of list
10717                 [Distance, DX, DY, DZ]
10718             """
10719             # Example: see GEOM_TestMeasures.py
10720             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
10721             RaiseIfFailed("GetMinDistance", self.MeasuOp)
10722             aRes = [aTuple[0], aTuple[4] - aTuple[1], aTuple[5] - aTuple[2], aTuple[6] - aTuple[3]]
10723             return aRes
10724
10725         ## Get closest points of the given shapes.
10726         #  @param theShape1,theShape2 Shapes to find closest points of.
10727         #  @return The number of found solutions (-1 in case of infinite number of
10728         #          solutions) and a list of (X, Y, Z) coordinates for all couples of points.
10729         #
10730         #  @ref tui_min_distance_page "Example"
10731         @ManageTransactions("MeasuOp")
10732         def ClosestPoints (self, theShape1, theShape2):
10733             """
10734             Get closest points of the given shapes.
10735
10736             Parameters:
10737                 theShape1,theShape2 Shapes to find closest points of.
10738
10739             Returns:
10740                 The number of found solutions (-1 in case of infinite number of
10741                 solutions) and a list of (X, Y, Z) coordinates for all couples of points.
10742             """
10743             # Example: see GEOM_TestMeasures.py
10744             aTuple = self.MeasuOp.ClosestPoints(theShape1, theShape2)
10745             RaiseIfFailed("ClosestPoints", self.MeasuOp)
10746             return aTuple
10747
10748         ## Get angle between the given shapes in degrees.
10749         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
10750         #  @note If both arguments are vectors, the angle is computed in accordance
10751         #        with their orientations, otherwise the minimum angle is computed.
10752         #  @return Value of the angle between the given shapes in degrees.
10753         #
10754         #  @ref tui_angle_page "Example"
10755         @ManageTransactions("MeasuOp")
10756         def GetAngle(self, theShape1, theShape2):
10757             """
10758             Get angle between the given shapes in degrees.
10759
10760             Parameters:
10761                 theShape1,theShape2 Lines or linear edges to find angle between.
10762
10763             Note:
10764                 If both arguments are vectors, the angle is computed in accordance
10765                 with their orientations, otherwise the minimum angle is computed.
10766
10767             Returns:
10768                 Value of the angle between the given shapes in degrees.
10769             """
10770             # Example: see GEOM_TestMeasures.py
10771             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)
10772             RaiseIfFailed("GetAngle", self.MeasuOp)
10773             return anAngle
10774
10775         ## Get angle between the given shapes in radians.
10776         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
10777         #  @note If both arguments are vectors, the angle is computed in accordance
10778         #        with their orientations, otherwise the minimum angle is computed.
10779         #  @return Value of the angle between the given shapes in radians.
10780         #
10781         #  @ref tui_angle_page "Example"
10782         @ManageTransactions("MeasuOp")
10783         def GetAngleRadians(self, theShape1, theShape2):
10784             """
10785             Get angle between the given shapes in radians.
10786
10787             Parameters:
10788                 theShape1,theShape2 Lines or linear edges to find angle between.
10789
10790
10791             Note:
10792                 If both arguments are vectors, the angle is computed in accordance
10793                 with their orientations, otherwise the minimum angle is computed.
10794
10795             Returns:
10796                 Value of the angle between the given shapes in radians.
10797             """
10798             # Example: see GEOM_TestMeasures.py
10799             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)*math.pi/180.
10800             RaiseIfFailed("GetAngle", self.MeasuOp)
10801             return anAngle
10802
10803         ## Get angle between the given vectors in degrees.
10804         #  @param theShape1,theShape2 Vectors to find angle between.
10805         #  @param theFlag If True, the normal vector is defined by the two vectors cross,
10806         #                 if False, the opposite vector to the normal vector is used.
10807         #  @return Value of the angle between the given vectors in degrees.
10808         #
10809         #  @ref tui_angle_page "Example"
10810         @ManageTransactions("MeasuOp")
10811         def GetAngleVectors(self, theShape1, theShape2, theFlag = True):
10812             """
10813             Get angle between the given vectors in degrees.
10814
10815             Parameters:
10816                 theShape1,theShape2 Vectors to find angle between.
10817                 theFlag If True, the normal vector is defined by the two vectors cross,
10818                         if False, the opposite vector to the normal vector is used.
10819
10820             Returns:
10821                 Value of the angle between the given vectors in degrees.
10822             """
10823             anAngle = self.MeasuOp.GetAngleBtwVectors(theShape1, theShape2)
10824             if not theFlag:
10825                 anAngle = 360. - anAngle
10826             RaiseIfFailed("GetAngleVectors", self.MeasuOp)
10827             return anAngle
10828
10829         ## The same as GetAngleVectors, but the result is in radians.
10830         def GetAngleRadiansVectors(self, theShape1, theShape2, theFlag = True):
10831             """
10832             Get angle between the given vectors in radians.
10833
10834             Parameters:
10835                 theShape1,theShape2 Vectors to find angle between.
10836                 theFlag If True, the normal vector is defined by the two vectors cross,
10837                         if False, the opposite vector to the normal vector is used.
10838
10839             Returns:
10840                 Value of the angle between the given vectors in radians.
10841             """
10842             anAngle = self.GetAngleVectors(theShape1, theShape2, theFlag)*math.pi/180.
10843             return anAngle
10844
10845         ## @name Curve Curvature Measurement
10846         #  Methods for receiving radius of curvature of curves
10847         #  in the given point
10848         ## @{
10849
10850         ## Measure curvature of a curve at a point, set by parameter.
10851         #  @param theCurve a curve.
10852         #  @param theParam parameter.
10853         #  @return radius of curvature of \a theCurve.
10854         #
10855         #  @ref swig_todo "Example"
10856         @ManageTransactions("MeasuOp")
10857         def CurveCurvatureByParam(self, theCurve, theParam):
10858             """
10859             Measure curvature of a curve at a point, set by parameter.
10860
10861             Parameters:
10862                 theCurve a curve.
10863                 theParam parameter.
10864
10865             Returns:
10866                 radius of curvature of theCurve.
10867             """
10868             # Example: see GEOM_TestMeasures.py
10869             aCurv = self.MeasuOp.CurveCurvatureByParam(theCurve,theParam)
10870             RaiseIfFailed("CurveCurvatureByParam", self.MeasuOp)
10871             return aCurv
10872
10873         ## Measure curvature of a curve at a point.
10874         #  @param theCurve a curve.
10875         #  @param thePoint given point.
10876         #  @return radius of curvature of \a theCurve.
10877         #
10878         #  @ref swig_todo "Example"
10879         @ManageTransactions("MeasuOp")
10880         def CurveCurvatureByPoint(self, theCurve, thePoint):
10881             """
10882             Measure curvature of a curve at a point.
10883
10884             Parameters:
10885                 theCurve a curve.
10886                 thePoint given point.
10887
10888             Returns:
10889                 radius of curvature of theCurve.
10890             """
10891             aCurv = self.MeasuOp.CurveCurvatureByPoint(theCurve,thePoint)
10892             RaiseIfFailed("CurveCurvatureByPoint", self.MeasuOp)
10893             return aCurv
10894         ## @}
10895
10896         ## @name Surface Curvature Measurement
10897         #  Methods for receiving max and min radius of curvature of surfaces
10898         #  in the given point
10899         ## @{
10900
10901         ## Measure max radius of curvature of surface.
10902         #  @param theSurf the given surface.
10903         #  @param theUParam Value of U-parameter on the referenced surface.
10904         #  @param theVParam Value of V-parameter on the referenced surface.
10905         #  @return max radius of curvature of theSurf.
10906         #
10907         ## @ref swig_todo "Example"
10908         @ManageTransactions("MeasuOp")
10909         def MaxSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
10910             """
10911             Measure max radius of curvature of surface.
10912
10913             Parameters:
10914                 theSurf the given surface.
10915                 theUParam Value of U-parameter on the referenced surface.
10916                 theVParam Value of V-parameter on the referenced surface.
10917
10918             Returns:
10919                 max radius of curvature of theSurf.
10920             """
10921             # Example: see GEOM_TestMeasures.py
10922             aSurf = self.MeasuOp.MaxSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
10923             RaiseIfFailed("MaxSurfaceCurvatureByParam", self.MeasuOp)
10924             return aSurf
10925
10926         ## Measure max radius of curvature of surface in the given point
10927         #  @param theSurf the given surface.
10928         #  @param thePoint given point.
10929         #  @return max radius of curvature of theSurf.
10930         #
10931         ## @ref swig_todo "Example"
10932         @ManageTransactions("MeasuOp")
10933         def MaxSurfaceCurvatureByPoint(self, theSurf, thePoint):
10934             """
10935             Measure max radius of curvature of surface in the given point.
10936
10937             Parameters:
10938                 theSurf the given surface.
10939                 thePoint given point.
10940
10941             Returns:
10942                 max radius of curvature of theSurf.
10943             """
10944             aSurf = self.MeasuOp.MaxSurfaceCurvatureByPoint(theSurf,thePoint)
10945             RaiseIfFailed("MaxSurfaceCurvatureByPoint", self.MeasuOp)
10946             return aSurf
10947
10948         ## Measure min radius of curvature of surface.
10949         #  @param theSurf the given surface.
10950         #  @param theUParam Value of U-parameter on the referenced surface.
10951         #  @param theVParam Value of V-parameter on the referenced surface.
10952         #  @return min radius of curvature of theSurf.
10953         #
10954         ## @ref swig_todo "Example"
10955         @ManageTransactions("MeasuOp")
10956         def MinSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
10957             """
10958             Measure min radius of curvature of surface.
10959
10960             Parameters:
10961                 theSurf the given surface.
10962                 theUParam Value of U-parameter on the referenced surface.
10963                 theVParam Value of V-parameter on the referenced surface.
10964
10965             Returns:
10966                 Min radius of curvature of theSurf.
10967             """
10968             aSurf = self.MeasuOp.MinSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
10969             RaiseIfFailed("MinSurfaceCurvatureByParam", self.MeasuOp)
10970             return aSurf
10971
10972         ## Measure min radius of curvature of surface in the given point
10973         #  @param theSurf the given surface.
10974         #  @param thePoint given point.
10975         #  @return min radius of curvature of theSurf.
10976         #
10977         ## @ref swig_todo "Example"
10978         @ManageTransactions("MeasuOp")
10979         def MinSurfaceCurvatureByPoint(self, theSurf, thePoint):
10980             """
10981             Measure min radius of curvature of surface in the given point.
10982
10983             Parameters:
10984                 theSurf the given surface.
10985                 thePoint given point.
10986
10987             Returns:
10988                 Min radius of curvature of theSurf.
10989             """
10990             aSurf = self.MeasuOp.MinSurfaceCurvatureByPoint(theSurf,thePoint)
10991             RaiseIfFailed("MinSurfaceCurvatureByPoint", self.MeasuOp)
10992             return aSurf
10993         ## @}
10994
10995         ## Get min and max tolerances of sub-shapes of theShape
10996         #  @param theShape Shape, to get tolerances of.
10997         #  @return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]\n
10998         #  FaceMin,FaceMax: Min and max tolerances of the faces.\n
10999         #  EdgeMin,EdgeMax: Min and max tolerances of the edges.\n
11000         #  VertMin,VertMax: Min and max tolerances of the vertices.
11001         #
11002         #  @ref tui_tolerance_page "Example"
11003         @ManageTransactions("MeasuOp")
11004         def Tolerance(self,theShape):
11005             """
11006             Get min and max tolerances of sub-shapes of theShape
11007
11008             Parameters:
11009                 theShape Shape, to get tolerances of.
11010
11011             Returns:
11012                 [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
11013                  FaceMin,FaceMax: Min and max tolerances of the faces.
11014                  EdgeMin,EdgeMax: Min and max tolerances of the edges.
11015                  VertMin,VertMax: Min and max tolerances of the vertices.
11016             """
11017             # Example: see GEOM_TestMeasures.py
11018             aTuple = self.MeasuOp.GetTolerance(theShape)
11019             RaiseIfFailed("GetTolerance", self.MeasuOp)
11020             return aTuple
11021
11022         ## Obtain description of the given shape (number of sub-shapes of each type)
11023         #  @param theShape Shape to be described.
11024         #  @return Description of the given shape.
11025         #
11026         #  @ref tui_whatis_page "Example"
11027         @ManageTransactions("MeasuOp")
11028         def WhatIs(self,theShape):
11029             """
11030             Obtain description of the given shape (number of sub-shapes of each type)
11031
11032             Parameters:
11033                 theShape Shape to be described.
11034
11035             Returns:
11036                 Description of the given shape.
11037             """
11038             # Example: see GEOM_TestMeasures.py
11039             aDescr = self.MeasuOp.WhatIs(theShape)
11040             RaiseIfFailed("WhatIs", self.MeasuOp)
11041             return aDescr
11042
11043         ## Obtain quantity of shapes of the given type in \a theShape.
11044         #  If \a theShape is of type \a theType, it is also counted.
11045         #  @param theShape Shape to be described.
11046         #  @param theType the given ShapeType().
11047         #  @return Quantity of shapes of type \a theType in \a theShape.
11048         #
11049         #  @ref tui_measurement_tools_page "Example"
11050         def NbShapes (self, theShape, theType):
11051             """
11052             Obtain quantity of shapes of the given type in theShape.
11053             If theShape is of type theType, it is also counted.
11054
11055             Parameters:
11056                 theShape Shape to be described.
11057                 theType the given geompy.ShapeType
11058
11059             Returns:
11060                 Quantity of shapes of type theType in theShape.
11061             """
11062             # Example: see GEOM_TestMeasures.py
11063             listSh = self.SubShapeAllIDs(theShape, theType)
11064             Nb = len(listSh)
11065             return Nb
11066
11067         ## Obtain quantity of shapes of each type in \a theShape.
11068         #  The \a theShape is also counted.
11069         #  @param theShape Shape to be described.
11070         #  @return Dictionary of ShapeType() with bound quantities of shapes.
11071         #
11072         #  @ref tui_measurement_tools_page "Example"
11073         def ShapeInfo (self, theShape):
11074             """
11075             Obtain quantity of shapes of each type in theShape.
11076             The theShape is also counted.
11077
11078             Parameters:
11079                 theShape Shape to be described.
11080
11081             Returns:
11082                 Dictionary of geompy.ShapeType with bound quantities of shapes.
11083             """
11084             # Example: see GEOM_TestMeasures.py
11085             aDict = {}
11086             for typeSh in self.ShapeType:
11087                 if typeSh in ( "AUTO", "SHAPE" ): continue
11088                 listSh = self.SubShapeAllIDs(theShape, self.ShapeType[typeSh])
11089                 Nb = len(listSh)
11090                 aDict[typeSh] = Nb
11091                 pass
11092             return aDict
11093
11094         def GetCreationInformation(self, theShape):
11095             res = ''
11096             infos = theShape.GetCreationInformation()
11097             for info in infos:
11098                 # operationName
11099                 opName = info.operationName
11100                 if not opName: opName = "no info available"
11101                 if res: res += "\n"
11102                 res += "Operation: " + opName
11103                 # parameters
11104                 for parVal in info.params:
11105                     res += "\n \t%s = %s" % ( parVal.name, parVal.value )
11106             return res
11107
11108         ## Get a point, situated at the centre of mass of theShape.
11109         #  @param theShape Shape to define centre of mass of.
11110         #  @param theName Object name; when specified, this parameter is used
11111         #         for result publication in the study. Otherwise, if automatic
11112         #         publication is switched on, default value is used for result name.
11113         #
11114         #  @return New GEOM.GEOM_Object, containing the created point.
11115         #
11116         #  @ref tui_center_of_mass_page "Example"
11117         @ManageTransactions("MeasuOp")
11118         def MakeCDG(self, theShape, theName=None):
11119             """
11120             Get a point, situated at the centre of mass of theShape.
11121
11122             Parameters:
11123                 theShape Shape to define centre of mass of.
11124                 theName Object name; when specified, this parameter is used
11125                         for result publication in the study. Otherwise, if automatic
11126                         publication is switched on, default value is used for result name.
11127
11128             Returns:
11129                 New GEOM.GEOM_Object, containing the created point.
11130             """
11131             # Example: see GEOM_TestMeasures.py
11132             anObj = self.MeasuOp.GetCentreOfMass(theShape)
11133             RaiseIfFailed("GetCentreOfMass", self.MeasuOp)
11134             self._autoPublish(anObj, theName, "centerOfMass")
11135             return anObj
11136
11137         ## Get a vertex sub-shape by index depended with orientation.
11138         #  @param theShape Shape to find sub-shape.
11139         #  @param theIndex Index to find vertex by this index (starting from zero)
11140         #  @param theName Object name; when specified, this parameter is used
11141         #         for result publication in the study. Otherwise, if automatic
11142         #         publication is switched on, default value is used for result name.
11143         #
11144         #  @return New GEOM.GEOM_Object, containing the created vertex.
11145         #
11146         #  @ref tui_measurement_tools_page "Example"
11147         @ManageTransactions("MeasuOp")
11148         def GetVertexByIndex(self, theShape, theIndex, theName=None):
11149             """
11150             Get a vertex sub-shape by index depended with orientation.
11151
11152             Parameters:
11153                 theShape Shape to find sub-shape.
11154                 theIndex Index to find vertex by this index (starting from zero)
11155                 theName Object name; when specified, this parameter is used
11156                         for result publication in the study. Otherwise, if automatic
11157                         publication is switched on, default value is used for result name.
11158
11159             Returns:
11160                 New GEOM.GEOM_Object, containing the created vertex.
11161             """
11162             # Example: see GEOM_TestMeasures.py
11163             anObj = self.MeasuOp.GetVertexByIndex(theShape, theIndex)
11164             RaiseIfFailed("GetVertexByIndex", self.MeasuOp)
11165             self._autoPublish(anObj, theName, "vertex")
11166             return anObj
11167
11168         ## Get the first vertex of wire/edge depended orientation.
11169         #  @param theShape Shape to find first vertex.
11170         #  @param theName Object name; when specified, this parameter is used
11171         #         for result publication in the study. Otherwise, if automatic
11172         #         publication is switched on, default value is used for result name.
11173         #
11174         #  @return New GEOM.GEOM_Object, containing the created vertex.
11175         #
11176         #  @ref tui_measurement_tools_page "Example"
11177         def GetFirstVertex(self, theShape, theName=None):
11178             """
11179             Get the first vertex of wire/edge depended orientation.
11180
11181             Parameters:
11182                 theShape Shape to find first vertex.
11183                 theName Object name; when specified, this parameter is used
11184                         for result publication in the study. Otherwise, if automatic
11185                         publication is switched on, default value is used for result name.
11186
11187             Returns:
11188                 New GEOM.GEOM_Object, containing the created vertex.
11189             """
11190             # Example: see GEOM_TestMeasures.py
11191             # note: auto-publishing is done in self.GetVertexByIndex()
11192             return self.GetVertexByIndex(theShape, 0, theName)
11193
11194         ## Get the last vertex of wire/edge depended orientation.
11195         #  @param theShape Shape to find last vertex.
11196         #  @param theName Object name; when specified, this parameter is used
11197         #         for result publication in the study. Otherwise, if automatic
11198         #         publication is switched on, default value is used for result name.
11199         #
11200         #  @return New GEOM.GEOM_Object, containing the created vertex.
11201         #
11202         #  @ref tui_measurement_tools_page "Example"
11203         def GetLastVertex(self, theShape, theName=None):
11204             """
11205             Get the last vertex of wire/edge depended orientation.
11206
11207             Parameters:
11208                 theShape Shape to find last vertex.
11209                 theName Object name; when specified, this parameter is used
11210                         for result publication in the study. Otherwise, if automatic
11211                         publication is switched on, default value is used for result name.
11212
11213             Returns:
11214                 New GEOM.GEOM_Object, containing the created vertex.
11215             """
11216             # Example: see GEOM_TestMeasures.py
11217             nb_vert =  self.NumberOfSubShapes(theShape, self.ShapeType["VERTEX"])
11218             # note: auto-publishing is done in self.GetVertexByIndex()
11219             return self.GetVertexByIndex(theShape, (nb_vert-1), theName)
11220
11221         ## Get a normale to the given face. If the point is not given,
11222         #  the normale is calculated at the center of mass.
11223         #  @param theFace Face to define normale of.
11224         #  @param theOptionalPoint Point to compute the normale at.
11225         #  @param theName Object name; when specified, this parameter is used
11226         #         for result publication in the study. Otherwise, if automatic
11227         #         publication is switched on, default value is used for result name.
11228         #
11229         #  @return New GEOM.GEOM_Object, containing the created vector.
11230         #
11231         #  @ref swig_todo "Example"
11232         @ManageTransactions("MeasuOp")
11233         def GetNormal(self, theFace, theOptionalPoint = None, theName=None):
11234             """
11235             Get a normale to the given face. If the point is not given,
11236             the normale is calculated at the center of mass.
11237
11238             Parameters:
11239                 theFace Face to define normale of.
11240                 theOptionalPoint Point to compute the normale at.
11241                 theName Object name; when specified, this parameter is used
11242                         for result publication in the study. Otherwise, if automatic
11243                         publication is switched on, default value is used for result name.
11244
11245             Returns:
11246                 New GEOM.GEOM_Object, containing the created vector.
11247             """
11248             # Example: see GEOM_TestMeasures.py
11249             anObj = self.MeasuOp.GetNormal(theFace, theOptionalPoint)
11250             RaiseIfFailed("GetNormal", self.MeasuOp)
11251             self._autoPublish(anObj, theName, "normal")
11252             return anObj
11253
11254         ## Print shape errors obtained from CheckShape.
11255         #  @param theShape Shape that was checked.
11256         #  @param theShapeErrors the shape errors obtained by CheckShape.
11257         #  @param theReturnStatus If 0 the description of problem is printed.
11258         #                         If 1 the description of problem is returned.
11259         #  @return If theReturnStatus is equal to 1 the description is returned.
11260         #          Otherwise doesn't return anything.
11261         #
11262         #  @ref tui_check_shape_page "Example"
11263         @ManageTransactions("MeasuOp")
11264         def PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0):
11265             """
11266             Print shape errors obtained from CheckShape.
11267
11268             Parameters:
11269                 theShape Shape that was checked.
11270                 theShapeErrors the shape errors obtained by CheckShape.
11271                 theReturnStatus If 0 the description of problem is printed.
11272                                 If 1 the description of problem is returned.
11273
11274             Returns:
11275                 If theReturnStatus is equal to 1 the description is returned.
11276                   Otherwise doesn't return anything.
11277             """
11278             # Example: see GEOM_TestMeasures.py
11279             Descr = self.MeasuOp.PrintShapeErrors(theShape, theShapeErrors)
11280             if theReturnStatus == 1:
11281                 return Descr
11282             print Descr
11283             pass
11284
11285         ## Check a topology of the given shape.
11286         #  @param theShape Shape to check validity of.
11287         #  @param theIsCheckGeom If FALSE, only the shape's topology will be checked, \n
11288         #                        if TRUE, the shape's geometry will be checked also.
11289         #  @param theReturnStatus If 0 and if theShape is invalid, a description
11290         #                         of problem is printed.
11291         #                         If 1 isValid flag and the description of
11292         #                         problem is returned.
11293         #                         If 2 isValid flag and the list of error data
11294         #                         is returned.
11295         #  @return TRUE, if the shape "seems to be valid".
11296         #          If theShape is invalid, prints a description of problem.
11297         #          If theReturnStatus is equal to 1 the description is returned
11298         #          along with IsValid flag.
11299         #          If theReturnStatus is equal to 2 the list of error data is
11300         #          returned along with IsValid flag.
11301         #
11302         #  @ref tui_check_shape_page "Example"
11303         @ManageTransactions("MeasuOp")
11304         def CheckShape(self,theShape, theIsCheckGeom = 0, theReturnStatus = 0):
11305             """
11306             Check a topology of the given shape.
11307
11308             Parameters:
11309                 theShape Shape to check validity of.
11310                 theIsCheckGeom If FALSE, only the shape's topology will be checked,
11311                                if TRUE, the shape's geometry will be checked also.
11312                 theReturnStatus If 0 and if theShape is invalid, a description
11313                                 of problem is printed.
11314                                 If 1 IsValid flag and the description of
11315                                 problem is returned.
11316                                 If 2 IsValid flag and the list of error data
11317                                 is returned.
11318
11319             Returns:
11320                 TRUE, if the shape "seems to be valid".
11321                 If theShape is invalid, prints a description of problem.
11322                 If theReturnStatus is equal to 1 the description is returned
11323                 along with IsValid flag.
11324                 If theReturnStatus is equal to 2 the list of error data is
11325                 returned along with IsValid flag.
11326             """
11327             # Example: see GEOM_TestMeasures.py
11328             if theIsCheckGeom:
11329                 (IsValid, ShapeErrors) = self.MeasuOp.CheckShapeWithGeometry(theShape)
11330                 RaiseIfFailed("CheckShapeWithGeometry", self.MeasuOp)
11331             else:
11332                 (IsValid, ShapeErrors) = self.MeasuOp.CheckShape(theShape)
11333                 RaiseIfFailed("CheckShape", self.MeasuOp)
11334             if IsValid == 0:
11335                 if theReturnStatus == 0:
11336                     Descr = self.MeasuOp.PrintShapeErrors(theShape, ShapeErrors)
11337                     print Descr
11338             if theReturnStatus == 1:
11339               Descr = self.MeasuOp.PrintShapeErrors(theShape, ShapeErrors)
11340               return (IsValid, Descr)
11341             elif theReturnStatus == 2:
11342               return (IsValid, ShapeErrors)
11343             return IsValid
11344
11345         ## Detect self-intersections in the given shape.
11346         #  @param theShape Shape to check.
11347         #  @param theCheckLevel is the level of self-intersection check.
11348         #         Possible input values are:
11349         #         - GEOM.SI_V_V(0) - only V/V interferences
11350         #         - GEOM.SI_V_E(1) - V/V and V/E interferences
11351         #         - GEOM.SI_E_E(2) - V/V, V/E and E/E interferences
11352         #         - GEOM.SI_V_F(3) - V/V, V/E, E/E and V/F interferences
11353         #         - GEOM.SI_E_F(4) - V/V, V/E, E/E, V/F and E/F interferences
11354         #         - GEOM.SI_ALL(5) - all interferences.
11355         #  @return TRUE, if the shape contains no self-intersections.
11356         #
11357         #  @ref tui_check_self_intersections_page "Example"
11358         @ManageTransactions("MeasuOp")
11359         def CheckSelfIntersections(self, theShape, theCheckLevel = GEOM.SI_ALL):
11360             """
11361             Detect self-intersections in the given shape.
11362
11363             Parameters:
11364                 theShape Shape to check.
11365                 theCheckLevel is the level of self-intersection check.
11366                   Possible input values are:
11367                    - GEOM.SI_V_V(0) - only V/V interferences
11368                    - GEOM.SI_V_E(1) - V/V and V/E interferences
11369                    - GEOM.SI_E_E(2) - V/V, V/E and E/E interferences
11370                    - GEOM.SI_V_F(3) - V/V, V/E, E/E and V/F interferences
11371                    - GEOM.SI_E_F(4) - V/V, V/E, E/E, V/F and E/F interferences
11372                    - GEOM.SI_ALL(5) - all interferences.
11373  
11374             Returns:
11375                 TRUE, if the shape contains no self-intersections.
11376             """
11377             # Example: see GEOM_TestMeasures.py
11378             (IsValid, Pairs) = self.MeasuOp.CheckSelfIntersections(theShape, EnumToLong(theCheckLevel))
11379             RaiseIfFailed("CheckSelfIntersections", self.MeasuOp)
11380             return IsValid
11381
11382         ## Detect self-intersections of the given shape with algorithm based on mesh intersections.
11383         #  @param theShape Shape to check.
11384         #  @param theDeflection Linear deflection coefficient that specifies quality of tesselation:
11385         #         - if \a theDeflection <= 0, default deflection 0.001 is used
11386         #  @param theTolerance Specifies a distance between sub-shapes used for detecting gaps:
11387         #         - if \a theTolerance <= 0, algorithm detects intersections (default behavior)
11388         #         - if \a theTolerance > 0, algorithm detects gaps
11389         #  @return TRUE, if the shape contains no self-intersections.
11390         #
11391         #  @ref tui_check_self_intersections_fast_page "Example"
11392         @ManageTransactions("MeasuOp")
11393         def CheckSelfIntersectionsFast(self, theShape, theDeflection = 0.001, theTolerance = 0.0):
11394             """
11395             Detect self-intersections of the given shape with algorithm based on mesh intersections.
11396
11397             Parameters:
11398                 theShape Shape to check.
11399                 theDeflection Linear deflection coefficient that specifies quality of tesselation:
11400                     - if theDeflection <= 0, default deflection 0.001 is used
11401                 theTolerance Specifies a distance between shapes used for detecting gaps:
11402                     - if theTolerance <= 0, algorithm detects intersections (default behavior)
11403                     - if theTolerance > 0, algorithm detects gaps
11404  
11405             Returns:
11406                 TRUE, if the shape contains no self-intersections.
11407             """
11408             # Example: see GEOM_TestMeasures.py
11409             (IsValid, Pairs) = self.MeasuOp.CheckSelfIntersectionsFast(theShape, theDeflection, theTolerance)
11410             RaiseIfFailed("CheckSelfIntersectionsFast", self.MeasuOp)
11411             return IsValid
11412
11413         ## Detect intersections of the given shapes with algorithm based on mesh intersections.
11414         #  @param theShape1 First source object
11415         #  @param theShape2 Second source object
11416         #  @param theTolerance Specifies a distance between shapes used for detecting gaps:
11417         #         - if \a theTolerance <= 0, algorithm detects intersections (default behavior)
11418         #         - if \a theTolerance > 0, algorithm detects gaps
11419         #  @param theDeflection Linear deflection coefficient that specifies quality of tesselation:
11420         #         - if \a theDeflection <= 0, default deflection 0.001 is used
11421         #  @return TRUE, if there are intersections (gaps) between source shapes
11422         #  @return List of sub-shapes IDs from 1st shape that localize intersection.
11423         #  @return List of sub-shapes IDs from 2nd shape that localize intersection.
11424         #
11425         #  @ref tui_fast_intersection_page "Example"
11426         @ManageTransactions("MeasuOp")
11427         def FastIntersect(self, theShape1, theShape2, theTolerance = 0.0, theDeflection = 0.001):
11428             """
11429             Detect intersections of the given shapes with algorithm based on mesh intersections.
11430
11431             Parameters:
11432                 theShape1 First source object
11433                 theShape2 Second source object
11434                 theTolerance Specifies a distance between shapes used for detecting gaps:
11435                     - if theTolerance <= 0, algorithm detects intersections (default behavior)
11436                     - if theTolerance > 0, algorithm detects gaps
11437                 theDeflection Linear deflection coefficient that specifies quality of tesselation:
11438                     - if theDeflection <= 0, default deflection 0.001 is used
11439  
11440             Returns:
11441                 TRUE, if there are intersections (gaps) between source shapes
11442                 List of sub-shapes IDs from 1st shape that localize intersection.
11443                 List of sub-shapes IDs from 2nd shape that localize intersection.
11444             """
11445             # Example: see GEOM_TestMeasures.py
11446             IsOk, Res1, Res2 = self.MeasuOp.FastIntersect(theShape1, theShape2, theTolerance, theDeflection)
11447             RaiseIfFailed("FastIntersect", self.MeasuOp)
11448             return IsOk, Res1, Res2
11449
11450         ## Get position (LCS) of theShape.
11451         #
11452         #  Origin of the LCS is situated at the shape's center of mass.
11453         #  Axes of the LCS are obtained from shape's location or,
11454         #  if the shape is a planar face, from position of its plane.
11455         #
11456         #  @param theShape Shape to calculate position of.
11457         #  @return [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
11458         #          Ox,Oy,Oz: Coordinates of shape's LCS origin.
11459         #          Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
11460         #          Xx,Xy,Xz: Coordinates of shape's LCS X direction.
11461         #
11462         #  @ref swig_todo "Example"
11463         @ManageTransactions("MeasuOp")
11464         def GetPosition(self,theShape):
11465             """
11466             Get position (LCS) of theShape.
11467             Origin of the LCS is situated at the shape's center of mass.
11468             Axes of the LCS are obtained from shape's location or,
11469             if the shape is a planar face, from position of its plane.
11470
11471             Parameters:
11472                 theShape Shape to calculate position of.
11473
11474             Returns:
11475                 [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
11476                  Ox,Oy,Oz: Coordinates of shape's LCS origin.
11477                  Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
11478                  Xx,Xy,Xz: Coordinates of shape's LCS X direction.
11479             """
11480             # Example: see GEOM_TestMeasures.py
11481             aTuple = self.MeasuOp.GetPosition(theShape)
11482             RaiseIfFailed("GetPosition", self.MeasuOp)
11483             return aTuple
11484
11485         ## Get kind of theShape.
11486         #
11487         #  @param theShape Shape to get a kind of.
11488         #  @return Returns a kind of shape in terms of <VAR>GEOM.GEOM_IKindOfShape.shape_kind</VAR> enumeration
11489         #          and a list of parameters, describing the shape.
11490         #  @note  Concrete meaning of each value, returned via \a theIntegers
11491         #         or \a theDoubles list depends on the kind() of the shape.
11492         #
11493         #  @ref swig_todo "Example"
11494         @ManageTransactions("MeasuOp")
11495         def KindOfShape(self,theShape):
11496             """
11497             Get kind of theShape.
11498
11499             Parameters:
11500                 theShape Shape to get a kind of.
11501
11502             Returns:
11503                 a kind of shape in terms of GEOM_IKindOfShape.shape_kind enumeration
11504                     and a list of parameters, describing the shape.
11505             Note:
11506                 Concrete meaning of each value, returned via theIntegers
11507                 or theDoubles list depends on the geompy.kind of the shape
11508             """
11509             # Example: see GEOM_TestMeasures.py
11510             aRoughTuple = self.MeasuOp.KindOfShape(theShape)
11511             RaiseIfFailed("KindOfShape", self.MeasuOp)
11512
11513             aKind  = aRoughTuple[0]
11514             anInts = aRoughTuple[1]
11515             aDbls  = aRoughTuple[2]
11516
11517             # Now there is no exception from this rule:
11518             aKindTuple = [aKind] + aDbls + anInts
11519
11520             # If they are we will regroup parameters for such kind of shape.
11521             # For example:
11522             #if aKind == kind.SOME_KIND:
11523             #    #  SOME_KIND     int int double int double double
11524             #    aKindTuple = [aKind, anInts[0], anInts[1], aDbls[0], anInts[2], aDbls[1], aDbls[2]]
11525
11526             return aKindTuple
11527
11528         ## Returns the string that describes if the shell is good for solid.
11529         #  This is a support method for MakeSolid.
11530         #
11531         #  @param theShell the shell to be checked.
11532         #  @return Returns a string that describes the shell validity for
11533         #          solid construction.
11534         @ManageTransactions("MeasuOp")
11535         def _IsGoodForSolid(self, theShell):
11536             """
11537             Returns the string that describes if the shell is good for solid.
11538             This is a support method for MakeSolid.
11539
11540             Parameter:
11541                 theShell the shell to be checked.
11542
11543             Returns:
11544                 Returns a string that describes the shell validity for
11545                 solid construction.
11546             """
11547             aDescr = self.MeasuOp.IsGoodForSolid(theShell)
11548             return aDescr
11549
11550         # end of l2_measure
11551         ## @}
11552
11553         ## @addtogroup l2_import_export
11554         ## @{
11555
11556         ## Import a shape from the BREP, IGES, STEP or other file
11557         #  (depends on given format) with given name.
11558         #
11559         #  Note: this function is deprecated, it is kept for backward compatibility only
11560         #  Use Import<FormatName> instead, where <FormatName> is a name of desirable format to import.
11561         #
11562         #  @param theFileName The file, containing the shape.
11563         #  @param theFormatName Specify format for the file reading.
11564         #         Available formats can be obtained with InsertOp.ImportTranslators() method.
11565         #         If format 'IGES_SCALE' is used instead of 'IGES' or
11566         #            format 'STEP_SCALE' is used instead of 'STEP',
11567         #            length unit will be set to 'meter' and result model will be scaled.
11568         #  @param theName Object name; when specified, this parameter is used
11569         #         for result publication in the study. Otherwise, if automatic
11570         #         publication is switched on, default value is used for result name.
11571         #
11572         #  @return New GEOM.GEOM_Object, containing the imported shape.
11573         #          If material names are imported it returns the list of
11574         #          objects. The first one is the imported object followed by
11575         #          material groups.
11576         #  @note Auto publishing is allowed for the shape itself. Imported
11577         #        material groups are not automatically published.
11578         #
11579         #  @ref swig_Import_Export "Example"
11580         @ManageTransactions("InsertOp")
11581         def ImportFile(self, theFileName, theFormatName, theName=None):
11582             """
11583             Import a shape from the BREP, IGES, STEP or other file
11584             (depends on given format) with given name.
11585
11586             Note: this function is deprecated, it is kept for backward compatibility only
11587             Use Import<FormatName> instead, where <FormatName> is a name of desirable format to import.
11588
11589             Parameters: 
11590                 theFileName The file, containing the shape.
11591                 theFormatName Specify format for the file reading.
11592                     Available formats can be obtained with geompy.InsertOp.ImportTranslators() method.
11593                     If format 'IGES_SCALE' is used instead of 'IGES' or
11594                        format 'STEP_SCALE' is used instead of 'STEP',
11595                        length unit will be set to 'meter' and result model will be scaled.
11596                 theName Object name; when specified, this parameter is used
11597                         for result publication in the study. Otherwise, if automatic
11598                         publication is switched on, default value is used for result name.
11599
11600             Returns:
11601                 New GEOM.GEOM_Object, containing the imported shape.
11602                 If material names are imported it returns the list of
11603                 objects. The first one is the imported object followed by
11604                 material groups.
11605             Note:
11606                 Auto publishing is allowed for the shape itself. Imported
11607                 material groups are not automatically published.
11608             """
11609             # Example: see GEOM_TestOthers.py
11610             print """
11611             WARNING: Function ImportFile is deprecated, use Import<FormatName> instead,
11612             where <FormatName> is a name of desirable format for importing.
11613             """
11614             aListObj = self.InsertOp.ImportFile(theFileName, theFormatName)
11615             RaiseIfFailed("ImportFile", self.InsertOp)
11616             aNbObj = len(aListObj)
11617             if aNbObj > 0:
11618                 self._autoPublish(aListObj[0], theName, "imported")
11619             if aNbObj == 1:
11620                 return aListObj[0]
11621             return aListObj
11622
11623         ## Deprecated analog of ImportFile()
11624         def Import(self, theFileName, theFormatName, theName=None):
11625             """
11626             Deprecated analog of geompy.ImportFile, kept for backward compatibility only.
11627             """
11628             # note: auto-publishing is done in self.ImportFile()
11629             return self.ImportFile(theFileName, theFormatName, theName)
11630
11631         ## Read a shape from the binary stream, containing its bounding representation (BRep).
11632         #  @note This method will not be dumped to the python script by DumpStudy functionality.
11633         #  @note GEOM.GEOM_Object.GetShapeStream() method can be used to obtain the shape's BRep stream.
11634         #  @param theStream The BRep binary stream.
11635         #  @param theName Object name; when specified, this parameter is used
11636         #         for result publication in the study. Otherwise, if automatic
11637         #         publication is switched on, default value is used for result name.
11638         #
11639         #  @return New GEOM_Object, containing the shape, read from theStream.
11640         #
11641         #  @ref swig_Import_Export "Example"
11642         @ManageTransactions("InsertOp")
11643         def RestoreShape (self, theStream, theName=None):
11644             """
11645             Read a shape from the binary stream, containing its bounding representation (BRep).
11646
11647             Note:
11648                 shape.GetShapeStream() method can be used to obtain the shape's BRep stream.
11649
11650             Parameters:
11651                 theStream The BRep binary stream.
11652                 theName Object name; when specified, this parameter is used
11653                         for result publication in the study. Otherwise, if automatic
11654                         publication is switched on, default value is used for result name.
11655
11656             Returns:
11657                 New GEOM_Object, containing the shape, read from theStream.
11658             """
11659             # Example: see GEOM_TestOthers.py
11660             anObj = self.InsertOp.RestoreShape(theStream)
11661             RaiseIfFailed("RestoreShape", self.InsertOp)
11662             self._autoPublish(anObj, theName, "restored")
11663             return anObj
11664
11665         ## Export the given shape into a file with given name.
11666         #
11667         #  Note: this function is deprecated, it is kept for backward compatibility only
11668         #  Use Export<FormatName> instead, where <FormatName> is a name of desirable format to export.
11669         #
11670         #  @param theObject Shape to be stored in the file.
11671         #  @param theFileName Name of the file to store the given shape in.
11672         #  @param theFormatName Specify format for the shape storage.
11673         #         Available formats can be obtained with
11674         #         geompy.InsertOp.ExportTranslators()[0] method.
11675         #
11676         #  @ref swig_Import_Export "Example"
11677         @ManageTransactions("InsertOp")
11678         def Export(self, theObject, theFileName, theFormatName):
11679             """
11680             Export the given shape into a file with given name.
11681
11682             Note: this function is deprecated, it is kept for backward compatibility only
11683             Use Export<FormatName> instead, where <FormatName> is a name of desirable format to export.
11684             
11685             Parameters: 
11686                 theObject Shape to be stored in the file.
11687                 theFileName Name of the file to store the given shape in.
11688                 theFormatName Specify format for the shape storage.
11689                               Available formats can be obtained with
11690                               geompy.InsertOp.ExportTranslators()[0] method.
11691             """
11692             # Example: see GEOM_TestOthers.py
11693             print """
11694             WARNING: Function Export is deprecated, use Export<FormatName> instead,
11695             where <FormatName> is a name of desirable format for exporting.
11696             """
11697             self.InsertOp.Export(theObject, theFileName, theFormatName)
11698             if self.InsertOp.IsDone() == 0:
11699                 raise RuntimeError,  "Export : " + self.InsertOp.GetErrorCode()
11700                 pass
11701             pass
11702
11703         # end of l2_import_export
11704         ## @}
11705
11706         ## @addtogroup l3_blocks
11707         ## @{
11708
11709         ## Create a quadrangle face from four edges. Order of Edges is not
11710         #  important. It is  not necessary that edges share the same vertex.
11711         #  @param E1,E2,E3,E4 Edges for the face bound.
11712         #  @param theName Object name; when specified, this parameter is used
11713         #         for result publication in the study. Otherwise, if automatic
11714         #         publication is switched on, default value is used for result name.
11715         #
11716         #  @return New GEOM.GEOM_Object, containing the created face.
11717         #
11718         #  @ref tui_building_by_blocks_page "Example"
11719         @ManageTransactions("BlocksOp")
11720         def MakeQuad(self, E1, E2, E3, E4, theName=None):
11721             """
11722             Create a quadrangle face from four edges. Order of Edges is not
11723             important. It is  not necessary that edges share the same vertex.
11724
11725             Parameters:
11726                 E1,E2,E3,E4 Edges for the face bound.
11727                 theName Object name; when specified, this parameter is used
11728                         for result publication in the study. Otherwise, if automatic
11729                         publication is switched on, default value is used for result name.
11730
11731             Returns:
11732                 New GEOM.GEOM_Object, containing the created face.
11733
11734             Example of usage:
11735                 qface1 = geompy.MakeQuad(edge1, edge2, edge3, edge4)
11736             """
11737             # Example: see GEOM_Spanner.py
11738             anObj = self.BlocksOp.MakeQuad(E1, E2, E3, E4)
11739             RaiseIfFailed("MakeQuad", self.BlocksOp)
11740             self._autoPublish(anObj, theName, "quad")
11741             return anObj
11742
11743         ## Create a quadrangle face on two edges.
11744         #  The missing edges will be built by creating the shortest ones.
11745         #  @param E1,E2 Two opposite edges for the face.
11746         #  @param theName Object name; when specified, this parameter is used
11747         #         for result publication in the study. Otherwise, if automatic
11748         #         publication is switched on, default value is used for result name.
11749         #
11750         #  @return New GEOM.GEOM_Object, containing the created face.
11751         #
11752         #  @ref tui_building_by_blocks_page "Example"
11753         @ManageTransactions("BlocksOp")
11754         def MakeQuad2Edges(self, E1, E2, theName=None):
11755             """
11756             Create a quadrangle face on two edges.
11757             The missing edges will be built by creating the shortest ones.
11758
11759             Parameters:
11760                 E1,E2 Two opposite edges for the face.
11761                 theName Object name; when specified, this parameter is used
11762                         for result publication in the study. Otherwise, if automatic
11763                         publication is switched on, default value is used for result name.
11764
11765             Returns:
11766                 New GEOM.GEOM_Object, containing the created face.
11767
11768             Example of usage:
11769                 # create vertices
11770                 p1 = geompy.MakeVertex(  0.,   0.,   0.)
11771                 p2 = geompy.MakeVertex(150.,  30.,   0.)
11772                 p3 = geompy.MakeVertex(  0., 120.,  50.)
11773                 p4 = geompy.MakeVertex(  0.,  40.,  70.)
11774                 # create edges
11775                 edge1 = geompy.MakeEdge(p1, p2)
11776                 edge2 = geompy.MakeEdge(p3, p4)
11777                 # create a quadrangle face from two edges
11778                 qface2 = geompy.MakeQuad2Edges(edge1, edge2)
11779             """
11780             # Example: see GEOM_Spanner.py
11781             anObj = self.BlocksOp.MakeQuad2Edges(E1, E2)
11782             RaiseIfFailed("MakeQuad2Edges", self.BlocksOp)
11783             self._autoPublish(anObj, theName, "quad")
11784             return anObj
11785
11786         ## Create a quadrangle face with specified corners.
11787         #  The missing edges will be built by creating the shortest ones.
11788         #  @param V1,V2,V3,V4 Corner vertices for the face.
11789         #  @param theName Object name; when specified, this parameter is used
11790         #         for result publication in the study. Otherwise, if automatic
11791         #         publication is switched on, default value is used for result name.
11792         #
11793         #  @return New GEOM.GEOM_Object, containing the created face.
11794         #
11795         #  @ref tui_building_by_blocks_page "Example 1"
11796         #  \n @ref swig_MakeQuad4Vertices "Example 2"
11797         @ManageTransactions("BlocksOp")
11798         def MakeQuad4Vertices(self, V1, V2, V3, V4, theName=None):
11799             """
11800             Create a quadrangle face with specified corners.
11801             The missing edges will be built by creating the shortest ones.
11802
11803             Parameters:
11804                 V1,V2,V3,V4 Corner vertices for the face.
11805                 theName Object name; when specified, this parameter is used
11806                         for result publication in the study. Otherwise, if automatic
11807                         publication is switched on, default value is used for result name.
11808
11809             Returns:
11810                 New GEOM.GEOM_Object, containing the created face.
11811
11812             Example of usage:
11813                 # create vertices
11814                 p1 = geompy.MakeVertex(  0.,   0.,   0.)
11815                 p2 = geompy.MakeVertex(150.,  30.,   0.)
11816                 p3 = geompy.MakeVertex(  0., 120.,  50.)
11817                 p4 = geompy.MakeVertex(  0.,  40.,  70.)
11818                 # create a quadrangle from four points in its corners
11819                 qface3 = geompy.MakeQuad4Vertices(p1, p2, p3, p4)
11820             """
11821             # Example: see GEOM_Spanner.py
11822             anObj = self.BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
11823             RaiseIfFailed("MakeQuad4Vertices", self.BlocksOp)
11824             self._autoPublish(anObj, theName, "quad")
11825             return anObj
11826
11827         ## Create a hexahedral solid, bounded by the six given faces. Order of
11828         #  faces is not important. It is  not necessary that Faces share the same edge.
11829         #  @param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
11830         #  @param theName Object name; when specified, this parameter is used
11831         #         for result publication in the study. Otherwise, if automatic
11832         #         publication is switched on, default value is used for result name.
11833         #
11834         #  @return New GEOM.GEOM_Object, containing the created solid.
11835         #
11836         #  @ref tui_building_by_blocks_page "Example 1"
11837         #  \n @ref swig_MakeHexa "Example 2"
11838         @ManageTransactions("BlocksOp")
11839         def MakeHexa(self, F1, F2, F3, F4, F5, F6, theName=None):
11840             """
11841             Create a hexahedral solid, bounded by the six given faces. Order of
11842             faces is not important. It is  not necessary that Faces share the same edge.
11843
11844             Parameters:
11845                 F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
11846                 theName Object name; when specified, this parameter is used
11847                         for result publication in the study. Otherwise, if automatic
11848                         publication is switched on, default value is used for result name.
11849
11850             Returns:
11851                 New GEOM.GEOM_Object, containing the created solid.
11852
11853             Example of usage:
11854                 solid = geompy.MakeHexa(qface1, qface2, qface3, qface4, qface5, qface6)
11855             """
11856             # Example: see GEOM_Spanner.py
11857             anObj = self.BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
11858             RaiseIfFailed("MakeHexa", self.BlocksOp)
11859             self._autoPublish(anObj, theName, "hexa")
11860             return anObj
11861
11862         ## Create a hexahedral solid between two given faces.
11863         #  The missing faces will be built by creating the smallest ones.
11864         #  @param F1,F2 Two opposite faces for the hexahedral solid.
11865         #  @param theName Object name; when specified, this parameter is used
11866         #         for result publication in the study. Otherwise, if automatic
11867         #         publication is switched on, default value is used for result name.
11868         #
11869         #  @return New GEOM.GEOM_Object, containing the created solid.
11870         #
11871         #  @ref tui_building_by_blocks_page "Example 1"
11872         #  \n @ref swig_MakeHexa2Faces "Example 2"
11873         @ManageTransactions("BlocksOp")
11874         def MakeHexa2Faces(self, F1, F2, theName=None):
11875             """
11876             Create a hexahedral solid between two given faces.
11877             The missing faces will be built by creating the smallest ones.
11878
11879             Parameters:
11880                 F1,F2 Two opposite faces for the hexahedral solid.
11881                 theName Object name; when specified, this parameter is used
11882                         for result publication in the study. Otherwise, if automatic
11883                         publication is switched on, default value is used for result name.
11884
11885             Returns:
11886                 New GEOM.GEOM_Object, containing the created solid.
11887
11888             Example of usage:
11889                 solid1 = geompy.MakeHexa2Faces(qface1, qface2)
11890             """
11891             # Example: see GEOM_Spanner.py
11892             anObj = self.BlocksOp.MakeHexa2Faces(F1, F2)
11893             RaiseIfFailed("MakeHexa2Faces", self.BlocksOp)
11894             self._autoPublish(anObj, theName, "hexa")
11895             return anObj
11896
11897         # end of l3_blocks
11898         ## @}
11899
11900         ## @addtogroup l3_blocks_op
11901         ## @{
11902
11903         ## Get a vertex, found in the given shape by its coordinates.
11904         #  @param theShape Block or a compound of blocks.
11905         #  @param theX,theY,theZ Coordinates of the sought vertex.
11906         #  @param theEpsilon Maximum allowed distance between the resulting
11907         #                    vertex and point with the given coordinates.
11908         #  @param theName Object name; when specified, this parameter is used
11909         #         for result publication in the study. Otherwise, if automatic
11910         #         publication is switched on, default value is used for result name.
11911         #
11912         #  @return New GEOM.GEOM_Object, containing the found vertex.
11913         #
11914         #  @ref swig_GetPoint "Example"
11915         @ManageTransactions("BlocksOp")
11916         def GetPoint(self, theShape, theX, theY, theZ, theEpsilon, theName=None):
11917             """
11918             Get a vertex, found in the given shape by its coordinates.
11919
11920             Parameters:
11921                 theShape Block or a compound of blocks.
11922                 theX,theY,theZ Coordinates of the sought vertex.
11923                 theEpsilon Maximum allowed distance between the resulting
11924                            vertex and point with the given coordinates.
11925                 theName Object name; when specified, this parameter is used
11926                         for result publication in the study. Otherwise, if automatic
11927                         publication is switched on, default value is used for result name.
11928
11929             Returns:
11930                 New GEOM.GEOM_Object, containing the found vertex.
11931
11932             Example of usage:
11933                 pnt = geompy.GetPoint(shape, -50,  50,  50, 0.01)
11934             """
11935             # Example: see GEOM_TestOthers.py
11936             anObj = self.BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
11937             RaiseIfFailed("GetPoint", self.BlocksOp)
11938             self._autoPublish(anObj, theName, "vertex")
11939             return anObj
11940
11941         ## Find a vertex of the given shape, which has minimal distance to the given point.
11942         #  @param theShape Any shape.
11943         #  @param thePoint Point, close to the desired vertex.
11944         #  @param theName Object name; when specified, this parameter is used
11945         #         for result publication in the study. Otherwise, if automatic
11946         #         publication is switched on, default value is used for result name.
11947         #
11948         #  @return New GEOM.GEOM_Object, containing the found vertex.
11949         #
11950         #  @ref swig_GetVertexNearPoint "Example"
11951         @ManageTransactions("BlocksOp")
11952         def GetVertexNearPoint(self, theShape, thePoint, theName=None):
11953             """
11954             Find a vertex of the given shape, which has minimal distance to the given point.
11955
11956             Parameters:
11957                 theShape Any shape.
11958                 thePoint Point, close to the desired vertex.
11959                 theName Object name; when specified, this parameter is used
11960                         for result publication in the study. Otherwise, if automatic
11961                         publication is switched on, default value is used for result name.
11962
11963             Returns:
11964                 New GEOM.GEOM_Object, containing the found vertex.
11965
11966             Example of usage:
11967                 pmidle = geompy.MakeVertex(50, 0, 50)
11968                 edge1 = geompy.GetEdgeNearPoint(blocksComp, pmidle)
11969             """
11970             # Example: see GEOM_TestOthers.py
11971             anObj = self.BlocksOp.GetVertexNearPoint(theShape, thePoint)
11972             RaiseIfFailed("GetVertexNearPoint", self.BlocksOp)
11973             self._autoPublish(anObj, theName, "vertex")
11974             return anObj
11975
11976         ## Get an edge, found in the given shape by two given vertices.
11977         #  @param theShape Block or a compound of blocks.
11978         #  @param thePoint1,thePoint2 Points, close to the ends of the desired edge.
11979         #  @param theName Object name; when specified, this parameter is used
11980         #         for result publication in the study. Otherwise, if automatic
11981         #         publication is switched on, default value is used for result name.
11982         #
11983         #  @return New GEOM.GEOM_Object, containing the found edge.
11984         #
11985         #  @ref swig_GetEdge "Example"
11986         @ManageTransactions("BlocksOp")
11987         def GetEdge(self, theShape, thePoint1, thePoint2, theName=None):
11988             """
11989             Get an edge, found in the given shape by two given vertices.
11990
11991             Parameters:
11992                 theShape Block or a compound of blocks.
11993                 thePoint1,thePoint2 Points, close to the ends of the desired edge.
11994                 theName Object name; when specified, this parameter is used
11995                         for result publication in the study. Otherwise, if automatic
11996                         publication is switched on, default value is used for result name.
11997
11998             Returns:
11999                 New GEOM.GEOM_Object, containing the found edge.
12000             """
12001             # Example: see GEOM_Spanner.py
12002             anObj = self.BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
12003             RaiseIfFailed("GetEdge", self.BlocksOp)
12004             self._autoPublish(anObj, theName, "edge")
12005             return anObj
12006
12007         ## Find an edge of the given shape, which has minimal distance to the given point.
12008         #  @param theShape Block or a compound of blocks.
12009         #  @param thePoint Point, close to the desired edge.
12010         #  @param theName Object name; when specified, this parameter is used
12011         #         for result publication in the study. Otherwise, if automatic
12012         #         publication is switched on, default value is used for result name.
12013         #
12014         #  @return New GEOM.GEOM_Object, containing the found edge.
12015         #
12016         #  @ref swig_GetEdgeNearPoint "Example"
12017         @ManageTransactions("BlocksOp")
12018         def GetEdgeNearPoint(self, theShape, thePoint, theName=None):
12019             """
12020             Find an edge of the given shape, which has minimal distance to the given point.
12021
12022             Parameters:
12023                 theShape Block or a compound of blocks.
12024                 thePoint Point, close to the desired edge.
12025                 theName Object name; when specified, this parameter is used
12026                         for result publication in the study. Otherwise, if automatic
12027                         publication is switched on, default value is used for result name.
12028
12029             Returns:
12030                 New GEOM.GEOM_Object, containing the found edge.
12031             """
12032             # Example: see GEOM_TestOthers.py
12033             anObj = self.BlocksOp.GetEdgeNearPoint(theShape, thePoint)
12034             RaiseIfFailed("GetEdgeNearPoint", self.BlocksOp)
12035             self._autoPublish(anObj, theName, "edge")
12036             return anObj
12037
12038         ## Returns a face, found in the given shape by four given corner vertices.
12039         #  @param theShape Block or a compound of blocks.
12040         #  @param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
12041         #  @param theName Object name; when specified, this parameter is used
12042         #         for result publication in the study. Otherwise, if automatic
12043         #         publication is switched on, default value is used for result name.
12044         #
12045         #  @return New GEOM.GEOM_Object, containing the found face.
12046         #
12047         #  @ref swig_todo "Example"
12048         @ManageTransactions("BlocksOp")
12049         def GetFaceByPoints(self, theShape, thePoint1, thePoint2, thePoint3, thePoint4, theName=None):
12050             """
12051             Returns a face, found in the given shape by four given corner vertices.
12052
12053             Parameters:
12054                 theShape Block or a compound of blocks.
12055                 thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
12056                 theName Object name; when specified, this parameter is used
12057                         for result publication in the study. Otherwise, if automatic
12058                         publication is switched on, default value is used for result name.
12059
12060             Returns:
12061                 New GEOM.GEOM_Object, containing the found face.
12062             """
12063             # Example: see GEOM_Spanner.py
12064             anObj = self.BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
12065             RaiseIfFailed("GetFaceByPoints", self.BlocksOp)
12066             self._autoPublish(anObj, theName, "face")
12067             return anObj
12068
12069         ## Get a face of block, found in the given shape by two given edges.
12070         #  @param theShape Block or a compound of blocks.
12071         #  @param theEdge1,theEdge2 Edges, close to the edges of the desired face.
12072         #  @param theName Object name; when specified, this parameter is used
12073         #         for result publication in the study. Otherwise, if automatic
12074         #         publication is switched on, default value is used for result name.
12075         #
12076         #  @return New GEOM.GEOM_Object, containing the found face.
12077         #
12078         #  @ref swig_todo "Example"
12079         @ManageTransactions("BlocksOp")
12080         def GetFaceByEdges(self, theShape, theEdge1, theEdge2, theName=None):
12081             """
12082             Get a face of block, found in the given shape by two given edges.
12083
12084             Parameters:
12085                 theShape Block or a compound of blocks.
12086                 theEdge1,theEdge2 Edges, close to the edges of the desired face.
12087                 theName Object name; when specified, this parameter is used
12088                         for result publication in the study. Otherwise, if automatic
12089                         publication is switched on, default value is used for result name.
12090
12091             Returns:
12092                 New GEOM.GEOM_Object, containing the found face.
12093             """
12094             # Example: see GEOM_Spanner.py
12095             anObj = self.BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
12096             RaiseIfFailed("GetFaceByEdges", self.BlocksOp)
12097             self._autoPublish(anObj, theName, "face")
12098             return anObj
12099
12100         ## Find a face, opposite to the given one in the given block.
12101         #  @param theBlock Must be a hexahedral solid.
12102         #  @param theFace Face of \a theBlock, opposite to the desired face.
12103         #  @param theName Object name; when specified, this parameter is used
12104         #         for result publication in the study. Otherwise, if automatic
12105         #         publication is switched on, default value is used for result name.
12106         #
12107         #  @return New GEOM.GEOM_Object, containing the found face.
12108         #
12109         #  @ref swig_GetOppositeFace "Example"
12110         @ManageTransactions("BlocksOp")
12111         def GetOppositeFace(self, theBlock, theFace, theName=None):
12112             """
12113             Find a face, opposite to the given one in the given block.
12114
12115             Parameters:
12116                 theBlock Must be a hexahedral solid.
12117                 theFace Face of theBlock, opposite to the desired face.
12118                 theName Object name; when specified, this parameter is used
12119                         for result publication in the study. Otherwise, if automatic
12120                         publication is switched on, default value is used for result name.
12121
12122             Returns:
12123                 New GEOM.GEOM_Object, containing the found face.
12124             """
12125             # Example: see GEOM_Spanner.py
12126             anObj = self.BlocksOp.GetOppositeFace(theBlock, theFace)
12127             RaiseIfFailed("GetOppositeFace", self.BlocksOp)
12128             self._autoPublish(anObj, theName, "face")
12129             return anObj
12130
12131         ## Find a face of the given shape, which has minimal distance to the given point.
12132         #  @param theShape Block or a compound of blocks.
12133         #  @param thePoint Point, close to the desired face.
12134         #  @param theName Object name; when specified, this parameter is used
12135         #         for result publication in the study. Otherwise, if automatic
12136         #         publication is switched on, default value is used for result name.
12137         #
12138         #  @return New GEOM.GEOM_Object, containing the found face.
12139         #
12140         #  @ref swig_GetFaceNearPoint "Example"
12141         @ManageTransactions("BlocksOp")
12142         def GetFaceNearPoint(self, theShape, thePoint, theName=None):
12143             """
12144             Find a face of the given shape, which has minimal distance to the given point.
12145
12146             Parameters:
12147                 theShape Block or a compound of blocks.
12148                 thePoint Point, close to the desired face.
12149                 theName Object name; when specified, this parameter is used
12150                         for result publication in the study. Otherwise, if automatic
12151                         publication is switched on, default value is used for result name.
12152
12153             Returns:
12154                 New GEOM.GEOM_Object, containing the found face.
12155             """
12156             # Example: see GEOM_Spanner.py
12157             anObj = self.BlocksOp.GetFaceNearPoint(theShape, thePoint)
12158             RaiseIfFailed("GetFaceNearPoint", self.BlocksOp)
12159             self._autoPublish(anObj, theName, "face")
12160             return anObj
12161
12162         ## Find a face of block, whose outside normale has minimal angle with the given vector.
12163         #  @param theBlock Block or a compound of blocks.
12164         #  @param theVector Vector, close to the normale of the desired face.
12165         #  @param theName Object name; when specified, this parameter is used
12166         #         for result publication in the study. Otherwise, if automatic
12167         #         publication is switched on, default value is used for result name.
12168         #
12169         #  @return New GEOM.GEOM_Object, containing the found face.
12170         #
12171         #  @ref swig_todo "Example"
12172         @ManageTransactions("BlocksOp")
12173         def GetFaceByNormale(self, theBlock, theVector, theName=None):
12174             """
12175             Find a face of block, whose outside normale has minimal angle with the given vector.
12176
12177             Parameters:
12178                 theBlock Block or a compound of blocks.
12179                 theVector Vector, close to the normale of the desired face.
12180                 theName Object name; when specified, this parameter is used
12181                         for result publication in the study. Otherwise, if automatic
12182                         publication is switched on, default value is used for result name.
12183
12184             Returns:
12185                 New GEOM.GEOM_Object, containing the found face.
12186             """
12187             # Example: see GEOM_Spanner.py
12188             anObj = self.BlocksOp.GetFaceByNormale(theBlock, theVector)
12189             RaiseIfFailed("GetFaceByNormale", self.BlocksOp)
12190             self._autoPublish(anObj, theName, "face")
12191             return anObj
12192
12193         ## Find all sub-shapes of type \a theShapeType of the given shape,
12194         #  which have minimal distance to the given point.
12195         #  @param theShape Any shape.
12196         #  @param thePoint Point, close to the desired shape.
12197         #  @param theShapeType Defines what kind of sub-shapes is searched GEOM::shape_type
12198         #  @param theTolerance The tolerance for distances comparison. All shapes
12199         #                      with distances to the given point in interval
12200         #                      [minimal_distance, minimal_distance + theTolerance] will be gathered.
12201         #  @param theName Object name; when specified, this parameter is used
12202         #         for result publication in the study. Otherwise, if automatic
12203         #         publication is switched on, default value is used for result name.
12204         #
12205         #  @return New GEOM_Object, containing a group of all found shapes.
12206         #
12207         #  @ref swig_GetShapesNearPoint "Example"
12208         @ManageTransactions("BlocksOp")
12209         def GetShapesNearPoint(self, theShape, thePoint, theShapeType, theTolerance = 1e-07, theName=None):
12210             """
12211             Find all sub-shapes of type theShapeType of the given shape,
12212             which have minimal distance to the given point.
12213
12214             Parameters:
12215                 theShape Any shape.
12216                 thePoint Point, close to the desired shape.
12217                 theShapeType Defines what kind of sub-shapes is searched (see GEOM::shape_type)
12218                 theTolerance The tolerance for distances comparison. All shapes
12219                                 with distances to the given point in interval
12220                                 [minimal_distance, minimal_distance + theTolerance] will be gathered.
12221                 theName Object name; when specified, this parameter is used
12222                         for result publication in the study. Otherwise, if automatic
12223                         publication is switched on, default value is used for result name.
12224
12225             Returns:
12226                 New GEOM_Object, containing a group of all found shapes.
12227             """
12228             # Example: see GEOM_TestOthers.py
12229             anObj = self.BlocksOp.GetShapesNearPoint(theShape, thePoint, theShapeType, theTolerance)
12230             RaiseIfFailed("GetShapesNearPoint", self.BlocksOp)
12231             self._autoPublish(anObj, theName, "group")
12232             return anObj
12233
12234         # end of l3_blocks_op
12235         ## @}
12236
12237         ## @addtogroup l4_blocks_measure
12238         ## @{
12239
12240         ## Check, if the compound of blocks is given.
12241         #  To be considered as a compound of blocks, the
12242         #  given shape must satisfy the following conditions:
12243         #  - Each element of the compound should be a Block (6 faces).
12244         #  - Each face should be a quadrangle, i.e. it should have only 1 wire
12245         #       with 4 edges. If <VAR>theIsUseC1</VAR> is set to True and
12246         #       there are more than 4 edges in the only wire of a face,
12247         #       this face is considered to be quadrangle if it has 4 bounds
12248         #       (1 or more edge) of C1 continuity.
12249         #  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
12250         #  - The compound should be connexe.
12251         #  - The glue between two quadrangle faces should be applied.
12252         #  @param theCompound The compound to check.
12253         #  @param theIsUseC1 Flag to check if there are 4 bounds on a face
12254         #         taking into account C1 continuity.
12255         #  @param theAngTolerance the angular tolerance to check if two neighbor
12256         #         edges are codirectional in the common vertex with this
12257         #         tolerance. This parameter is used only if
12258         #         <VAR>theIsUseC1</VAR> is set to True.
12259         #  @return TRUE, if the given shape is a compound of blocks.
12260         #  If theCompound is not valid, prints all discovered errors.
12261         #
12262         #  @ref tui_check_compound_of_blocks_page "Example 1"
12263         #  \n @ref swig_CheckCompoundOfBlocks "Example 2"
12264         @ManageTransactions("BlocksOp")
12265         def CheckCompoundOfBlocks(self,theCompound, theIsUseC1 = False,
12266                                   theAngTolerance = 1.e-12):
12267             """
12268             Check, if the compound of blocks is given.
12269             To be considered as a compound of blocks, the
12270             given shape must satisfy the following conditions:
12271             - Each element of the compound should be a Block (6 faces).
12272             - Each face should be a quadrangle, i.e. it should have only 1 wire
12273                  with 4 edges. If theIsUseC1 is set to True and
12274                  there are more than 4 edges in the only wire of a face,
12275                  this face is considered to be quadrangle if it has 4 bounds
12276                  (1 or more edge) of C1 continuity.
12277             - A connection between two Blocks should be an entire quadrangle face or an entire edge.
12278             - The compound should be connexe.
12279             - The glue between two quadrangle faces should be applied.
12280
12281             Parameters:
12282                 theCompound The compound to check.
12283                 theIsUseC1 Flag to check if there are 4 bounds on a face
12284                            taking into account C1 continuity.
12285                 theAngTolerance the angular tolerance to check if two neighbor
12286                            edges are codirectional in the common vertex with this
12287                            tolerance. This parameter is used only if
12288                            theIsUseC1 is set to True.
12289
12290             Returns:
12291                 TRUE, if the given shape is a compound of blocks.
12292                 If theCompound is not valid, prints all discovered errors.
12293             """
12294             # Example: see GEOM_Spanner.py
12295             aTolerance = -1.0
12296             if theIsUseC1:
12297                 aTolerance = theAngTolerance
12298             (IsValid, BCErrors) = self.BlocksOp.CheckCompoundOfBlocks(theCompound, aTolerance)
12299             RaiseIfFailed("CheckCompoundOfBlocks", self.BlocksOp)
12300             if IsValid == 0:
12301                 Descr = self.BlocksOp.PrintBCErrors(theCompound, BCErrors)
12302                 print Descr
12303             return IsValid
12304
12305         ## Retrieve all non blocks solids and faces from \a theShape.
12306         #  @param theShape The shape to explore.
12307         #  @param theIsUseC1 Flag to check if there are 4 bounds on a face
12308         #         taking into account C1 continuity.
12309         #  @param theAngTolerance the angular tolerance to check if two neighbor
12310         #         edges are codirectional in the common vertex with this
12311         #         tolerance. This parameter is used only if
12312         #         <VAR>theIsUseC1</VAR> is set to True.
12313         #  @param theName Object name; when specified, this parameter is used
12314         #         for result publication in the study. Otherwise, if automatic
12315         #         publication is switched on, default value is used for result name.
12316         #
12317         #  @return A tuple of two GEOM_Objects. The first object is a group of all
12318         #          non block solids (= not 6 faces, or with 6 faces, but with the
12319         #          presence of non-quadrangular faces). The second object is a
12320         #          group of all non quadrangular faces (= faces with more then
12321         #          1 wire or, if <VAR>theIsUseC1</VAR> is set to True, faces
12322         #          with 1 wire with not 4 edges that do not form 4 bounds of
12323         #          C1 continuity).
12324         #
12325         #  @ref tui_get_non_blocks_page "Example 1"
12326         #  \n @ref swig_GetNonBlocks "Example 2"
12327         @ManageTransactions("BlocksOp")
12328         def GetNonBlocks (self, theShape, theIsUseC1 = False,
12329                           theAngTolerance = 1.e-12, theName=None):
12330             """
12331             Retrieve all non blocks solids and faces from theShape.
12332
12333             Parameters:
12334                 theShape The shape to explore.
12335                 theIsUseC1 Flag to check if there are 4 bounds on a face
12336                            taking into account C1 continuity.
12337                 theAngTolerance the angular tolerance to check if two neighbor
12338                            edges are codirectional in the common vertex with this
12339                            tolerance. This parameter is used only if
12340                            theIsUseC1 is set to True.
12341                 theName Object name; when specified, this parameter is used
12342                         for result publication in the study. Otherwise, if automatic
12343                         publication is switched on, default value is used for result name.
12344
12345             Returns:
12346                 A tuple of two GEOM_Objects. The first object is a group of all
12347                 non block solids (= not 6 faces, or with 6 faces, but with the
12348                 presence of non-quadrangular faces). The second object is a
12349                 group of all non quadrangular faces (= faces with more then
12350                 1 wire or, if <VAR>theIsUseC1</VAR> is set to True, faces
12351                 with 1 wire with not 4 edges that do not form 4 bounds of
12352                 C1 continuity).
12353
12354             Usage:
12355                 (res_sols, res_faces) = geompy.GetNonBlocks(myShape1)
12356             """
12357             # Example: see GEOM_Spanner.py
12358             aTolerance = -1.0
12359             if theIsUseC1:
12360                 aTolerance = theAngTolerance
12361             aTuple = self.BlocksOp.GetNonBlocks(theShape, aTolerance)
12362             RaiseIfFailed("GetNonBlocks", self.BlocksOp)
12363             self._autoPublish(aTuple, theName, ("groupNonHexas", "groupNonQuads"))
12364             return aTuple
12365
12366         ## Remove all seam and degenerated edges from \a theShape.
12367         #  Unite faces and edges, sharing one surface. It means that
12368         #  this faces must have references to one C++ surface object (handle).
12369         #  @param theShape The compound or single solid to remove irregular edges from.
12370         #  @param doUnionFaces If True, then unite faces. If False (the default value),
12371         #         do not unite faces.
12372         #  @param theName Object name; when specified, this parameter is used
12373         #         for result publication in the study. Otherwise, if automatic
12374         #         publication is switched on, default value is used for result name.
12375         #
12376         #  @return Improved shape.
12377         #
12378         #  @ref swig_RemoveExtraEdges "Example"
12379         @ManageTransactions("BlocksOp")
12380         def RemoveExtraEdges(self, theShape, doUnionFaces=False, theName=None):
12381             """
12382             Remove all seam and degenerated edges from theShape.
12383             Unite faces and edges, sharing one surface. It means that
12384             this faces must have references to one C++ surface object (handle).
12385
12386             Parameters:
12387                 theShape The compound or single solid to remove irregular edges from.
12388                 doUnionFaces If True, then unite faces. If False (the default value),
12389                              do not unite faces.
12390                 theName Object name; when specified, this parameter is used
12391                         for result publication in the study. Otherwise, if automatic
12392                         publication is switched on, default value is used for result name.
12393
12394             Returns:
12395                 Improved shape.
12396             """
12397             # Example: see GEOM_TestOthers.py
12398             nbFacesOptimum = -1 # -1 means do not unite faces
12399             if doUnionFaces is True: nbFacesOptimum = 0 # 0 means unite faces
12400             anObj = self.BlocksOp.RemoveExtraEdges(theShape, nbFacesOptimum)
12401             RaiseIfFailed("RemoveExtraEdges", self.BlocksOp)
12402             self._autoPublish(anObj, theName, "removeExtraEdges")
12403             return anObj
12404
12405         ## Performs union faces of \a theShape
12406         #  Unite faces sharing one surface. It means that
12407         #  these faces must have references to one C++ surface object (handle).
12408         #  @param theShape The compound or single solid that contains faces
12409         #         to perform union.
12410         #  @param theName Object name; when specified, this parameter is used
12411         #         for result publication in the study. Otherwise, if automatic
12412         #         publication is switched on, default value is used for result name.
12413         #
12414         #  @return Improved shape.
12415         #
12416         #  @ref swig_UnionFaces "Example"
12417         @ManageTransactions("BlocksOp")
12418         def UnionFaces(self, theShape, theName=None):
12419             """
12420             Performs union faces of theShape.
12421             Unite faces sharing one surface. It means that
12422             these faces must have references to one C++ surface object (handle).
12423
12424             Parameters:
12425                 theShape The compound or single solid that contains faces
12426                          to perform union.
12427                 theName Object name; when specified, this parameter is used
12428                         for result publication in the study. Otherwise, if automatic
12429                         publication is switched on, default value is used for result name.
12430
12431             Returns:
12432                 Improved shape.
12433             """
12434             # Example: see GEOM_TestOthers.py
12435             anObj = self.BlocksOp.UnionFaces(theShape)
12436             RaiseIfFailed("UnionFaces", self.BlocksOp)
12437             self._autoPublish(anObj, theName, "unionFaces")
12438             return anObj
12439
12440         ## Check, if the given shape is a blocks compound.
12441         #  Fix all detected errors.
12442         #    \note Single block can be also fixed by this method.
12443         #  @param theShape The compound to check and improve.
12444         #  @param theName Object name; when specified, this parameter is used
12445         #         for result publication in the study. Otherwise, if automatic
12446         #         publication is switched on, default value is used for result name.
12447         #
12448         #  @return Improved compound.
12449         #
12450         #  @ref swig_CheckAndImprove "Example"
12451         @ManageTransactions("BlocksOp")
12452         def CheckAndImprove(self, theShape, theName=None):
12453             """
12454             Check, if the given shape is a blocks compound.
12455             Fix all detected errors.
12456
12457             Note:
12458                 Single block can be also fixed by this method.
12459
12460             Parameters:
12461                 theShape The compound to check and improve.
12462                 theName Object name; when specified, this parameter is used
12463                         for result publication in the study. Otherwise, if automatic
12464                         publication is switched on, default value is used for result name.
12465
12466             Returns:
12467                 Improved compound.
12468             """
12469             # Example: see GEOM_TestOthers.py
12470             anObj = self.BlocksOp.CheckAndImprove(theShape)
12471             RaiseIfFailed("CheckAndImprove", self.BlocksOp)
12472             self._autoPublish(anObj, theName, "improved")
12473             return anObj
12474
12475         # end of l4_blocks_measure
12476         ## @}
12477
12478         ## @addtogroup l3_blocks_op
12479         ## @{
12480
12481         ## Get all the blocks, contained in the given compound.
12482         #  @param theCompound The compound to explode.
12483         #  @param theMinNbFaces If solid has lower number of faces, it is not a block.
12484         #  @param theMaxNbFaces If solid has higher number of faces, it is not a block.
12485         #  @param theName Object name; when specified, this parameter is used
12486         #         for result publication in the study. Otherwise, if automatic
12487         #         publication is switched on, default value is used for result name.
12488         #
12489         #  @note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
12490         #
12491         #  @return List of GEOM.GEOM_Object, containing the retrieved blocks.
12492         #
12493         #  @ref tui_explode_on_blocks "Example 1"
12494         #  \n @ref swig_MakeBlockExplode "Example 2"
12495         @ManageTransactions("BlocksOp")
12496         def MakeBlockExplode(self, theCompound, theMinNbFaces, theMaxNbFaces, theName=None):
12497             """
12498             Get all the blocks, contained in the given compound.
12499
12500             Parameters:
12501                 theCompound The compound to explode.
12502                 theMinNbFaces If solid has lower number of faces, it is not a block.
12503                 theMaxNbFaces If solid has higher number of faces, it is not a block.
12504                 theName Object name; when specified, this parameter is used
12505                         for result publication in the study. Otherwise, if automatic
12506                         publication is switched on, default value is used for result name.
12507
12508             Note:
12509                 If theMaxNbFaces = 0, the maximum number of faces is not restricted.
12510
12511             Returns:
12512                 List of GEOM.GEOM_Object, containing the retrieved blocks.
12513             """
12514             # Example: see GEOM_TestOthers.py
12515             theMinNbFaces,theMaxNbFaces,Parameters = ParseParameters(theMinNbFaces,theMaxNbFaces)
12516             aList = self.BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
12517             RaiseIfFailed("ExplodeCompoundOfBlocks", self.BlocksOp)
12518             for anObj in aList:
12519                 anObj.SetParameters(Parameters)
12520                 pass
12521             self._autoPublish(aList, theName, "block")
12522             return aList
12523
12524         ## Find block, containing the given point inside its volume or on boundary.
12525         #  @param theCompound Compound, to find block in.
12526         #  @param thePoint Point, close to the desired block. If the point lays on
12527         #         boundary between some blocks, we return block with nearest center.
12528         #  @param theName Object name; when specified, this parameter is used
12529         #         for result publication in the study. Otherwise, if automatic
12530         #         publication is switched on, default value is used for result name.
12531         #
12532         #  @return New GEOM.GEOM_Object, containing the found block.
12533         #
12534         #  @ref swig_todo "Example"
12535         @ManageTransactions("BlocksOp")
12536         def GetBlockNearPoint(self, theCompound, thePoint, theName=None):
12537             """
12538             Find block, containing the given point inside its volume or on boundary.
12539
12540             Parameters:
12541                 theCompound Compound, to find block in.
12542                 thePoint Point, close to the desired block. If the point lays on
12543                          boundary between some blocks, we return block with nearest center.
12544                 theName Object name; when specified, this parameter is used
12545                         for result publication in the study. Otherwise, if automatic
12546                         publication is switched on, default value is used for result name.
12547
12548             Returns:
12549                 New GEOM.GEOM_Object, containing the found block.
12550             """
12551             # Example: see GEOM_Spanner.py
12552             anObj = self.BlocksOp.GetBlockNearPoint(theCompound, thePoint)
12553             RaiseIfFailed("GetBlockNearPoint", self.BlocksOp)
12554             self._autoPublish(anObj, theName, "block")
12555             return anObj
12556
12557         ## Find block, containing all the elements, passed as the parts, or maximum quantity of them.
12558         #  @param theCompound Compound, to find block in.
12559         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found block.
12560         #  @param theName Object name; when specified, this parameter is used
12561         #         for result publication in the study. Otherwise, if automatic
12562         #         publication is switched on, default value is used for result name.
12563         #
12564         #  @return New GEOM.GEOM_Object, containing the found block.
12565         #
12566         #  @ref swig_GetBlockByParts "Example"
12567         @ManageTransactions("BlocksOp")
12568         def GetBlockByParts(self, theCompound, theParts, theName=None):
12569             """
12570              Find block, containing all the elements, passed as the parts, or maximum quantity of them.
12571
12572              Parameters:
12573                 theCompound Compound, to find block in.
12574                 theParts List of faces and/or edges and/or vertices to be parts of the found block.
12575                 theName Object name; when specified, this parameter is used
12576                         for result publication in the study. Otherwise, if automatic
12577                         publication is switched on, default value is used for result name.
12578
12579             Returns:
12580                 New GEOM_Object, containing the found block.
12581             """
12582             # Example: see GEOM_TestOthers.py
12583             anObj = self.BlocksOp.GetBlockByParts(theCompound, theParts)
12584             RaiseIfFailed("GetBlockByParts", self.BlocksOp)
12585             self._autoPublish(anObj, theName, "block")
12586             return anObj
12587
12588         ## Return all blocks, containing all the elements, passed as the parts.
12589         #  @param theCompound Compound, to find blocks in.
12590         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
12591         #  @param theName Object name; when specified, this parameter is used
12592         #         for result publication in the study. Otherwise, if automatic
12593         #         publication is switched on, default value is used for result name.
12594         #
12595         #  @return List of GEOM.GEOM_Object, containing the found blocks.
12596         #
12597         #  @ref swig_todo "Example"
12598         @ManageTransactions("BlocksOp")
12599         def GetBlocksByParts(self, theCompound, theParts, theName=None):
12600             """
12601             Return all blocks, containing all the elements, passed as the parts.
12602
12603             Parameters:
12604                 theCompound Compound, to find blocks in.
12605                 theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
12606                 theName Object name; when specified, this parameter is used
12607                         for result publication in the study. Otherwise, if automatic
12608                         publication is switched on, default value is used for result name.
12609
12610             Returns:
12611                 List of GEOM.GEOM_Object, containing the found blocks.
12612             """
12613             # Example: see GEOM_Spanner.py
12614             aList = self.BlocksOp.GetBlocksByParts(theCompound, theParts)
12615             RaiseIfFailed("GetBlocksByParts", self.BlocksOp)
12616             self._autoPublish(aList, theName, "block")
12617             return aList
12618
12619         ## Multi-transformate block and glue the result.
12620         #  Transformation is defined so, as to superpose direction faces.
12621         #  @param Block Hexahedral solid to be multi-transformed.
12622         #  @param DirFace1 ID of First direction face.
12623         #  @param DirFace2 ID of Second direction face.
12624         #  @param NbTimes Quantity of transformations to be done.
12625         #  @param theName Object name; when specified, this parameter is used
12626         #         for result publication in the study. Otherwise, if automatic
12627         #         publication is switched on, default value is used for result name.
12628         #
12629         #  @note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
12630         #
12631         #  @return New GEOM.GEOM_Object, containing the result shape.
12632         #
12633         #  @ref tui_multi_transformation "Example"
12634         @ManageTransactions("BlocksOp")
12635         def MakeMultiTransformation1D(self, Block, DirFace1, DirFace2, NbTimes, theName=None):
12636             """
12637             Multi-transformate block and glue the result.
12638             Transformation is defined so, as to superpose direction faces.
12639
12640             Parameters:
12641                 Block Hexahedral solid to be multi-transformed.
12642                 DirFace1 ID of First direction face.
12643                 DirFace2 ID of Second direction face.
12644                 NbTimes Quantity of transformations to be done.
12645                 theName Object name; when specified, this parameter is used
12646                         for result publication in the study. Otherwise, if automatic
12647                         publication is switched on, default value is used for result name.
12648
12649             Note:
12650                 Unique ID of sub-shape can be obtained, using method GetSubShapeID().
12651
12652             Returns:
12653                 New GEOM.GEOM_Object, containing the result shape.
12654             """
12655             # Example: see GEOM_Spanner.py
12656             DirFace1,DirFace2,NbTimes,Parameters = ParseParameters(DirFace1,DirFace2,NbTimes)
12657             anObj = self.BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
12658             RaiseIfFailed("MakeMultiTransformation1D", self.BlocksOp)
12659             anObj.SetParameters(Parameters)
12660             self._autoPublish(anObj, theName, "transformed")
12661             return anObj
12662
12663         ## Multi-transformate block and glue the result.
12664         #  @param Block Hexahedral solid to be multi-transformed.
12665         #  @param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
12666         #  @param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
12667         #  @param NbTimesU,NbTimesV Quantity of transformations to be done.
12668         #  @param theName Object name; when specified, this parameter is used
12669         #         for result publication in the study. Otherwise, if automatic
12670         #         publication is switched on, default value is used for result name.
12671         #
12672         #  @return New GEOM.GEOM_Object, containing the result shape.
12673         #
12674         #  @ref tui_multi_transformation "Example"
12675         @ManageTransactions("BlocksOp")
12676         def MakeMultiTransformation2D(self, Block, DirFace1U, DirFace2U, NbTimesU,
12677                                       DirFace1V, DirFace2V, NbTimesV, theName=None):
12678             """
12679             Multi-transformate block and glue the result.
12680
12681             Parameters:
12682                 Block Hexahedral solid to be multi-transformed.
12683                 DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
12684                 DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
12685                 NbTimesU,NbTimesV Quantity of transformations to be done.
12686                 theName Object name; when specified, this parameter is used
12687                         for result publication in the study. Otherwise, if automatic
12688                         publication is switched on, default value is used for result name.
12689
12690             Returns:
12691                 New GEOM.GEOM_Object, containing the result shape.
12692             """
12693             # Example: see GEOM_Spanner.py
12694             DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV,Parameters = ParseParameters(
12695               DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV)
12696             anObj = self.BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
12697                                                             DirFace1V, DirFace2V, NbTimesV)
12698             RaiseIfFailed("MakeMultiTransformation2D", self.BlocksOp)
12699             anObj.SetParameters(Parameters)
12700             self._autoPublish(anObj, theName, "transformed")
12701             return anObj
12702
12703         ## Build all possible propagation groups.
12704         #  Propagation group is a set of all edges, opposite to one (main)
12705         #  edge of this group directly or through other opposite edges.
12706         #  Notion of Opposite Edge make sence only on quadrangle face.
12707         #  @param theShape Shape to build propagation groups on.
12708         #  @param theName Object name; when specified, this parameter is used
12709         #         for result publication in the study. Otherwise, if automatic
12710         #         publication is switched on, default value is used for result name.
12711         #
12712         #  @return List of GEOM.GEOM_Object, each of them is a propagation group.
12713         #
12714         #  @ref swig_Propagate "Example"
12715         @ManageTransactions("BlocksOp")
12716         def Propagate(self, theShape, theName=None):
12717             """
12718             Build all possible propagation groups.
12719             Propagation group is a set of all edges, opposite to one (main)
12720             edge of this group directly or through other opposite edges.
12721             Notion of Opposite Edge make sence only on quadrangle face.
12722
12723             Parameters:
12724                 theShape Shape to build propagation groups on.
12725                 theName Object name; when specified, this parameter is used
12726                         for result publication in the study. Otherwise, if automatic
12727                         publication is switched on, default value is used for result name.
12728
12729             Returns:
12730                 List of GEOM.GEOM_Object, each of them is a propagation group.
12731             """
12732             # Example: see GEOM_TestOthers.py
12733             listChains = self.BlocksOp.Propagate(theShape)
12734             RaiseIfFailed("Propagate", self.BlocksOp)
12735             self._autoPublish(listChains, theName, "propagate")
12736             return listChains
12737
12738         # end of l3_blocks_op
12739         ## @}
12740
12741         ## @addtogroup l3_groups
12742         ## @{
12743
12744         ## Creates a new group which will store sub-shapes of theMainShape
12745         #  @param theMainShape is a GEOM object on which the group is selected
12746         #  @param theShapeType defines a shape type of the group (see GEOM::shape_type)
12747         #  @param theName Object name; when specified, this parameter is used
12748         #         for result publication in the study. Otherwise, if automatic
12749         #         publication is switched on, default value is used for result name.
12750         #
12751         #  @return a newly created GEOM group (GEOM.GEOM_Object)
12752         #
12753         #  @ref tui_working_with_groups_page "Example 1"
12754         #  \n @ref swig_CreateGroup "Example 2"
12755         @ManageTransactions("GroupOp")
12756         def CreateGroup(self, theMainShape, theShapeType, theName=None):
12757             """
12758             Creates a new group which will store sub-shapes of theMainShape
12759
12760             Parameters:
12761                theMainShape is a GEOM object on which the group is selected
12762                theShapeType defines a shape type of the group:"COMPOUND", "COMPSOLID",
12763                             "SOLID", "SHELL", "FACE", "WIRE", "EDGE", "VERTEX", "SHAPE".
12764                 theName Object name; when specified, this parameter is used
12765                         for result publication in the study. Otherwise, if automatic
12766                         publication is switched on, default value is used for result name.
12767
12768             Returns:
12769                a newly created GEOM group
12770
12771             Example of usage:
12772                 group = geompy.CreateGroup(Box, geompy.ShapeType["FACE"])
12773
12774             """
12775             # Example: see GEOM_TestOthers.py
12776             anObj = self.GroupOp.CreateGroup(theMainShape, theShapeType)
12777             RaiseIfFailed("CreateGroup", self.GroupOp)
12778             self._autoPublish(anObj, theName, "group")
12779             return anObj
12780
12781         ## Adds a sub-object with ID theSubShapeId to the group
12782         #  @param theGroup is a GEOM group to which the new sub-shape is added
12783         #  @param theSubShapeID is a sub-shape ID in the main object.
12784         #  \note Use method GetSubShapeID() to get an unique ID of the sub-shape
12785         #
12786         #  @ref tui_working_with_groups_page "Example"
12787         @ManageTransactions("GroupOp")
12788         def AddObject(self,theGroup, theSubShapeID):
12789             """
12790             Adds a sub-object with ID theSubShapeId to the group
12791
12792             Parameters:
12793                 theGroup       is a GEOM group to which the new sub-shape is added
12794                 theSubShapeID  is a sub-shape ID in the main object.
12795
12796             Note:
12797                 Use method GetSubShapeID() to get an unique ID of the sub-shape
12798             """
12799             # Example: see GEOM_TestOthers.py
12800             self.GroupOp.AddObject(theGroup, theSubShapeID)
12801             if self.GroupOp.GetErrorCode() != "PAL_ELEMENT_ALREADY_PRESENT":
12802                 RaiseIfFailed("AddObject", self.GroupOp)
12803                 pass
12804             pass
12805
12806         ## Removes a sub-object with ID \a theSubShapeId from the group
12807         #  @param theGroup is a GEOM group from which the new sub-shape is removed
12808         #  @param theSubShapeID is a sub-shape ID in the main object.
12809         #  \note Use method GetSubShapeID() to get an unique ID of the sub-shape
12810         #
12811         #  @ref tui_working_with_groups_page "Example"
12812         @ManageTransactions("GroupOp")
12813         def RemoveObject(self,theGroup, theSubShapeID):
12814             """
12815             Removes a sub-object with ID theSubShapeId from the group
12816
12817             Parameters:
12818                 theGroup is a GEOM group from which the new sub-shape is removed
12819                 theSubShapeID is a sub-shape ID in the main object.
12820
12821             Note:
12822                 Use method GetSubShapeID() to get an unique ID of the sub-shape
12823             """
12824             # Example: see GEOM_TestOthers.py
12825             self.GroupOp.RemoveObject(theGroup, theSubShapeID)
12826             RaiseIfFailed("RemoveObject", self.GroupOp)
12827             pass
12828
12829         ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12830         #  @param theGroup is a GEOM group to which the new sub-shapes are added.
12831         #  @param theSubShapes is a list of sub-shapes to be added.
12832         #
12833         #  @ref tui_working_with_groups_page "Example"
12834         @ManageTransactions("GroupOp")
12835         def UnionList (self,theGroup, theSubShapes):
12836             """
12837             Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12838
12839             Parameters:
12840                 theGroup is a GEOM group to which the new sub-shapes are added.
12841                 theSubShapes is a list of sub-shapes to be added.
12842             """
12843             # Example: see GEOM_TestOthers.py
12844             self.GroupOp.UnionList(theGroup, theSubShapes)
12845             RaiseIfFailed("UnionList", self.GroupOp)
12846             pass
12847
12848         ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12849         #  @param theGroup is a GEOM group to which the new sub-shapes are added.
12850         #  @param theSubShapes is a list of indices of sub-shapes to be added.
12851         #
12852         #  @ref swig_UnionIDs "Example"
12853         @ManageTransactions("GroupOp")
12854         def UnionIDs(self,theGroup, theSubShapes):
12855             """
12856             Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12857
12858             Parameters:
12859                 theGroup is a GEOM group to which the new sub-shapes are added.
12860                 theSubShapes is a list of indices of sub-shapes to be added.
12861             """
12862             # Example: see GEOM_TestOthers.py
12863             self.GroupOp.UnionIDs(theGroup, theSubShapes)
12864             RaiseIfFailed("UnionIDs", self.GroupOp)
12865             pass
12866
12867         ## Removes from the group all the given shapes. No errors, if some shapes are not included.
12868         #  @param theGroup is a GEOM group from which the sub-shapes are removed.
12869         #  @param theSubShapes is a list of sub-shapes to be removed.
12870         #
12871         #  @ref tui_working_with_groups_page "Example"
12872         @ManageTransactions("GroupOp")
12873         def DifferenceList (self,theGroup, theSubShapes):
12874             """
12875             Removes from the group all the given shapes. No errors, if some shapes are not included.
12876
12877             Parameters:
12878                 theGroup is a GEOM group from which the sub-shapes are removed.
12879                 theSubShapes is a list of sub-shapes to be removed.
12880             """
12881             # Example: see GEOM_TestOthers.py
12882             self.GroupOp.DifferenceList(theGroup, theSubShapes)
12883             RaiseIfFailed("DifferenceList", self.GroupOp)
12884             pass
12885
12886         ## Removes from the group all the given shapes. No errors, if some shapes are not included.
12887         #  @param theGroup is a GEOM group from which the sub-shapes are removed.
12888         #  @param theSubShapes is a list of indices of sub-shapes to be removed.
12889         #
12890         #  @ref swig_DifferenceIDs "Example"
12891         @ManageTransactions("GroupOp")
12892         def DifferenceIDs(self,theGroup, theSubShapes):
12893             """
12894             Removes from the group all the given shapes. No errors, if some shapes are not included.
12895
12896             Parameters:
12897                 theGroup is a GEOM group from which the sub-shapes are removed.
12898                 theSubShapes is a list of indices of sub-shapes to be removed.
12899             """
12900             # Example: see GEOM_TestOthers.py
12901             self.GroupOp.DifferenceIDs(theGroup, theSubShapes)
12902             RaiseIfFailed("DifferenceIDs", self.GroupOp)
12903             pass
12904
12905         ## Union of two groups.
12906         #  New group is created. It will contain all entities
12907         #  which are present in groups theGroup1 and theGroup2.
12908         #  @param theGroup1, theGroup2 are the initial GEOM groups
12909         #                              to create the united group from.
12910         #  @param theName Object name; when specified, this parameter is used
12911         #         for result publication in the study. Otherwise, if automatic
12912         #         publication is switched on, default value is used for result name.
12913         #
12914         #  @return a newly created GEOM group.
12915         #
12916         #  @ref tui_union_groups_anchor "Example"
12917         @ManageTransactions("GroupOp")
12918         def UnionGroups (self, theGroup1, theGroup2, theName=None):
12919             """
12920             Union of two groups.
12921             New group is created. It will contain all entities
12922             which are present in groups theGroup1 and theGroup2.
12923
12924             Parameters:
12925                 theGroup1, theGroup2 are the initial GEOM groups
12926                                      to create the united group from.
12927                 theName Object name; when specified, this parameter is used
12928                         for result publication in the study. Otherwise, if automatic
12929                         publication is switched on, default value is used for result name.
12930
12931             Returns:
12932                 a newly created GEOM group.
12933             """
12934             # Example: see GEOM_TestOthers.py
12935             aGroup = self.GroupOp.UnionGroups(theGroup1, theGroup2)
12936             RaiseIfFailed("UnionGroups", self.GroupOp)
12937             self._autoPublish(aGroup, theName, "group")
12938             return aGroup
12939
12940         ## Intersection of two groups.
12941         #  New group is created. It will contain only those entities
12942         #  which are present in both groups theGroup1 and theGroup2.
12943         #  @param theGroup1, theGroup2 are the initial GEOM groups to get common part of.
12944         #  @param theName Object name; when specified, this parameter is used
12945         #         for result publication in the study. Otherwise, if automatic
12946         #         publication is switched on, default value is used for result name.
12947         #
12948         #  @return a newly created GEOM group.
12949         #
12950         #  @ref tui_intersect_groups_anchor "Example"
12951         @ManageTransactions("GroupOp")
12952         def IntersectGroups (self, theGroup1, theGroup2, theName=None):
12953             """
12954             Intersection of two groups.
12955             New group is created. It will contain only those entities
12956             which are present in both groups theGroup1 and theGroup2.
12957
12958             Parameters:
12959                 theGroup1, theGroup2 are the initial GEOM groups to get common part of.
12960                 theName Object name; when specified, this parameter is used
12961                         for result publication in the study. Otherwise, if automatic
12962                         publication is switched on, default value is used for result name.
12963
12964             Returns:
12965                 a newly created GEOM group.
12966             """
12967             # Example: see GEOM_TestOthers.py
12968             aGroup = self.GroupOp.IntersectGroups(theGroup1, theGroup2)
12969             RaiseIfFailed("IntersectGroups", self.GroupOp)
12970             self._autoPublish(aGroup, theName, "group")
12971             return aGroup
12972
12973         ## Cut of two groups.
12974         #  New group is created. It will contain entities which are
12975         #  present in group theGroup1 but are not present in group theGroup2.
12976         #  @param theGroup1 is a GEOM group to include elements of.
12977         #  @param theGroup2 is a GEOM group to exclude elements of.
12978         #  @param theName Object name; when specified, this parameter is used
12979         #         for result publication in the study. Otherwise, if automatic
12980         #         publication is switched on, default value is used for result name.
12981         #
12982         #  @return a newly created GEOM group.
12983         #
12984         #  @ref tui_cut_groups_anchor "Example"
12985         @ManageTransactions("GroupOp")
12986         def CutGroups (self, theGroup1, theGroup2, theName=None):
12987             """
12988             Cut of two groups.
12989             New group is created. It will contain entities which are
12990             present in group theGroup1 but are not present in group theGroup2.
12991
12992             Parameters:
12993                 theGroup1 is a GEOM group to include elements of.
12994                 theGroup2 is a GEOM group to exclude elements of.
12995                 theName Object name; when specified, this parameter is used
12996                         for result publication in the study. Otherwise, if automatic
12997                         publication is switched on, default value is used for result name.
12998
12999             Returns:
13000                 a newly created GEOM group.
13001             """
13002             # Example: see GEOM_TestOthers.py
13003             aGroup = self.GroupOp.CutGroups(theGroup1, theGroup2)
13004             RaiseIfFailed("CutGroups", self.GroupOp)
13005             self._autoPublish(aGroup, theName, "group")
13006             return aGroup
13007
13008         ## Union of list of groups.
13009         #  New group is created. It will contain all entities that are
13010         #  present in groups listed in theGList.
13011         #  @param theGList is a list of GEOM groups to create the united group from.
13012         #  @param theName Object name; when specified, this parameter is used
13013         #         for result publication in the study. Otherwise, if automatic
13014         #         publication is switched on, default value is used for result name.
13015         #
13016         #  @return a newly created GEOM group.
13017         #
13018         #  @ref tui_union_groups_anchor "Example"
13019         @ManageTransactions("GroupOp")
13020         def UnionListOfGroups (self, theGList, theName=None):
13021             """
13022             Union of list of groups.
13023             New group is created. It will contain all entities that are
13024             present in groups listed in theGList.
13025
13026             Parameters:
13027                 theGList is a list of GEOM groups to create the united group from.
13028                 theName Object name; when specified, this parameter is used
13029                         for result publication in the study. Otherwise, if automatic
13030                         publication is switched on, default value is used for result name.
13031
13032             Returns:
13033                 a newly created GEOM group.
13034             """
13035             # Example: see GEOM_TestOthers.py
13036             aGroup = self.GroupOp.UnionListOfGroups(theGList)
13037             RaiseIfFailed("UnionListOfGroups", self.GroupOp)
13038             self._autoPublish(aGroup, theName, "group")
13039             return aGroup
13040
13041         ## Cut of lists of groups.
13042         #  New group is created. It will contain only entities
13043         #  which are present in groups listed in theGList.
13044         #  @param theGList is a list of GEOM groups to include elements of.
13045         #  @param theName Object name; when specified, this parameter is used
13046         #         for result publication in the study. Otherwise, if automatic
13047         #         publication is switched on, default value is used for result name.
13048         #
13049         #  @return a newly created GEOM group.
13050         #
13051         #  @ref tui_intersect_groups_anchor "Example"
13052         @ManageTransactions("GroupOp")
13053         def IntersectListOfGroups (self, theGList, theName=None):
13054             """
13055             Cut of lists of groups.
13056             New group is created. It will contain only entities
13057             which are present in groups listed in theGList.
13058
13059             Parameters:
13060                 theGList is a list of GEOM groups to include elements of.
13061                 theName Object name; when specified, this parameter is used
13062                         for result publication in the study. Otherwise, if automatic
13063                         publication is switched on, default value is used for result name.
13064
13065             Returns:
13066                 a newly created GEOM group.
13067             """
13068             # Example: see GEOM_TestOthers.py
13069             aGroup = self.GroupOp.IntersectListOfGroups(theGList)
13070             RaiseIfFailed("IntersectListOfGroups", self.GroupOp)
13071             self._autoPublish(aGroup, theName, "group")
13072             return aGroup
13073
13074         ## Cut of lists of groups.
13075         #  New group is created. It will contain only entities
13076         #  which are present in groups listed in theGList1 but
13077         #  are not present in groups from theGList2.
13078         #  @param theGList1 is a list of GEOM groups to include elements of.
13079         #  @param theGList2 is a list of GEOM groups to exclude elements of.
13080         #  @param theName Object name; when specified, this parameter is used
13081         #         for result publication in the study. Otherwise, if automatic
13082         #         publication is switched on, default value is used for result name.
13083         #
13084         #  @return a newly created GEOM group.
13085         #
13086         #  @ref tui_cut_groups_anchor "Example"
13087         @ManageTransactions("GroupOp")
13088         def CutListOfGroups (self, theGList1, theGList2, theName=None):
13089             """
13090             Cut of lists of groups.
13091             New group is created. It will contain only entities
13092             which are present in groups listed in theGList1 but
13093             are not present in groups from theGList2.
13094
13095             Parameters:
13096                 theGList1 is a list of GEOM groups to include elements of.
13097                 theGList2 is a list of GEOM groups to exclude elements of.
13098                 theName Object name; when specified, this parameter is used
13099                         for result publication in the study. Otherwise, if automatic
13100                         publication is switched on, default value is used for result name.
13101
13102             Returns:
13103                 a newly created GEOM group.
13104             """
13105             # Example: see GEOM_TestOthers.py
13106             aGroup = self.GroupOp.CutListOfGroups(theGList1, theGList2)
13107             RaiseIfFailed("CutListOfGroups", self.GroupOp)
13108             self._autoPublish(aGroup, theName, "group")
13109             return aGroup
13110
13111         ## Returns a list of sub-objects ID stored in the group
13112         #  @param theGroup is a GEOM group for which a list of IDs is requested
13113         #
13114         #  @ref swig_GetObjectIDs "Example"
13115         @ManageTransactions("GroupOp")
13116         def GetObjectIDs(self,theGroup):
13117             """
13118             Returns a list of sub-objects ID stored in the group
13119
13120             Parameters:
13121                 theGroup is a GEOM group for which a list of IDs is requested
13122             """
13123             # Example: see GEOM_TestOthers.py
13124             ListIDs = self.GroupOp.GetObjects(theGroup)
13125             RaiseIfFailed("GetObjects", self.GroupOp)
13126             return ListIDs
13127
13128         ## Returns a type of sub-objects stored in the group
13129         #  @param theGroup is a GEOM group which type is returned.
13130         #
13131         #  @ref swig_GetType "Example"
13132         @ManageTransactions("GroupOp")
13133         def GetType(self,theGroup):
13134             """
13135             Returns a type of sub-objects stored in the group
13136
13137             Parameters:
13138                 theGroup is a GEOM group which type is returned.
13139             """
13140             # Example: see GEOM_TestOthers.py
13141             aType = self.GroupOp.GetType(theGroup)
13142             RaiseIfFailed("GetType", self.GroupOp)
13143             return aType
13144
13145         ## Convert a type of geom object from id to string value
13146         #  @param theId is a GEOM obect type id.
13147         #  @return type of geom object (POINT, VECTOR, PLANE, LINE, TORUS, ... )
13148         #  @ref swig_GetType "Example"
13149         def ShapeIdToType(self, theId):
13150             """
13151             Convert a type of geom object from id to string value
13152
13153             Parameters:
13154                 theId is a GEOM obect type id.
13155
13156             Returns:
13157                 type of geom object (POINT, VECTOR, PLANE, LINE, TORUS, ... )
13158             """
13159             if theId == 0:
13160                 return "COPY"
13161             if theId == 1:
13162                 return "IMPORT"
13163             if theId == 2:
13164                 return "POINT"
13165             if theId == 3:
13166                 return "VECTOR"
13167             if theId == 4:
13168                 return "PLANE"
13169             if theId == 5:
13170                 return "LINE"
13171             if theId == 6:
13172                 return "TORUS"
13173             if theId == 7:
13174                 return "BOX"
13175             if theId == 8:
13176                 return "CYLINDER"
13177             if theId == 9:
13178                 return "CONE"
13179             if theId == 10:
13180                 return "SPHERE"
13181             if theId == 11:
13182                 return "PRISM"
13183             if theId == 12:
13184                 return "REVOLUTION"
13185             if theId == 13:
13186                 return "BOOLEAN"
13187             if theId == 14:
13188                 return "PARTITION"
13189             if theId == 15:
13190                 return "POLYLINE"
13191             if theId == 16:
13192                 return "CIRCLE"
13193             if theId == 17:
13194                 return "SPLINE"
13195             if theId == 18:
13196                 return "ELLIPSE"
13197             if theId == 19:
13198                 return "CIRC_ARC"
13199             if theId == 20:
13200                 return "FILLET"
13201             if theId == 21:
13202                 return "CHAMFER"
13203             if theId == 22:
13204                 return "EDGE"
13205             if theId == 23:
13206                 return "WIRE"
13207             if theId == 24:
13208                 return "FACE"
13209             if theId == 25:
13210                 return "SHELL"
13211             if theId == 26:
13212                 return "SOLID"
13213             if theId == 27:
13214                 return "COMPOUND"
13215             if theId == 28:
13216                 return "SUBSHAPE"
13217             if theId == 29:
13218                 return "PIPE"
13219             if theId == 30:
13220                 return "ARCHIMEDE"
13221             if theId == 31:
13222                 return "FILLING"
13223             if theId == 32:
13224                 return "EXPLODE"
13225             if theId == 33:
13226                 return "GLUED"
13227             if theId == 34:
13228                 return "SKETCHER"
13229             if theId == 35:
13230                 return "CDG"
13231             if theId == 36:
13232                 return "FREE_BOUNDS"
13233             if theId == 37:
13234                 return "GROUP"
13235             if theId == 38:
13236                 return "BLOCK"
13237             if theId == 39:
13238                 return "MARKER"
13239             if theId == 40:
13240                 return "THRUSECTIONS"
13241             if theId == 41:
13242                 return "COMPOUNDFILTER"
13243             if theId == 42:
13244                 return "SHAPES_ON_SHAPE"
13245             if theId == 43:
13246                 return "ELLIPSE_ARC"
13247             if theId == 44:
13248                 return "3DSKETCHER"
13249             if theId == 45:
13250                 return "FILLET_2D"
13251             if theId == 46:
13252                 return "FILLET_1D"
13253             if theId == 201:
13254                 return "PIPETSHAPE"
13255             return "Shape Id not exist."
13256
13257         ## Returns a main shape associated with the group
13258         #  @param theGroup is a GEOM group for which a main shape object is requested
13259         #  @return a GEOM object which is a main shape for theGroup
13260         #
13261         #  @ref swig_GetMainShape "Example"
13262         @ManageTransactions("GroupOp")
13263         def GetMainShape(self,theGroup):
13264             """
13265             Returns a main shape associated with the group
13266
13267             Parameters:
13268                 theGroup is a GEOM group for which a main shape object is requested
13269
13270             Returns:
13271                 a GEOM object which is a main shape for theGroup
13272
13273             Example of usage: BoxCopy = geompy.GetMainShape(CreateGroup)
13274             """
13275             # Example: see GEOM_TestOthers.py
13276             anObj = self.GroupOp.GetMainShape(theGroup)
13277             RaiseIfFailed("GetMainShape", self.GroupOp)
13278             return anObj
13279
13280         ## Create group of edges of theShape, whose length is in range [min_length, max_length].
13281         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
13282         #  @param theShape given shape (see GEOM.GEOM_Object)
13283         #  @param min_length minimum length of edges of theShape
13284         #  @param max_length maximum length of edges of theShape
13285         #  @param include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
13286         #  @param include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
13287         #  @param theName Object name; when specified, this parameter is used
13288         #         for result publication in the study. Otherwise, if automatic
13289         #         publication is switched on, default value is used for result name.
13290         #
13291         #  @return a newly created GEOM group of edges
13292         #
13293         #  @@ref swig_todo "Example"
13294         def GetEdgesByLength (self, theShape, min_length, max_length, include_min = 1, include_max = 1, theName=None):
13295             """
13296             Create group of edges of theShape, whose length is in range [min_length, max_length].
13297             If include_min/max == 0, edges with length == min/max_length will not be included in result.
13298
13299             Parameters:
13300                 theShape given shape
13301                 min_length minimum length of edges of theShape
13302                 max_length maximum length of edges of theShape
13303                 include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
13304                 include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
13305                 theName Object name; when specified, this parameter is used
13306                         for result publication in the study. Otherwise, if automatic
13307                         publication is switched on, default value is used for result name.
13308
13309              Returns:
13310                 a newly created GEOM group of edges.
13311             """
13312             edges = self.SubShapeAll(theShape, self.ShapeType["EDGE"])
13313             edges_in_range = []
13314             for edge in edges:
13315                 Props = self.BasicProperties(edge)
13316                 if min_length <= Props[0] and Props[0] <= max_length:
13317                     if (not include_min) and (min_length == Props[0]):
13318                         skip = 1
13319                     else:
13320                         if (not include_max) and (Props[0] == max_length):
13321                             skip = 1
13322                         else:
13323                             edges_in_range.append(edge)
13324
13325             if len(edges_in_range) <= 0:
13326                 print "No edges found by given criteria"
13327                 return None
13328
13329             # note: auto-publishing is done in self.CreateGroup()
13330             group_edges = self.CreateGroup(theShape, self.ShapeType["EDGE"], theName)
13331             self.UnionList(group_edges, edges_in_range)
13332
13333             return group_edges
13334
13335         ## Create group of edges of selected shape, whose length is in range [min_length, max_length].
13336         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
13337         #  @param min_length minimum length of edges of selected shape
13338         #  @param max_length maximum length of edges of selected shape
13339         #  @param include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
13340         #  @param include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
13341         #  @return a newly created GEOM group of edges
13342         #  @ref swig_todo "Example"
13343         def SelectEdges (self, min_length, max_length, include_min = 1, include_max = 1):
13344             """
13345             Create group of edges of selected shape, whose length is in range [min_length, max_length].
13346             If include_min/max == 0, edges with length == min/max_length will not be included in result.
13347
13348             Parameters:
13349                 min_length minimum length of edges of selected shape
13350                 max_length maximum length of edges of selected shape
13351                 include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
13352                 include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
13353
13354              Returns:
13355                 a newly created GEOM group of edges.
13356             """
13357             nb_selected = sg.SelectedCount()
13358             if nb_selected < 1:
13359                 print "Select a shape before calling this function, please."
13360                 return 0
13361             if nb_selected > 1:
13362                 print "Only one shape must be selected"
13363                 return 0
13364
13365             id_shape = sg.getSelected(0)
13366             shape = IDToObject( id_shape )
13367
13368             group_edges = self.GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
13369
13370             left_str  = " < "
13371             right_str = " < "
13372             if include_min: left_str  = " <= "
13373             if include_max: right_str  = " <= "
13374
13375             self.addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
13376                                     + left_str + "length" + right_str + `max_length`)
13377
13378             sg.updateObjBrowser(1)
13379
13380             return group_edges
13381
13382         # end of l3_groups
13383         ## @}
13384
13385         #@@ insert new functions before this line @@ do not remove this line @@#
13386
13387         ## Create a copy of the given object
13388         #
13389         #  @param theOriginal geometry object for copy
13390         #  @param theName Object name; when specified, this parameter is used
13391         #         for result publication in the study. Otherwise, if automatic
13392         #         publication is switched on, default value is used for result name.
13393         #
13394         #  @return New GEOM_Object, containing the copied shape.
13395         #
13396         #  @ingroup l1_geomBuilder_auxiliary
13397         #  @ref swig_MakeCopy "Example"
13398         @ManageTransactions("InsertOp")
13399         def MakeCopy(self, theOriginal, theName=None):
13400             """
13401             Create a copy of the given object
13402
13403             Parameters:
13404                 theOriginal geometry object for copy
13405                 theName Object name; when specified, this parameter is used
13406                         for result publication in the study. Otherwise, if automatic
13407                         publication is switched on, default value is used for result name.
13408
13409             Returns:
13410                 New GEOM_Object, containing the copied shape.
13411
13412             Example of usage: Copy = geompy.MakeCopy(Box)
13413             """
13414             # Example: see GEOM_TestAll.py
13415             anObj = self.InsertOp.MakeCopy(theOriginal)
13416             RaiseIfFailed("MakeCopy", self.InsertOp)
13417             self._autoPublish(anObj, theName, "copy")
13418             return anObj
13419
13420         ## Add Path to load python scripts from
13421         #  @param Path a path to load python scripts from
13422         #  @ingroup l1_geomBuilder_auxiliary
13423         def addPath(self,Path):
13424             """
13425             Add Path to load python scripts from
13426
13427             Parameters:
13428                 Path a path to load python scripts from
13429             """
13430             if (sys.path.count(Path) < 1):
13431                 sys.path.append(Path)
13432                 pass
13433             pass
13434
13435         ## Load marker texture from the file
13436         #  @param Path a path to the texture file
13437         #  @return unique texture identifier
13438         #  @ingroup l1_geomBuilder_auxiliary
13439         @ManageTransactions("InsertOp")
13440         def LoadTexture(self, Path):
13441             """
13442             Load marker texture from the file
13443
13444             Parameters:
13445                 Path a path to the texture file
13446
13447             Returns:
13448                 unique texture identifier
13449             """
13450             # Example: see GEOM_TestAll.py
13451             ID = self.InsertOp.LoadTexture(Path)
13452             RaiseIfFailed("LoadTexture", self.InsertOp)
13453             return ID
13454
13455         ## Get internal name of the object based on its study entry
13456         #  @note This method does not provide an unique identifier of the geometry object.
13457         #  @note This is internal function of GEOM component, though it can be used outside it for
13458         #  appropriate reason (e.g. for identification of geometry object).
13459         #  @param obj geometry object
13460         #  @return unique object identifier
13461         #  @ingroup l1_geomBuilder_auxiliary
13462         def getObjectID(self, obj):
13463             """
13464             Get internal name of the object based on its study entry.
13465             Note: this method does not provide an unique identifier of the geometry object.
13466             It is an internal function of GEOM component, though it can be used outside GEOM for
13467             appropriate reason (e.g. for identification of geometry object).
13468
13469             Parameters:
13470                 obj geometry object
13471
13472             Returns:
13473                 unique object identifier
13474             """
13475             ID = ""
13476             entry = salome.ObjectToID(obj)
13477             if entry is not None:
13478                 lst = entry.split(":")
13479                 if len(lst) > 0:
13480                     ID = lst[-1] # -1 means last item in the list
13481                     return "GEOM_" + ID
13482             return ID
13483
13484
13485
13486         ## Add marker texture. @a Width and @a Height parameters
13487         #  specify width and height of the texture in pixels.
13488         #  If @a RowData is @c True, @a Texture parameter should represent texture data
13489         #  packed into the byte array. If @a RowData is @c False (default), @a Texture
13490         #  parameter should be unpacked string, in which '1' symbols represent opaque
13491         #  pixels and '0' represent transparent pixels of the texture bitmap.
13492         #
13493         #  @param Width texture width in pixels
13494         #  @param Height texture height in pixels
13495         #  @param Texture texture data
13496         #  @param RowData if @c True, @a Texture data are packed in the byte stream
13497         #  @return unique texture identifier
13498         #  @ingroup l1_geomBuilder_auxiliary
13499         @ManageTransactions("InsertOp")
13500         def AddTexture(self, Width, Height, Texture, RowData=False):
13501             """
13502             Add marker texture. Width and Height parameters
13503             specify width and height of the texture in pixels.
13504             If RowData is True, Texture parameter should represent texture data
13505             packed into the byte array. If RowData is False (default), Texture
13506             parameter should be unpacked string, in which '1' symbols represent opaque
13507             pixels and '0' represent transparent pixels of the texture bitmap.
13508
13509             Parameters:
13510                 Width texture width in pixels
13511                 Height texture height in pixels
13512                 Texture texture data
13513                 RowData if True, Texture data are packed in the byte stream
13514
13515             Returns:
13516                 return unique texture identifier
13517             """
13518             if not RowData: Texture = PackData(Texture)
13519             ID = self.InsertOp.AddTexture(Width, Height, Texture)
13520             RaiseIfFailed("AddTexture", self.InsertOp)
13521             return ID
13522
13523         ## Transfer not topological data from one GEOM object to another.
13524         #
13525         #  @param theObjectFrom the source object of non-topological data
13526         #  @param theObjectTo the destination object of non-topological data
13527         #  @param theFindMethod method to search sub-shapes of theObjectFrom
13528         #         in shape theObjectTo. Possible values are: GEOM.FSM_GetInPlace,
13529         #         GEOM.FSM_GetInPlaceByHistory and GEOM.FSM_GetInPlace_Old.
13530         #         Other values of GEOM.find_shape_method are not supported.
13531         #
13532         #  @return True in case of success; False otherwise.
13533         #
13534         #  @ingroup l1_geomBuilder_auxiliary
13535         #
13536         #  @ref swig_TransferData "Example"
13537         @ManageTransactions("InsertOp")
13538         def TransferData(self, theObjectFrom, theObjectTo,
13539                          theFindMethod=GEOM.FSM_GetInPlace):
13540             """
13541             Transfer not topological data from one GEOM object to another.
13542
13543             Parameters:
13544                 theObjectFrom the source object of non-topological data
13545                 theObjectTo the destination object of non-topological data
13546                 theFindMethod method to search sub-shapes of theObjectFrom
13547                               in shape theObjectTo. Possible values are:
13548                               GEOM.FSM_GetInPlace, GEOM.FSM_GetInPlaceByHistory
13549                               and GEOM.FSM_GetInPlace_Old. Other values of
13550                               GEOM.find_shape_method are not supported.
13551
13552             Returns:
13553                 True in case of success; False otherwise.
13554
13555             # Example: see GEOM_TestOthers.py
13556             """
13557             # Example: see GEOM_TestAll.py
13558             isOk = self.InsertOp.TransferData(theObjectFrom,
13559                                                theObjectTo, theFindMethod)
13560             RaiseIfFailed("TransferData", self.InsertOp)
13561             return isOk
13562
13563         ## Creates a new folder object. It is a container for any GEOM objects.
13564         #  @param Name name of the container
13565         #  @param Father parent object. If None,
13566         #         folder under 'Geometry' root object will be created.
13567         #  @return a new created folder
13568         #  @ingroup l1_publish_data
13569         def NewFolder(self, Name, Father=None):
13570             """
13571             Create a new folder object. It is an auxiliary container for any GEOM objects.
13572
13573             Parameters:
13574                 Name name of the container
13575                 Father parent object. If None,
13576                 folder under 'Geometry' root object will be created.
13577
13578             Returns:
13579                 a new created folder
13580             """
13581             if not Father: Father = self.father
13582             return self.CreateFolder(Name, Father)
13583
13584         ## Move object to the specified folder
13585         #  @param Object object to move
13586         #  @param Folder target folder
13587         #  @ingroup l1_publish_data
13588         def PutToFolder(self, Object, Folder):
13589             """
13590             Move object to the specified folder
13591
13592             Parameters:
13593                 Object object to move
13594                 Folder target folder
13595             """
13596             self.MoveToFolder(Object, Folder)
13597             pass
13598
13599         ## Move list of objects to the specified folder
13600         #  @param ListOfSO list of objects to move
13601         #  @param Folder target folder
13602         #  @ingroup l1_publish_data
13603         def PutListToFolder(self, ListOfSO, Folder):
13604             """
13605             Move list of objects to the specified folder
13606
13607             Parameters:
13608                 ListOfSO list of objects to move
13609                 Folder target folder
13610             """
13611             self.MoveListToFolder(ListOfSO, Folder)
13612             pass
13613
13614         ## @addtogroup l2_field
13615         ## @{
13616
13617         ## Creates a field
13618         #  @param shape the shape the field lies on
13619         #  @param name the field name
13620         #  @param type type of field data: 0 - bool, 1 - int, 2 - double, 3 - string
13621         #  @param dimension dimension of the shape the field lies on
13622         #         0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13623         #  @param componentNames names of components
13624         #  @return a created field
13625         @ManageTransactions("FieldOp")
13626         def CreateField(self, shape, name, type, dimension, componentNames):
13627             """
13628             Creates a field
13629
13630             Parameters:
13631                 shape the shape the field lies on
13632                 name  the field name
13633                 type  type of field data
13634                 dimension dimension of the shape the field lies on
13635                           0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13636                 componentNames names of components
13637
13638             Returns:
13639                 a created field
13640             """
13641             if isinstance( type, int ):
13642                 if type < 0 or type > 3:
13643                     raise RuntimeError, "CreateField : Error: data type must be within [0-3] range"
13644                 type = [GEOM.FDT_Bool,GEOM.FDT_Int,GEOM.FDT_Double,GEOM.FDT_String][type]
13645
13646             f = self.FieldOp.CreateField( shape, name, type, dimension, componentNames)
13647             RaiseIfFailed("CreateField", self.FieldOp)
13648             global geom
13649             geom._autoPublish( f, "", name)
13650             return f
13651
13652         ## Removes a field from the GEOM component
13653         #  @param field the field to remove
13654         def RemoveField(self, field):
13655             "Removes a field from the GEOM component"
13656             global geom
13657             if isinstance( field, GEOM._objref_GEOM_Field ):
13658                 geom.RemoveObject( field )
13659             elif isinstance( field, geomField ):
13660                 geom.RemoveObject( field.field )
13661             else:
13662                 raise RuntimeError, "RemoveField() : the object is not a field"
13663             return
13664
13665         ## Returns number of fields on a shape
13666         @ManageTransactions("FieldOp")
13667         def CountFields(self, shape):
13668             "Returns number of fields on a shape"
13669             nb = self.FieldOp.CountFields( shape )
13670             RaiseIfFailed("CountFields", self.FieldOp)
13671             return nb
13672
13673         ## Returns all fields on a shape
13674         @ManageTransactions("FieldOp")
13675         def GetFields(self, shape):
13676             "Returns all fields on a shape"
13677             ff = self.FieldOp.GetFields( shape )
13678             RaiseIfFailed("GetFields", self.FieldOp)
13679             return ff
13680
13681         ## Returns a field on a shape by its name
13682         @ManageTransactions("FieldOp")
13683         def GetField(self, shape, name):
13684             "Returns a field on a shape by its name"
13685             f = self.FieldOp.GetField( shape, name )
13686             RaiseIfFailed("GetField", self.FieldOp)
13687             return f
13688
13689         # end of l2_field
13690         ## @}
13691
13692
13693 import omniORB
13694 # Register the new proxy for GEOM_Gen
13695 omniORB.registerObjref(GEOM._objref_GEOM_Gen._NP_RepositoryId, geomBuilder)
13696
13697
13698 ## Field on Geometry
13699 #  @ingroup l2_field
13700 class geomField( GEOM._objref_GEOM_Field ):
13701
13702     def __init__(self):
13703         GEOM._objref_GEOM_Field.__init__(self)
13704         self.field = GEOM._objref_GEOM_Field
13705         return
13706
13707     ## Returns the shape the field lies on
13708     def getShape(self):
13709         "Returns the shape the field lies on"
13710         return self.field.GetShape(self)
13711
13712     ## Returns the field name
13713     def getName(self):
13714         "Returns the field name"
13715         return self.field.GetName(self)
13716
13717     ## Returns type of field data as integer [0-3]
13718     def getType(self):
13719         "Returns type of field data"
13720         return self.field.GetDataType(self)._v
13721
13722     ## Returns type of field data:
13723     #  one of GEOM.FDT_Bool, GEOM.FDT_Int, GEOM.FDT_Double, GEOM.FDT_String
13724     def getTypeEnum(self):
13725         "Returns type of field data"
13726         return self.field.GetDataType(self)
13727
13728     ## Returns dimension of the shape the field lies on:
13729     #  0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13730     def getDimension(self):
13731         """Returns dimension of the shape the field lies on:
13732         0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape"""
13733         return self.field.GetDimension(self)
13734
13735     ## Returns names of components
13736     def getComponents(self):
13737         "Returns names of components"
13738         return self.field.GetComponents(self)
13739
13740     ## Adds a time step to the field
13741     #  @param step the time step number further used as the step identifier
13742     #  @param stamp the time step time
13743     #  @param values the values of the time step
13744     def addStep(self, step, stamp, values):
13745         "Adds a time step to the field"
13746         stp = self.field.AddStep( self, step, stamp )
13747         if not stp:
13748             raise RuntimeError, \
13749                   "Field.addStep() : Error: step %s already exists in this field"%step
13750         global geom
13751         geom._autoPublish( stp, "", "Step %s, %s"%(step,stamp))
13752         self.setValues( step, values )
13753         return stp
13754
13755     ## Remove a time step from the field
13756     def removeStep(self,step):
13757         "Remove a time step from the field"
13758         stepSO = None
13759         try:
13760             stepObj = self.field.GetStep( self, step )
13761             if stepObj:
13762                 stepSO = geom.myStudy.FindObjectID( stepObj.GetStudyEntry() )
13763         except:
13764             #import traceback
13765             #traceback.print_exc()
13766             pass
13767         self.field.RemoveStep( self, step )
13768         if stepSO:
13769             geom.myBuilder.RemoveObjectWithChildren( stepSO )
13770         return
13771
13772     ## Returns number of time steps in the field
13773     def countSteps(self):
13774         "Returns number of time steps in the field"
13775         return self.field.CountSteps(self)
13776
13777     ## Returns a list of time step IDs in the field
13778     def getSteps(self):
13779         "Returns a list of time step IDs in the field"
13780         return self.field.GetSteps(self)
13781
13782     ## Returns a time step by its ID
13783     def getStep(self,step):
13784         "Returns a time step by its ID"
13785         stp = self.field.GetStep(self, step)
13786         if not stp:
13787             raise RuntimeError, "Step %s is missing from this field"%step
13788         return stp
13789
13790     ## Returns the time of the field step
13791     def getStamp(self,step):
13792         "Returns the time of the field step"
13793         return self.getStep(step).GetStamp()
13794
13795     ## Changes the time of the field step
13796     def setStamp(self, step, stamp):
13797         "Changes the time of the field step"
13798         return self.getStep(step).SetStamp(stamp)
13799
13800     ## Returns values of the field step
13801     def getValues(self, step):
13802         "Returns values of the field step"
13803         return self.getStep(step).GetValues()
13804
13805     ## Changes values of the field step
13806     def setValues(self, step, values):
13807         "Changes values of the field step"
13808         stp = self.getStep(step)
13809         errBeg = "Field.setValues(values) : Error: "
13810         try:
13811             ok = stp.SetValues( values )
13812         except Exception, e:
13813             excStr = str(e)
13814             if excStr.find("WrongPythonType") > 0:
13815                 raise RuntimeError, errBeg +\
13816                       "wrong type of values, %s values are expected"%str(self.getTypeEnum())[4:]
13817             raise RuntimeError, errBeg + str(e)
13818         if not ok:
13819             nbOK = self.field.GetArraySize(self)
13820             nbKO = len(values)
13821             if nbOK != nbKO:
13822                 raise RuntimeError, errBeg + "len(values) must be %s but not %s"%(nbOK,nbKO)
13823             else:
13824                 raise RuntimeError, errBeg + "failed"
13825         return
13826
13827     pass # end of class geomField
13828
13829 # Register the new proxy for GEOM_Field
13830 omniORB.registerObjref(GEOM._objref_GEOM_Field._NP_RepositoryId, geomField)
13831
13832
13833 ## Create a new geomBuilder instance.The geomBuilder class provides the Python
13834 #  interface to GEOM operations.
13835 #
13836 #  Typical use is:
13837 #  \code
13838 #    import salome
13839 #    salome.salome_init()
13840 #    from salome.geom import geomBuilder
13841 #    geompy = geomBuilder.New(salome.myStudy)
13842 #  \endcode
13843 #  @param  study     SALOME study, generally obtained by salome.myStudy.
13844 #  @param  instance  CORBA proxy of GEOM Engine. If None, the default Engine is used.
13845 #  @return geomBuilder instance
13846 def New( study, instance=None):
13847     """
13848     Create a new geomBuilder instance.The geomBuilder class provides the Python
13849     interface to GEOM operations.
13850
13851     Typical use is:
13852         import salome
13853         salome.salome_init()
13854         from salome.geom import geomBuilder
13855         geompy = geomBuilder.New(salome.myStudy)
13856
13857     Parameters:
13858         study     SALOME study, generally obtained by salome.myStudy.
13859         instance  CORBA proxy of GEOM Engine. If None, the default Engine is used.
13860     Returns:
13861         geomBuilder instance
13862     """
13863     #print "New geomBuilder ", study, instance
13864     global engine
13865     global geom
13866     global doLcc
13867     engine = instance
13868     if engine is None:
13869       doLcc = True
13870     geom = geomBuilder()
13871     assert isinstance(geom,geomBuilder), "Geom engine class is %s but should be geomBuilder.geomBuilder. Import geomBuilder before creating the instance."%geom.__class__
13872     geom.init_geom(study)
13873     return geom
13874
13875
13876 # Register methods from the plug-ins in the geomBuilder class 
13877 plugins_var = os.environ.get( "GEOM_PluginsList" )
13878
13879 plugins = None
13880 if plugins_var is not None:
13881     plugins = plugins_var.split( ":" )
13882     plugins=filter(lambda x: len(x)>0, plugins)
13883 if plugins is not None:
13884     for pluginName in plugins:
13885         pluginBuilderName = pluginName + "Builder"
13886         try:
13887             exec( "from salome.%s.%s import *" % (pluginName, pluginBuilderName))
13888         except Exception, e:
13889             from salome_utils import verbose
13890             print "Exception while loading %s: %s" % ( pluginBuilderName, e )
13891             continue
13892         exec( "from salome.%s import %s" % (pluginName, pluginBuilderName))
13893         plugin = eval( pluginBuilderName )
13894         
13895         # add methods from plugin module to the geomBuilder class
13896         for k in dir( plugin ):
13897             if k[0] == '_': continue
13898             method = getattr( plugin, k )
13899             if type( method ).__name__ == 'function':
13900                 if not hasattr( geomBuilder, k ):
13901                     setattr( geomBuilder, k, method )
13902                 pass
13903             pass
13904         del pluginName
13905         pass
13906     pass