Salome HOME
0022762: [EDF] Fast detection of face/face face/solid solid/solid interference
[modules/geom.git] / src / GEOM_SWIG / geomBuilder.py
1 #  -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2014  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, "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, ("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 Operation.IsDone() == 0 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         #  @ingroup l1_geomBuilder_auxiliary
604         kind = GEOM.GEOM_IKindOfShape
605
606         def __new__(cls):
607             global engine
608             global geom
609             global doLcc
610             global created
611             #print "==== __new__ ", engine, geom, doLcc, created
612             if geom is None:
613                 # geom engine is either retrieved from engine, or created
614                 geom = engine
615                 # Following test avoids a recursive loop
616                 if doLcc:
617                     if geom is not None:
618                         # geom engine not created: existing engine found
619                         doLcc = False
620                     if doLcc and not created:
621                         doLcc = False
622                         # FindOrLoadComponent called:
623                         # 1. CORBA resolution of server
624                         # 2. the __new__ method is called again
625                         #print "==== FindOrLoadComponent ", engine, geom, doLcc, created
626                         geom = lcc.FindOrLoadComponent( "FactoryServer", "GEOM" )
627                         #print "====1 ",geom
628                 else:
629                     # FindOrLoadComponent not called
630                     if geom is None:
631                         # geomBuilder instance is created from lcc.FindOrLoadComponent
632                         #print "==== super ", engine, geom, doLcc, created
633                         geom = super(geomBuilder,cls).__new__(cls)
634                         #print "====2 ",geom
635                     else:
636                         # geom engine not created: existing engine found
637                         #print "==== existing ", engine, geom, doLcc, created
638                         pass
639                 #print "return geom 1 ", geom
640                 return geom
641
642             #print "return geom 2 ", geom
643             return geom
644
645         def __init__(self):
646             global created
647             #print "-------- geomBuilder __init__ --- ", created, self
648             if not created:
649               created = True
650               GEOM._objref_GEOM_Gen.__init__(self)
651               self.myMaxNbSubShapesAllowed = 0 # auto-publishing is disabled by default
652               self.myBuilder = None
653               self.myStudyId = 0
654               self.father    = None
655
656               self.BasicOp  = None
657               self.CurvesOp = None
658               self.PrimOp   = None
659               self.ShapesOp = None
660               self.HealOp   = None
661               self.InsertOp = None
662               self.BoolOp   = None
663               self.TrsfOp   = None
664               self.LocalOp  = None
665               self.MeasuOp  = None
666               self.BlocksOp = None
667               self.GroupOp  = None
668               self.FieldOp  = None
669             pass
670
671         ## Process object publication in the study, as follows:
672         #  - if @a theName is specified (not None), the object is published in the study
673         #    with this name, not taking into account "auto-publishing" option;
674         #  - if @a theName is NOT specified, the object is published in the study
675         #    (using default name, which can be customized using @a theDefaultName parameter)
676         #    only if auto-publishing is switched on.
677         #
678         #  @param theObj  object, a subject for publishing
679         #  @param theName object name for study
680         #  @param theDefaultName default name for the auto-publishing
681         #
682         #  @sa addToStudyAuto()
683         def _autoPublish(self, theObj, theName, theDefaultName="noname"):
684             # ---
685             def _item_name(_names, _defname, _idx=-1):
686                 if not _names: _names = _defname
687                 if type(_names) in [types.ListType, types.TupleType]:
688                     if _idx >= 0:
689                         if _idx >= len(_names) or not _names[_idx]:
690                             if type(_defname) not in [types.ListType, types.TupleType]:
691                                 _name = "%s_%d"%(_defname, _idx+1)
692                             elif len(_defname) > 0 and _idx >= 0 and _idx < len(_defname):
693                                 _name = _defname[_idx]
694                             else:
695                                 _name = "%noname_%d"%(dn, _idx+1)
696                             pass
697                         else:
698                             _name = _names[_idx]
699                         pass
700                     else:
701                         # must be wrong  usage
702                         _name = _names[0]
703                     pass
704                 else:
705                     if _idx >= 0:
706                         _name = "%s_%d"%(_names, _idx+1)
707                     else:
708                         _name = _names
709                     pass
710                 return _name
711             # ---
712             def _publish( _name, _obj ):
713                 fatherObj = None
714                 if isinstance( _obj, GEOM._objref_GEOM_Field ):
715                     fatherObj = _obj.GetShape()
716                 elif isinstance( _obj, GEOM._objref_GEOM_FieldStep ):
717                     fatherObj = _obj.GetField()
718                 elif not _obj.IsMainShape():
719                     fatherObj = _obj.GetMainShape()
720                     pass
721                 if fatherObj and fatherObj.GetStudyEntry():
722                     self.addToStudyInFather(fatherObj, _obj, _name)
723                 else:
724                     self.addToStudy(_obj, _name)
725                     pass
726                 return
727             # ---
728             if not theObj:
729                 return # null object
730             if not theName and not self.myMaxNbSubShapesAllowed:
731                 return # nothing to do: auto-publishing is disabled
732             if not theName and not theDefaultName:
733                 return # neither theName nor theDefaultName is given
734             import types
735             if type(theObj) in [types.ListType, types.TupleType]:
736                 # list of objects is being published
737                 idx = 0
738                 for obj in theObj:
739                     if not obj: continue # bad object
740                     name = _item_name(theName, theDefaultName, idx)
741                     _publish( name, obj )
742                     idx = idx+1
743                     if not theName and idx == self.myMaxNbSubShapesAllowed: break
744                     pass
745                 pass
746             else:
747                 # single object is published
748                 name = _item_name(theName, theDefaultName)
749                 _publish( name, theObj )
750             pass
751
752         ## @addtogroup l1_geomBuilder_auxiliary
753         ## @{
754         def init_geom(self,theStudy):
755             self.myStudy = theStudy
756             self.myStudyId = self.myStudy._get_StudyId()
757             self.myBuilder = self.myStudy.NewBuilder()
758             self.father = self.myStudy.FindComponent("GEOM")
759             notebook.myStudy = theStudy
760             if self.father is None:
761                 self.father = self.myBuilder.NewComponent("GEOM")
762                 A1 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributeName")
763                 FName = A1._narrow(SALOMEDS.AttributeName)
764                 FName.SetValue("Geometry")
765                 A2 = self.myBuilder.FindOrCreateAttribute(self.father, "AttributePixMap")
766                 aPixmap = A2._narrow(SALOMEDS.AttributePixMap)
767                 aPixmap.SetPixMap("ICON_OBJBROWSER_Geometry")
768                 self.myBuilder.DefineComponentInstance(self.father,self)
769                 pass
770             self.BasicOp  = self.GetIBasicOperations    (self.myStudyId)
771             self.CurvesOp = self.GetICurvesOperations   (self.myStudyId)
772             self.PrimOp   = self.GetI3DPrimOperations   (self.myStudyId)
773             self.ShapesOp = self.GetIShapesOperations   (self.myStudyId)
774             self.HealOp   = self.GetIHealingOperations  (self.myStudyId)
775             self.InsertOp = self.GetIInsertOperations   (self.myStudyId)
776             self.BoolOp   = self.GetIBooleanOperations  (self.myStudyId)
777             self.TrsfOp   = self.GetITransformOperations(self.myStudyId)
778             self.LocalOp  = self.GetILocalOperations    (self.myStudyId)
779             self.MeasuOp  = self.GetIMeasureOperations  (self.myStudyId)
780             self.BlocksOp = self.GetIBlocksOperations   (self.myStudyId)
781             self.GroupOp  = self.GetIGroupOperations    (self.myStudyId)
782             self.FieldOp  = self.GetIFieldOperations    (self.myStudyId)
783
784             # set GEOM as root in the use case tree
785             self.myUseCaseBuilder = self.myStudy.GetUseCaseBuilder()
786             self.myUseCaseBuilder.SetRootCurrent()
787             self.myUseCaseBuilder.Append(self.father)
788             pass
789
790         def GetPluginOperations(self, studyID, libraryName):
791             op = GEOM._objref_GEOM_Gen.GetPluginOperations(self, studyID, libraryName)
792             return op
793
794         ## Enable / disable results auto-publishing
795         #
796         #  The automatic publishing is managed in the following way:
797         #  - if @a maxNbSubShapes = 0, automatic publishing is disabled.
798         #  - if @a maxNbSubShapes = -1 (default), automatic publishing is enabled and
799         #  maximum number of sub-shapes allowed for publishing is unlimited; any negative
800         #  value passed as parameter has the same effect.
801         #  - if @a maxNbSubShapes is any positive value, automatic publishing is enabled and
802         #  maximum number of sub-shapes allowed for publishing is set to specified value.
803         #
804         #  @param maxNbSubShapes maximum number of sub-shapes allowed for publishing.
805         #  @ingroup l1_publish_data
806         def addToStudyAuto(self, maxNbSubShapes=-1):
807             """
808             Enable / disable results auto-publishing
809
810             The automatic publishing is managed in the following way:
811             - if @a maxNbSubShapes = 0, automatic publishing is disabled;
812             - if @a maxNbSubShapes = -1 (default), automatic publishing is enabled and
813             maximum number of sub-shapes allowed for publishing is unlimited; any negative
814             value passed as parameter has the same effect.
815             - if @a maxNbSubShapes is any positive value, automatic publishing is enabled and
816             maximum number of sub-shapes allowed for publishing is set to this value.
817
818             Parameters:
819                 maxNbSubShapes maximum number of sub-shapes allowed for publishing.
820
821             Example of usage:
822                 geompy.addToStudyAuto()   # enable auto-publishing
823                 geompy.MakeBoxDXDYDZ(100) # box is created and published with default name
824                 geompy.addToStudyAuto(0)  # disable auto-publishing
825             """
826             self.myMaxNbSubShapesAllowed = max(-1, maxNbSubShapes)
827             pass
828
829         ## Dump component to the Python script
830         #  This method overrides IDL function to allow default values for the parameters.
831         def DumpPython(self, theStudy, theIsPublished=True, theIsMultiFile=True):
832             """
833             Dump component to the Python script
834             This method overrides IDL function to allow default values for the parameters.
835             """
836             return GEOM._objref_GEOM_Gen.DumpPython(self, theStudy, theIsPublished, theIsMultiFile)
837
838         ## Get name for sub-shape aSubObj of shape aMainObj
839         #
840         # @ref swig_SubShapeName "Example"
841         @ManageTransactions("ShapesOp")
842         def SubShapeName(self,aSubObj, aMainObj):
843             """
844             Get name for sub-shape aSubObj of shape aMainObj
845             """
846             # Example: see GEOM_TestAll.py
847
848             #aSubId  = orb.object_to_string(aSubObj)
849             #aMainId = orb.object_to_string(aMainObj)
850             #index = gg.getIndexTopology(aSubId, aMainId)
851             #name = gg.getShapeTypeString(aSubId) + "_%d"%(index)
852             index = self.ShapesOp.GetTopologyIndex(aMainObj, aSubObj)
853             name = self.ShapesOp.GetShapeTypeString(aSubObj) + "_%d"%(index)
854             return name
855
856         ## Publish in study aShape with name aName
857         #
858         #  \param aShape the shape to be published
859         #  \param aName  the name for the shape
860         #  \param doRestoreSubShapes if True, finds and publishes also
861         #         sub-shapes of <VAR>aShape</VAR>, corresponding to its arguments
862         #         and published sub-shapes of arguments
863         #  \param theArgs,theFindMethod,theInheritFirstArg see RestoreSubShapes() for
864         #                                                  these arguments description
865         #  \return study entry of the published shape in form of string
866         #
867         #  @ingroup l1_publish_data
868         #  @ref swig_all_addtostudy "Example"
869         def addToStudy(self, aShape, aName, doRestoreSubShapes=False,
870                        theArgs=[], theFindMethod=GEOM.FSM_GetInPlace, theInheritFirstArg=False):
871             """
872             Publish in study aShape with name aName
873
874             Parameters:
875                 aShape the shape to be published
876                 aName  the name for the shape
877                 doRestoreSubShapes if True, finds and publishes also
878                                    sub-shapes of aShape, corresponding to its arguments
879                                    and published sub-shapes of arguments
880                 theArgs,theFindMethod,theInheritFirstArg see geompy.RestoreSubShapes() for
881                                                          these arguments description
882
883             Returns:
884                 study entry of the published shape in form of string
885
886             Example of usage:
887                 id_block1 = geompy.addToStudy(Block1, "Block 1")
888             """
889             # Example: see GEOM_TestAll.py
890             try:
891                 aSObject = self.AddInStudy(self.myStudy, aShape, aName, None)
892                 if aSObject and aName: aSObject.SetAttrString("AttributeName", aName)
893                 if doRestoreSubShapes:
894                     self.RestoreSubShapesSO(self.myStudy, aSObject, theArgs,
895                                             theFindMethod, theInheritFirstArg, True )
896             except:
897                 print "addToStudy() failed"
898                 return ""
899             return aShape.GetStudyEntry()
900
901         ## Publish in study aShape with name aName as sub-object of previously published aFather
902         #  \param aFather previously published object
903         #  \param aShape the shape to be published as sub-object of <VAR>aFather</VAR>
904         #  \param aName  the name for the shape
905         #
906         #  \return study entry of the published shape in form of string
907         #
908         #  @ingroup l1_publish_data
909         #  @ref swig_all_addtostudyInFather "Example"
910         def addToStudyInFather(self, aFather, aShape, aName):
911             """
912             Publish in study aShape with name aName as sub-object of previously published aFather
913
914             Parameters:
915                 aFather previously published object
916                 aShape the shape to be published as sub-object of aFather
917                 aName  the name for the shape
918
919             Returns:
920                 study entry of the published shape in form of string
921             """
922             # Example: see GEOM_TestAll.py
923             try:
924                 aSObject = self.AddInStudy(self.myStudy, aShape, aName, aFather)
925                 if aSObject and aName: aSObject.SetAttrString("AttributeName", aName)
926             except:
927                 print "addToStudyInFather() failed"
928                 return ""
929             return aShape.GetStudyEntry()
930
931         ## Unpublish object in study
932         #
933         #  \param obj the object to be unpublished
934         def hideInStudy(self, obj):
935             """
936             Unpublish object in study
937
938             Parameters:
939                 obj the object to be unpublished
940             """
941             ior = salome.orb.object_to_string(obj)
942             aSObject = self.myStudy.FindObjectIOR(ior)
943             if aSObject is not None:
944                 genericAttribute = self.myBuilder.FindOrCreateAttribute(aSObject, "AttributeDrawable")
945                 drwAttribute = genericAttribute._narrow(SALOMEDS.AttributeDrawable)
946                 drwAttribute.SetDrawable(False)
947                 # hide references if any
948                 vso = self.myStudy.FindDependances(aSObject);
949                 for refObj in vso :
950                     genericAttribute = self.myBuilder.FindOrCreateAttribute(refObj, "AttributeDrawable")
951                     drwAttribute = genericAttribute._narrow(SALOMEDS.AttributeDrawable)
952                     drwAttribute.SetDrawable(False)
953                     pass
954                 pass
955
956         # end of l1_geomBuilder_auxiliary
957         ## @}
958
959         ## @addtogroup l3_restore_ss
960         ## @{
961
962         ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
963         #  To be used from python scripts out of addToStudy() (non-default usage)
964         #  \param theObject published GEOM.GEOM_Object, arguments of which will be published
965         #  \param theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
966         #                   If this list is empty, all operation arguments will be published
967         #  \param theFindMethod method to search sub-shapes, corresponding to arguments and
968         #                       their sub-shapes. Value from enumeration GEOM.find_shape_method.
969         #  \param theInheritFirstArg set properties of the first argument for <VAR>theObject</VAR>.
970         #                            Do not publish sub-shapes in place of arguments, but only
971         #                            in place of sub-shapes of the first argument,
972         #                            because the whole shape corresponds to the first argument.
973         #                            Mainly to be used after transformations, but it also can be
974         #                            usefull after partition with one object shape, and some other
975         #                            operations, where only the first argument has to be considered.
976         #                            If theObject has only one argument shape, this flag is automatically
977         #                            considered as True, not regarding really passed value.
978         #  \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
979         #                      and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
980         #  \return list of published sub-shapes
981         #
982         #  @ref tui_restore_prs_params "Example"
983         def RestoreSubShapes (self, theObject, theArgs=[], theFindMethod=GEOM.FSM_GetInPlace,
984                               theInheritFirstArg=False, theAddPrefix=True):
985             """
986             Publish sub-shapes, standing for arguments and sub-shapes of arguments
987             To be used from python scripts out of geompy.addToStudy (non-default usage)
988
989             Parameters:
990                 theObject published GEOM.GEOM_Object, arguments of which will be published
991                 theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
992                           If this list is empty, all operation arguments will be published
993                 theFindMethod method to search sub-shapes, corresponding to arguments and
994                               their sub-shapes. Value from enumeration GEOM.find_shape_method.
995                 theInheritFirstArg set properties of the first argument for theObject.
996                                    Do not publish sub-shapes in place of arguments, but only
997                                    in place of sub-shapes of the first argument,
998                                    because the whole shape corresponds to the first argument.
999                                    Mainly to be used after transformations, but it also can be
1000                                    usefull after partition with one object shape, and some other
1001                                    operations, where only the first argument has to be considered.
1002                                    If theObject has only one argument shape, this flag is automatically
1003                                    considered as True, not regarding really passed value.
1004                 theAddPrefix add prefix "from_" to names of restored sub-shapes,
1005                              and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
1006             Returns:
1007                 list of published sub-shapes
1008             """
1009             # Example: see GEOM_TestAll.py
1010             return self.RestoreSubShapesO(self.myStudy, theObject, theArgs,
1011                                           theFindMethod, theInheritFirstArg, theAddPrefix)
1012
1013         ## Publish sub-shapes, standing for arguments and sub-shapes of arguments
1014         #  To be used from python scripts out of addToStudy() (non-default usage)
1015         #  \param theObject published GEOM.GEOM_Object, arguments of which will be published
1016         #  \param theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
1017         #                   If this list is empty, all operation arguments will be published
1018         #  \param theFindMethod method to search sub-shapes, corresponding to arguments and
1019         #                       their sub-shapes. Value from enumeration GEOM::find_shape_method.
1020         #  \param theInheritFirstArg set properties of the first argument for <VAR>theObject</VAR>.
1021         #                            Do not publish sub-shapes in place of arguments, but only
1022         #                            in place of sub-shapes of the first argument,
1023         #                            because the whole shape corresponds to the first argument.
1024         #                            Mainly to be used after transformations, but it also can be
1025         #                            usefull after partition with one object shape, and some other
1026         #                            operations, where only the first argument has to be considered.
1027         #                            If theObject has only one argument shape, this flag is automatically
1028         #                            considered as True, not regarding really passed value.
1029         #  \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
1030         #                      and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
1031         #  \return list of published sub-shapes
1032         #
1033         #  @ref tui_restore_prs_params "Example"
1034         def RestoreGivenSubShapes (self, theObject, theArgs=[], theFindMethod=GEOM.FSM_GetInPlace,
1035                                    theInheritFirstArg=False, theAddPrefix=True):
1036             """
1037             Publish sub-shapes, standing for arguments and sub-shapes of arguments
1038             To be used from python scripts out of geompy.addToStudy() (non-default usage)
1039
1040             Parameters:
1041                 theObject published GEOM.GEOM_Object, arguments of which will be published
1042                 theArgs   list of GEOM.GEOM_Object, operation arguments to be published.
1043                           If this list is empty, all operation arguments will be published
1044                 theFindMethod method to search sub-shapes, corresponding to arguments and
1045                               their sub-shapes. Value from enumeration GEOM::find_shape_method.
1046                 theInheritFirstArg set properties of the first argument for theObject.
1047                                    Do not publish sub-shapes in place of arguments, but only
1048                                    in place of sub-shapes of the first argument,
1049                                    because the whole shape corresponds to the first argument.
1050                                    Mainly to be used after transformations, but it also can be
1051                                    usefull after partition with one object shape, and some other
1052                                    operations, where only the first argument has to be considered.
1053                                    If theObject has only one argument shape, this flag is automatically
1054                                    considered as True, not regarding really passed value.
1055                 theAddPrefix add prefix "from_" to names of restored sub-shapes,
1056                              and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
1057
1058             Returns:
1059                 list of published sub-shapes
1060             """
1061             # Example: see GEOM_TestAll.py
1062             return self.RestoreGivenSubShapesO(self.myStudy, theObject, theArgs,
1063                                                theFindMethod, theInheritFirstArg, theAddPrefix)
1064
1065         # end of l3_restore_ss
1066         ## @}
1067
1068         ## @addtogroup l3_basic_go
1069         ## @{
1070
1071         ## Create point by three coordinates.
1072         #  @param theX The X coordinate of the point.
1073         #  @param theY The Y coordinate of the point.
1074         #  @param theZ The Z coordinate of the point.
1075         #  @param theName Object name; when specified, this parameter is used
1076         #         for result publication in the study. Otherwise, if automatic
1077         #         publication is switched on, default value is used for result name.
1078         #
1079         #  @return New GEOM.GEOM_Object, containing the created point.
1080         #
1081         #  @ref tui_creation_point "Example"
1082         @ManageTransactions("BasicOp")
1083         def MakeVertex(self, theX, theY, theZ, theName=None):
1084             """
1085             Create point by three coordinates.
1086
1087             Parameters:
1088                 theX The X coordinate of the point.
1089                 theY The Y coordinate of the point.
1090                 theZ The Z coordinate of the point.
1091                 theName Object name; when specified, this parameter is used
1092                         for result publication in the study. Otherwise, if automatic
1093                         publication is switched on, default value is used for result name.
1094
1095             Returns:
1096                 New GEOM.GEOM_Object, containing the created point.
1097             """
1098             # Example: see GEOM_TestAll.py
1099             theX,theY,theZ,Parameters = ParseParameters(theX, theY, theZ)
1100             anObj = self.BasicOp.MakePointXYZ(theX, theY, theZ)
1101             RaiseIfFailed("MakePointXYZ", self.BasicOp)
1102             anObj.SetParameters(Parameters)
1103             self._autoPublish(anObj, theName, "vertex")
1104             return anObj
1105
1106         ## Create a point, distant from the referenced point
1107         #  on the given distances along the coordinate axes.
1108         #  @param theReference The referenced point.
1109         #  @param theX Displacement from the referenced point along OX axis.
1110         #  @param theY Displacement from the referenced point along OY axis.
1111         #  @param theZ Displacement from the referenced point along OZ axis.
1112         #  @param theName Object name; when specified, this parameter is used
1113         #         for result publication in the study. Otherwise, if automatic
1114         #         publication is switched on, default value is used for result name.
1115         #
1116         #  @return New GEOM.GEOM_Object, containing the created point.
1117         #
1118         #  @ref tui_creation_point "Example"
1119         @ManageTransactions("BasicOp")
1120         def MakeVertexWithRef(self, theReference, theX, theY, theZ, theName=None):
1121             """
1122             Create a point, distant from the referenced point
1123             on the given distances along the coordinate axes.
1124
1125             Parameters:
1126                 theReference The referenced point.
1127                 theX Displacement from the referenced point along OX axis.
1128                 theY Displacement from the referenced point along OY axis.
1129                 theZ Displacement from the referenced point along OZ axis.
1130                 theName Object name; when specified, this parameter is used
1131                         for result publication in the study. Otherwise, if automatic
1132                         publication is switched on, default value is used for result name.
1133
1134             Returns:
1135                 New GEOM.GEOM_Object, containing the created point.
1136             """
1137             # Example: see GEOM_TestAll.py
1138             theX,theY,theZ,Parameters = ParseParameters(theX, theY, theZ)
1139             anObj = self.BasicOp.MakePointWithReference(theReference, theX, theY, theZ)
1140             RaiseIfFailed("MakePointWithReference", self.BasicOp)
1141             anObj.SetParameters(Parameters)
1142             self._autoPublish(anObj, theName, "vertex")
1143             return anObj
1144
1145         ## Create a point, corresponding to the given parameter on the given curve.
1146         #  @param theRefCurve The referenced curve.
1147         #  @param theParameter Value of parameter on the referenced curve.
1148         #  @param theName Object name; when specified, this parameter is used
1149         #         for result publication in the study. Otherwise, if automatic
1150         #         publication is switched on, default value is used for result name.
1151         #
1152         #  @return New GEOM.GEOM_Object, containing the created point.
1153         #
1154         #  @ref tui_creation_point "Example"
1155         @ManageTransactions("BasicOp")
1156         def MakeVertexOnCurve(self, theRefCurve, theParameter, theName=None):
1157             """
1158             Create a point, corresponding to the given parameter on the given curve.
1159
1160             Parameters:
1161                 theRefCurve The referenced curve.
1162                 theParameter Value of parameter on the referenced curve.
1163                 theName Object name; when specified, this parameter is used
1164                         for result publication in the study. Otherwise, if automatic
1165                         publication is switched on, default value is used for result name.
1166
1167             Returns:
1168                 New GEOM.GEOM_Object, containing the created point.
1169
1170             Example of usage:
1171                 p_on_arc = geompy.MakeVertexOnCurve(Arc, 0.25)
1172             """
1173             # Example: see GEOM_TestAll.py
1174             theParameter, Parameters = ParseParameters(theParameter)
1175             anObj = self.BasicOp.MakePointOnCurve(theRefCurve, theParameter)
1176             RaiseIfFailed("MakePointOnCurve", self.BasicOp)
1177             anObj.SetParameters(Parameters)
1178             self._autoPublish(anObj, theName, "vertex")
1179             return anObj
1180
1181         ## Create a point by projection give coordinates on the given curve
1182         #  @param theRefCurve The referenced curve.
1183         #  @param theX X-coordinate in 3D space
1184         #  @param theY Y-coordinate in 3D space
1185         #  @param theZ Z-coordinate in 3D space
1186         #  @param theName Object name; when specified, this parameter is used
1187         #         for result publication in the study. Otherwise, if automatic
1188         #         publication is switched on, default value is used for result name.
1189         #
1190         #  @return New GEOM.GEOM_Object, containing the created point.
1191         #
1192         #  @ref tui_creation_point "Example"
1193         @ManageTransactions("BasicOp")
1194         def MakeVertexOnCurveByCoord(self, theRefCurve, theX, theY, theZ, theName=None):
1195             """
1196             Create a point by projection give coordinates on the given curve
1197
1198             Parameters:
1199                 theRefCurve The referenced curve.
1200                 theX X-coordinate in 3D space
1201                 theY Y-coordinate in 3D space
1202                 theZ Z-coordinate in 3D space
1203                 theName Object name; when specified, this parameter is used
1204                         for result publication in the study. Otherwise, if automatic
1205                         publication is switched on, default value is used for result name.
1206
1207             Returns:
1208                 New GEOM.GEOM_Object, containing the created point.
1209
1210             Example of usage:
1211                 p_on_arc3 = geompy.MakeVertexOnCurveByCoord(Arc, 100, -10, 10)
1212             """
1213             # Example: see GEOM_TestAll.py
1214             theX, theY, theZ, Parameters = ParseParameters(theX, theY, theZ)
1215             anObj = self.BasicOp.MakePointOnCurveByCoord(theRefCurve, theX, theY, theZ)
1216             RaiseIfFailed("MakeVertexOnCurveByCoord", self.BasicOp)
1217             anObj.SetParameters(Parameters)
1218             self._autoPublish(anObj, theName, "vertex")
1219             return anObj
1220
1221         ## Create a point, corresponding to the given length on the given curve.
1222         #  @param theRefCurve The referenced curve.
1223         #  @param theLength Length on the referenced curve. It can be negative.
1224         #  @param theStartPoint Point allowing to choose the direction for the calculation
1225         #                       of the length. If None, start from the first point of theRefCurve.
1226         #  @param theName Object name; when specified, this parameter is used
1227         #         for result publication in the study. Otherwise, if automatic
1228         #         publication is switched on, default value is used for result name.
1229         #
1230         #  @return New GEOM.GEOM_Object, containing the created point.
1231         #
1232         #  @ref tui_creation_point "Example"
1233         @ManageTransactions("BasicOp")
1234         def MakeVertexOnCurveByLength(self, theRefCurve, theLength, theStartPoint = None, theName=None):
1235             """
1236             Create a point, corresponding to the given length on the given curve.
1237
1238             Parameters:
1239                 theRefCurve The referenced curve.
1240                 theLength Length on the referenced curve. It can be negative.
1241                 theStartPoint Point allowing to choose the direction for the calculation
1242                               of the length. If None, start from the first point of theRefCurve.
1243                 theName Object name; when specified, this parameter is used
1244                         for result publication in the study. Otherwise, if automatic
1245                         publication is switched on, default value is used for result name.
1246
1247             Returns:
1248                 New GEOM.GEOM_Object, containing the created point.
1249             """
1250             # Example: see GEOM_TestAll.py
1251             theLength, Parameters = ParseParameters(theLength)
1252             anObj = self.BasicOp.MakePointOnCurveByLength(theRefCurve, theLength, theStartPoint)
1253             RaiseIfFailed("MakePointOnCurveByLength", self.BasicOp)
1254             anObj.SetParameters(Parameters)
1255             self._autoPublish(anObj, theName, "vertex")
1256             return anObj
1257
1258         ## Create a point, corresponding to the given parameters on the
1259         #    given surface.
1260         #  @param theRefSurf The referenced surface.
1261         #  @param theUParameter Value of U-parameter on the referenced surface.
1262         #  @param theVParameter Value of V-parameter on the referenced surface.
1263         #  @param theName Object name; when specified, this parameter is used
1264         #         for result publication in the study. Otherwise, if automatic
1265         #         publication is switched on, default value is used for result name.
1266         #
1267         #  @return New GEOM.GEOM_Object, containing the created point.
1268         #
1269         #  @ref swig_MakeVertexOnSurface "Example"
1270         @ManageTransactions("BasicOp")
1271         def MakeVertexOnSurface(self, theRefSurf, theUParameter, theVParameter, theName=None):
1272             """
1273             Create a point, corresponding to the given parameters on the
1274             given surface.
1275
1276             Parameters:
1277                 theRefSurf The referenced surface.
1278                 theUParameter Value of U-parameter on the referenced surface.
1279                 theVParameter Value of V-parameter on the referenced surface.
1280                 theName Object name; when specified, this parameter is used
1281                         for result publication in the study. Otherwise, if automatic
1282                         publication is switched on, default value is used for result name.
1283
1284             Returns:
1285                 New GEOM.GEOM_Object, containing the created point.
1286
1287             Example of usage:
1288                 p_on_face = geompy.MakeVertexOnSurface(Face, 0.1, 0.8)
1289             """
1290             theUParameter, theVParameter, Parameters = ParseParameters(theUParameter, theVParameter)
1291             # Example: see GEOM_TestAll.py
1292             anObj = self.BasicOp.MakePointOnSurface(theRefSurf, theUParameter, theVParameter)
1293             RaiseIfFailed("MakePointOnSurface", self.BasicOp)
1294             anObj.SetParameters(Parameters);
1295             self._autoPublish(anObj, theName, "vertex")
1296             return anObj
1297
1298         ## Create a point by projection give coordinates on the given surface
1299         #  @param theRefSurf The referenced surface.
1300         #  @param theX X-coordinate in 3D space
1301         #  @param theY Y-coordinate in 3D space
1302         #  @param theZ Z-coordinate in 3D space
1303         #  @param theName Object name; when specified, this parameter is used
1304         #         for result publication in the study. Otherwise, if automatic
1305         #         publication is switched on, default value is used for result name.
1306         #
1307         #  @return New GEOM.GEOM_Object, containing the created point.
1308         #
1309         #  @ref swig_MakeVertexOnSurfaceByCoord "Example"
1310         @ManageTransactions("BasicOp")
1311         def MakeVertexOnSurfaceByCoord(self, theRefSurf, theX, theY, theZ, theName=None):
1312             """
1313             Create a point by projection give coordinates on the given surface
1314
1315             Parameters:
1316                 theRefSurf The referenced surface.
1317                 theX X-coordinate in 3D space
1318                 theY Y-coordinate in 3D space
1319                 theZ Z-coordinate in 3D space
1320                 theName Object name; when specified, this parameter is used
1321                         for result publication in the study. Otherwise, if automatic
1322                         publication is switched on, default value is used for result name.
1323
1324             Returns:
1325                 New GEOM.GEOM_Object, containing the created point.
1326
1327             Example of usage:
1328                 p_on_face2 = geompy.MakeVertexOnSurfaceByCoord(Face, 0., 0., 0.)
1329             """
1330             theX, theY, theZ, Parameters = ParseParameters(theX, theY, theZ)
1331             # Example: see GEOM_TestAll.py
1332             anObj = self.BasicOp.MakePointOnSurfaceByCoord(theRefSurf, theX, theY, theZ)
1333             RaiseIfFailed("MakeVertexOnSurfaceByCoord", self.BasicOp)
1334             anObj.SetParameters(Parameters);
1335             self._autoPublish(anObj, theName, "vertex")
1336             return anObj
1337
1338         ## Create a point, which lays on the given face.
1339         #  The point will lay in arbitrary place of the face.
1340         #  The only condition on it is a non-zero distance to the face boundary.
1341         #  Such point can be used to uniquely identify the face inside any
1342         #  shape in case, when the shape does not contain overlapped faces.
1343         #  @param theFace The referenced face.
1344         #  @param theName Object name; when specified, this parameter is used
1345         #         for result publication in the study. Otherwise, if automatic
1346         #         publication is switched on, default value is used for result name.
1347         #
1348         #  @return New GEOM.GEOM_Object, containing the created point.
1349         #
1350         #  @ref swig_MakeVertexInsideFace "Example"
1351         @ManageTransactions("BasicOp")
1352         def MakeVertexInsideFace (self, theFace, theName=None):
1353             """
1354             Create a point, which lays on the given face.
1355             The point will lay in arbitrary place of the face.
1356             The only condition on it is a non-zero distance to the face boundary.
1357             Such point can be used to uniquely identify the face inside any
1358             shape in case, when the shape does not contain overlapped faces.
1359
1360             Parameters:
1361                 theFace The referenced face.
1362                 theName Object name; when specified, this parameter is used
1363                         for result publication in the study. Otherwise, if automatic
1364                         publication is switched on, default value is used for result name.
1365
1366             Returns:
1367                 New GEOM.GEOM_Object, containing the created point.
1368
1369             Example of usage:
1370                 p_on_face = geompy.MakeVertexInsideFace(Face)
1371             """
1372             # Example: see GEOM_TestAll.py
1373             anObj = self.BasicOp.MakePointOnFace(theFace)
1374             RaiseIfFailed("MakeVertexInsideFace", self.BasicOp)
1375             self._autoPublish(anObj, theName, "vertex")
1376             return anObj
1377
1378         ## Create a point on intersection of two lines.
1379         #  @param theRefLine1, theRefLine2 The referenced lines.
1380         #  @param theName Object name; when specified, this parameter is used
1381         #         for result publication in the study. Otherwise, if automatic
1382         #         publication is switched on, default value is used for result name.
1383         #
1384         #  @return New GEOM.GEOM_Object, containing the created point.
1385         #
1386         #  @ref swig_MakeVertexOnLinesIntersection "Example"
1387         @ManageTransactions("BasicOp")
1388         def MakeVertexOnLinesIntersection(self, theRefLine1, theRefLine2, theName=None):
1389             """
1390             Create a point on intersection of two lines.
1391
1392             Parameters:
1393                 theRefLine1, theRefLine2 The referenced lines.
1394                 theName Object name; when specified, this parameter is used
1395                         for result publication in the study. Otherwise, if automatic
1396                         publication is switched on, default value is used for result name.
1397
1398             Returns:
1399                 New GEOM.GEOM_Object, containing the created point.
1400             """
1401             # Example: see GEOM_TestAll.py
1402             anObj = self.BasicOp.MakePointOnLinesIntersection(theRefLine1, theRefLine2)
1403             RaiseIfFailed("MakePointOnLinesIntersection", self.BasicOp)
1404             self._autoPublish(anObj, theName, "vertex")
1405             return anObj
1406
1407         ## Create a tangent, corresponding to the given parameter on the given curve.
1408         #  @param theRefCurve The referenced curve.
1409         #  @param theParameter Value of parameter on the referenced curve.
1410         #  @param theName Object name; when specified, this parameter is used
1411         #         for result publication in the study. Otherwise, if automatic
1412         #         publication is switched on, default value is used for result name.
1413         #
1414         #  @return New GEOM.GEOM_Object, containing the created tangent.
1415         #
1416         #  @ref swig_MakeTangentOnCurve "Example"
1417         @ManageTransactions("BasicOp")
1418         def MakeTangentOnCurve(self, theRefCurve, theParameter, theName=None):
1419             """
1420             Create a tangent, corresponding to the given parameter on the given curve.
1421
1422             Parameters:
1423                 theRefCurve The referenced curve.
1424                 theParameter Value of parameter on the referenced curve.
1425                 theName Object name; when specified, this parameter is used
1426                         for result publication in the study. Otherwise, if automatic
1427                         publication is switched on, default value is used for result name.
1428
1429             Returns:
1430                 New GEOM.GEOM_Object, containing the created tangent.
1431
1432             Example of usage:
1433                 tan_on_arc = geompy.MakeTangentOnCurve(Arc, 0.7)
1434             """
1435             anObj = self.BasicOp.MakeTangentOnCurve(theRefCurve, theParameter)
1436             RaiseIfFailed("MakeTangentOnCurve", self.BasicOp)
1437             self._autoPublish(anObj, theName, "tangent")
1438             return anObj
1439
1440         ## Create a tangent plane, corresponding to the given parameter on the given face.
1441         #  @param theFace The face for which tangent plane should be built.
1442         #  @param theParameterV vertical value of the center point (0.0 - 1.0).
1443         #  @param theParameterU horisontal value of the center point (0.0 - 1.0).
1444         #  @param theTrimSize the size of plane.
1445         #  @param theName Object name; when specified, this parameter is used
1446         #         for result publication in the study. Otherwise, if automatic
1447         #         publication is switched on, default value is used for result name.
1448         #
1449         #  @return New GEOM.GEOM_Object, containing the created tangent.
1450         #
1451         #  @ref swig_MakeTangentPlaneOnFace "Example"
1452         @ManageTransactions("BasicOp")
1453         def MakeTangentPlaneOnFace(self, theFace, theParameterU, theParameterV, theTrimSize, theName=None):
1454             """
1455             Create a tangent plane, corresponding to the given parameter on the given face.
1456
1457             Parameters:
1458                 theFace The face for which tangent plane should be built.
1459                 theParameterV vertical value of the center point (0.0 - 1.0).
1460                 theParameterU horisontal value of the center point (0.0 - 1.0).
1461                 theTrimSize the size of plane.
1462                 theName Object name; when specified, this parameter is used
1463                         for result publication in the study. Otherwise, if automatic
1464                         publication is switched on, default value is used for result name.
1465
1466            Returns:
1467                 New GEOM.GEOM_Object, containing the created tangent.
1468
1469            Example of usage:
1470                 an_on_face = geompy.MakeTangentPlaneOnFace(tan_extrusion, 0.7, 0.5, 150)
1471             """
1472             anObj = self.BasicOp.MakeTangentPlaneOnFace(theFace, theParameterU, theParameterV, theTrimSize)
1473             RaiseIfFailed("MakeTangentPlaneOnFace", self.BasicOp)
1474             self._autoPublish(anObj, theName, "tangent")
1475             return anObj
1476
1477         ## Create a vector with the given components.
1478         #  @param theDX X component of the vector.
1479         #  @param theDY Y component of the vector.
1480         #  @param theDZ Z component of the vector.
1481         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created vector.
1486         #
1487         #  @ref tui_creation_vector "Example"
1488         @ManageTransactions("BasicOp")
1489         def MakeVectorDXDYDZ(self, theDX, theDY, theDZ, theName=None):
1490             """
1491             Create a vector with the given components.
1492
1493             Parameters:
1494                 theDX X component of the vector.
1495                 theDY Y component of the vector.
1496                 theDZ Z component of the vector.
1497                 theName Object name; when specified, this parameter is used
1498                         for result publication in the study. Otherwise, if automatic
1499                         publication is switched on, default value is used for result name.
1500
1501             Returns:
1502                 New GEOM.GEOM_Object, containing the created vector.
1503             """
1504             # Example: see GEOM_TestAll.py
1505             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
1506             anObj = self.BasicOp.MakeVectorDXDYDZ(theDX, theDY, theDZ)
1507             RaiseIfFailed("MakeVectorDXDYDZ", self.BasicOp)
1508             anObj.SetParameters(Parameters)
1509             self._autoPublish(anObj, theName, "vector")
1510             return anObj
1511
1512         ## Create a vector between two points.
1513         #  @param thePnt1 Start point for the vector.
1514         #  @param thePnt2 End point for the vector.
1515         #  @param theName Object name; when specified, this parameter is used
1516         #         for result publication in the study. Otherwise, if automatic
1517         #         publication is switched on, default value is used for result name.
1518         #
1519         #  @return New GEOM.GEOM_Object, containing the created vector.
1520         #
1521         #  @ref tui_creation_vector "Example"
1522         @ManageTransactions("BasicOp")
1523         def MakeVector(self, thePnt1, thePnt2, theName=None):
1524             """
1525             Create a vector between two points.
1526
1527             Parameters:
1528                 thePnt1 Start point for the vector.
1529                 thePnt2 End point for the vector.
1530                 theName Object name; when specified, this parameter is used
1531                         for result publication in the study. Otherwise, if automatic
1532                         publication is switched on, default value is used for result name.
1533
1534             Returns:
1535                 New GEOM.GEOM_Object, containing the created vector.
1536             """
1537             # Example: see GEOM_TestAll.py
1538             anObj = self.BasicOp.MakeVectorTwoPnt(thePnt1, thePnt2)
1539             RaiseIfFailed("MakeVectorTwoPnt", self.BasicOp)
1540             self._autoPublish(anObj, theName, "vector")
1541             return anObj
1542
1543         ## Create a line, passing through the given point
1544         #  and parrallel to the given direction
1545         #  @param thePnt Point. The resulting line will pass through it.
1546         #  @param theDir Direction. The resulting line will be parallel to it.
1547         #  @param theName Object name; when specified, this parameter is used
1548         #         for result publication in the study. Otherwise, if automatic
1549         #         publication is switched on, default value is used for result name.
1550         #
1551         #  @return New GEOM.GEOM_Object, containing the created line.
1552         #
1553         #  @ref tui_creation_line "Example"
1554         @ManageTransactions("BasicOp")
1555         def MakeLine(self, thePnt, theDir, theName=None):
1556             """
1557             Create a line, passing through the given point
1558             and parrallel to the given direction
1559
1560             Parameters:
1561                 thePnt Point. The resulting line will pass through it.
1562                 theDir Direction. The resulting line will be parallel to it.
1563                 theName Object name; when specified, this parameter is used
1564                         for result publication in the study. Otherwise, if automatic
1565                         publication is switched on, default value is used for result name.
1566
1567             Returns:
1568                 New GEOM.GEOM_Object, containing the created line.
1569             """
1570             # Example: see GEOM_TestAll.py
1571             anObj = self.BasicOp.MakeLine(thePnt, theDir)
1572             RaiseIfFailed("MakeLine", self.BasicOp)
1573             self._autoPublish(anObj, theName, "line")
1574             return anObj
1575
1576         ## Create a line, passing through the given points
1577         #  @param thePnt1 First of two points, defining the line.
1578         #  @param thePnt2 Second of two points, defining the line.
1579         #  @param theName Object name; when specified, this parameter is used
1580         #         for result publication in the study. Otherwise, if automatic
1581         #         publication is switched on, default value is used for result name.
1582         #
1583         #  @return New GEOM.GEOM_Object, containing the created line.
1584         #
1585         #  @ref tui_creation_line "Example"
1586         @ManageTransactions("BasicOp")
1587         def MakeLineTwoPnt(self, thePnt1, thePnt2, theName=None):
1588             """
1589             Create a line, passing through the given points
1590
1591             Parameters:
1592                 thePnt1 First of two points, defining the line.
1593                 thePnt2 Second of two points, defining the line.
1594                 theName Object name; when specified, this parameter is used
1595                         for result publication in the study. Otherwise, if automatic
1596                         publication is switched on, default value is used for result name.
1597
1598             Returns:
1599                 New GEOM.GEOM_Object, containing the created line.
1600             """
1601             # Example: see GEOM_TestAll.py
1602             anObj = self.BasicOp.MakeLineTwoPnt(thePnt1, thePnt2)
1603             RaiseIfFailed("MakeLineTwoPnt", self.BasicOp)
1604             self._autoPublish(anObj, theName, "line")
1605             return anObj
1606
1607         ## Create a line on two faces intersection.
1608         #  @param theFace1 First of two faces, defining the line.
1609         #  @param theFace2 Second of two faces, defining the line.
1610         #  @param theName Object name; when specified, this parameter is used
1611         #         for result publication in the study. Otherwise, if automatic
1612         #         publication is switched on, default value is used for result name.
1613         #
1614         #  @return New GEOM.GEOM_Object, containing the created line.
1615         #
1616         #  @ref swig_MakeLineTwoFaces "Example"
1617         @ManageTransactions("BasicOp")
1618         def MakeLineTwoFaces(self, theFace1, theFace2, theName=None):
1619             """
1620             Create a line on two faces intersection.
1621
1622             Parameters:
1623                 theFace1 First of two faces, defining the line.
1624                 theFace2 Second of two faces, defining the line.
1625                 theName Object name; when specified, this parameter is used
1626                         for result publication in the study. Otherwise, if automatic
1627                         publication is switched on, default value is used for result name.
1628
1629             Returns:
1630                 New GEOM.GEOM_Object, containing the created line.
1631             """
1632             # Example: see GEOM_TestAll.py
1633             anObj = self.BasicOp.MakeLineTwoFaces(theFace1, theFace2)
1634             RaiseIfFailed("MakeLineTwoFaces", self.BasicOp)
1635             self._autoPublish(anObj, theName, "line")
1636             return anObj
1637
1638         ## Create a plane, passing through the given point
1639         #  and normal to the given vector.
1640         #  @param thePnt Point, the plane has to pass through.
1641         #  @param theVec Vector, defining the plane normal direction.
1642         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1643         #  @param theName Object name; when specified, this parameter is used
1644         #         for result publication in the study. Otherwise, if automatic
1645         #         publication is switched on, default value is used for result name.
1646         #
1647         #  @return New GEOM.GEOM_Object, containing the created plane.
1648         #
1649         #  @ref tui_creation_plane "Example"
1650         @ManageTransactions("BasicOp")
1651         def MakePlane(self, thePnt, theVec, theTrimSize, theName=None):
1652             """
1653             Create a plane, passing through the given point
1654             and normal to the given vector.
1655
1656             Parameters:
1657                 thePnt Point, the plane has to pass through.
1658                 theVec Vector, defining the plane normal direction.
1659                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1660                 theName Object name; when specified, this parameter is used
1661                         for result publication in the study. Otherwise, if automatic
1662                         publication is switched on, default value is used for result name.
1663
1664             Returns:
1665                 New GEOM.GEOM_Object, containing the created plane.
1666             """
1667             # Example: see GEOM_TestAll.py
1668             theTrimSize, Parameters = ParseParameters(theTrimSize);
1669             anObj = self.BasicOp.MakePlanePntVec(thePnt, theVec, theTrimSize)
1670             RaiseIfFailed("MakePlanePntVec", self.BasicOp)
1671             anObj.SetParameters(Parameters)
1672             self._autoPublish(anObj, theName, "plane")
1673             return anObj
1674
1675         ## Create a plane, passing through the three given points
1676         #  @param thePnt1 First of three points, defining the plane.
1677         #  @param thePnt2 Second of three points, defining the plane.
1678         #  @param thePnt3 Fird of three points, defining the plane.
1679         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1680         #  @param theName Object name; when specified, this parameter is used
1681         #         for result publication in the study. Otherwise, if automatic
1682         #         publication is switched on, default value is used for result name.
1683         #
1684         #  @return New GEOM.GEOM_Object, containing the created plane.
1685         #
1686         #  @ref tui_creation_plane "Example"
1687         @ManageTransactions("BasicOp")
1688         def MakePlaneThreePnt(self, thePnt1, thePnt2, thePnt3, theTrimSize, theName=None):
1689             """
1690             Create a plane, passing through the three given points
1691
1692             Parameters:
1693                 thePnt1 First of three points, defining the plane.
1694                 thePnt2 Second of three points, defining the plane.
1695                 thePnt3 Fird of three points, defining the plane.
1696                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1697                 theName Object name; when specified, this parameter is used
1698                         for result publication in the study. Otherwise, if automatic
1699                         publication is switched on, default value is used for result name.
1700
1701             Returns:
1702                 New GEOM.GEOM_Object, containing the created plane.
1703             """
1704             # Example: see GEOM_TestAll.py
1705             theTrimSize, Parameters = ParseParameters(theTrimSize);
1706             anObj = self.BasicOp.MakePlaneThreePnt(thePnt1, thePnt2, thePnt3, theTrimSize)
1707             RaiseIfFailed("MakePlaneThreePnt", self.BasicOp)
1708             anObj.SetParameters(Parameters)
1709             self._autoPublish(anObj, theName, "plane")
1710             return anObj
1711
1712         ## Create a plane, similar to the existing one, but with another size of representing face.
1713         #  @param theFace Referenced plane or LCS(Marker).
1714         #  @param theTrimSize New half size of a side of quadrangle face, representing the plane.
1715         #  @param theName Object name; when specified, this parameter is used
1716         #         for result publication in the study. Otherwise, if automatic
1717         #         publication is switched on, default value is used for result name.
1718         #
1719         #  @return New GEOM.GEOM_Object, containing the created plane.
1720         #
1721         #  @ref tui_creation_plane "Example"
1722         @ManageTransactions("BasicOp")
1723         def MakePlaneFace(self, theFace, theTrimSize, theName=None):
1724             """
1725             Create a plane, similar to the existing one, but with another size of representing face.
1726
1727             Parameters:
1728                 theFace Referenced plane or LCS(Marker).
1729                 theTrimSize New half size of a side of quadrangle face, representing the plane.
1730                 theName Object name; when specified, this parameter is used
1731                         for result publication in the study. Otherwise, if automatic
1732                         publication is switched on, default value is used for result name.
1733
1734             Returns:
1735                 New GEOM.GEOM_Object, containing the created plane.
1736             """
1737             # Example: see GEOM_TestAll.py
1738             theTrimSize, Parameters = ParseParameters(theTrimSize);
1739             anObj = self.BasicOp.MakePlaneFace(theFace, theTrimSize)
1740             RaiseIfFailed("MakePlaneFace", self.BasicOp)
1741             anObj.SetParameters(Parameters)
1742             self._autoPublish(anObj, theName, "plane")
1743             return anObj
1744
1745         ## Create a plane, passing through the 2 vectors
1746         #  with center in a start point of the first vector.
1747         #  @param theVec1 Vector, defining center point and plane direction.
1748         #  @param theVec2 Vector, defining the plane normal direction.
1749         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1750         #  @param theName Object name; when specified, this parameter is used
1751         #         for result publication in the study. Otherwise, if automatic
1752         #         publication is switched on, default value is used for result name.
1753         #
1754         #  @return New GEOM.GEOM_Object, containing the created plane.
1755         #
1756         #  @ref tui_creation_plane "Example"
1757         @ManageTransactions("BasicOp")
1758         def MakePlane2Vec(self, theVec1, theVec2, theTrimSize, theName=None):
1759             """
1760             Create a plane, passing through the 2 vectors
1761             with center in a start point of the first vector.
1762
1763             Parameters:
1764                 theVec1 Vector, defining center point and plane direction.
1765                 theVec2 Vector, defining the plane normal direction.
1766                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1767                 theName Object name; when specified, this parameter is used
1768                         for result publication in the study. Otherwise, if automatic
1769                         publication is switched on, default value is used for result name.
1770
1771             Returns:
1772                 New GEOM.GEOM_Object, containing the created plane.
1773             """
1774             # Example: see GEOM_TestAll.py
1775             theTrimSize, Parameters = ParseParameters(theTrimSize);
1776             anObj = self.BasicOp.MakePlane2Vec(theVec1, theVec2, theTrimSize)
1777             RaiseIfFailed("MakePlane2Vec", self.BasicOp)
1778             anObj.SetParameters(Parameters)
1779             self._autoPublish(anObj, theName, "plane")
1780             return anObj
1781
1782         ## Create a plane, based on a Local coordinate system.
1783         #  @param theLCS  coordinate system, defining plane.
1784         #  @param theTrimSize Half size of a side of quadrangle face, representing the plane.
1785         #  @param theOrientation OXY, OYZ or OZX orientation - (1, 2 or 3)
1786         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created plane.
1791         #
1792         #  @ref tui_creation_plane "Example"
1793         @ManageTransactions("BasicOp")
1794         def MakePlaneLCS(self, theLCS, theTrimSize, theOrientation, theName=None):
1795             """
1796             Create a plane, based on a Local coordinate system.
1797
1798            Parameters:
1799                 theLCS  coordinate system, defining plane.
1800                 theTrimSize Half size of a side of quadrangle face, representing the plane.
1801                 theOrientation OXY, OYZ or OZX orientation - (1, 2 or 3)
1802                 theName Object name; when specified, this parameter is used
1803                         for result publication in the study. Otherwise, if automatic
1804                         publication is switched on, default value is used for result name.
1805
1806             Returns:
1807                 New GEOM.GEOM_Object, containing the created plane.
1808             """
1809             # Example: see GEOM_TestAll.py
1810             theTrimSize, Parameters = ParseParameters(theTrimSize);
1811             anObj = self.BasicOp.MakePlaneLCS(theLCS, theTrimSize, theOrientation)
1812             RaiseIfFailed("MakePlaneLCS", self.BasicOp)
1813             anObj.SetParameters(Parameters)
1814             self._autoPublish(anObj, theName, "plane")
1815             return anObj
1816
1817         ## Create a local coordinate system.
1818         #  @param OX,OY,OZ Three coordinates of coordinate system origin.
1819         #  @param XDX,XDY,XDZ Three components of OX direction
1820         #  @param YDX,YDY,YDZ Three components of OY direction
1821         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created coordinate system.
1826         #
1827         #  @ref swig_MakeMarker "Example"
1828         @ManageTransactions("BasicOp")
1829         def MakeMarker(self, OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ, theName=None):
1830             """
1831             Create a local coordinate system.
1832
1833             Parameters:
1834                 OX,OY,OZ Three coordinates of coordinate system origin.
1835                 XDX,XDY,XDZ Three components of OX direction
1836                 YDX,YDY,YDZ Three components of OY direction
1837                 theName Object name; when specified, this parameter is used
1838                         for result publication in the study. Otherwise, if automatic
1839                         publication is switched on, default value is used for result name.
1840
1841             Returns:
1842                 New GEOM.GEOM_Object, containing the created coordinate system.
1843             """
1844             # Example: see GEOM_TestAll.py
1845             OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ, Parameters = ParseParameters(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ);
1846             anObj = self.BasicOp.MakeMarker(OX,OY,OZ, XDX,XDY,XDZ, YDX,YDY,YDZ)
1847             RaiseIfFailed("MakeMarker", self.BasicOp)
1848             anObj.SetParameters(Parameters)
1849             self._autoPublish(anObj, theName, "lcs")
1850             return anObj
1851
1852         ## Create a local coordinate system from shape.
1853         #  @param theShape The initial shape to detect the coordinate system.
1854         #  @param theName Object name; when specified, this parameter is used
1855         #         for result publication in the study. Otherwise, if automatic
1856         #         publication is switched on, default value is used for result name.
1857         #
1858         #  @return New GEOM.GEOM_Object, containing the created coordinate system.
1859         #
1860         #  @ref tui_creation_lcs "Example"
1861         @ManageTransactions("BasicOp")
1862         def MakeMarkerFromShape(self, theShape, theName=None):
1863             """
1864             Create a local coordinate system from shape.
1865
1866             Parameters:
1867                 theShape The initial shape to detect the coordinate system.
1868                 theName Object name; when specified, this parameter is used
1869                         for result publication in the study. Otherwise, if automatic
1870                         publication is switched on, default value is used for result name.
1871
1872             Returns:
1873                 New GEOM.GEOM_Object, containing the created coordinate system.
1874             """
1875             anObj = self.BasicOp.MakeMarkerFromShape(theShape)
1876             RaiseIfFailed("MakeMarkerFromShape", self.BasicOp)
1877             self._autoPublish(anObj, theName, "lcs")
1878             return anObj
1879
1880         ## Create a local coordinate system from point and two vectors.
1881         #  @param theOrigin Point of coordinate system origin.
1882         #  @param theXVec Vector of X direction
1883         #  @param theYVec Vector of Y direction
1884         #  @param theName Object name; when specified, this parameter is used
1885         #         for result publication in the study. Otherwise, if automatic
1886         #         publication is switched on, default value is used for result name.
1887         #
1888         #  @return New GEOM.GEOM_Object, containing the created coordinate system.
1889         #
1890         #  @ref tui_creation_lcs "Example"
1891         @ManageTransactions("BasicOp")
1892         def MakeMarkerPntTwoVec(self, theOrigin, theXVec, theYVec, theName=None):
1893             """
1894             Create a local coordinate system from point and two vectors.
1895
1896             Parameters:
1897                 theOrigin Point of coordinate system origin.
1898                 theXVec Vector of X direction
1899                 theYVec Vector of Y direction
1900                 theName Object name; when specified, this parameter is used
1901                         for result publication in the study. Otherwise, if automatic
1902                         publication is switched on, default value is used for result name.
1903
1904             Returns:
1905                 New GEOM.GEOM_Object, containing the created coordinate system.
1906
1907             """
1908             anObj = self.BasicOp.MakeMarkerPntTwoVec(theOrigin, theXVec, theYVec)
1909             RaiseIfFailed("MakeMarkerPntTwoVec", self.BasicOp)
1910             self._autoPublish(anObj, theName, "lcs")
1911             return anObj
1912
1913         # end of l3_basic_go
1914         ## @}
1915
1916         ## @addtogroup l4_curves
1917         ## @{
1918
1919         ##  Create an arc of circle, passing through three given points.
1920         #  @param thePnt1 Start point of the arc.
1921         #  @param thePnt2 Middle point of the arc.
1922         #  @param thePnt3 End point of the arc.
1923         #  @param theName Object name; when specified, this parameter is used
1924         #         for result publication in the study. Otherwise, if automatic
1925         #         publication is switched on, default value is used for result name.
1926         #
1927         #  @return New GEOM.GEOM_Object, containing the created arc.
1928         #
1929         #  @ref swig_MakeArc "Example"
1930         @ManageTransactions("CurvesOp")
1931         def MakeArc(self, thePnt1, thePnt2, thePnt3, theName=None):
1932             """
1933             Create an arc of circle, passing through three given points.
1934
1935             Parameters:
1936                 thePnt1 Start point of the arc.
1937                 thePnt2 Middle point of the arc.
1938                 thePnt3 End point of the arc.
1939                 theName Object name; when specified, this parameter is used
1940                         for result publication in the study. Otherwise, if automatic
1941                         publication is switched on, default value is used for result name.
1942
1943             Returns:
1944                 New GEOM.GEOM_Object, containing the created arc.
1945             """
1946             # Example: see GEOM_TestAll.py
1947             anObj = self.CurvesOp.MakeArc(thePnt1, thePnt2, thePnt3)
1948             RaiseIfFailed("MakeArc", self.CurvesOp)
1949             self._autoPublish(anObj, theName, "arc")
1950             return anObj
1951
1952         ##  Create an arc of circle from a center and 2 points.
1953         #  @param thePnt1 Center of the arc
1954         #  @param thePnt2 Start point of the arc. (Gives also the radius of the arc)
1955         #  @param thePnt3 End point of the arc (Gives also a direction)
1956         #  @param theSense Orientation of the arc
1957         #  @param theName Object name; when specified, this parameter is used
1958         #         for result publication in the study. Otherwise, if automatic
1959         #         publication is switched on, default value is used for result name.
1960         #
1961         #  @return New GEOM.GEOM_Object, containing the created arc.
1962         #
1963         #  @ref swig_MakeArc "Example"
1964         @ManageTransactions("CurvesOp")
1965         def MakeArcCenter(self, thePnt1, thePnt2, thePnt3, theSense=False, theName=None):
1966             """
1967             Create an arc of circle from a center and 2 points.
1968
1969             Parameters:
1970                 thePnt1 Center of the arc
1971                 thePnt2 Start point of the arc. (Gives also the radius of the arc)
1972                 thePnt3 End point of the arc (Gives also a direction)
1973                 theSense Orientation of the arc
1974                 theName Object name; when specified, this parameter is used
1975                         for result publication in the study. Otherwise, if automatic
1976                         publication is switched on, default value is used for result name.
1977
1978             Returns:
1979                 New GEOM.GEOM_Object, containing the created arc.
1980             """
1981             # Example: see GEOM_TestAll.py
1982             anObj = self.CurvesOp.MakeArcCenter(thePnt1, thePnt2, thePnt3, theSense)
1983             RaiseIfFailed("MakeArcCenter", self.CurvesOp)
1984             self._autoPublish(anObj, theName, "arc")
1985             return anObj
1986
1987         ##  Create an arc of ellipse, of center and two points.
1988         #  @param theCenter Center of the arc.
1989         #  @param thePnt1 defines major radius of the arc by distance from Pnt1 to Pnt2.
1990         #  @param thePnt2 defines plane of ellipse and minor radius as distance from Pnt3 to line from Pnt1 to Pnt2.
1991         #  @param theName Object name; when specified, this parameter is used
1992         #         for result publication in the study. Otherwise, if automatic
1993         #         publication is switched on, default value is used for result name.
1994         #
1995         #  @return New GEOM.GEOM_Object, containing the created arc.
1996         #
1997         #  @ref swig_MakeArc "Example"
1998         @ManageTransactions("CurvesOp")
1999         def MakeArcOfEllipse(self, theCenter, thePnt1, thePnt2, theName=None):
2000             """
2001             Create an arc of ellipse, of center and two points.
2002
2003             Parameters:
2004                 theCenter Center of the arc.
2005                 thePnt1 defines major radius of the arc by distance from Pnt1 to Pnt2.
2006                 thePnt2 defines plane of ellipse and minor radius as distance from Pnt3 to line from Pnt1 to Pnt2.
2007                 theName Object name; when specified, this parameter is used
2008                         for result publication in the study. Otherwise, if automatic
2009                         publication is switched on, default value is used for result name.
2010
2011             Returns:
2012                 New GEOM.GEOM_Object, containing the created arc.
2013             """
2014             # Example: see GEOM_TestAll.py
2015             anObj = self.CurvesOp.MakeArcOfEllipse(theCenter, thePnt1, thePnt2)
2016             RaiseIfFailed("MakeArcOfEllipse", self.CurvesOp)
2017             self._autoPublish(anObj, theName, "arc")
2018             return anObj
2019
2020         ## Create a circle with given center, normal vector and radius.
2021         #  @param thePnt Circle center.
2022         #  @param theVec Vector, normal to the plane of the circle.
2023         #  @param theR Circle radius.
2024         #  @param theName Object name; when specified, this parameter is used
2025         #         for result publication in the study. Otherwise, if automatic
2026         #         publication is switched on, default value is used for result name.
2027         #
2028         #  @return New GEOM.GEOM_Object, containing the created circle.
2029         #
2030         #  @ref tui_creation_circle "Example"
2031         @ManageTransactions("CurvesOp")
2032         def MakeCircle(self, thePnt, theVec, theR, theName=None):
2033             """
2034             Create a circle with given center, normal vector and radius.
2035
2036             Parameters:
2037                 thePnt Circle center.
2038                 theVec Vector, normal to the plane of the circle.
2039                 theR Circle radius.
2040                 theName Object name; when specified, this parameter is used
2041                         for result publication in the study. Otherwise, if automatic
2042                         publication is switched on, default value is used for result name.
2043
2044             Returns:
2045                 New GEOM.GEOM_Object, containing the created circle.
2046             """
2047             # Example: see GEOM_TestAll.py
2048             theR, Parameters = ParseParameters(theR)
2049             anObj = self.CurvesOp.MakeCirclePntVecR(thePnt, theVec, theR)
2050             RaiseIfFailed("MakeCirclePntVecR", self.CurvesOp)
2051             anObj.SetParameters(Parameters)
2052             self._autoPublish(anObj, theName, "circle")
2053             return anObj
2054
2055         ## Create a circle with given radius.
2056         #  Center of the circle will be in the origin of global
2057         #  coordinate system and normal vector will be codirected with Z axis
2058         #  @param theR Circle radius.
2059         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created circle.
2064         @ManageTransactions("CurvesOp")
2065         def MakeCircleR(self, theR, theName=None):
2066             """
2067             Create a circle with given radius.
2068             Center of the circle will be in the origin of global
2069             coordinate system and normal vector will be codirected with Z axis
2070
2071             Parameters:
2072                 theR Circle radius.
2073                 theName Object name; when specified, this parameter is used
2074                         for result publication in the study. Otherwise, if automatic
2075                         publication is switched on, default value is used for result name.
2076
2077             Returns:
2078                 New GEOM.GEOM_Object, containing the created circle.
2079             """
2080             anObj = self.CurvesOp.MakeCirclePntVecR(None, None, theR)
2081             RaiseIfFailed("MakeCirclePntVecR", self.CurvesOp)
2082             self._autoPublish(anObj, theName, "circle")
2083             return anObj
2084
2085         ## Create a circle, passing through three given points
2086         #  @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2087         #  @param theName Object name; when specified, this parameter is used
2088         #         for result publication in the study. Otherwise, if automatic
2089         #         publication is switched on, default value is used for result name.
2090         #
2091         #  @return New GEOM.GEOM_Object, containing the created circle.
2092         #
2093         #  @ref tui_creation_circle "Example"
2094         @ManageTransactions("CurvesOp")
2095         def MakeCircleThreePnt(self, thePnt1, thePnt2, thePnt3, theName=None):
2096             """
2097             Create a circle, passing through three given points
2098
2099             Parameters:
2100                 thePnt1,thePnt2,thePnt3 Points, defining the circle.
2101                 theName Object name; when specified, this parameter is used
2102                         for result publication in the study. Otherwise, if automatic
2103                         publication is switched on, default value is used for result name.
2104
2105             Returns:
2106                 New GEOM.GEOM_Object, containing the created circle.
2107             """
2108             # Example: see GEOM_TestAll.py
2109             anObj = self.CurvesOp.MakeCircleThreePnt(thePnt1, thePnt2, thePnt3)
2110             RaiseIfFailed("MakeCircleThreePnt", self.CurvesOp)
2111             self._autoPublish(anObj, theName, "circle")
2112             return anObj
2113
2114         ## Create a circle, with given point1 as center,
2115         #  passing through the point2 as radius and laying in the plane,
2116         #  defined by all three given points.
2117         #  @param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2118         #  @param theName Object name; when specified, this parameter is used
2119         #         for result publication in the study. Otherwise, if automatic
2120         #         publication is switched on, default value is used for result name.
2121         #
2122         #  @return New GEOM.GEOM_Object, containing the created circle.
2123         #
2124         #  @ref swig_MakeCircle "Example"
2125         @ManageTransactions("CurvesOp")
2126         def MakeCircleCenter2Pnt(self, thePnt1, thePnt2, thePnt3, theName=None):
2127             """
2128             Create a circle, with given point1 as center,
2129             passing through the point2 as radius and laying in the plane,
2130             defined by all three given points.
2131
2132             Parameters:
2133                 thePnt1,thePnt2,thePnt3 Points, defining the circle.
2134                 theName Object name; when specified, this parameter is used
2135                         for result publication in the study. Otherwise, if automatic
2136                         publication is switched on, default value is used for result name.
2137
2138             Returns:
2139                 New GEOM.GEOM_Object, containing the created circle.
2140             """
2141             # Example: see GEOM_example6.py
2142             anObj = self.CurvesOp.MakeCircleCenter2Pnt(thePnt1, thePnt2, thePnt3)
2143             RaiseIfFailed("MakeCircleCenter2Pnt", self.CurvesOp)
2144             self._autoPublish(anObj, theName, "circle")
2145             return anObj
2146
2147         ## Create an ellipse with given center, normal vector and radiuses.
2148         #  @param thePnt Ellipse center.
2149         #  @param theVec Vector, normal to the plane of the ellipse.
2150         #  @param theRMajor Major ellipse radius.
2151         #  @param theRMinor Minor ellipse radius.
2152         #  @param theVecMaj Vector, direction of the ellipse's main axis.
2153         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created ellipse.
2158         #
2159         #  @ref tui_creation_ellipse "Example"
2160         @ManageTransactions("CurvesOp")
2161         def MakeEllipse(self, thePnt, theVec, theRMajor, theRMinor, theVecMaj=None, theName=None):
2162             """
2163             Create an ellipse with given center, normal vector and radiuses.
2164
2165             Parameters:
2166                 thePnt Ellipse center.
2167                 theVec Vector, normal to the plane of the ellipse.
2168                 theRMajor Major ellipse radius.
2169                 theRMinor Minor ellipse radius.
2170                 theVecMaj Vector, direction of the ellipse's main axis.
2171                 theName Object name; when specified, this parameter is used
2172                         for result publication in the study. Otherwise, if automatic
2173                         publication is switched on, default value is used for result name.
2174
2175             Returns:
2176                 New GEOM.GEOM_Object, containing the created ellipse.
2177             """
2178             # Example: see GEOM_TestAll.py
2179             theRMajor, theRMinor, Parameters = ParseParameters(theRMajor, theRMinor)
2180             if theVecMaj is not None:
2181                 anObj = self.CurvesOp.MakeEllipseVec(thePnt, theVec, theRMajor, theRMinor, theVecMaj)
2182             else:
2183                 anObj = self.CurvesOp.MakeEllipse(thePnt, theVec, theRMajor, theRMinor)
2184                 pass
2185             RaiseIfFailed("MakeEllipse", self.CurvesOp)
2186             anObj.SetParameters(Parameters)
2187             self._autoPublish(anObj, theName, "ellipse")
2188             return anObj
2189
2190         ## Create an ellipse with given radiuses.
2191         #  Center of the ellipse will be in the origin of global
2192         #  coordinate system and normal vector will be codirected with Z axis
2193         #  @param theRMajor Major ellipse radius.
2194         #  @param theRMinor Minor ellipse radius.
2195         #  @param theName Object name; when specified, this parameter is used
2196         #         for result publication in the study. Otherwise, if automatic
2197         #         publication is switched on, default value is used for result name.
2198         #
2199         #  @return New GEOM.GEOM_Object, containing the created ellipse.
2200         @ManageTransactions("CurvesOp")
2201         def MakeEllipseRR(self, theRMajor, theRMinor, theName=None):
2202             """
2203             Create an ellipse with given radiuses.
2204             Center of the ellipse will be in the origin of global
2205             coordinate system and normal vector will be codirected with Z axis
2206
2207             Parameters:
2208                 theRMajor Major ellipse radius.
2209                 theRMinor Minor ellipse radius.
2210                 theName Object name; when specified, this parameter is used
2211                         for result publication in the study. Otherwise, if automatic
2212                         publication is switched on, default value is used for result name.
2213
2214             Returns:
2215             New GEOM.GEOM_Object, containing the created ellipse.
2216             """
2217             anObj = self.CurvesOp.MakeEllipse(None, None, theRMajor, theRMinor)
2218             RaiseIfFailed("MakeEllipse", self.CurvesOp)
2219             self._autoPublish(anObj, theName, "ellipse")
2220             return anObj
2221
2222         ## Create a polyline on the set of points.
2223         #  @param thePoints Sequence of points for the polyline.
2224         #  @param theIsClosed If True, build a closed wire.
2225         #  @param theName Object name; when specified, this parameter is used
2226         #         for result publication in the study. Otherwise, if automatic
2227         #         publication is switched on, default value is used for result name.
2228         #
2229         #  @return New GEOM.GEOM_Object, containing the created polyline.
2230         #
2231         #  @ref tui_creation_curve "Example"
2232         @ManageTransactions("CurvesOp")
2233         def MakePolyline(self, thePoints, theIsClosed=False, theName=None):
2234             """
2235             Create a polyline on the set of points.
2236
2237             Parameters:
2238                 thePoints Sequence of points for the polyline.
2239                 theIsClosed If True, build a closed wire.
2240                 theName Object name; when specified, this parameter is used
2241                         for result publication in the study. Otherwise, if automatic
2242                         publication is switched on, default value is used for result name.
2243
2244             Returns:
2245                 New GEOM.GEOM_Object, containing the created polyline.
2246             """
2247             # Example: see GEOM_TestAll.py
2248             anObj = self.CurvesOp.MakePolyline(thePoints, theIsClosed)
2249             RaiseIfFailed("MakePolyline", self.CurvesOp)
2250             self._autoPublish(anObj, theName, "polyline")
2251             return anObj
2252
2253         ## Create bezier curve on the set of points.
2254         #  @param thePoints Sequence of points for the bezier curve.
2255         #  @param theIsClosed If True, build a closed curve.
2256         #  @param theName Object name; when specified, this parameter is used
2257         #         for result publication in the study. Otherwise, if automatic
2258         #         publication is switched on, default value is used for result name.
2259         #
2260         #  @return New GEOM.GEOM_Object, containing the created bezier curve.
2261         #
2262         #  @ref tui_creation_curve "Example"
2263         @ManageTransactions("CurvesOp")
2264         def MakeBezier(self, thePoints, theIsClosed=False, theName=None):
2265             """
2266             Create bezier curve on the set of points.
2267
2268             Parameters:
2269                 thePoints Sequence of points for the bezier curve.
2270                 theIsClosed If True, build a closed curve.
2271                 theName Object name; when specified, this parameter is used
2272                         for result publication in the study. Otherwise, if automatic
2273                         publication is switched on, default value is used for result name.
2274
2275             Returns:
2276                 New GEOM.GEOM_Object, containing the created bezier curve.
2277             """
2278             # Example: see GEOM_TestAll.py
2279             anObj = self.CurvesOp.MakeSplineBezier(thePoints, theIsClosed)
2280             RaiseIfFailed("MakeSplineBezier", self.CurvesOp)
2281             self._autoPublish(anObj, theName, "bezier")
2282             return anObj
2283
2284         ## Create B-Spline curve on the set of points.
2285         #  @param thePoints Sequence of points for the B-Spline curve.
2286         #  @param theIsClosed If True, build a closed curve.
2287         #  @param theDoReordering If TRUE, the algo does not follow the order of
2288         #                         \a thePoints but searches for the closest vertex.
2289         #  @param theName Object name; when specified, this parameter is used
2290         #         for result publication in the study. Otherwise, if automatic
2291         #         publication is switched on, default value is used for result name.
2292         #
2293         #  @return New GEOM.GEOM_Object, containing the created B-Spline curve.
2294         #
2295         #  @ref tui_creation_curve "Example"
2296         @ManageTransactions("CurvesOp")
2297         def MakeInterpol(self, thePoints, theIsClosed=False, theDoReordering=False, theName=None):
2298             """
2299             Create B-Spline curve on the set of points.
2300
2301             Parameters:
2302                 thePoints Sequence of points for the B-Spline curve.
2303                 theIsClosed If True, build a closed curve.
2304                 theDoReordering If True, the algo does not follow the order of
2305                                 thePoints but searches for the closest vertex.
2306                 theName Object name; when specified, this parameter is used
2307                         for result publication in the study. Otherwise, if automatic
2308                         publication is switched on, default value is used for result name.
2309
2310             Returns:
2311                 New GEOM.GEOM_Object, containing the created B-Spline curve.
2312             """
2313             # Example: see GEOM_TestAll.py
2314             anObj = self.CurvesOp.MakeSplineInterpolation(thePoints, theIsClosed, theDoReordering)
2315             RaiseIfFailed("MakeInterpol", self.CurvesOp)
2316             self._autoPublish(anObj, theName, "bspline")
2317             return anObj
2318
2319         ## Create B-Spline curve on the set of points.
2320         #  @param thePoints Sequence of points for the B-Spline curve.
2321         #  @param theFirstVec Vector object, defining the curve direction at its first point.
2322         #  @param theLastVec Vector object, defining the curve direction at its last point.
2323         #  @param theName Object name; when specified, this parameter is used
2324         #         for result publication in the study. Otherwise, if automatic
2325         #         publication is switched on, default value is used for result name.
2326         #
2327         #  @return New GEOM.GEOM_Object, containing the created B-Spline curve.
2328         #
2329         #  @ref tui_creation_curve "Example"
2330         @ManageTransactions("CurvesOp")
2331         def MakeInterpolWithTangents(self, thePoints, theFirstVec, theLastVec, theName=None):
2332             """
2333             Create B-Spline curve on the set of points.
2334
2335             Parameters:
2336                 thePoints Sequence of points for the B-Spline curve.
2337                 theFirstVec Vector object, defining the curve direction at its first point.
2338                 theLastVec Vector object, defining the curve direction at its last point.
2339                 theName Object name; when specified, this parameter is used
2340                         for result publication in the study. Otherwise, if automatic
2341                         publication is switched on, default value is used for result name.
2342
2343             Returns:
2344                 New GEOM.GEOM_Object, containing the created B-Spline curve.
2345             """
2346             # Example: see GEOM_TestAll.py
2347             anObj = self.CurvesOp.MakeSplineInterpolWithTangents(thePoints, theFirstVec, theLastVec)
2348             RaiseIfFailed("MakeInterpolWithTangents", self.CurvesOp)
2349             self._autoPublish(anObj, theName, "bspline")
2350             return anObj
2351
2352         ## Creates a curve using the parametric definition of the basic points.
2353         #  @param thexExpr parametric equation of the coordinates X.
2354         #  @param theyExpr parametric equation of the coordinates Y.
2355         #  @param thezExpr parametric equation of the coordinates Z.
2356         #  @param theParamMin the minimal value of the parameter.
2357         #  @param theParamMax the maximum value of the parameter.
2358         #  @param theParamStep the number of steps if theNewMethod = True, else step value of the parameter.
2359         #  @param theCurveType the type of the curve,
2360         #         one of GEOM.Polyline, GEOM.Bezier, GEOM.Interpolation.
2361         #  @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.
2362         #  @param theName Object name; when specified, this parameter is used
2363         #         for result publication in the study. Otherwise, if automatic
2364         #         publication is switched on, default value is used for result name.
2365         #
2366         #  @return New GEOM.GEOM_Object, containing the created curve.
2367         #
2368         #  @ref tui_creation_curve "Example"
2369         @ManageTransactions("CurvesOp")
2370         def MakeCurveParametric(self, thexExpr, theyExpr, thezExpr,
2371                                 theParamMin, theParamMax, theParamStep, theCurveType, theNewMethod=False, theName=None ):
2372             """
2373             Creates a curve using the parametric definition of the basic points.
2374
2375             Parameters:
2376                 thexExpr parametric equation of the coordinates X.
2377                 theyExpr parametric equation of the coordinates Y.
2378                 thezExpr parametric equation of the coordinates Z.
2379                 theParamMin the minimal value of the parameter.
2380                 theParamMax the maximum value of the parameter.
2381                 theParamStep the number of steps if theNewMethod = True, else step value of the parameter.
2382                 theCurveType the type of the curve,
2383                              one of GEOM.Polyline, GEOM.Bezier, GEOM.Interpolation.
2384                 theNewMethod flag for switching to the new method if the flag is set to false a deprecated
2385                              method is used which can lead to a bug.
2386                 theName Object name; when specified, this parameter is used
2387                         for result publication in the study. Otherwise, if automatic
2388                         publication is switched on, default value is used for result name.
2389
2390             Returns:
2391                 New GEOM.GEOM_Object, containing the created curve.
2392             """
2393             theParamMin,theParamMax,theParamStep,Parameters = ParseParameters(theParamMin,theParamMax,theParamStep)
2394             if theNewMethod:
2395               anObj = self.CurvesOp.MakeCurveParametricNew(thexExpr,theyExpr,thezExpr,theParamMin,theParamMax,theParamStep,theCurveType)
2396             else:
2397               anObj = self.CurvesOp.MakeCurveParametric(thexExpr,theyExpr,thezExpr,theParamMin,theParamMax,theParamStep,theCurveType)
2398             RaiseIfFailed("MakeSplineInterpolation", self.CurvesOp)
2399             anObj.SetParameters(Parameters)
2400             self._autoPublish(anObj, theName, "curve")
2401             return anObj
2402
2403         ## Create an isoline curve on a face.
2404         #  @param theFace the face for which an isoline is created.
2405         #  @param IsUIsoline True for U-isoline creation; False for V-isoline
2406         #         creation.
2407         #  @param theParameter the U parameter for U-isoline or V parameter
2408         #         for V-isoline.
2409         #  @param theName Object name; when specified, this parameter is used
2410         #         for result publication in the study. Otherwise, if automatic
2411         #         publication is switched on, default value is used for result name.
2412         #
2413         #  @return New GEOM.GEOM_Object, containing the created isoline edge or
2414         #          a compound of edges.
2415         #
2416         #  @ref tui_creation_curve "Example"
2417         @ManageTransactions("CurvesOp")
2418         def MakeIsoline(self, theFace, IsUIsoline, theParameter, theName=None):
2419             """
2420             Create an isoline curve on a face.
2421
2422             Parameters:
2423                 theFace the face for which an isoline is created.
2424                 IsUIsoline True for U-isoline creation; False for V-isoline
2425                            creation.
2426                 theParameter the U parameter for U-isoline or V parameter
2427                              for V-isoline.
2428                 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             Returns:
2433                 New GEOM.GEOM_Object, containing the created isoline edge or a
2434                 compound of edges.
2435             """
2436             # Example: see GEOM_TestAll.py
2437             anObj = self.CurvesOp.MakeIsoline(theFace, IsUIsoline, theParameter)
2438             RaiseIfFailed("MakeIsoline", self.CurvesOp)
2439             if IsUIsoline:
2440                 self._autoPublish(anObj, theName, "U-Isoline")
2441             else:
2442                 self._autoPublish(anObj, theName, "V-Isoline")
2443             return anObj
2444
2445         # end of l4_curves
2446         ## @}
2447
2448         ## @addtogroup l3_sketcher
2449         ## @{
2450
2451         ## Create a sketcher (wire or face), following the textual description,
2452         #  passed through <VAR>theCommand</VAR> argument. \n
2453         #  Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2454         #  Format of the description string have to be the following:
2455         #
2456         #  "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2457         #
2458         #  Where:
2459         #  - x1, y1 are coordinates of the first sketcher point (zero by default),
2460         #  - CMD is one of
2461         #     - "R angle" : Set the direction by angle
2462         #     - "D dx dy" : Set the direction by DX & DY
2463         #     .
2464         #       \n
2465         #     - "TT x y" : Create segment by point at X & Y
2466         #     - "T dx dy" : Create segment by point with DX & DY
2467         #     - "L length" : Create segment by direction & Length
2468         #     - "IX x" : Create segment by direction & Intersect. X
2469         #     - "IY y" : Create segment by direction & Intersect. Y
2470         #     .
2471         #       \n
2472         #     - "C radius length" : Create arc by direction, radius and length(in degree)
2473         #     - "AA x y": Create arc by point at X & Y
2474         #     - "A dx dy" : Create arc by point with DX & DY
2475         #     - "UU x y radius flag1": Create arc by point at X & Y with given radiUs
2476         #     - "U dx dy radius flag1" : Create arc by point with DX & DY with given radiUs
2477         #     - "EE x y xc yc flag1 flag2": Create arc by point at X & Y with given cEnter coordinates
2478         #     - "E dx dy dxc dyc radius flag1 flag2" : Create arc by point with DX & DY with given cEnter coordinates
2479         #     .
2480         #       \n
2481         #     - "WW" : Close Wire (to finish)
2482         #     - "WF" : Close Wire and build face (to finish)
2483         #     .
2484         #        \n
2485         #  - Flag1 (= reverse) is 0 or 2 ...
2486         #     - if 0 the drawn arc is the one of lower angle (< Pi)
2487         #     - if 2 the drawn arc ius the one of greater angle (> Pi)
2488         #     .
2489         #        \n
2490         #  - Flag2 (= control tolerance) is 0 or 1 ...
2491         #     - if 0 the specified end point can be at a distance of the arc greater than the tolerance (10^-7)
2492         #     - if 1 the wire is built only if the end point is on the arc
2493         #       with a tolerance of 10^-7 on the distance else the creation fails
2494         #
2495         #  @param theCommand String, defining the sketcher in local
2496         #                    coordinates of the working plane.
2497         #  @param theWorkingPlane Nine double values, defining origin,
2498         #                         OZ and OX directions of the working plane.
2499         #  @param theName Object name; when specified, this parameter is used
2500         #         for result publication in the study. Otherwise, if automatic
2501         #         publication is switched on, default value is used for result name.
2502         #
2503         #  @return New GEOM.GEOM_Object, containing the created wire.
2504         #
2505         #  @ref tui_sketcher_page "Example"
2506         @ManageTransactions("CurvesOp")
2507         def MakeSketcher(self, theCommand, theWorkingPlane = [0,0,0, 0,0,1, 1,0,0], theName=None):
2508             """
2509             Create a sketcher (wire or face), following the textual description, passed
2510             through theCommand argument.
2511             Edges of the resulting wire or face will be arcs of circles and/or linear segments.
2512             Format of the description string have to be the following:
2513                 "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2514             Where:
2515             - x1, y1 are coordinates of the first sketcher point (zero by default),
2516             - CMD is one of
2517                - "R angle" : Set the direction by angle
2518                - "D dx dy" : Set the direction by DX & DY
2519
2520                - "TT x y" : Create segment by point at X & Y
2521                - "T dx dy" : Create segment by point with DX & DY
2522                - "L length" : Create segment by direction & Length
2523                - "IX x" : Create segment by direction & Intersect. X
2524                - "IY y" : Create segment by direction & Intersect. Y
2525
2526                - "C radius length" : Create arc by direction, radius and length(in degree)
2527                - "AA x y": Create arc by point at X & Y
2528                - "A dx dy" : Create arc by point with DX & DY
2529                - "UU x y radius flag1": Create arc by point at X & Y with given radiUs
2530                - "U dx dy radius flag1" : Create arc by point with DX & DY with given radiUs
2531                - "EE x y xc yc flag1 flag2": Create arc by point at X & Y with given cEnter coordinates
2532                - "E dx dy dxc dyc radius flag1 flag2" : Create arc by point with DX & DY with given cEnter coordinates
2533
2534                - "WW" : Close Wire (to finish)
2535                - "WF" : Close Wire and build face (to finish)
2536
2537             - Flag1 (= reverse) is 0 or 2 ...
2538                - if 0 the drawn arc is the one of lower angle (< Pi)
2539                - if 2 the drawn arc ius the one of greater angle (> Pi)
2540
2541             - Flag2 (= control tolerance) is 0 or 1 ...
2542                - if 0 the specified end point can be at a distance of the arc greater than the tolerance (10^-7)
2543                - if 1 the wire is built only if the end point is on the arc
2544                  with a tolerance of 10^-7 on the distance else the creation fails
2545
2546             Parameters:
2547                 theCommand String, defining the sketcher in local
2548                            coordinates of the working plane.
2549                 theWorkingPlane Nine double values, defining origin,
2550                                 OZ and OX directions of the working plane.
2551                 theName Object name; when specified, this parameter is used
2552                         for result publication in the study. Otherwise, if automatic
2553                         publication is switched on, default value is used for result name.
2554
2555             Returns:
2556                 New GEOM.GEOM_Object, containing the created wire.
2557             """
2558             # Example: see GEOM_TestAll.py
2559             theCommand,Parameters = ParseSketcherCommand(theCommand)
2560             anObj = self.CurvesOp.MakeSketcher(theCommand, theWorkingPlane)
2561             RaiseIfFailed("MakeSketcher", self.CurvesOp)
2562             anObj.SetParameters(Parameters)
2563             self._autoPublish(anObj, theName, "wire")
2564             return anObj
2565
2566         ## Create a sketcher (wire or face), following the textual description,
2567         #  passed through <VAR>theCommand</VAR> argument. \n
2568         #  For format of the description string see MakeSketcher() method.\n
2569         #  @param theCommand String, defining the sketcher in local
2570         #                    coordinates of the working plane.
2571         #  @param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2572         #  @param theName Object name; when specified, this parameter is used
2573         #         for result publication in the study. Otherwise, if automatic
2574         #         publication is switched on, default value is used for result name.
2575         #
2576         #  @return New GEOM.GEOM_Object, containing the created wire.
2577         #
2578         #  @ref tui_sketcher_page "Example"
2579         @ManageTransactions("CurvesOp")
2580         def MakeSketcherOnPlane(self, theCommand, theWorkingPlane, theName=None):
2581             """
2582             Create a sketcher (wire or face), following the textual description,
2583             passed through theCommand argument.
2584             For format of the description string see geompy.MakeSketcher() method.
2585
2586             Parameters:
2587                 theCommand String, defining the sketcher in local
2588                            coordinates of the working plane.
2589                 theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2590                 theName Object name; when specified, this parameter is used
2591                         for result publication in the study. Otherwise, if automatic
2592                         publication is switched on, default value is used for result name.
2593
2594             Returns:
2595                 New GEOM.GEOM_Object, containing the created wire.
2596             """
2597             theCommand,Parameters = ParseSketcherCommand(theCommand)
2598             anObj = self.CurvesOp.MakeSketcherOnPlane(theCommand, theWorkingPlane)
2599             RaiseIfFailed("MakeSketcherOnPlane", self.CurvesOp)
2600             anObj.SetParameters(Parameters)
2601             self._autoPublish(anObj, theName, "wire")
2602             return anObj
2603
2604         ## Obtain a 2D sketcher interface
2605         #  @return An instance of @ref gsketcher.Sketcher2D "Sketcher2D" interface
2606         def Sketcher2D (self):
2607             """
2608             Obtain a 2D sketcher interface.
2609
2610             Example of usage:
2611                sk = geompy.Sketcher2D()
2612                sk.addPoint(20, 20)
2613                sk.addSegmentRelative(15, 70)
2614                sk.addSegmentPerpY(50)
2615                sk.addArcRadiusRelative(25, 15, 14.5, 0)
2616                sk.addArcCenterAbsolute(1, 1, 50, 50, 0, 0)
2617                sk.addArcDirectionRadiusLength(20, 20, 101, 162.13)
2618                sk.close()
2619                Sketch_1 = sk.wire(geomObj_1)
2620             """
2621             sk = Sketcher2D (self)
2622             return sk
2623
2624         ## Create a sketcher wire, following the numerical description,
2625         #  passed through <VAR>theCoordinates</VAR> argument. \n
2626         #  @param theCoordinates double values, defining points to create a wire,
2627         #                                                      passing from it.
2628         #  @param theName Object name; when specified, this parameter is used
2629         #         for result publication in the study. Otherwise, if automatic
2630         #         publication is switched on, default value is used for result name.
2631         #
2632         #  @return New GEOM.GEOM_Object, containing the created wire.
2633         #
2634         #  @ref tui_3dsketcher_page "Example"
2635         @ManageTransactions("CurvesOp")
2636         def Make3DSketcher(self, theCoordinates, theName=None):
2637             """
2638             Create a sketcher wire, following the numerical description,
2639             passed through theCoordinates argument.
2640
2641             Parameters:
2642                 theCoordinates double values, defining points to create a wire,
2643                                passing from it.
2644                 theName Object name; when specified, this parameter is used
2645                         for result publication in the study. Otherwise, if automatic
2646                         publication is switched on, default value is used for result name.
2647
2648             Returns:
2649                 New GEOM_Object, containing the created wire.
2650             """
2651             theCoordinates,Parameters = ParseParameters(theCoordinates)
2652             anObj = self.CurvesOp.Make3DSketcher(theCoordinates)
2653             RaiseIfFailed("Make3DSketcher", self.CurvesOp)
2654             anObj.SetParameters(Parameters)
2655             self._autoPublish(anObj, theName, "wire")
2656             return anObj
2657
2658         ## Obtain a 3D sketcher interface
2659         #  @return An instance of @ref gsketcher.Sketcher3D "Sketcher3D" interface
2660         #
2661         #  @ref tui_3dsketcher_page "Example"
2662         def Sketcher3D (self):
2663             """
2664             Obtain a 3D sketcher interface.
2665
2666             Example of usage:
2667                 sk = geompy.Sketcher3D()
2668                 sk.addPointsAbsolute(0,0,0, 70,0,0)
2669                 sk.addPointsRelative(0, 0, 130)
2670                 sk.addPointAnglesLength("OXY", 50, 0, 100)
2671                 sk.addPointAnglesLength("OXZ", 30, 80, 130)
2672                 sk.close()
2673                 a3D_Sketcher_1 = sk.wire()
2674             """
2675             sk = Sketcher3D (self)
2676             return sk
2677
2678         ## Obtain a 2D polyline creation interface
2679         #  @return An instance of @ref gsketcher.Polyline2D "Polyline2D" interface
2680         #
2681         #  @ref tui_3dsketcher_page "Example"
2682         def Polyline2D (self):
2683             """
2684             Obtain a 2D polyline creation interface.
2685
2686             Example of usage:
2687                 pl = geompy.Polyline2D()
2688                 pl.addSection("section 1", GEOM.Polyline, True)
2689                 pl.addPoints(0, 0, 10, 0, 10, 10)
2690                 pl.addSection("section 2", GEOM.Interpolation, False)
2691                 pl.addPoints(20, 0, 30, 0, 30, 10)
2692                 resultObj = pl.result(WorkingPlane)
2693             """
2694             pl = Polyline2D (self)
2695             return pl
2696
2697         # end of l3_sketcher
2698         ## @}
2699
2700         ## @addtogroup l3_3d_primitives
2701         ## @{
2702
2703         ## Create a box by coordinates of two opposite vertices.
2704         #
2705         #  @param x1,y1,z1 double values, defining first point it.
2706         #  @param x2,y2,z2 double values, defining first point it.
2707         #  @param theName Object name; when specified, this parameter is used
2708         #         for result publication in the study. Otherwise, if automatic
2709         #         publication is switched on, default value is used for result name.
2710         #
2711         #  @return New GEOM.GEOM_Object, containing the created box.
2712         #
2713         #  @ref tui_creation_box "Example"
2714         def MakeBox(self, x1, y1, z1, x2, y2, z2, theName=None):
2715             """
2716             Create a box by coordinates of two opposite vertices.
2717
2718             Parameters:
2719                 x1,y1,z1 double values, defining first point.
2720                 x2,y2,z2 double values, defining second point.
2721                 theName Object name; when specified, this parameter is used
2722                         for result publication in the study. Otherwise, if automatic
2723                         publication is switched on, default value is used for result name.
2724
2725             Returns:
2726                 New GEOM.GEOM_Object, containing the created box.
2727             """
2728             # Example: see GEOM_TestAll.py
2729             pnt1 = self.MakeVertex(x1,y1,z1)
2730             pnt2 = self.MakeVertex(x2,y2,z2)
2731             # note: auto-publishing is done in self.MakeBoxTwoPnt()
2732             return self.MakeBoxTwoPnt(pnt1, pnt2, theName)
2733
2734         ## Create a box with specified dimensions along the coordinate axes
2735         #  and with edges, parallel to the coordinate axes.
2736         #  Center of the box will be at point (DX/2, DY/2, DZ/2).
2737         #  @param theDX Length of Box edges, parallel to OX axis.
2738         #  @param theDY Length of Box edges, parallel to OY axis.
2739         #  @param theDZ Length of Box edges, parallel to OZ axis.
2740         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created box.
2745         #
2746         #  @ref tui_creation_box "Example"
2747         @ManageTransactions("PrimOp")
2748         def MakeBoxDXDYDZ(self, theDX, theDY, theDZ, theName=None):
2749             """
2750             Create a box with specified dimensions along the coordinate axes
2751             and with edges, parallel to the coordinate axes.
2752             Center of the box will be at point (DX/2, DY/2, DZ/2).
2753
2754             Parameters:
2755                 theDX Length of Box edges, parallel to OX axis.
2756                 theDY Length of Box edges, parallel to OY axis.
2757                 theDZ Length of Box edges, parallel to OZ axis.
2758                 theName Object name; when specified, this parameter is used
2759                         for result publication in the study. Otherwise, if automatic
2760                         publication is switched on, default value is used for result name.
2761
2762             Returns:
2763                 New GEOM.GEOM_Object, containing the created box.
2764             """
2765             # Example: see GEOM_TestAll.py
2766             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
2767             anObj = self.PrimOp.MakeBoxDXDYDZ(theDX, theDY, theDZ)
2768             RaiseIfFailed("MakeBoxDXDYDZ", self.PrimOp)
2769             anObj.SetParameters(Parameters)
2770             self._autoPublish(anObj, theName, "box")
2771             return anObj
2772
2773         ## Create a box with two specified opposite vertices,
2774         #  and with edges, parallel to the coordinate axes
2775         #  @param thePnt1 First of two opposite vertices.
2776         #  @param thePnt2 Second of two opposite vertices.
2777         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created box.
2782         #
2783         #  @ref tui_creation_box "Example"
2784         @ManageTransactions("PrimOp")
2785         def MakeBoxTwoPnt(self, thePnt1, thePnt2, theName=None):
2786             """
2787             Create a box with two specified opposite vertices,
2788             and with edges, parallel to the coordinate axes
2789
2790             Parameters:
2791                 thePnt1 First of two opposite vertices.
2792                 thePnt2 Second of two opposite vertices.
2793                 theName Object name; when specified, this parameter is used
2794                         for result publication in the study. Otherwise, if automatic
2795                         publication is switched on, default value is used for result name.
2796
2797             Returns:
2798                 New GEOM.GEOM_Object, containing the created box.
2799             """
2800             # Example: see GEOM_TestAll.py
2801             anObj = self.PrimOp.MakeBoxTwoPnt(thePnt1, thePnt2)
2802             RaiseIfFailed("MakeBoxTwoPnt", self.PrimOp)
2803             self._autoPublish(anObj, theName, "box")
2804             return anObj
2805
2806         ## Create a face with specified dimensions with edges parallel to coordinate axes.
2807         #  @param theH height of Face.
2808         #  @param theW width of Face.
2809         #  @param theOrientation face orientation: 1-OXY, 2-OYZ, 3-OZX
2810         #  @param theName Object name; when specified, this parameter is used
2811         #         for result publication in the study. Otherwise, if automatic
2812         #         publication is switched on, default value is used for result name.
2813         #
2814         #  @return New GEOM.GEOM_Object, containing the created face.
2815         #
2816         #  @ref tui_creation_face "Example"
2817         @ManageTransactions("PrimOp")
2818         def MakeFaceHW(self, theH, theW, theOrientation, theName=None):
2819             """
2820             Create a face with specified dimensions with edges parallel to coordinate axes.
2821
2822             Parameters:
2823                 theH height of Face.
2824                 theW width of Face.
2825                 theOrientation face orientation: 1-OXY, 2-OYZ, 3-OZX
2826                 theName Object name; when specified, this parameter is used
2827                         for result publication in the study. Otherwise, if automatic
2828                         publication is switched on, default value is used for result name.
2829
2830             Returns:
2831                 New GEOM.GEOM_Object, containing the created face.
2832             """
2833             # Example: see GEOM_TestAll.py
2834             theH,theW,Parameters = ParseParameters(theH, theW)
2835             anObj = self.PrimOp.MakeFaceHW(theH, theW, theOrientation)
2836             RaiseIfFailed("MakeFaceHW", self.PrimOp)
2837             anObj.SetParameters(Parameters)
2838             self._autoPublish(anObj, theName, "rectangle")
2839             return anObj
2840
2841         ## Create a face from another plane and two sizes,
2842         #  vertical size and horisontal size.
2843         #  @param theObj   Normale vector to the creating face or
2844         #  the face object.
2845         #  @param theH     Height (vertical size).
2846         #  @param theW     Width (horisontal size).
2847         #  @param theName Object name; when specified, this parameter is used
2848         #         for result publication in the study. Otherwise, if automatic
2849         #         publication is switched on, default value is used for result name.
2850         #
2851         #  @return New GEOM.GEOM_Object, containing the created face.
2852         #
2853         #  @ref tui_creation_face "Example"
2854         @ManageTransactions("PrimOp")
2855         def MakeFaceObjHW(self, theObj, theH, theW, theName=None):
2856             """
2857             Create a face from another plane and two sizes,
2858             vertical size and horisontal size.
2859
2860             Parameters:
2861                 theObj   Normale vector to the creating face or
2862                          the face object.
2863                 theH     Height (vertical size).
2864                 theW     Width (horisontal size).
2865                 theName Object name; when specified, this parameter is used
2866                         for result publication in the study. Otherwise, if automatic
2867                         publication is switched on, default value is used for result name.
2868
2869             Returns:
2870                 New GEOM_Object, containing the created face.
2871             """
2872             # Example: see GEOM_TestAll.py
2873             theH,theW,Parameters = ParseParameters(theH, theW)
2874             anObj = self.PrimOp.MakeFaceObjHW(theObj, theH, theW)
2875             RaiseIfFailed("MakeFaceObjHW", self.PrimOp)
2876             anObj.SetParameters(Parameters)
2877             self._autoPublish(anObj, theName, "rectangle")
2878             return anObj
2879
2880         ## Create a disk with given center, normal vector and radius.
2881         #  @param thePnt Disk center.
2882         #  @param theVec Vector, normal to the plane of the disk.
2883         #  @param theR Disk radius.
2884         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created disk.
2889         #
2890         #  @ref tui_creation_disk "Example"
2891         @ManageTransactions("PrimOp")
2892         def MakeDiskPntVecR(self, thePnt, theVec, theR, theName=None):
2893             """
2894             Create a disk with given center, normal vector and radius.
2895
2896             Parameters:
2897                 thePnt Disk center.
2898                 theVec Vector, normal to the plane of the disk.
2899                 theR Disk radius.
2900                 theName Object name; when specified, this parameter is used
2901                         for result publication in the study. Otherwise, if automatic
2902                         publication is switched on, default value is used for result name.
2903
2904             Returns:
2905                 New GEOM.GEOM_Object, containing the created disk.
2906             """
2907             # Example: see GEOM_TestAll.py
2908             theR,Parameters = ParseParameters(theR)
2909             anObj = self.PrimOp.MakeDiskPntVecR(thePnt, theVec, theR)
2910             RaiseIfFailed("MakeDiskPntVecR", self.PrimOp)
2911             anObj.SetParameters(Parameters)
2912             self._autoPublish(anObj, theName, "disk")
2913             return anObj
2914
2915         ## Create a disk, passing through three given points
2916         #  @param thePnt1,thePnt2,thePnt3 Points, defining the disk.
2917         #  @param theName Object name; when specified, this parameter is used
2918         #         for result publication in the study. Otherwise, if automatic
2919         #         publication is switched on, default value is used for result name.
2920         #
2921         #  @return New GEOM.GEOM_Object, containing the created disk.
2922         #
2923         #  @ref tui_creation_disk "Example"
2924         @ManageTransactions("PrimOp")
2925         def MakeDiskThreePnt(self, thePnt1, thePnt2, thePnt3, theName=None):
2926             """
2927             Create a disk, passing through three given points
2928
2929             Parameters:
2930                 thePnt1,thePnt2,thePnt3 Points, defining the disk.
2931                 theName Object name; when specified, this parameter is used
2932                         for result publication in the study. Otherwise, if automatic
2933                         publication is switched on, default value is used for result name.
2934
2935             Returns:
2936                 New GEOM.GEOM_Object, containing the created disk.
2937             """
2938             # Example: see GEOM_TestAll.py
2939             anObj = self.PrimOp.MakeDiskThreePnt(thePnt1, thePnt2, thePnt3)
2940             RaiseIfFailed("MakeDiskThreePnt", self.PrimOp)
2941             self._autoPublish(anObj, theName, "disk")
2942             return anObj
2943
2944         ## Create a disk with specified dimensions along OX-OY coordinate axes.
2945         #  @param theR Radius of Face.
2946         #  @param theOrientation set the orientation belong axis OXY or OYZ or OZX
2947         #  @param theName Object name; when specified, this parameter is used
2948         #         for result publication in the study. Otherwise, if automatic
2949         #         publication is switched on, default value is used for result name.
2950         #
2951         #  @return New GEOM.GEOM_Object, containing the created disk.
2952         #
2953         #  @ref tui_creation_face "Example"
2954         @ManageTransactions("PrimOp")
2955         def MakeDiskR(self, theR, theOrientation, theName=None):
2956             """
2957             Create a disk with specified dimensions along OX-OY coordinate axes.
2958
2959             Parameters:
2960                 theR Radius of Face.
2961                 theOrientation set the orientation belong axis OXY or OYZ or OZX
2962                 theName Object name; when specified, this parameter is used
2963                         for result publication in the study. Otherwise, if automatic
2964                         publication is switched on, default value is used for result name.
2965
2966             Returns:
2967                 New GEOM.GEOM_Object, containing the created disk.
2968
2969             Example of usage:
2970                 Disk3 = geompy.MakeDiskR(100., 1)
2971             """
2972             # Example: see GEOM_TestAll.py
2973             theR,Parameters = ParseParameters(theR)
2974             anObj = self.PrimOp.MakeDiskR(theR, theOrientation)
2975             RaiseIfFailed("MakeDiskR", self.PrimOp)
2976             anObj.SetParameters(Parameters)
2977             self._autoPublish(anObj, theName, "disk")
2978             return anObj
2979
2980         ## Create a cylinder with given base point, axis, radius and height.
2981         #  @param thePnt Central point of cylinder base.
2982         #  @param theAxis Cylinder axis.
2983         #  @param theR Cylinder radius.
2984         #  @param theH Cylinder height.
2985         #  @param theName Object name; when specified, this parameter is used
2986         #         for result publication in the study. Otherwise, if automatic
2987         #         publication is switched on, default value is used for result name.
2988         #
2989         #  @return New GEOM.GEOM_Object, containing the created cylinder.
2990         #
2991         #  @ref tui_creation_cylinder "Example"
2992         @ManageTransactions("PrimOp")
2993         def MakeCylinder(self, thePnt, theAxis, theR, theH, theName=None):
2994             """
2995             Create a cylinder with given base point, axis, radius and height.
2996
2997             Parameters:
2998                 thePnt Central point of cylinder base.
2999                 theAxis Cylinder axis.
3000                 theR Cylinder radius.
3001                 theH Cylinder height.
3002                 theName Object name; when specified, this parameter is used
3003                         for result publication in the study. Otherwise, if automatic
3004                         publication is switched on, default value is used for result name.
3005
3006             Returns:
3007                 New GEOM.GEOM_Object, containing the created cylinder.
3008             """
3009             # Example: see GEOM_TestAll.py
3010             theR,theH,Parameters = ParseParameters(theR, theH)
3011             anObj = self.PrimOp.MakeCylinderPntVecRH(thePnt, theAxis, theR, theH)
3012             RaiseIfFailed("MakeCylinderPntVecRH", self.PrimOp)
3013             anObj.SetParameters(Parameters)
3014             self._autoPublish(anObj, theName, "cylinder")
3015             return anObj
3016             
3017         ## Create a portion of cylinder with given base point, axis, radius, height and angle.
3018         #  @param thePnt Central point of cylinder base.
3019         #  @param theAxis Cylinder axis.
3020         #  @param theR Cylinder radius.
3021         #  @param theH Cylinder height.
3022         #  @param theA Cylinder angle in radians.
3023         #  @param theName Object name; when specified, this parameter is used
3024         #         for result publication in the study. Otherwise, if automatic
3025         #         publication is switched on, default value is used for result name.
3026         #
3027         #  @return New GEOM.GEOM_Object, containing the created cylinder.
3028         #
3029         #  @ref tui_creation_cylinder "Example"
3030         @ManageTransactions("PrimOp")
3031         def MakeCylinderA(self, thePnt, theAxis, theR, theH, theA, theName=None):
3032             """
3033             Create a portion of cylinder with given base point, axis, radius, height and angle.
3034
3035             Parameters:
3036                 thePnt Central point of cylinder base.
3037                 theAxis Cylinder axis.
3038                 theR Cylinder radius.
3039                 theH Cylinder height.
3040                 theA Cylinder angle in radians.
3041                 theName Object name; when specified, this parameter is used
3042                         for result publication in the study. Otherwise, if automatic
3043                         publication is switched on, default value is used for result name.
3044
3045             Returns:
3046                 New GEOM.GEOM_Object, containing the created cylinder.
3047             """
3048             # Example: see GEOM_TestAll.py
3049             flag = False
3050             if isinstance(theA,str):
3051                 flag = True
3052             theR,theH,theA,Parameters = ParseParameters(theR, theH, theA)
3053             if flag:
3054                 theA = theA*math.pi/180.
3055             anObj = self.PrimOp.MakeCylinderPntVecRHA(thePnt, theAxis, theR, theH, theA)
3056             RaiseIfFailed("MakeCylinderPntVecRHA", self.PrimOp)
3057             anObj.SetParameters(Parameters)
3058             self._autoPublish(anObj, theName, "cylinder")
3059             return anObj
3060
3061         ## Create a cylinder with given radius and height at
3062         #  the origin of coordinate system. Axis of the cylinder
3063         #  will be collinear to the OZ axis of the coordinate system.
3064         #  @param theR Cylinder radius.
3065         #  @param theH Cylinder height.
3066         #  @param theName Object name; when specified, this parameter is used
3067         #         for result publication in the study. Otherwise, if automatic
3068         #         publication is switched on, default value is used for result name.
3069         #
3070         #  @return New GEOM.GEOM_Object, containing the created cylinder.
3071         #
3072         #  @ref tui_creation_cylinder "Example"
3073         @ManageTransactions("PrimOp")
3074         def MakeCylinderRH(self, theR, theH, theName=None):
3075             """
3076             Create a cylinder with given radius and height at
3077             the origin of coordinate system. Axis of the cylinder
3078             will be collinear to the OZ axis of the coordinate system.
3079
3080             Parameters:
3081                 theR Cylinder radius.
3082                 theH Cylinder height.
3083                 theName Object name; when specified, this parameter is used
3084                         for result publication in the study. Otherwise, if automatic
3085                         publication is switched on, default value is used for result name.
3086
3087             Returns:
3088                 New GEOM.GEOM_Object, containing the created cylinder.
3089             """
3090             # Example: see GEOM_TestAll.py
3091             theR,theH,Parameters = ParseParameters(theR, theH)
3092             anObj = self.PrimOp.MakeCylinderRH(theR, theH)
3093             RaiseIfFailed("MakeCylinderRH", self.PrimOp)
3094             anObj.SetParameters(Parameters)
3095             self._autoPublish(anObj, theName, "cylinder")
3096             return anObj
3097             
3098         ## Create a portion of cylinder with given radius, height and angle at
3099         #  the origin of coordinate system. Axis of the cylinder
3100         #  will be collinear to the OZ axis of the coordinate system.
3101         #  @param theR Cylinder radius.
3102         #  @param theH Cylinder height.
3103         #  @param theA Cylinder angle in radians.
3104         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created cylinder.
3109         #
3110         #  @ref tui_creation_cylinder "Example"
3111         @ManageTransactions("PrimOp")
3112         def MakeCylinderRHA(self, theR, theH, theA, theName=None):
3113             """
3114             Create a portion of cylinder with given radius, height and angle at
3115             the origin of coordinate system. Axis of the cylinder
3116             will be collinear to the OZ axis of the coordinate system.
3117
3118             Parameters:
3119                 theR Cylinder radius.
3120                 theH Cylinder height.
3121                 theA Cylinder angle in radians.
3122                 theName Object name; when specified, this parameter is used
3123                         for result publication in the study. Otherwise, if automatic
3124                         publication is switched on, default value is used for result name.
3125
3126             Returns:
3127                 New GEOM.GEOM_Object, containing the created cylinder.
3128             """
3129             # Example: see GEOM_TestAll.py
3130             flag = False
3131             if isinstance(theA,str):
3132                 flag = True
3133             theR,theH,theA,Parameters = ParseParameters(theR, theH, theA)
3134             if flag:
3135                 theA = theA*math.pi/180.
3136             anObj = self.PrimOp.MakeCylinderRHA(theR, theH, theA)
3137             RaiseIfFailed("MakeCylinderRHA", self.PrimOp)
3138             anObj.SetParameters(Parameters)
3139             self._autoPublish(anObj, theName, "cylinder")
3140             return anObj
3141
3142         ## Create a sphere with given center and radius.
3143         #  @param thePnt Sphere center.
3144         #  @param theR Sphere radius.
3145         #  @param theName Object name; when specified, this parameter is used
3146         #         for result publication in the study. Otherwise, if automatic
3147         #         publication is switched on, default value is used for result name.
3148         #
3149         #  @return New GEOM.GEOM_Object, containing the created sphere.
3150         #
3151         #  @ref tui_creation_sphere "Example"
3152         @ManageTransactions("PrimOp")
3153         def MakeSpherePntR(self, thePnt, theR, theName=None):
3154             """
3155             Create a sphere with given center and radius.
3156
3157             Parameters:
3158                 thePnt Sphere center.
3159                 theR Sphere radius.
3160                 theName Object name; when specified, this parameter is used
3161                         for result publication in the study. Otherwise, if automatic
3162                         publication is switched on, default value is used for result name.
3163
3164             Returns:
3165                 New GEOM.GEOM_Object, containing the created sphere.
3166             """
3167             # Example: see GEOM_TestAll.py
3168             theR,Parameters = ParseParameters(theR)
3169             anObj = self.PrimOp.MakeSpherePntR(thePnt, theR)
3170             RaiseIfFailed("MakeSpherePntR", self.PrimOp)
3171             anObj.SetParameters(Parameters)
3172             self._autoPublish(anObj, theName, "sphere")
3173             return anObj
3174
3175         ## Create a sphere with given center and radius.
3176         #  @param x,y,z Coordinates of sphere center.
3177         #  @param theR Sphere radius.
3178         #  @param theName Object name; when specified, this parameter is used
3179         #         for result publication in the study. Otherwise, if automatic
3180         #         publication is switched on, default value is used for result name.
3181         #
3182         #  @return New GEOM.GEOM_Object, containing the created sphere.
3183         #
3184         #  @ref tui_creation_sphere "Example"
3185         def MakeSphere(self, x, y, z, theR, theName=None):
3186             """
3187             Create a sphere with given center and radius.
3188
3189             Parameters:
3190                 x,y,z Coordinates of sphere center.
3191                 theR Sphere radius.
3192                 theName Object name; when specified, this parameter is used
3193                         for result publication in the study. Otherwise, if automatic
3194                         publication is switched on, default value is used for result name.
3195
3196             Returns:
3197                 New GEOM.GEOM_Object, containing the created sphere.
3198             """
3199             # Example: see GEOM_TestAll.py
3200             point = self.MakeVertex(x, y, z)
3201             # note: auto-publishing is done in self.MakeSpherePntR()
3202             anObj = self.MakeSpherePntR(point, theR, theName)
3203             return anObj
3204
3205         ## Create a sphere with given radius at the origin of coordinate system.
3206         #  @param theR Sphere radius.
3207         #  @param theName Object name; when specified, this parameter is used
3208         #         for result publication in the study. Otherwise, if automatic
3209         #         publication is switched on, default value is used for result name.
3210         #
3211         #  @return New GEOM.GEOM_Object, containing the created sphere.
3212         #
3213         #  @ref tui_creation_sphere "Example"
3214         @ManageTransactions("PrimOp")
3215         def MakeSphereR(self, theR, theName=None):
3216             """
3217             Create a sphere with given radius at the origin of coordinate system.
3218
3219             Parameters:
3220                 theR Sphere radius.
3221                 theName Object name; when specified, this parameter is used
3222                         for result publication in the study. Otherwise, if automatic
3223                         publication is switched on, default value is used for result name.
3224
3225             Returns:
3226                 New GEOM.GEOM_Object, containing the created sphere.
3227             """
3228             # Example: see GEOM_TestAll.py
3229             theR,Parameters = ParseParameters(theR)
3230             anObj = self.PrimOp.MakeSphereR(theR)
3231             RaiseIfFailed("MakeSphereR", self.PrimOp)
3232             anObj.SetParameters(Parameters)
3233             self._autoPublish(anObj, theName, "sphere")
3234             return anObj
3235
3236         ## Create a cone with given base point, axis, height and radiuses.
3237         #  @param thePnt Central point of the first cone base.
3238         #  @param theAxis Cone axis.
3239         #  @param theR1 Radius of the first cone base.
3240         #  @param theR2 Radius of the second cone base.
3241         #    \note If both radiuses are non-zero, the cone will be truncated.
3242         #    \note If the radiuses are equal, a cylinder will be created instead.
3243         #  @param theH Cone height.
3244         #  @param 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         #  @return New GEOM.GEOM_Object, containing the created cone.
3249         #
3250         #  @ref tui_creation_cone "Example"
3251         @ManageTransactions("PrimOp")
3252         def MakeCone(self, thePnt, theAxis, theR1, theR2, theH, theName=None):
3253             """
3254             Create a cone with given base point, axis, height and radiuses.
3255
3256             Parameters:
3257                 thePnt Central point of the first cone base.
3258                 theAxis Cone axis.
3259                 theR1 Radius of the first cone base.
3260                 theR2 Radius of the second cone base.
3261                 theH Cone height.
3262                 theName Object name; when specified, this parameter is used
3263                         for result publication in the study. Otherwise, if automatic
3264                         publication is switched on, default value is used for result name.
3265
3266             Note:
3267                 If both radiuses are non-zero, the cone will be truncated.
3268                 If the radiuses are equal, a cylinder will be created instead.
3269
3270             Returns:
3271                 New GEOM.GEOM_Object, containing the created cone.
3272             """
3273             # Example: see GEOM_TestAll.py
3274             theR1,theR2,theH,Parameters = ParseParameters(theR1,theR2,theH)
3275             anObj = self.PrimOp.MakeConePntVecR1R2H(thePnt, theAxis, theR1, theR2, theH)
3276             RaiseIfFailed("MakeConePntVecR1R2H", self.PrimOp)
3277             anObj.SetParameters(Parameters)
3278             self._autoPublish(anObj, theName, "cone")
3279             return anObj
3280
3281         ## Create a cone with given height and radiuses at
3282         #  the origin of coordinate system. Axis of the cone will
3283         #  be collinear to the OZ axis of the coordinate system.
3284         #  @param theR1 Radius of the first cone base.
3285         #  @param theR2 Radius of the second cone base.
3286         #    \note If both radiuses are non-zero, the cone will be truncated.
3287         #    \note If the radiuses are equal, a cylinder will be created instead.
3288         #  @param theH Cone height.
3289         #  @param theName Object name; when specified, this parameter is used
3290         #         for result publication in the study. Otherwise, if automatic
3291         #         publication is switched on, default value is used for result name.
3292         #
3293         #  @return New GEOM.GEOM_Object, containing the created cone.
3294         #
3295         #  @ref tui_creation_cone "Example"
3296         @ManageTransactions("PrimOp")
3297         def MakeConeR1R2H(self, theR1, theR2, theH, theName=None):
3298             """
3299             Create a cone with given height and radiuses at
3300             the origin of coordinate system. Axis of the cone will
3301             be collinear to the OZ axis of the coordinate system.
3302
3303             Parameters:
3304                 theR1 Radius of the first cone base.
3305                 theR2 Radius of the second cone base.
3306                 theH Cone height.
3307                 theName Object name; when specified, this parameter is used
3308                         for result publication in the study. Otherwise, if automatic
3309                         publication is switched on, default value is used for result name.
3310
3311             Note:
3312                 If both radiuses are non-zero, the cone will be truncated.
3313                 If the radiuses are equal, a cylinder will be created instead.
3314
3315             Returns:
3316                 New GEOM.GEOM_Object, containing the created cone.
3317             """
3318             # Example: see GEOM_TestAll.py
3319             theR1,theR2,theH,Parameters = ParseParameters(theR1,theR2,theH)
3320             anObj = self.PrimOp.MakeConeR1R2H(theR1, theR2, theH)
3321             RaiseIfFailed("MakeConeR1R2H", self.PrimOp)
3322             anObj.SetParameters(Parameters)
3323             self._autoPublish(anObj, theName, "cone")
3324             return anObj
3325
3326         ## Create a torus with given center, normal vector and radiuses.
3327         #  @param thePnt Torus central point.
3328         #  @param theVec Torus axis of symmetry.
3329         #  @param theRMajor Torus major radius.
3330         #  @param theRMinor Torus minor radius.
3331         #  @param theName Object name; when specified, this parameter is used
3332         #         for result publication in the study. Otherwise, if automatic
3333         #         publication is switched on, default value is used for result name.
3334         #
3335         #  @return New GEOM.GEOM_Object, containing the created torus.
3336         #
3337         #  @ref tui_creation_torus "Example"
3338         @ManageTransactions("PrimOp")
3339         def MakeTorus(self, thePnt, theVec, theRMajor, theRMinor, theName=None):
3340             """
3341             Create a torus with given center, normal vector and radiuses.
3342
3343             Parameters:
3344                 thePnt Torus central point.
3345                 theVec Torus axis of symmetry.
3346                 theRMajor Torus major radius.
3347                 theRMinor Torus minor radius.
3348                 theName Object name; when specified, this parameter is used
3349                         for result publication in the study. Otherwise, if automatic
3350                         publication is switched on, default value is used for result name.
3351
3352            Returns:
3353                 New GEOM.GEOM_Object, containing the created torus.
3354             """
3355             # Example: see GEOM_TestAll.py
3356             theRMajor,theRMinor,Parameters = ParseParameters(theRMajor,theRMinor)
3357             anObj = self.PrimOp.MakeTorusPntVecRR(thePnt, theVec, theRMajor, theRMinor)
3358             RaiseIfFailed("MakeTorusPntVecRR", self.PrimOp)
3359             anObj.SetParameters(Parameters)
3360             self._autoPublish(anObj, theName, "torus")
3361             return anObj
3362
3363         ## Create a torus with given radiuses at the origin of coordinate system.
3364         #  @param theRMajor Torus major radius.
3365         #  @param theRMinor Torus minor radius.
3366         #  @param theName Object name; when specified, this parameter is used
3367         #         for result publication in the study. Otherwise, if automatic
3368         #         publication is switched on, default value is used for result name.
3369         #
3370         #  @return New GEOM.GEOM_Object, containing the created torus.
3371         #
3372         #  @ref tui_creation_torus "Example"
3373         @ManageTransactions("PrimOp")
3374         def MakeTorusRR(self, theRMajor, theRMinor, theName=None):
3375             """
3376            Create a torus with given radiuses at the origin of coordinate system.
3377
3378            Parameters:
3379                 theRMajor Torus major radius.
3380                 theRMinor Torus minor radius.
3381                 theName Object name; when specified, this parameter is used
3382                         for result publication in the study. Otherwise, if automatic
3383                         publication is switched on, default value is used for result name.
3384
3385            Returns:
3386                 New GEOM.GEOM_Object, containing the created torus.
3387             """
3388             # Example: see GEOM_TestAll.py
3389             theRMajor,theRMinor,Parameters = ParseParameters(theRMajor,theRMinor)
3390             anObj = self.PrimOp.MakeTorusRR(theRMajor, theRMinor)
3391             RaiseIfFailed("MakeTorusRR", self.PrimOp)
3392             anObj.SetParameters(Parameters)
3393             self._autoPublish(anObj, theName, "torus")
3394             return anObj
3395
3396         # end of l3_3d_primitives
3397         ## @}
3398
3399         ## @addtogroup l3_complex
3400         ## @{
3401
3402         ## Create a shape by extrusion of the base shape along a vector, defined by two points.
3403         #  @param theBase Base shape to be extruded.
3404         #  @param thePoint1 First end of extrusion vector.
3405         #  @param thePoint2 Second end of extrusion vector.
3406         #  @param theScaleFactor Use it to make prism with scaled second base.
3407         #                        Nagative value means not scaled second base.
3408         #  @param theName Object name; when specified, this parameter is used
3409         #         for result publication in the study. Otherwise, if automatic
3410         #         publication is switched on, default value is used for result name.
3411         #
3412         #  @return New GEOM.GEOM_Object, containing the created prism.
3413         #
3414         #  @ref tui_creation_prism "Example"
3415         @ManageTransactions("PrimOp")
3416         def MakePrism(self, theBase, thePoint1, thePoint2, theScaleFactor = -1.0, theName=None):
3417             """
3418             Create a shape by extrusion of the base shape along a vector, defined by two points.
3419
3420             Parameters:
3421                 theBase Base shape to be extruded.
3422                 thePoint1 First end of extrusion vector.
3423                 thePoint2 Second end of extrusion vector.
3424                 theScaleFactor Use it to make prism with scaled second base.
3425                                Nagative value means not scaled second base.
3426                 theName Object name; when specified, this parameter is used
3427                         for result publication in the study. Otherwise, if automatic
3428                         publication is switched on, default value is used for result name.
3429
3430             Returns:
3431                 New GEOM.GEOM_Object, containing the created prism.
3432             """
3433             # Example: see GEOM_TestAll.py
3434             anObj = None
3435             Parameters = ""
3436             if theScaleFactor > 0:
3437                 theScaleFactor,Parameters = ParseParameters(theScaleFactor)
3438                 anObj = self.PrimOp.MakePrismTwoPntWithScaling(theBase, thePoint1, thePoint2, theScaleFactor)
3439             else:
3440                 anObj = self.PrimOp.MakePrismTwoPnt(theBase, thePoint1, thePoint2)
3441             RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
3442             anObj.SetParameters(Parameters)
3443             self._autoPublish(anObj, theName, "prism")
3444             return anObj
3445
3446         ## Create a shape by extrusion of the base shape along a
3447         #  vector, defined by two points, in 2 Ways (forward/backward).
3448         #  @param theBase Base shape to be extruded.
3449         #  @param thePoint1 First end of extrusion vector.
3450         #  @param thePoint2 Second end of extrusion vector.
3451         #  @param theName Object name; when specified, this parameter is used
3452         #         for result publication in the study. Otherwise, if automatic
3453         #         publication is switched on, default value is used for result name.
3454         #
3455         #  @return New GEOM.GEOM_Object, containing the created prism.
3456         #
3457         #  @ref tui_creation_prism "Example"
3458         @ManageTransactions("PrimOp")
3459         def MakePrism2Ways(self, theBase, thePoint1, thePoint2, theName=None):
3460             """
3461             Create a shape by extrusion of the base shape along a
3462             vector, defined by two points, in 2 Ways (forward/backward).
3463
3464             Parameters:
3465                 theBase Base shape to be extruded.
3466                 thePoint1 First end of extrusion vector.
3467                 thePoint2 Second end of extrusion vector.
3468                 theName Object name; when specified, this parameter is used
3469                         for result publication in the study. Otherwise, if automatic
3470                         publication is switched on, default value is used for result name.
3471
3472             Returns:
3473                 New GEOM.GEOM_Object, containing the created prism.
3474             """
3475             # Example: see GEOM_TestAll.py
3476             anObj = self.PrimOp.MakePrismTwoPnt2Ways(theBase, thePoint1, thePoint2)
3477             RaiseIfFailed("MakePrismTwoPnt", self.PrimOp)
3478             self._autoPublish(anObj, theName, "prism")
3479             return anObj
3480
3481         ## Create a shape by extrusion of the base shape along the vector,
3482         #  i.e. all the space, transfixed by the base shape during its translation
3483         #  along the vector on the given distance.
3484         #  @param theBase Base shape to be extruded.
3485         #  @param theVec Direction of extrusion.
3486         #  @param theH Prism dimension along theVec.
3487         #  @param theScaleFactor Use it to make prism with scaled second base.
3488         #                        Negative value means not scaled second base.
3489         #  @param theName Object name; when specified, this parameter is used
3490         #         for result publication in the study. Otherwise, if automatic
3491         #         publication is switched on, default value is used for result name.
3492         #
3493         #  @return New GEOM.GEOM_Object, containing the created prism.
3494         #
3495         #  @ref tui_creation_prism "Example"
3496         @ManageTransactions("PrimOp")
3497         def MakePrismVecH(self, theBase, theVec, theH, theScaleFactor = -1.0, theName=None):
3498             """
3499             Create a shape by extrusion of the base shape along the vector,
3500             i.e. all the space, transfixed by the base shape during its translation
3501             along the vector on the given distance.
3502
3503             Parameters:
3504                 theBase Base shape to be extruded.
3505                 theVec Direction of extrusion.
3506                 theH Prism dimension along theVec.
3507                 theScaleFactor Use it to make prism with scaled second base.
3508                                Negative value means not scaled second base.
3509                 theName Object name; when specified, this parameter is used
3510                         for result publication in the study. Otherwise, if automatic
3511                         publication is switched on, default value is used for result name.
3512
3513             Returns:
3514                 New GEOM.GEOM_Object, containing the created prism.
3515             """
3516             # Example: see GEOM_TestAll.py
3517             anObj = None
3518             Parameters = ""
3519             if theScaleFactor > 0:
3520                 theH,theScaleFactor,Parameters = ParseParameters(theH,theScaleFactor)
3521                 anObj = self.PrimOp.MakePrismVecHWithScaling(theBase, theVec, theH, theScaleFactor)
3522             else:
3523                 theH,Parameters = ParseParameters(theH)
3524                 anObj = self.PrimOp.MakePrismVecH(theBase, theVec, theH)
3525             RaiseIfFailed("MakePrismVecH", self.PrimOp)
3526             anObj.SetParameters(Parameters)
3527             self._autoPublish(anObj, theName, "prism")
3528             return anObj
3529
3530         ## Create a shape by extrusion of the base shape along the vector,
3531         #  i.e. all the space, transfixed by the base shape during its translation
3532         #  along the vector on the given distance in 2 Ways (forward/backward).
3533         #  @param theBase Base shape to be extruded.
3534         #  @param theVec Direction of extrusion.
3535         #  @param theH Prism dimension along theVec in forward direction.
3536         #  @param theName Object name; when specified, this parameter is used
3537         #         for result publication in the study. Otherwise, if automatic
3538         #         publication is switched on, default value is used for result name.
3539         #
3540         #  @return New GEOM.GEOM_Object, containing the created prism.
3541         #
3542         #  @ref tui_creation_prism "Example"
3543         @ManageTransactions("PrimOp")
3544         def MakePrismVecH2Ways(self, theBase, theVec, theH, theName=None):
3545             """
3546             Create a shape by extrusion of the base shape along the vector,
3547             i.e. all the space, transfixed by the base shape during its translation
3548             along the vector on the given distance in 2 Ways (forward/backward).
3549
3550             Parameters:
3551                 theBase Base shape to be extruded.
3552                 theVec Direction of extrusion.
3553                 theH Prism dimension along theVec in forward direction.
3554                 theName Object name; when specified, this parameter is used
3555                         for result publication in the study. Otherwise, if automatic
3556                         publication is switched on, default value is used for result name.
3557
3558             Returns:
3559                 New GEOM.GEOM_Object, containing the created prism.
3560             """
3561             # Example: see GEOM_TestAll.py
3562             theH,Parameters = ParseParameters(theH)
3563             anObj = self.PrimOp.MakePrismVecH2Ways(theBase, theVec, theH)
3564             RaiseIfFailed("MakePrismVecH2Ways", self.PrimOp)
3565             anObj.SetParameters(Parameters)
3566             self._autoPublish(anObj, theName, "prism")
3567             return anObj
3568
3569         ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
3570         #  @param theBase Base shape to be extruded.
3571         #  @param theDX, theDY, theDZ Directions of extrusion.
3572         #  @param theScaleFactor Use it to make prism with scaled second base.
3573         #                        Nagative value means not scaled second base.
3574         #  @param theName Object name; when specified, this parameter is used
3575         #         for result publication in the study. Otherwise, if automatic
3576         #         publication is switched on, default value is used for result name.
3577         #
3578         #  @return New GEOM.GEOM_Object, containing the created prism.
3579         #
3580         #  @ref tui_creation_prism "Example"
3581         @ManageTransactions("PrimOp")
3582         def MakePrismDXDYDZ(self, theBase, theDX, theDY, theDZ, theScaleFactor = -1.0, theName=None):
3583             """
3584             Create a shape by extrusion of the base shape along the dx, dy, dz direction
3585
3586             Parameters:
3587                 theBase Base shape to be extruded.
3588                 theDX, theDY, theDZ Directions of extrusion.
3589                 theScaleFactor Use it to make prism with scaled second base.
3590                                Nagative value means not scaled second base.
3591                 theName Object name; when specified, this parameter is used
3592                         for result publication in the study. Otherwise, if automatic
3593                         publication is switched on, default value is used for result name.
3594
3595             Returns:
3596                 New GEOM.GEOM_Object, containing the created prism.
3597             """
3598             # Example: see GEOM_TestAll.py
3599             anObj = None
3600             Parameters = ""
3601             if theScaleFactor > 0:
3602                 theDX,theDY,theDZ,theScaleFactor,Parameters = ParseParameters(theDX, theDY, theDZ, theScaleFactor)
3603                 anObj = self.PrimOp.MakePrismDXDYDZWithScaling(theBase, theDX, theDY, theDZ, theScaleFactor)
3604             else:
3605                 theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
3606                 anObj = self.PrimOp.MakePrismDXDYDZ(theBase, theDX, theDY, theDZ)
3607             RaiseIfFailed("MakePrismDXDYDZ", self.PrimOp)
3608             anObj.SetParameters(Parameters)
3609             self._autoPublish(anObj, theName, "prism")
3610             return anObj
3611
3612         ## Create a shape by extrusion of the base shape along the dx, dy, dz direction
3613         #  i.e. all the space, transfixed by the base shape during its translation
3614         #  along the vector on the given distance in 2 Ways (forward/backward).
3615         #  @param theBase Base shape to be extruded.
3616         #  @param theDX, theDY, theDZ Directions of extrusion.
3617         #  @param theName Object name; when specified, this parameter is used
3618         #         for result publication in the study. Otherwise, if automatic
3619         #         publication is switched on, default value is used for result name.
3620         #
3621         #  @return New GEOM.GEOM_Object, containing the created prism.
3622         #
3623         #  @ref tui_creation_prism "Example"
3624         @ManageTransactions("PrimOp")
3625         def MakePrismDXDYDZ2Ways(self, theBase, theDX, theDY, theDZ, theName=None):
3626             """
3627             Create a shape by extrusion of the base shape along the dx, dy, dz direction
3628             i.e. all the space, transfixed by the base shape during its translation
3629             along the vector on the given distance in 2 Ways (forward/backward).
3630
3631             Parameters:
3632                 theBase Base shape to be extruded.
3633                 theDX, theDY, theDZ Directions of extrusion.
3634                 theName Object name; when specified, this parameter is used
3635                         for result publication in the study. Otherwise, if automatic
3636                         publication is switched on, default value is used for result name.
3637
3638             Returns:
3639                 New GEOM.GEOM_Object, containing the created prism.
3640             """
3641             # Example: see GEOM_TestAll.py
3642             theDX,theDY,theDZ,Parameters = ParseParameters(theDX, theDY, theDZ)
3643             anObj = self.PrimOp.MakePrismDXDYDZ2Ways(theBase, theDX, theDY, theDZ)
3644             RaiseIfFailed("MakePrismDXDYDZ2Ways", self.PrimOp)
3645             anObj.SetParameters(Parameters)
3646             self._autoPublish(anObj, theName, "prism")
3647             return anObj
3648
3649         ## Create a shape by revolution of the base shape around the axis
3650         #  on the given angle, i.e. all the space, transfixed by the base
3651         #  shape during its rotation around the axis on the given angle.
3652         #  @param theBase Base shape to be rotated.
3653         #  @param theAxis Rotation axis.
3654         #  @param theAngle Rotation angle in radians.
3655         #  @param theName Object name; when specified, this parameter is used
3656         #         for result publication in the study. Otherwise, if automatic
3657         #         publication is switched on, default value is used for result name.
3658         #
3659         #  @return New GEOM.GEOM_Object, containing the created revolution.
3660         #
3661         #  @ref tui_creation_revolution "Example"
3662         @ManageTransactions("PrimOp")
3663         def MakeRevolution(self, theBase, theAxis, theAngle, theName=None):
3664             """
3665             Create a shape by revolution of the base shape around the axis
3666             on the given angle, i.e. all the space, transfixed by the base
3667             shape during its rotation around the axis on the given angle.
3668
3669             Parameters:
3670                 theBase Base shape to be rotated.
3671                 theAxis Rotation axis.
3672                 theAngle Rotation angle in radians.
3673                 theName Object name; when specified, this parameter is used
3674                         for result publication in the study. Otherwise, if automatic
3675                         publication is switched on, default value is used for result name.
3676
3677             Returns:
3678                 New GEOM.GEOM_Object, containing the created revolution.
3679             """
3680             # Example: see GEOM_TestAll.py
3681             theAngle,Parameters = ParseParameters(theAngle)
3682             anObj = self.PrimOp.MakeRevolutionAxisAngle(theBase, theAxis, theAngle)
3683             RaiseIfFailed("MakeRevolutionAxisAngle", self.PrimOp)
3684             anObj.SetParameters(Parameters)
3685             self._autoPublish(anObj, theName, "revolution")
3686             return anObj
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 in
3691         #  both directions (forward/backward)
3692         #  @param theBase Base shape to be rotated.
3693         #  @param theAxis Rotation axis.
3694         #  @param theAngle Rotation angle in radians.
3695         #  @param theName Object name; when specified, this parameter is used
3696         #         for result publication in the study. Otherwise, if automatic
3697         #         publication is switched on, default value is used for result name.
3698         #
3699         #  @return New GEOM.GEOM_Object, containing the created revolution.
3700         #
3701         #  @ref tui_creation_revolution "Example"
3702         @ManageTransactions("PrimOp")
3703         def MakeRevolution2Ways(self, theBase, theAxis, theAngle, theName=None):
3704             """
3705             Create a shape by revolution of the base shape around the axis
3706             on the given angle, i.e. all the space, transfixed by the base
3707             shape during its rotation around the axis on the given angle in
3708             both directions (forward/backward).
3709
3710             Parameters:
3711                 theBase Base shape to be rotated.
3712                 theAxis Rotation axis.
3713                 theAngle Rotation angle in radians.
3714                 theName Object name; when specified, this parameter is used
3715                         for result publication in the study. Otherwise, if automatic
3716                         publication is switched on, default value is used for result name.
3717
3718             Returns:
3719                 New GEOM.GEOM_Object, containing the created revolution.
3720             """
3721             theAngle,Parameters = ParseParameters(theAngle)
3722             anObj = self.PrimOp.MakeRevolutionAxisAngle2Ways(theBase, theAxis, theAngle)
3723             RaiseIfFailed("MakeRevolutionAxisAngle2Ways", self.PrimOp)
3724             anObj.SetParameters(Parameters)
3725             self._autoPublish(anObj, theName, "revolution")
3726             return anObj
3727
3728         ## Create a face from a given set of contours.
3729         #  @param theContours either a list or a compound of edges/wires.
3730         #  @param theMinDeg a minimal degree of BSpline surface to create.
3731         #  @param theMaxDeg a maximal degree of BSpline surface to create.
3732         #  @param theTol2D a 2d tolerance to be reached.
3733         #  @param theTol3D a 3d tolerance to be reached.
3734         #  @param theNbIter a number of iteration of approximation algorithm.
3735         #  @param theMethod Kind of method to perform filling operation
3736         #         (see GEOM.filling_oper_method enum).
3737         #  @param isApprox if True, BSpline curves are generated in the process
3738         #                  of surface construction. By default it is False, that means
3739         #                  the surface is created using given curves. The usage of
3740         #                  Approximation makes the algorithm work slower, but allows
3741         #                  building the surface for rather complex cases.
3742         #  @param theName Object name; when specified, this parameter is used
3743         #         for result publication in the study. Otherwise, if automatic
3744         #         publication is switched on, default value is used for result name.
3745         #
3746         #  @return New GEOM.GEOM_Object (face), containing the created filling surface.
3747         #
3748         #  @ref tui_creation_filling "Example"
3749         @ManageTransactions("PrimOp")
3750         def MakeFilling(self, theContours, theMinDeg=2, theMaxDeg=5, theTol2D=0.0001,
3751                         theTol3D=0.0001, theNbIter=0, theMethod=GEOM.FOM_Default, isApprox=0, theName=None):
3752             """
3753             Create a face from a given set of contours.
3754
3755             Parameters:
3756                 theContours either a list or a compound of edges/wires.
3757                 theMinDeg a minimal degree of BSpline surface to create.
3758                 theMaxDeg a maximal degree of BSpline surface to create.
3759                 theTol2D a 2d tolerance to be reached.
3760                 theTol3D a 3d tolerance to be reached.
3761                 theNbIter a number of iteration of approximation algorithm.
3762                 theMethod Kind of method to perform filling operation
3763                           (see GEOM.filling_oper_method enum).
3764                 isApprox if True, BSpline curves are generated in the process
3765                          of surface construction. By default it is False, that means
3766                          the surface is created using given curves. The usage of
3767                          Approximation makes the algorithm work slower, but allows
3768                          building the surface for rather complex cases.
3769                 theName Object name; when specified, this parameter is used
3770                         for result publication in the study. Otherwise, if automatic
3771                         publication is switched on, default value is used for result name.
3772
3773             Returns:
3774                 New GEOM.GEOM_Object (face), containing the created filling surface.
3775
3776             Example of usage:
3777                 filling = geompy.MakeFilling(compound, 2, 5, 0.0001, 0.0001, 5)
3778             """
3779             # Example: see GEOM_TestAll.py
3780             theMinDeg,theMaxDeg,theTol2D,theTol3D,theNbIter,Parameters = ParseParameters(theMinDeg, theMaxDeg, theTol2D, theTol3D, theNbIter)
3781             anObj = self.PrimOp.MakeFilling(ToList(theContours), theMinDeg, theMaxDeg,
3782                                             theTol2D, theTol3D, theNbIter,
3783                                             theMethod, isApprox)
3784             RaiseIfFailed("MakeFilling", self.PrimOp)
3785             anObj.SetParameters(Parameters)
3786             self._autoPublish(anObj, theName, "filling")
3787             return anObj
3788
3789
3790         ## Create a face from a given set of contours.
3791         #  This method corresponds to MakeFilling() with isApprox=True.
3792         #  @param theContours either a list or a compound of edges/wires.
3793         #  @param theMinDeg a minimal degree of BSpline surface to create.
3794         #  @param theMaxDeg a maximal degree of BSpline surface to create.
3795         #  @param theTol3D a 3d tolerance to be reached.
3796         #  @param theName Object name; when specified, this parameter is used
3797         #         for result publication in the study. Otherwise, if automatic
3798         #         publication is switched on, default value is used for result name.
3799         #
3800         #  @return New GEOM.GEOM_Object (face), containing the created filling surface.
3801         #
3802         #  @ref tui_creation_filling "Example"
3803         @ManageTransactions("PrimOp")
3804         def MakeFillingNew(self, theContours, theMinDeg=2, theMaxDeg=5, theTol3D=0.0001, theName=None):
3805             """
3806             Create a filling from the given compound of contours.
3807             This method corresponds to MakeFilling() with isApprox=True.
3808
3809             Parameters:
3810                 theContours either a list or a compound of edges/wires.
3811                 theMinDeg a minimal degree of BSpline surface to create.
3812                 theMaxDeg a maximal degree of BSpline surface to create.
3813                 theTol3D a 3d tolerance to be reached.
3814                 theName Object name; when specified, this parameter is used
3815                         for result publication in the study. Otherwise, if automatic
3816                         publication is switched on, default value is used for result name.
3817
3818             Returns:
3819                 New GEOM.GEOM_Object (face), containing the created filling surface.
3820
3821             Example of usage:
3822                 filling = geompy.MakeFillingNew(compound, 2, 5, 0.0001)
3823             """
3824             # Example: see GEOM_TestAll.py
3825             theMinDeg,theMaxDeg,theTol3D,Parameters = ParseParameters(theMinDeg, theMaxDeg, theTol3D)
3826             anObj = self.PrimOp.MakeFilling(theContours, theMinDeg, theMaxDeg,
3827                                             0, theTol3D, 0, GEOM.FOM_Default, True)
3828             RaiseIfFailed("MakeFillingNew", self.PrimOp)
3829             anObj.SetParameters(Parameters)
3830             self._autoPublish(anObj, theName, "filling")
3831             return anObj
3832
3833         ## Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
3834         #  @param theSeqSections - set of specified sections.
3835         #  @param theModeSolid - mode defining building solid or shell
3836         #  @param thePreci - precision 3D used for smoothing
3837         #  @param theRuled - mode defining type of the result surfaces (ruled or smoothed).
3838         #  @param theName Object name; when specified, this parameter is used
3839         #         for result publication in the study. Otherwise, if automatic
3840         #         publication is switched on, default value is used for result name.
3841         #
3842         #  @return New GEOM.GEOM_Object, containing the created shell or solid.
3843         #
3844         #  @ref swig_todo "Example"
3845         @ManageTransactions("PrimOp")
3846         def MakeThruSections(self, theSeqSections, theModeSolid, thePreci, theRuled, theName=None):
3847             """
3848             Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
3849
3850             Parameters:
3851                 theSeqSections - set of specified sections.
3852                 theModeSolid - mode defining building solid or shell
3853                 thePreci - precision 3D used for smoothing
3854                 theRuled - mode defining type of the result surfaces (ruled or smoothed).
3855                 theName Object name; when specified, this parameter is used
3856                         for result publication in the study. Otherwise, if automatic
3857                         publication is switched on, default value is used for result name.
3858
3859             Returns:
3860                 New GEOM.GEOM_Object, containing the created shell or solid.
3861             """
3862             # Example: see GEOM_TestAll.py
3863             anObj = self.PrimOp.MakeThruSections(theSeqSections,theModeSolid,thePreci,theRuled)
3864             RaiseIfFailed("MakeThruSections", self.PrimOp)
3865             self._autoPublish(anObj, theName, "filling")
3866             return anObj
3867
3868         ## Create a shape by extrusion of the base shape along
3869         #  the path shape. The path shape can be a wire or an edge.
3870         #  @param theBase Base shape to be extruded.
3871         #  @param thePath Path shape to extrude the base shape along it.
3872         #  @param theName Object name; when specified, this parameter is used
3873         #         for result publication in the study. Otherwise, if automatic
3874         #         publication is switched on, default value is used for result name.
3875         #
3876         #  @return New GEOM.GEOM_Object, containing the created pipe.
3877         #
3878         #  @ref tui_creation_pipe "Example"
3879         @ManageTransactions("PrimOp")
3880         def MakePipe(self, theBase, thePath, theName=None):
3881             """
3882             Create a shape by extrusion of the base shape along
3883             the path shape. The path shape can be a wire or an edge.
3884
3885             Parameters:
3886                 theBase Base shape to be extruded.
3887                 thePath Path shape to extrude the base shape along it.
3888                 theName Object name; when specified, this parameter is used
3889                         for result publication in the study. Otherwise, if automatic
3890                         publication is switched on, default value is used for result name.
3891
3892             Returns:
3893                 New GEOM.GEOM_Object, containing the created pipe.
3894             """
3895             # Example: see GEOM_TestAll.py
3896             anObj = self.PrimOp.MakePipe(theBase, thePath)
3897             RaiseIfFailed("MakePipe", self.PrimOp)
3898             self._autoPublish(anObj, theName, "pipe")
3899             return anObj
3900
3901         ## Create a shape by extrusion of the profile shape along
3902         #  the path shape. The path shape can be a wire or an edge.
3903         #  the several profiles can be specified in the several locations of path.
3904         #  @param theSeqBases - list of  Bases shape to be extruded.
3905         #  @param theLocations - list of locations on the path corresponding
3906         #                        specified list of the Bases shapes. Number of locations
3907         #                        should be equal to number of bases or list of locations can be empty.
3908         #  @param thePath - Path shape to extrude the base shape along it.
3909         #  @param theWithContact - the mode defining that the section is translated to be in
3910         #                          contact with the spine.
3911         #  @param theWithCorrection - defining that the section is rotated to be
3912         #                             orthogonal to the spine tangent in the correspondent point
3913         #  @param theName Object name; when specified, this parameter is used
3914         #         for result publication in the study. Otherwise, if automatic
3915         #         publication is switched on, default value is used for result name.
3916         #
3917         #  @return New GEOM.GEOM_Object, containing the created pipe.
3918         #
3919         #  @ref tui_creation_pipe_with_diff_sec "Example"
3920         @ManageTransactions("PrimOp")
3921         def MakePipeWithDifferentSections(self, theSeqBases,
3922                                           theLocations, thePath,
3923                                           theWithContact, theWithCorrection, theName=None):
3924             """
3925             Create a shape by extrusion of the profile shape along
3926             the path shape. The path shape can be a wire or an edge.
3927             the several profiles can be specified in the several locations of path.
3928
3929             Parameters:
3930                 theSeqBases - list of  Bases shape to be extruded.
3931                 theLocations - list of locations on the path corresponding
3932                                specified list of the Bases shapes. Number of locations
3933                                should be equal to number of bases or list of locations can be empty.
3934                 thePath - Path shape to extrude the base shape along it.
3935                 theWithContact - the mode defining that the section is translated to be in
3936                                  contact with the spine(0/1)
3937                 theWithCorrection - defining that the section is rotated to be
3938                                     orthogonal to the spine tangent in the correspondent point (0/1)
3939                 theName Object name; when specified, this parameter is used
3940                         for result publication in the study. Otherwise, if automatic
3941                         publication is switched on, default value is used for result name.
3942
3943             Returns:
3944                 New GEOM.GEOM_Object, containing the created pipe.
3945             """
3946             anObj = self.PrimOp.MakePipeWithDifferentSections(theSeqBases,
3947                                                               theLocations, thePath,
3948                                                               theWithContact, theWithCorrection)
3949             RaiseIfFailed("MakePipeWithDifferentSections", self.PrimOp)
3950             self._autoPublish(anObj, theName, "pipe")
3951             return anObj
3952
3953         ## Create a shape by extrusion of the profile shape along
3954         #  the path shape. The path shape can be a wire or a edge.
3955         #  the several profiles can be specified in the several locations of path.
3956         #  @param theSeqBases - list of  Bases shape to be extruded. Base shape must be
3957         #                       shell or face. If number of faces in neighbour sections
3958         #                       aren't coincided result solid between such sections will
3959         #                       be created using external boundaries of this shells.
3960         #  @param theSeqSubBases - list of corresponding sub-shapes of section shapes.
3961         #                          This list is used for searching correspondences between
3962         #                          faces in the sections. Size of this list must be equal
3963         #                          to size of list of base shapes.
3964         #  @param theLocations - list of locations on the path corresponding
3965         #                        specified list of the Bases shapes. Number of locations
3966         #                        should be equal to number of bases. First and last
3967         #                        locations must be coincided with first and last vertexes
3968         #                        of path correspondingly.
3969         #  @param thePath - Path shape to extrude the base shape along it.
3970         #  @param theWithContact - the mode defining that the section is translated to be in
3971         #                          contact with the spine.
3972         #  @param theWithCorrection - defining that the section is rotated to be
3973         #                             orthogonal to the spine tangent in the correspondent point
3974         #  @param theName Object name; when specified, this parameter is used
3975         #         for result publication in the study. Otherwise, if automatic
3976         #         publication is switched on, default value is used for result name.
3977         #
3978         #  @return New GEOM.GEOM_Object, containing the created solids.
3979         #
3980         #  @ref tui_creation_pipe_with_shell_sec "Example"
3981         @ManageTransactions("PrimOp")
3982         def MakePipeWithShellSections(self, theSeqBases, theSeqSubBases,
3983                                       theLocations, thePath,
3984                                       theWithContact, theWithCorrection, theName=None):
3985             """
3986             Create a shape by extrusion of the profile shape along
3987             the path shape. The path shape can be a wire or a edge.
3988             the several profiles can be specified in the several locations of path.
3989
3990             Parameters:
3991                 theSeqBases - list of  Bases shape to be extruded. Base shape must be
3992                               shell or face. If number of faces in neighbour sections
3993                               aren't coincided result solid between such sections will
3994                               be created using external boundaries of this shells.
3995                 theSeqSubBases - list of corresponding sub-shapes of section shapes.
3996                                  This list is used for searching correspondences between
3997                                  faces in the sections. Size of this list must be equal
3998                                  to size of list of base shapes.
3999                 theLocations - list of locations on the path corresponding
4000                                specified list of the Bases shapes. Number of locations
4001                                should be equal to number of bases. First and last
4002                                locations must be coincided with first and last vertexes
4003                                of path correspondingly.
4004                 thePath - Path shape to extrude the base shape along it.
4005                 theWithContact - the mode defining that the section is translated to be in
4006                                  contact with the spine (0/1)
4007                 theWithCorrection - defining that the section is rotated to be
4008                                     orthogonal to the spine tangent in the correspondent point (0/1)
4009                 theName Object name; when specified, this parameter is used
4010                         for result publication in the study. Otherwise, if automatic
4011                         publication is switched on, default value is used for result name.
4012
4013             Returns:
4014                 New GEOM.GEOM_Object, containing the created solids.
4015             """
4016             anObj = self.PrimOp.MakePipeWithShellSections(theSeqBases, theSeqSubBases,
4017                                                           theLocations, thePath,
4018                                                           theWithContact, theWithCorrection)
4019             RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
4020             self._autoPublish(anObj, theName, "pipe")
4021             return anObj
4022
4023         ## Create a shape by extrusion of the profile shape along
4024         #  the path shape. This function is used only for debug pipe
4025         #  functionality - it is a version of function MakePipeWithShellSections()
4026         #  which give a possibility to recieve information about
4027         #  creating pipe between each pair of sections step by step.
4028         @ManageTransactions("PrimOp")
4029         def MakePipeWithShellSectionsBySteps(self, theSeqBases, theSeqSubBases,
4030                                              theLocations, thePath,
4031                                              theWithContact, theWithCorrection, theName=None):
4032             """
4033             Create a shape by extrusion of the profile shape along
4034             the path shape. This function is used only for debug pipe
4035             functionality - it is a version of previous function
4036             geompy.MakePipeWithShellSections() which give a possibility to
4037             recieve information about creating pipe between each pair of
4038             sections step by step.
4039             """
4040             res = []
4041             nbsect = len(theSeqBases)
4042             nbsubsect = len(theSeqSubBases)
4043             #print "nbsect = ",nbsect
4044             for i in range(1,nbsect):
4045                 #print "  i = ",i
4046                 tmpSeqBases = [ theSeqBases[i-1], theSeqBases[i] ]
4047                 tmpLocations = [ theLocations[i-1], theLocations[i] ]
4048                 tmpSeqSubBases = []
4049                 if nbsubsect>0: tmpSeqSubBases = [ theSeqSubBases[i-1], theSeqSubBases[i] ]
4050                 anObj = self.PrimOp.MakePipeWithShellSections(tmpSeqBases, tmpSeqSubBases,
4051                                                               tmpLocations, thePath,
4052                                                               theWithContact, theWithCorrection)
4053                 if self.PrimOp.IsDone() == 0:
4054                     print "Problems with pipe creation between ",i," and ",i+1," sections"
4055                     RaiseIfFailed("MakePipeWithShellSections", self.PrimOp)
4056                     break
4057                 else:
4058                     print "Pipe between ",i," and ",i+1," sections is OK"
4059                     res.append(anObj)
4060                     pass
4061                 pass
4062
4063             resc = self.MakeCompound(res)
4064             #resc = self.MakeSewing(res, 0.001)
4065             #print "resc: ",resc
4066             self._autoPublish(resc, theName, "pipe")
4067             return resc
4068
4069         ## Create solids between given sections
4070         #  @param theSeqBases - list of sections (shell or face).
4071         #  @param theLocations - list of corresponding vertexes
4072         #  @param theName Object name; when specified, this parameter is used
4073         #         for result publication in the study. Otherwise, if automatic
4074         #         publication is switched on, default value is used for result name.
4075         #
4076         #  @return New GEOM.GEOM_Object, containing the created solids.
4077         #
4078         #  @ref tui_creation_pipe_without_path "Example"
4079         @ManageTransactions("PrimOp")
4080         def MakePipeShellsWithoutPath(self, theSeqBases, theLocations, theName=None):
4081             """
4082             Create solids between given sections
4083
4084             Parameters:
4085                 theSeqBases - list of sections (shell or face).
4086                 theLocations - list of corresponding vertexes
4087                 theName Object name; when specified, this parameter is used
4088                         for result publication in the study. Otherwise, if automatic
4089                         publication is switched on, default value is used for result name.
4090
4091             Returns:
4092                 New GEOM.GEOM_Object, containing the created solids.
4093             """
4094             anObj = self.PrimOp.MakePipeShellsWithoutPath(theSeqBases, theLocations)
4095             RaiseIfFailed("MakePipeShellsWithoutPath", self.PrimOp)
4096             self._autoPublish(anObj, theName, "pipe")
4097             return anObj
4098
4099         ## Create a shape by extrusion of the base shape along
4100         #  the path shape with constant bi-normal direction along the given vector.
4101         #  The path shape can be a wire or an edge.
4102         #  @param theBase Base shape to be extruded.
4103         #  @param thePath Path shape to extrude the base shape along it.
4104         #  @param theVec Vector defines a constant binormal direction to keep the
4105         #                same angle beetween the direction and the sections
4106         #                along the sweep surface.
4107         #  @param theName Object name; when specified, this parameter is used
4108         #         for result publication in the study. Otherwise, if automatic
4109         #         publication is switched on, default value is used for result name.
4110         #
4111         #  @return New GEOM.GEOM_Object, containing the created pipe.
4112         #
4113         #  @ref tui_creation_pipe "Example"
4114         @ManageTransactions("PrimOp")
4115         def MakePipeBiNormalAlongVector(self, theBase, thePath, theVec, theName=None):
4116             """
4117             Create a shape by extrusion of the base shape along
4118             the path shape with constant bi-normal direction along the given vector.
4119             The path shape can be a wire or an edge.
4120
4121             Parameters:
4122                 theBase Base shape to be extruded.
4123                 thePath Path shape to extrude the base shape along it.
4124                 theVec Vector defines a constant binormal direction to keep the
4125                        same angle beetween the direction and the sections
4126                        along the sweep surface.
4127                 theName Object name; when specified, this parameter is used
4128                         for result publication in the study. Otherwise, if automatic
4129                         publication is switched on, default value is used for result name.
4130
4131             Returns:
4132                 New GEOM.GEOM_Object, containing the created pipe.
4133             """
4134             # Example: see GEOM_TestAll.py
4135             anObj = self.PrimOp.MakePipeBiNormalAlongVector(theBase, thePath, theVec)
4136             RaiseIfFailed("MakePipeBiNormalAlongVector", self.PrimOp)
4137             self._autoPublish(anObj, theName, "pipe")
4138             return anObj
4139
4140         ## Makes a thick solid from a face or a shell
4141         #  @param theShape Face or Shell to be thicken
4142         #  @param theThickness Thickness of the resulting solid
4143         #  @param theName Object name; when specified, this parameter is used
4144         #         for result publication in the study. Otherwise, if automatic
4145         #         publication is switched on, default value is used for result name.
4146         #
4147         #  @return New GEOM.GEOM_Object, containing the created solid
4148         #
4149         @ManageTransactions("PrimOp")
4150         def MakeThickSolid(self, theShape, theThickness, theName=None):
4151             """
4152             Make a thick solid from a face or a shell
4153
4154             Parameters:
4155                  theShape Face or Shell to be thicken
4156                  theThickness Thickness of the resulting solid
4157                  theName Object name; when specified, this parameter is used
4158                  for result publication in the study. Otherwise, if automatic
4159                  publication is switched on, default value is used for result name.
4160
4161             Returns:
4162                 New GEOM.GEOM_Object, containing the created solid
4163             """
4164             # Example: see GEOM_TestAll.py
4165             anObj = self.PrimOp.MakeThickening(theShape, theThickness, True)
4166             RaiseIfFailed("MakeThickening", self.PrimOp)
4167             self._autoPublish(anObj, theName, "pipe")
4168             return anObj
4169
4170
4171         ## Modifies a face or a shell to make it a thick solid
4172         #  @param theShape Face or Shell to be thicken
4173         #  @param theThickness Thickness of the resulting solid
4174         #
4175         #  @return The modified shape
4176         #
4177         @ManageTransactions("PrimOp")
4178         def Thicken(self, theShape, theThickness):
4179             """
4180             Modifies a face or a shell to make it a thick solid
4181
4182             Parameters:
4183                 theBase Base shape to be extruded.
4184                 thePath Path shape to extrude the base shape along it.
4185                 theName Object name; when specified, this parameter is used
4186                         for result publication in the study. Otherwise, if automatic
4187                         publication is switched on, default value is used for result name.
4188
4189             Returns:
4190                 The modified shape
4191             """
4192             # Example: see GEOM_TestAll.py
4193             anObj = self.PrimOp.MakeThickening(theShape, theThickness, False)
4194             RaiseIfFailed("MakeThickening", self.PrimOp)
4195             return anObj
4196
4197         ## Build a middle path of a pipe-like shape.
4198         #  The path shape can be a wire or an edge.
4199         #  @param theShape It can be closed or unclosed pipe-like shell
4200         #                  or a pipe-like solid.
4201         #  @param theBase1, theBase2 Two bases of the supposed pipe. This
4202         #                            should be wires or faces of theShape.
4203         #  @param theName Object name; when specified, this parameter is used
4204         #         for result publication in the study. Otherwise, if automatic
4205         #         publication is switched on, default value is used for result name.
4206         #
4207         #  @note It is not assumed that exact or approximate copy of theShape
4208         #        can be obtained by applying existing Pipe operation on the
4209         #        resulting "Path" wire taking theBase1 as the base - it is not
4210         #        always possible; though in some particular cases it might work
4211         #        it is not guaranteed. Thus, RestorePath function should not be
4212         #        considered as an exact reverse operation of the Pipe.
4213         #
4214         #  @return New GEOM.GEOM_Object, containing an edge or wire that represent
4215         #                                source pipe's "path".
4216         #
4217         #  @ref tui_creation_pipe_path "Example"
4218         @ManageTransactions("PrimOp")
4219         def RestorePath (self, theShape, theBase1, theBase2, theName=None):
4220             """
4221             Build a middle path of a pipe-like shape.
4222             The path shape can be a wire or an edge.
4223
4224             Parameters:
4225                 theShape It can be closed or unclosed pipe-like shell
4226                          or a pipe-like solid.
4227                 theBase1, theBase2 Two bases of the supposed pipe. This
4228                                    should be wires or faces of theShape.
4229                 theName Object name; when specified, this parameter is used
4230                         for result publication in the study. Otherwise, if automatic
4231                         publication is switched on, default value is used for result name.
4232
4233             Returns:
4234                 New GEOM_Object, containing an edge or wire that represent
4235                                  source pipe's path.
4236             """
4237             anObj = self.PrimOp.RestorePath(theShape, theBase1, theBase2)
4238             RaiseIfFailed("RestorePath", self.PrimOp)
4239             self._autoPublish(anObj, theName, "path")
4240             return anObj
4241
4242         ## Build a middle path of a pipe-like shape.
4243         #  The path shape can be a wire or an edge.
4244         #  @param theShape It can be closed or unclosed pipe-like shell
4245         #                  or a pipe-like solid.
4246         #  @param listEdges1, listEdges2 Two bases of the supposed pipe. This
4247         #                                should be lists of edges of theShape.
4248         #  @param theName Object name; when specified, this parameter is used
4249         #         for result publication in the study. Otherwise, if automatic
4250         #         publication is switched on, default value is used for result name.
4251         #
4252         #  @note It is not assumed that exact or approximate copy of theShape
4253         #        can be obtained by applying existing Pipe operation on the
4254         #        resulting "Path" wire taking theBase1 as the base - it is not
4255         #        always possible; though in some particular cases it might work
4256         #        it is not guaranteed. Thus, RestorePath function should not be
4257         #        considered as an exact reverse operation of the Pipe.
4258         #
4259         #  @return New GEOM.GEOM_Object, containing an edge or wire that represent
4260         #                                source pipe's "path".
4261         #
4262         #  @ref tui_creation_pipe_path "Example"
4263         @ManageTransactions("PrimOp")
4264         def RestorePathEdges (self, theShape, listEdges1, listEdges2, theName=None):
4265             """
4266             Build a middle path of a pipe-like shape.
4267             The path shape can be a wire or an edge.
4268
4269             Parameters:
4270                 theShape It can be closed or unclosed pipe-like shell
4271                          or a pipe-like solid.
4272                 listEdges1, listEdges2 Two bases of the supposed pipe. This
4273                                        should be lists of edges of theShape.
4274                 theName Object name; when specified, this parameter is used
4275                         for result publication in the study. Otherwise, if automatic
4276                         publication is switched on, default value is used for result name.
4277
4278             Returns:
4279                 New GEOM_Object, containing an edge or wire that represent
4280                                  source pipe's path.
4281             """
4282             anObj = self.PrimOp.RestorePathEdges(theShape, listEdges1, listEdges2)
4283             RaiseIfFailed("RestorePath", self.PrimOp)
4284             self._autoPublish(anObj, theName, "path")
4285             return anObj
4286
4287         # end of l3_complex
4288         ## @}
4289
4290         ## @addtogroup l3_advanced
4291         ## @{
4292
4293         ## Create a linear edge with specified ends.
4294         #  @param thePnt1 Point for the first end of edge.
4295         #  @param thePnt2 Point for the second end of edge.
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 edge.
4301         #
4302         #  @ref tui_creation_edge "Example"
4303         @ManageTransactions("ShapesOp")
4304         def MakeEdge(self, thePnt1, thePnt2, theName=None):
4305             """
4306             Create a linear edge with specified ends.
4307
4308             Parameters:
4309                 thePnt1 Point for the first end of edge.
4310                 thePnt2 Point for the second end of edge.
4311                 theName Object name; when specified, this parameter is used
4312                         for result publication in the study. Otherwise, if automatic
4313                         publication is switched on, default value is used for result name.
4314
4315             Returns:
4316                 New GEOM.GEOM_Object, containing the created edge.
4317             """
4318             # Example: see GEOM_TestAll.py
4319             anObj = self.ShapesOp.MakeEdge(thePnt1, thePnt2)
4320             RaiseIfFailed("MakeEdge", self.ShapesOp)
4321             self._autoPublish(anObj, theName, "edge")
4322             return anObj
4323
4324         ## Create a new edge, corresponding to the given length on the given curve.
4325         #  @param theRefCurve The referenced curve (edge).
4326         #  @param theLength Length on the referenced curve. It can be negative.
4327         #  @param theStartPoint Any point can be selected for it, the new edge will begin
4328         #                       at the end of \a theRefCurve, close to the selected point.
4329         #                       If None, start from the first point of \a theRefCurve.
4330         #  @param theName Object name; when specified, this parameter is used
4331         #         for result publication in the study. Otherwise, if automatic
4332         #         publication is switched on, default value is used for result name.
4333         #
4334         #  @return New GEOM.GEOM_Object, containing the created edge.
4335         #
4336         #  @ref tui_creation_edge "Example"
4337         @ManageTransactions("ShapesOp")
4338         def MakeEdgeOnCurveByLength(self, theRefCurve, theLength, theStartPoint = None, theName=None):
4339             """
4340             Create a new edge, corresponding to the given length on the given curve.
4341
4342             Parameters:
4343                 theRefCurve The referenced curve (edge).
4344                 theLength Length on the referenced curve. It can be negative.
4345                 theStartPoint Any point can be selected for it, the new edge will begin
4346                               at the end of theRefCurve, close to the selected point.
4347                               If None, start from the first point of theRefCurve.
4348                 theName Object name; when specified, this parameter is used
4349                         for result publication in the study. Otherwise, if automatic
4350                         publication is switched on, default value is used for result name.
4351
4352             Returns:
4353                 New GEOM.GEOM_Object, containing the created edge.
4354             """
4355             # Example: see GEOM_TestAll.py
4356             theLength, Parameters = ParseParameters(theLength)
4357             anObj = self.ShapesOp.MakeEdgeOnCurveByLength(theRefCurve, theLength, theStartPoint)
4358             RaiseIfFailed("MakeEdgeOnCurveByLength", self.ShapesOp)
4359             anObj.SetParameters(Parameters)
4360             self._autoPublish(anObj, theName, "edge")
4361             return anObj
4362
4363         ## Create an edge from specified wire.
4364         #  @param theWire source Wire
4365         #  @param theLinearTolerance linear tolerance value (default = 1e-07)
4366         #  @param theAngularTolerance angular tolerance value (default = 1e-12)
4367         #  @param theName Object name; when specified, this parameter is used
4368         #         for result publication in the study. Otherwise, if automatic
4369         #         publication is switched on, default value is used for result name.
4370         #
4371         #  @return New GEOM.GEOM_Object, containing the created edge.
4372         #
4373         #  @ref tui_creation_edge "Example"
4374         @ManageTransactions("ShapesOp")
4375         def MakeEdgeWire(self, theWire, theLinearTolerance = 1e-07, theAngularTolerance = 1e-12, theName=None):
4376             """
4377             Create an edge from specified wire.
4378
4379             Parameters:
4380                 theWire source Wire
4381                 theLinearTolerance linear tolerance value (default = 1e-07)
4382                 theAngularTolerance angular tolerance value (default = 1e-12)
4383                 theName Object name; when specified, this parameter is used
4384                         for result publication in the study. Otherwise, if automatic
4385                         publication is switched on, default value is used for result name.
4386
4387             Returns:
4388                 New GEOM.GEOM_Object, containing the created edge.
4389             """
4390             # Example: see GEOM_TestAll.py
4391             anObj = self.ShapesOp.MakeEdgeWire(theWire, theLinearTolerance, theAngularTolerance)
4392             RaiseIfFailed("MakeEdgeWire", self.ShapesOp)
4393             self._autoPublish(anObj, theName, "edge")
4394             return anObj
4395
4396         ## Create a wire from the set of edges and wires.
4397         #  @param theEdgesAndWires List of edges and/or wires.
4398         #  @param theTolerance Maximum distance between vertices, that will be merged.
4399         #                      Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion())
4400         #  @param theName Object name; when specified, this parameter is used
4401         #         for result publication in the study. Otherwise, if automatic
4402         #         publication is switched on, default value is used for result name.
4403         #
4404         #  @return New GEOM.GEOM_Object, containing the created wire.
4405         #
4406         #  @ref tui_creation_wire "Example"
4407         @ManageTransactions("ShapesOp")
4408         def MakeWire(self, theEdgesAndWires, theTolerance = 1e-07, theName=None):
4409             """
4410             Create a wire from the set of edges and wires.
4411
4412             Parameters:
4413                 theEdgesAndWires List of edges and/or wires.
4414                 theTolerance Maximum distance between vertices, that will be merged.
4415                              Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
4416                 theName Object name; when specified, this parameter is used
4417                         for result publication in the study. Otherwise, if automatic
4418                         publication is switched on, default value is used for result name.
4419
4420             Returns:
4421                 New GEOM.GEOM_Object, containing the created wire.
4422             """
4423             # Example: see GEOM_TestAll.py
4424             anObj = self.ShapesOp.MakeWire(theEdgesAndWires, theTolerance)
4425             RaiseIfFailed("MakeWire", self.ShapesOp)
4426             self._autoPublish(anObj, theName, "wire")
4427             return anObj
4428
4429         ## Create a face on the given wire.
4430         #  @param theWire closed Wire or Edge to build the face on.
4431         #  @param isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4432         #                        If the tolerance of the obtained planar face is less
4433         #                        than 1e-06, this face will be returned, otherwise the
4434         #                        algorithm tries to build any suitable face on the given
4435         #                        wire and prints a warning message.
4436         #  @param theName Object name; when specified, this parameter is used
4437         #         for result publication in the study. Otherwise, if automatic
4438         #         publication is switched on, default value is used for result name.
4439         #
4440         #  @return New GEOM.GEOM_Object, containing the created face.
4441         #
4442         #  @ref tui_creation_face "Example"
4443         @ManageTransactions("ShapesOp")
4444         def MakeFace(self, theWire, isPlanarWanted, theName=None):
4445             """
4446             Create a face on the given wire.
4447
4448             Parameters:
4449                 theWire closed Wire or Edge to build the face on.
4450                 isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4451                                If the tolerance of the obtained planar face is less
4452                                than 1e-06, this face will be returned, otherwise the
4453                                algorithm tries to build any suitable face on the given
4454                                wire and prints a warning message.
4455                 theName Object name; when specified, this parameter is used
4456                         for result publication in the study. Otherwise, if automatic
4457                         publication is switched on, default value is used for result name.
4458
4459             Returns:
4460                 New GEOM.GEOM_Object, containing the created face.
4461             """
4462             # Example: see GEOM_TestAll.py
4463             anObj = self.ShapesOp.MakeFace(theWire, isPlanarWanted)
4464             if isPlanarWanted and anObj is not None and self.ShapesOp.GetErrorCode() == "MAKE_FACE_TOLERANCE_TOO_BIG":
4465                 print "WARNING: Cannot build a planar face: required tolerance is too big. Non-planar face is built."
4466             else:
4467                 RaiseIfFailed("MakeFace", self.ShapesOp)
4468             self._autoPublish(anObj, theName, "face")
4469             return anObj
4470
4471         ## Create a face on the given wires set.
4472         #  @param theWires List of closed wires or edges to build the face on.
4473         #  @param isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4474         #                        If the tolerance of the obtained planar face is less
4475         #                        than 1e-06, this face will be returned, otherwise the
4476         #                        algorithm tries to build any suitable face on the given
4477         #                        wire and prints a warning message.
4478         #  @param theName Object name; when specified, this parameter is used
4479         #         for result publication in the study. Otherwise, if automatic
4480         #         publication is switched on, default value is used for result name.
4481         #
4482         #  @return New GEOM.GEOM_Object, containing the created face.
4483         #
4484         #  @ref tui_creation_face "Example"
4485         @ManageTransactions("ShapesOp")
4486         def MakeFaceWires(self, theWires, isPlanarWanted, theName=None):
4487             """
4488             Create a face on the given wires set.
4489
4490             Parameters:
4491                 theWires List of closed wires or edges to build the face on.
4492                 isPlanarWanted If TRUE, the algorithm tries to build a planar face.
4493                                If the tolerance of the obtained planar face is less
4494                                than 1e-06, this face will be returned, otherwise the
4495                                algorithm tries to build any suitable face on the given
4496                                wire and prints a warning message.
4497                 theName Object name; when specified, this parameter is used
4498                         for result publication in the study. Otherwise, if automatic
4499                         publication is switched on, default value is used for result name.
4500
4501             Returns:
4502                 New GEOM.GEOM_Object, containing the created face.
4503             """
4504             # Example: see GEOM_TestAll.py
4505             anObj = self.ShapesOp.MakeFaceWires(ToList(theWires), isPlanarWanted)
4506             if isPlanarWanted and anObj is not None and self.ShapesOp.GetErrorCode() == "MAKE_FACE_TOLERANCE_TOO_BIG":
4507                 print "WARNING: Cannot build a planar face: required tolerance is too big. Non-planar face is built."
4508             else:
4509                 RaiseIfFailed("MakeFaceWires", self.ShapesOp)
4510             self._autoPublish(anObj, theName, "face")
4511             return anObj
4512
4513         ## See MakeFaceWires() method for details.
4514         #
4515         #  @ref tui_creation_face "Example 1"
4516         #  \n @ref swig_MakeFaces  "Example 2"
4517         def MakeFaces(self, theWires, isPlanarWanted, theName=None):
4518             """
4519             See geompy.MakeFaceWires() method for details.
4520             """
4521             # Example: see GEOM_TestOthers.py
4522             # note: auto-publishing is done in self.MakeFaceWires()
4523             anObj = self.MakeFaceWires(theWires, isPlanarWanted, theName)
4524             return anObj
4525
4526         ## Create a face based on a surface from given face bounded
4527         #  by given wire.
4528         #  @param theFace the face whose surface is used to create a new face.
4529         #  @param theWire the wire that will bound a new face.
4530         #  @param theName Object name; when specified, this parameter is used
4531         #         for result publication in the study. Otherwise, if automatic
4532         #         publication is switched on, default value is used for result name.
4533         #
4534         #  @return New GEOM.GEOM_Object, containing the created face.
4535         #
4536         #  @ref tui_creation_face "Example"
4537         @ManageTransactions("ShapesOp")
4538         def MakeFaceFromSurface(self, theFace, theWire, theName=None):
4539             """
4540             Create a face based on a surface from given face bounded
4541             by given wire.
4542
4543             Parameters:
4544                 theFace the face whose surface is used to create a new face.
4545                 theWire the wire that will bound a new face.
4546                 theName Object name; when specified, this parameter is used
4547                         for result publication in the study. Otherwise, if automatic
4548                         publication is switched on, default value is used for result name.
4549
4550             Returns:
4551                 New GEOM.GEOM_Object, containing the created face.
4552             """
4553             # Example: see GEOM_TestAll.py
4554             anObj = self.ShapesOp.MakeFaceFromSurface(theFace, theWire)
4555             RaiseIfFailed("MakeFaceFromSurface", self.ShapesOp)
4556             self._autoPublish(anObj, theName, "face")
4557             return anObj
4558           
4559         ## Create a face from a set of edges with the given constraints.
4560         #  @param theConstraints List of edges and constraint faces (as a sequence of a Edge + Face couples):
4561         #         - edges should form a closed wire;
4562         #         - for each edge, constraint face is optional: if a constraint face is missing
4563         #           for some edge, this means that there no constraint associated with this edge.
4564         #  @param theName Object name; when specified, this parameter is used
4565         #         for result publication in the study. Otherwise, if automatic
4566         #         publication is switched on, default value is used for result name.
4567         # 
4568         # @return New GEOM.GEOM_Object, containing the created face.
4569         # 
4570         # @ref tui_creation_face "Example"
4571         @ManageTransactions("ShapesOp")
4572         def MakeFaceWithConstraints(self, theConstraints, theName=None):
4573             """
4574             Create a face from a set of edges with the given constraints.
4575
4576             Parameters:
4577                 theConstraints List of edges and constraint faces (as a sequence of a Edge + Face couples):
4578                         - edges should form a closed wire;
4579                         - for each edge, constraint face is optional: if a constraint face is missing
4580                           for some edge, this means that there no constraint associated with this edge.
4581                 theName Object name; when specified, this parameter is used
4582                         for result publication in the study. Otherwise, if automatic
4583                         publication is switched on, default value is used for result name.
4584
4585             Returns:
4586                 New GEOM.GEOM_Object, containing the created face.
4587             """
4588             # Example: see GEOM_TestAll.py
4589             anObj = self.ShapesOp.MakeFaceWithConstraints(theConstraints)
4590             if anObj is None:
4591                 RaiseIfFailed("MakeFaceWithConstraints", self.ShapesOp)
4592             self._autoPublish(anObj, theName, "face")
4593             return anObj
4594
4595         ## Create a shell from the set of faces and shells.
4596         #  @param theFacesAndShells List of faces and/or shells.
4597         #  @param theName Object name; when specified, this parameter is used
4598         #         for result publication in the study. Otherwise, if automatic
4599         #         publication is switched on, default value is used for result name.
4600         #
4601         #  @return New GEOM.GEOM_Object, containing the created shell.
4602         #
4603         #  @ref tui_creation_shell "Example"
4604         @ManageTransactions("ShapesOp")
4605         def MakeShell(self, theFacesAndShells, theName=None):
4606             """
4607             Create a shell from the set of faces and shells.
4608
4609             Parameters:
4610                 theFacesAndShells List of faces and/or shells.
4611                 theName Object name; when specified, this parameter is used
4612                         for result publication in the study. Otherwise, if automatic
4613                         publication is switched on, default value is used for result name.
4614
4615             Returns:
4616                 New GEOM.GEOM_Object, containing the created shell.
4617             """
4618             # Example: see GEOM_TestAll.py
4619             anObj = self.ShapesOp.MakeShell( ToList( theFacesAndShells ))
4620             RaiseIfFailed("MakeShell", self.ShapesOp)
4621             self._autoPublish(anObj, theName, "shell")
4622             return anObj
4623
4624         ## Create a solid, bounded by the given shells.
4625         #  @param theShells Sequence of bounding shells.
4626         #  @param theName Object name; when specified, this parameter is used
4627         #         for result publication in the study. Otherwise, if automatic
4628         #         publication is switched on, default value is used for result name.
4629         #
4630         #  @return New GEOM.GEOM_Object, containing the created solid.
4631         #
4632         #  @ref tui_creation_solid "Example"
4633         @ManageTransactions("ShapesOp")
4634         def MakeSolid(self, theShells, theName=None):
4635             """
4636             Create a solid, bounded by the given shells.
4637
4638             Parameters:
4639                 theShells Sequence of bounding shells.
4640                 theName Object name; when specified, this parameter is used
4641                         for result publication in the study. Otherwise, if automatic
4642                         publication is switched on, default value is used for result name.
4643
4644             Returns:
4645                 New GEOM.GEOM_Object, containing the created solid.
4646             """
4647             # Example: see GEOM_TestAll.py
4648             theShells = ToList(theShells)
4649             if len(theShells) == 1:
4650                 descr = self._IsGoodForSolid(theShells[0])
4651                 #if len(descr) > 0:
4652                 #    raise RuntimeError, "MakeSolidShells : " + descr
4653                 if descr == "WRN_SHAPE_UNCLOSED":
4654                     raise RuntimeError, "MakeSolidShells : Unable to create solid from unclosed shape"
4655             anObj = self.ShapesOp.MakeSolidShells(theShells)
4656             RaiseIfFailed("MakeSolidShells", self.ShapesOp)
4657             self._autoPublish(anObj, theName, "solid")
4658             return anObj
4659
4660         ## Create a compound of the given shapes.
4661         #  @param theShapes List of shapes to put in compound.
4662         #  @param theName Object name; when specified, this parameter is used
4663         #         for result publication in the study. Otherwise, if automatic
4664         #         publication is switched on, default value is used for result name.
4665         #
4666         #  @return New GEOM.GEOM_Object, containing the created compound.
4667         #
4668         #  @ref tui_creation_compound "Example"
4669         @ManageTransactions("ShapesOp")
4670         def MakeCompound(self, theShapes, theName=None):
4671             """
4672             Create a compound of the given shapes.
4673
4674             Parameters:
4675                 theShapes List of shapes to put in compound.
4676                 theName Object name; when specified, this parameter is used
4677                         for result publication in the study. Otherwise, if automatic
4678                         publication is switched on, default value is used for result name.
4679
4680             Returns:
4681                 New GEOM.GEOM_Object, containing the created compound.
4682             """
4683             # Example: see GEOM_TestAll.py
4684             anObj = self.ShapesOp.MakeCompound(ToList(theShapes))
4685             RaiseIfFailed("MakeCompound", self.ShapesOp)
4686             self._autoPublish(anObj, theName, "compound")
4687             return anObj
4688         
4689         ## Create a solid (or solids) from the set of faces and/or shells.
4690         #  @param theFacesOrShells List of faces and/or shells.
4691         #  @param isIntersect If TRUE, forces performing intersections
4692         #         between arguments; otherwise (default) intersection is not performed.
4693         #  @param theName Object name; when specified, this parameter is used
4694         #         for result publication in the study. Otherwise, if automatic
4695         #         publication is switched on, default value is used for result name.
4696         #
4697         #  @return New GEOM.GEOM_Object, containing the created solid (or compound of solids).
4698         #
4699         #  @ref tui_creation_solid_from_faces "Example"
4700         @ManageTransactions("ShapesOp")
4701         def MakeSolidFromConnectedFaces(self, theFacesOrShells, isIntersect = False, theName=None):
4702             """
4703             Create a solid (or solids) from the set of connected faces and/or shells.
4704
4705             Parameters:
4706                 theFacesOrShells List of faces and/or shells.
4707                 isIntersect If TRUE, forces performing intersections
4708                         between arguments; otherwise (default) intersection is not performed
4709                 theName Object name; when specified, this parameter is used.
4710                         for result publication in the study. Otherwise, if automatic
4711                         publication is switched on, default value is used for result name.
4712
4713             Returns:
4714                 New GEOM.GEOM_Object, containing the created solid (or compound of solids).
4715             """
4716             # Example: see GEOM_TestAll.py
4717             anObj = self.ShapesOp.MakeSolidFromConnectedFaces(theFacesOrShells, isIntersect)
4718             RaiseIfFailed("MakeSolidFromConnectedFaces", self.ShapesOp)
4719             self._autoPublish(anObj, theName, "solid")
4720             return anObj
4721
4722         # end of l3_advanced
4723         ## @}
4724
4725         ## @addtogroup l2_measure
4726         ## @{
4727
4728         ## Gives quantity of faces in the given shape.
4729         #  @param theShape Shape to count faces of.
4730         #  @return Quantity of faces.
4731         #
4732         #  @ref swig_NumberOf "Example"
4733         @ManageTransactions("ShapesOp")
4734         def NumberOfFaces(self, theShape):
4735             """
4736             Gives quantity of faces in the given shape.
4737
4738             Parameters:
4739                 theShape Shape to count faces of.
4740
4741             Returns:
4742                 Quantity of faces.
4743             """
4744             # Example: see GEOM_TestOthers.py
4745             nb_faces = self.ShapesOp.NumberOfFaces(theShape)
4746             RaiseIfFailed("NumberOfFaces", self.ShapesOp)
4747             return nb_faces
4748
4749         ## Gives quantity of edges in the given shape.
4750         #  @param theShape Shape to count edges of.
4751         #  @return Quantity of edges.
4752         #
4753         #  @ref swig_NumberOf "Example"
4754         @ManageTransactions("ShapesOp")
4755         def NumberOfEdges(self, theShape):
4756             """
4757             Gives quantity of edges in the given shape.
4758
4759             Parameters:
4760                 theShape Shape to count edges of.
4761
4762             Returns:
4763                 Quantity of edges.
4764             """
4765             # Example: see GEOM_TestOthers.py
4766             nb_edges = self.ShapesOp.NumberOfEdges(theShape)
4767             RaiseIfFailed("NumberOfEdges", self.ShapesOp)
4768             return nb_edges
4769
4770         ## Gives quantity of sub-shapes of type theShapeType in the given shape.
4771         #  @param theShape Shape to count sub-shapes of.
4772         #  @param theShapeType Type of sub-shapes to count (see ShapeType())
4773         #  @return Quantity of sub-shapes of given type.
4774         #
4775         #  @ref swig_NumberOf "Example"
4776         @ManageTransactions("ShapesOp")
4777         def NumberOfSubShapes(self, theShape, theShapeType):
4778             """
4779             Gives quantity of sub-shapes of type theShapeType in the given shape.
4780
4781             Parameters:
4782                 theShape Shape to count sub-shapes of.
4783                 theShapeType Type of sub-shapes to count (see geompy.ShapeType)
4784
4785             Returns:
4786                 Quantity of sub-shapes of given type.
4787             """
4788             # Example: see GEOM_TestOthers.py
4789             nb_ss = self.ShapesOp.NumberOfSubShapes(theShape, theShapeType)
4790             RaiseIfFailed("NumberOfSubShapes", self.ShapesOp)
4791             return nb_ss
4792
4793         ## Gives quantity of solids in the given shape.
4794         #  @param theShape Shape to count solids in.
4795         #  @return Quantity of solids.
4796         #
4797         #  @ref swig_NumberOf "Example"
4798         @ManageTransactions("ShapesOp")
4799         def NumberOfSolids(self, theShape):
4800             """
4801             Gives quantity of solids in the given shape.
4802
4803             Parameters:
4804                 theShape Shape to count solids in.
4805
4806             Returns:
4807                 Quantity of solids.
4808             """
4809             # Example: see GEOM_TestOthers.py
4810             nb_solids = self.ShapesOp.NumberOfSubShapes(theShape, self.ShapeType["SOLID"])
4811             RaiseIfFailed("NumberOfSolids", self.ShapesOp)
4812             return nb_solids
4813
4814         # end of l2_measure
4815         ## @}
4816
4817         ## @addtogroup l3_healing
4818         ## @{
4819
4820         ## Reverses an orientation the given shape.
4821         #  @param theShape Shape to be reversed.
4822         #  @param theName Object name; when specified, this parameter is used
4823         #         for result publication in the study. Otherwise, if automatic
4824         #         publication is switched on, default value is used for result name.
4825         #
4826         #  @return The reversed copy of theShape.
4827         #
4828         #  @ref swig_ChangeOrientation "Example"
4829         @ManageTransactions("ShapesOp")
4830         def ChangeOrientation(self, theShape, theName=None):
4831             """
4832             Reverses an orientation the given shape.
4833
4834             Parameters:
4835                 theShape Shape to be reversed.
4836                 theName Object name; when specified, this parameter is used
4837                         for result publication in the study. Otherwise, if automatic
4838                         publication is switched on, default value is used for result name.
4839
4840             Returns:
4841                 The reversed copy of theShape.
4842             """
4843             # Example: see GEOM_TestAll.py
4844             anObj = self.ShapesOp.ChangeOrientation(theShape)
4845             RaiseIfFailed("ChangeOrientation", self.ShapesOp)
4846             self._autoPublish(anObj, theName, "reversed")
4847             return anObj
4848
4849         ## See ChangeOrientation() method for details.
4850         #
4851         #  @ref swig_OrientationChange "Example"
4852         def OrientationChange(self, theShape, theName=None):
4853             """
4854             See geompy.ChangeOrientation method for details.
4855             """
4856             # Example: see GEOM_TestOthers.py
4857             # note: auto-publishing is done in self.ChangeOrientation()
4858             anObj = self.ChangeOrientation(theShape, theName)
4859             return anObj
4860
4861         # end of l3_healing
4862         ## @}
4863
4864         ## @addtogroup l4_obtain
4865         ## @{
4866
4867         ## Retrieve all free faces from the given shape.
4868         #  Free face is a face, which is not shared between two shells of the shape.
4869         #  @param theShape Shape to find free faces in.
4870         #  @return List of IDs of all free faces, contained in theShape.
4871         #
4872         #  @ref tui_free_faces_page "Example"
4873         @ManageTransactions("ShapesOp")
4874         def GetFreeFacesIDs(self,theShape):
4875             """
4876             Retrieve all free faces from the given shape.
4877             Free face is a face, which is not shared between two shells of the shape.
4878
4879             Parameters:
4880                 theShape Shape to find free faces in.
4881
4882             Returns:
4883                 List of IDs of all free faces, contained in theShape.
4884             """
4885             # Example: see GEOM_TestOthers.py
4886             anIDs = self.ShapesOp.GetFreeFacesIDs(theShape)
4887             RaiseIfFailed("GetFreeFacesIDs", self.ShapesOp)
4888             return anIDs
4889
4890         ## Get all sub-shapes of theShape1 of the given type, shared with theShape2.
4891         #  @param theShape1 Shape to find sub-shapes in.
4892         #  @param theShape2 Shape to find shared sub-shapes with.
4893         #  @param theShapeType Type of sub-shapes to be retrieved.
4894         #  @param theName Object name; when specified, this parameter is used
4895         #         for result publication in the study. Otherwise, if automatic
4896         #         publication is switched on, default value is used for result name.
4897         #
4898         #  @return List of sub-shapes of theShape1, shared with theShape2.
4899         #
4900         #  @ref swig_GetSharedShapes "Example"
4901         @ManageTransactions("ShapesOp")
4902         def GetSharedShapes(self, theShape1, theShape2, theShapeType, theName=None):
4903             """
4904             Get all sub-shapes of theShape1 of the given type, shared with theShape2.
4905
4906             Parameters:
4907                 theShape1 Shape to find sub-shapes in.
4908                 theShape2 Shape to find shared sub-shapes with.
4909                 theShapeType Type of sub-shapes to be retrieved.
4910                 theName Object name; when specified, this parameter is used
4911                         for result publication in the study. Otherwise, if automatic
4912                         publication is switched on, default value is used for result name.
4913
4914             Returns:
4915                 List of sub-shapes of theShape1, shared with theShape2.
4916             """
4917             # Example: see GEOM_TestOthers.py
4918             aList = self.ShapesOp.GetSharedShapes(theShape1, theShape2, theShapeType)
4919             RaiseIfFailed("GetSharedShapes", self.ShapesOp)
4920             self._autoPublish(aList, theName, "shared")
4921             return aList
4922
4923         ## Get all sub-shapes, shared by all shapes in the list <VAR>theShapes</VAR>.
4924         #  @param theShapes Either a list or compound of shapes to find common sub-shapes of.
4925         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
4926         #  @param theName Object name; when specified, this parameter is used
4927         #         for result publication in the study. Otherwise, if automatic
4928         #         publication is switched on, default value is used for result name.
4929         #
4930         #  @return List of objects, that are sub-shapes of all given shapes.
4931         #
4932         #  @ref swig_GetSharedShapes "Example"
4933         @ManageTransactions("ShapesOp")
4934         def GetSharedShapesMulti(self, theShapes, theShapeType, theName=None):
4935             """
4936             Get all sub-shapes, shared by all shapes in the list theShapes.
4937
4938             Parameters:
4939                 theShapes Either a list or compound of shapes to find common sub-shapes of.
4940                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
4941                 theName Object name; when specified, this parameter is used
4942                         for result publication in the study. Otherwise, if automatic
4943                         publication is switched on, default value is used for result name.
4944
4945             Returns:
4946                 List of GEOM.GEOM_Object, that are sub-shapes of all given shapes.
4947             """
4948             # Example: see GEOM_TestOthers.py
4949             aList = self.ShapesOp.GetSharedShapesMulti(ToList(theShapes), theShapeType)
4950             RaiseIfFailed("GetSharedShapesMulti", self.ShapesOp)
4951             self._autoPublish(aList, theName, "shared")
4952             return aList
4953
4954         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
4955         #  situated relatively the specified plane by the certain way,
4956         #  defined through <VAR>theState</VAR> parameter.
4957         #  @param theShape Shape to find sub-shapes of.
4958         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
4959         #  @param theAx1 Vector (or line, or linear edge), specifying normal
4960         #                direction and location of the plane to find shapes on.
4961         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
4962         #  @param theName Object name; when specified, this parameter is used
4963         #         for result publication in the study. Otherwise, if automatic
4964         #         publication is switched on, default value is used for result name.
4965         #
4966         #  @return List of all found sub-shapes.
4967         #
4968         #  @ref swig_GetShapesOnPlane "Example"
4969         @ManageTransactions("ShapesOp")
4970         def GetShapesOnPlane(self, theShape, theShapeType, theAx1, theState, theName=None):
4971             """
4972             Find in theShape all sub-shapes of type theShapeType,
4973             situated relatively the specified plane by the certain way,
4974             defined through theState parameter.
4975
4976             Parameters:
4977                 theShape Shape to find sub-shapes of.
4978                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
4979                 theAx1 Vector (or line, or linear edge), specifying normal
4980                        direction and location of the plane to find shapes on.
4981                 theState The state of the sub-shapes to find (see GEOM::shape_state)
4982                 theName Object name; when specified, this parameter is used
4983                         for result publication in the study. Otherwise, if automatic
4984                         publication is switched on, default value is used for result name.
4985
4986             Returns:
4987                 List of all found sub-shapes.
4988             """
4989             # Example: see GEOM_TestOthers.py
4990             aList = self.ShapesOp.GetShapesOnPlane(theShape, theShapeType, theAx1, theState)
4991             RaiseIfFailed("GetShapesOnPlane", self.ShapesOp)
4992             self._autoPublish(aList, theName, "shapeOnPlane")
4993             return aList
4994
4995         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
4996         #  situated relatively the specified plane by the certain way,
4997         #  defined through <VAR>theState</VAR> parameter.
4998         #  @param theShape Shape to find sub-shapes of.
4999         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5000         #  @param theAx1 Vector (or line, or linear edge), specifying normal
5001         #                direction and location of the plane to find shapes on.
5002         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5003         #
5004         #  @return List of all found sub-shapes indices.
5005         #
5006         #  @ref swig_GetShapesOnPlaneIDs "Example"
5007         @ManageTransactions("ShapesOp")
5008         def GetShapesOnPlaneIDs(self, theShape, theShapeType, theAx1, theState):
5009             """
5010             Find in theShape all sub-shapes of type theShapeType,
5011             situated relatively the specified plane by the certain way,
5012             defined through theState parameter.
5013
5014             Parameters:
5015                 theShape Shape to find sub-shapes of.
5016                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5017                 theAx1 Vector (or line, or linear edge), specifying normal
5018                        direction and location of the plane to find shapes on.
5019                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5020
5021             Returns:
5022                 List of all found sub-shapes indices.
5023             """
5024             # Example: see GEOM_TestOthers.py
5025             aList = self.ShapesOp.GetShapesOnPlaneIDs(theShape, theShapeType, theAx1, theState)
5026             RaiseIfFailed("GetShapesOnPlaneIDs", self.ShapesOp)
5027             return aList
5028
5029         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
5030         #  situated relatively the specified plane by the certain way,
5031         #  defined through <VAR>theState</VAR> parameter.
5032         #  @param theShape Shape to find sub-shapes of.
5033         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5034         #  @param theAx1 Vector (or line, or linear edge), specifying normal
5035         #                direction of the plane to find shapes on.
5036         #  @param thePnt Point specifying location of the plane to find shapes on.
5037         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5038         #  @param theName Object name; when specified, this parameter is used
5039         #         for result publication in the study. Otherwise, if automatic
5040         #         publication is switched on, default value is used for result name.
5041         #
5042         #  @return List of all found sub-shapes.
5043         #
5044         #  @ref swig_GetShapesOnPlaneWithLocation "Example"
5045         @ManageTransactions("ShapesOp")
5046         def GetShapesOnPlaneWithLocation(self, theShape, theShapeType, theAx1, thePnt, theState, theName=None):
5047             """
5048             Find in theShape all sub-shapes of type theShapeType,
5049             situated relatively the specified plane by the certain way,
5050             defined through theState parameter.
5051
5052             Parameters:
5053                 theShape Shape to find sub-shapes of.
5054                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5055                 theAx1 Vector (or line, or linear edge), specifying normal
5056                        direction and location of the plane to find shapes on.
5057                 thePnt Point specifying location of the plane to find shapes on.
5058                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5059                 theName Object name; when specified, this parameter is used
5060                         for result publication in the study. Otherwise, if automatic
5061                         publication is switched on, default value is used for result name.
5062
5063             Returns:
5064                 List of all found sub-shapes.
5065             """
5066             # Example: see GEOM_TestOthers.py
5067             aList = self.ShapesOp.GetShapesOnPlaneWithLocation(theShape, theShapeType,
5068                                                                theAx1, thePnt, theState)
5069             RaiseIfFailed("GetShapesOnPlaneWithLocation", self.ShapesOp)
5070             self._autoPublish(aList, theName, "shapeOnPlane")
5071             return aList
5072
5073         ## Find in <VAR>theShape</VAR> all sub-shapes of type <VAR>theShapeType</VAR>,
5074         #  situated relatively the specified plane by the certain way,
5075         #  defined through <VAR>theState</VAR> parameter.
5076         #  @param theShape Shape to find sub-shapes of.
5077         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5078         #  @param theAx1 Vector (or line, or linear edge), specifying normal
5079         #                direction of the plane to find shapes on.
5080         #  @param thePnt Point specifying location of the plane to find shapes on.
5081         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5082         #
5083         #  @return List of all found sub-shapes indices.
5084         #
5085         #  @ref swig_GetShapesOnPlaneWithLocationIDs "Example"
5086         @ManageTransactions("ShapesOp")
5087         def GetShapesOnPlaneWithLocationIDs(self, theShape, theShapeType, theAx1, thePnt, theState):
5088             """
5089             Find in theShape all sub-shapes of type theShapeType,
5090             situated relatively the specified plane by the certain way,
5091             defined through theState parameter.
5092
5093             Parameters:
5094                 theShape Shape to find sub-shapes of.
5095                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5096                 theAx1 Vector (or line, or linear edge), specifying normal
5097                        direction and location of the plane to find shapes on.
5098                 thePnt Point specifying location of the plane to find shapes on.
5099                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5100
5101             Returns:
5102                 List of all found sub-shapes indices.
5103             """
5104             # Example: see GEOM_TestOthers.py
5105             aList = self.ShapesOp.GetShapesOnPlaneWithLocationIDs(theShape, theShapeType,
5106                                                                   theAx1, thePnt, theState)
5107             RaiseIfFailed("GetShapesOnPlaneWithLocationIDs", self.ShapesOp)
5108             return aList
5109
5110         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5111         #  the specified cylinder by the certain way, defined through \a theState parameter.
5112         #  @param theShape Shape to find sub-shapes of.
5113         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5114         #  @param theAxis Vector (or line, or linear edge), specifying
5115         #                 axis of the cylinder to find shapes on.
5116         #  @param theRadius Radius of the cylinder to find shapes on.
5117         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5118         #  @param theName Object name; when specified, this parameter is used
5119         #         for result publication in the study. Otherwise, if automatic
5120         #         publication is switched on, default value is used for result name.
5121         #
5122         #  @return List of all found sub-shapes.
5123         #
5124         #  @ref swig_GetShapesOnCylinder "Example"
5125         @ManageTransactions("ShapesOp")
5126         def GetShapesOnCylinder(self, theShape, theShapeType, theAxis, theRadius, theState, theName=None):
5127             """
5128             Find in theShape all sub-shapes of type theShapeType, situated relatively
5129             the specified cylinder by the certain way, defined through theState parameter.
5130
5131             Parameters:
5132                 theShape Shape to find sub-shapes of.
5133                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5134                 theAxis Vector (or line, or linear edge), specifying
5135                         axis of the cylinder to find shapes on.
5136                 theRadius Radius of the cylinder to find shapes on.
5137                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5138                 theName Object name; when specified, this parameter is used
5139                         for result publication in the study. Otherwise, if automatic
5140                         publication is switched on, default value is used for result name.
5141
5142             Returns:
5143                 List of all found sub-shapes.
5144             """
5145             # Example: see GEOM_TestOthers.py
5146             aList = self.ShapesOp.GetShapesOnCylinder(theShape, theShapeType, theAxis, theRadius, theState)
5147             RaiseIfFailed("GetShapesOnCylinder", self.ShapesOp)
5148             self._autoPublish(aList, theName, "shapeOnCylinder")
5149             return aList
5150
5151         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5152         #  the specified cylinder by the certain way, defined through \a theState parameter.
5153         #  @param theShape Shape to find sub-shapes of.
5154         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5155         #  @param theAxis Vector (or line, or linear edge), specifying
5156         #                 axis of the cylinder to find shapes on.
5157         #  @param theRadius Radius of the cylinder to find shapes on.
5158         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5159         #
5160         #  @return List of all found sub-shapes indices.
5161         #
5162         #  @ref swig_GetShapesOnCylinderIDs "Example"
5163         @ManageTransactions("ShapesOp")
5164         def GetShapesOnCylinderIDs(self, theShape, theShapeType, theAxis, theRadius, theState):
5165             """
5166             Find in theShape all sub-shapes of type theShapeType, situated relatively
5167             the specified cylinder by the certain way, defined through theState parameter.
5168
5169             Parameters:
5170                 theShape Shape to find sub-shapes of.
5171                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5172                 theAxis Vector (or line, or linear edge), specifying
5173                         axis of the cylinder to find shapes on.
5174                 theRadius Radius of the cylinder to find shapes on.
5175                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5176
5177             Returns:
5178                 List of all found sub-shapes indices.
5179             """
5180             # Example: see GEOM_TestOthers.py
5181             aList = self.ShapesOp.GetShapesOnCylinderIDs(theShape, theShapeType, theAxis, theRadius, theState)
5182             RaiseIfFailed("GetShapesOnCylinderIDs", self.ShapesOp)
5183             return aList
5184
5185         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5186         #  the specified cylinder by the certain way, defined through \a theState parameter.
5187         #  @param theShape Shape to find sub-shapes of.
5188         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5189         #  @param theAxis Vector (or line, or linear edge), specifying
5190         #                 axis of the cylinder to find shapes on.
5191         #  @param thePnt Point specifying location of the bottom of the cylinder.
5192         #  @param theRadius Radius of the cylinder to find shapes on.
5193         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5194         #  @param theName Object name; when specified, this parameter is used
5195         #         for result publication in the study. Otherwise, if automatic
5196         #         publication is switched on, default value is used for result name.
5197         #
5198         #  @return List of all found sub-shapes.
5199         #
5200         #  @ref swig_GetShapesOnCylinderWithLocation "Example"
5201         @ManageTransactions("ShapesOp")
5202         def GetShapesOnCylinderWithLocation(self, theShape, theShapeType, theAxis, thePnt, theRadius, theState, theName=None):
5203             """
5204             Find in theShape all sub-shapes of type theShapeType, situated relatively
5205             the specified cylinder by the certain way, defined through theState parameter.
5206
5207             Parameters:
5208                 theShape Shape to find sub-shapes of.
5209                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5210                 theAxis Vector (or line, or linear edge), specifying
5211                         axis of the cylinder to find shapes on.
5212                 theRadius Radius of the cylinder to find shapes on.
5213                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5214                 theName Object name; when specified, this parameter is used
5215                         for result publication in the study. Otherwise, if automatic
5216                         publication is switched on, default value is used for result name.
5217
5218             Returns:
5219                 List of all found sub-shapes.
5220             """
5221             # Example: see GEOM_TestOthers.py
5222             aList = self.ShapesOp.GetShapesOnCylinderWithLocation(theShape, theShapeType, theAxis, thePnt, theRadius, theState)
5223             RaiseIfFailed("GetShapesOnCylinderWithLocation", self.ShapesOp)
5224             self._autoPublish(aList, theName, "shapeOnCylinder")
5225             return aList
5226
5227         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5228         #  the specified cylinder by the certain way, defined through \a theState parameter.
5229         #  @param theShape Shape to find sub-shapes of.
5230         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5231         #  @param theAxis Vector (or line, or linear edge), specifying
5232         #                 axis of the cylinder to find shapes on.
5233         #  @param thePnt Point specifying location of the bottom of the cylinder.
5234         #  @param theRadius Radius of the cylinder to find shapes on.
5235         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5236         #
5237         #  @return List of all found sub-shapes indices
5238         #
5239         #  @ref swig_GetShapesOnCylinderWithLocationIDs "Example"
5240         @ManageTransactions("ShapesOp")
5241         def GetShapesOnCylinderWithLocationIDs(self, theShape, theShapeType, theAxis, thePnt, theRadius, theState):
5242             """
5243             Find in theShape all sub-shapes of type theShapeType, situated relatively
5244             the specified cylinder by the certain way, defined through theState parameter.
5245
5246             Parameters:
5247                 theShape Shape to find sub-shapes of.
5248                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5249                 theAxis Vector (or line, or linear edge), specifying
5250                         axis of the cylinder to find shapes on.
5251                 theRadius Radius of the cylinder to find shapes on.
5252                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5253
5254             Returns:
5255                 List of all found sub-shapes indices.
5256             """
5257             # Example: see GEOM_TestOthers.py
5258             aList = self.ShapesOp.GetShapesOnCylinderWithLocationIDs(theShape, theShapeType, theAxis, thePnt, theRadius, theState)
5259             RaiseIfFailed("GetShapesOnCylinderWithLocationIDs", self.ShapesOp)
5260             return aList
5261
5262         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5263         #  the specified sphere by the certain way, defined through \a theState parameter.
5264         #  @param theShape Shape to find sub-shapes of.
5265         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5266         #  @param theCenter Point, specifying center of the sphere to find shapes on.
5267         #  @param theRadius Radius of the sphere to find shapes on.
5268         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5269         #  @param theName Object name; when specified, this parameter is used
5270         #         for result publication in the study. Otherwise, if automatic
5271         #         publication is switched on, default value is used for result name.
5272         #
5273         #  @return List of all found sub-shapes.
5274         #
5275         #  @ref swig_GetShapesOnSphere "Example"
5276         @ManageTransactions("ShapesOp")
5277         def GetShapesOnSphere(self, theShape, theShapeType, theCenter, theRadius, theState, theName=None):
5278             """
5279             Find in theShape all sub-shapes of type theShapeType, situated relatively
5280             the specified sphere by the certain way, defined through theState parameter.
5281
5282             Parameters:
5283                 theShape Shape to find sub-shapes of.
5284                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5285                 theCenter Point, specifying center of the sphere to find shapes on.
5286                 theRadius Radius of the sphere to find shapes on.
5287                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5288                 theName Object name; when specified, this parameter is used
5289                         for result publication in the study. Otherwise, if automatic
5290                         publication is switched on, default value is used for result name.
5291
5292             Returns:
5293                 List of all found sub-shapes.
5294             """
5295             # Example: see GEOM_TestOthers.py
5296             aList = self.ShapesOp.GetShapesOnSphere(theShape, theShapeType, theCenter, theRadius, theState)
5297             RaiseIfFailed("GetShapesOnSphere", self.ShapesOp)
5298             self._autoPublish(aList, theName, "shapeOnSphere")
5299             return aList
5300
5301         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5302         #  the specified sphere by the certain way, defined through \a theState parameter.
5303         #  @param theShape Shape to find sub-shapes of.
5304         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5305         #  @param theCenter Point, specifying center of the sphere to find shapes on.
5306         #  @param theRadius Radius of the sphere to find shapes on.
5307         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5308         #
5309         #  @return List of all found sub-shapes indices.
5310         #
5311         #  @ref swig_GetShapesOnSphereIDs "Example"
5312         @ManageTransactions("ShapesOp")
5313         def GetShapesOnSphereIDs(self, theShape, theShapeType, theCenter, theRadius, theState):
5314             """
5315             Find in theShape all sub-shapes of type theShapeType, situated relatively
5316             the specified sphere by the certain way, defined through theState parameter.
5317
5318             Parameters:
5319                 theShape Shape to find sub-shapes of.
5320                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5321                 theCenter Point, specifying center of the sphere to find shapes on.
5322                 theRadius Radius of the sphere to find shapes on.
5323                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5324
5325             Returns:
5326                 List of all found sub-shapes indices.
5327             """
5328             # Example: see GEOM_TestOthers.py
5329             aList = self.ShapesOp.GetShapesOnSphereIDs(theShape, theShapeType, theCenter, theRadius, theState)
5330             RaiseIfFailed("GetShapesOnSphereIDs", self.ShapesOp)
5331             return aList
5332
5333         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5334         #  the specified quadrangle by the certain way, defined through \a theState parameter.
5335         #  @param theShape Shape to find sub-shapes of.
5336         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5337         #  @param theTopLeftPoint Point, specifying top left corner of a quadrangle
5338         #  @param theTopRigthPoint Point, specifying top right corner of a quadrangle
5339         #  @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5340         #  @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5341         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5342         #  @param theName Object name; when specified, this parameter is used
5343         #         for result publication in the study. Otherwise, if automatic
5344         #         publication is switched on, default value is used for result name.
5345         #
5346         #  @return List of all found sub-shapes.
5347         #
5348         #  @ref swig_GetShapesOnQuadrangle "Example"
5349         @ManageTransactions("ShapesOp")
5350         def GetShapesOnQuadrangle(self, theShape, theShapeType,
5351                                   theTopLeftPoint, theTopRigthPoint,
5352                                   theBottomLeftPoint, theBottomRigthPoint, theState, theName=None):
5353             """
5354             Find in theShape all sub-shapes of type theShapeType, situated relatively
5355             the specified quadrangle by the certain way, defined through theState parameter.
5356
5357             Parameters:
5358                 theShape Shape to find sub-shapes of.
5359                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5360                 theTopLeftPoint Point, specifying top left corner of a quadrangle
5361                 theTopRigthPoint Point, specifying top right corner of a quadrangle
5362                 theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5363                 theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5364                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5365                 theName Object name; when specified, this parameter is used
5366                         for result publication in the study. Otherwise, if automatic
5367                         publication is switched on, default value is used for result name.
5368
5369             Returns:
5370                 List of all found sub-shapes.
5371             """
5372             # Example: see GEOM_TestOthers.py
5373             aList = self.ShapesOp.GetShapesOnQuadrangle(theShape, theShapeType,
5374                                                         theTopLeftPoint, theTopRigthPoint,
5375                                                         theBottomLeftPoint, theBottomRigthPoint, theState)
5376             RaiseIfFailed("GetShapesOnQuadrangle", self.ShapesOp)
5377             self._autoPublish(aList, theName, "shapeOnQuadrangle")
5378             return aList
5379
5380         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5381         #  the specified quadrangle by the certain way, defined through \a theState parameter.
5382         #  @param theShape Shape to find sub-shapes of.
5383         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5384         #  @param theTopLeftPoint Point, specifying top left corner of a quadrangle
5385         #  @param theTopRigthPoint Point, specifying top right corner of a quadrangle
5386         #  @param theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5387         #  @param theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5388         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5389         #
5390         #  @return List of all found sub-shapes indices.
5391         #
5392         #  @ref swig_GetShapesOnQuadrangleIDs "Example"
5393         @ManageTransactions("ShapesOp")
5394         def GetShapesOnQuadrangleIDs(self, theShape, theShapeType,
5395                                      theTopLeftPoint, theTopRigthPoint,
5396                                      theBottomLeftPoint, theBottomRigthPoint, theState):
5397             """
5398             Find in theShape all sub-shapes of type theShapeType, situated relatively
5399             the specified quadrangle by the certain way, defined through theState parameter.
5400
5401             Parameters:
5402                 theShape Shape to find sub-shapes of.
5403                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5404                 theTopLeftPoint Point, specifying top left corner of a quadrangle
5405                 theTopRigthPoint Point, specifying top right corner of a quadrangle
5406                 theBottomLeftPoint Point, specifying bottom left corner of a quadrangle
5407                 theBottomRigthPoint Point, specifying bottom right corner of a quadrangle
5408                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5409
5410             Returns:
5411                 List of all found sub-shapes indices.
5412             """
5413
5414             # Example: see GEOM_TestOthers.py
5415             aList = self.ShapesOp.GetShapesOnQuadrangleIDs(theShape, theShapeType,
5416                                                            theTopLeftPoint, theTopRigthPoint,
5417                                                            theBottomLeftPoint, theBottomRigthPoint, theState)
5418             RaiseIfFailed("GetShapesOnQuadrangleIDs", self.ShapesOp)
5419             return aList
5420
5421         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5422         #  the specified \a theBox by the certain way, defined through \a theState parameter.
5423         #  @param theBox Shape for relative comparing.
5424         #  @param theShape Shape to find sub-shapes of.
5425         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5426         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5427         #  @param theName Object name; when specified, this parameter is used
5428         #         for result publication in the study. Otherwise, if automatic
5429         #         publication is switched on, default value is used for result name.
5430         #
5431         #  @return List of all found sub-shapes.
5432         #
5433         #  @ref swig_GetShapesOnBox "Example"
5434         @ManageTransactions("ShapesOp")
5435         def GetShapesOnBox(self, theBox, theShape, theShapeType, theState, theName=None):
5436             """
5437             Find in theShape all sub-shapes of type theShapeType, situated relatively
5438             the specified theBox by the certain way, defined through theState parameter.
5439
5440             Parameters:
5441                 theBox Shape for relative comparing.
5442                 theShape Shape to find sub-shapes of.
5443                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5444                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5445                 theName Object name; when specified, this parameter is used
5446                         for result publication in the study. Otherwise, if automatic
5447                         publication is switched on, default value is used for result name.
5448
5449             Returns:
5450                 List of all found sub-shapes.
5451             """
5452             # Example: see GEOM_TestOthers.py
5453             aList = self.ShapesOp.GetShapesOnBox(theBox, theShape, theShapeType, theState)
5454             RaiseIfFailed("GetShapesOnBox", self.ShapesOp)
5455             self._autoPublish(aList, theName, "shapeOnBox")
5456             return aList
5457
5458         ## Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
5459         #  the specified \a theBox by the certain way, defined through \a theState parameter.
5460         #  @param theBox Shape for relative comparing.
5461         #  @param theShape Shape to find sub-shapes of.
5462         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5463         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5464         #
5465         #  @return List of all found sub-shapes indices.
5466         #
5467         #  @ref swig_GetShapesOnBoxIDs "Example"
5468         @ManageTransactions("ShapesOp")
5469         def GetShapesOnBoxIDs(self, theBox, theShape, theShapeType, theState):
5470             """
5471             Find in theShape all sub-shapes of type theShapeType, situated relatively
5472             the specified theBox by the certain way, defined through theState parameter.
5473
5474             Parameters:
5475                 theBox Shape for relative comparing.
5476                 theShape Shape to find sub-shapes of.
5477                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5478                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5479
5480             Returns:
5481                 List of all found sub-shapes indices.
5482             """
5483             # Example: see GEOM_TestOthers.py
5484             aList = self.ShapesOp.GetShapesOnBoxIDs(theBox, theShape, theShapeType, theState)
5485             RaiseIfFailed("GetShapesOnBoxIDs", self.ShapesOp)
5486             return aList
5487
5488         ## Find in \a theShape all sub-shapes of type \a theShapeType,
5489         #  situated relatively the specified \a theCheckShape by the
5490         #  certain way, defined through \a theState parameter.
5491         #  @param theCheckShape Shape for relative comparing. It must be a solid.
5492         #  @param theShape Shape to find sub-shapes of.
5493         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5494         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5495         #  @param theName Object name; when specified, this parameter is used
5496         #         for result publication in the study. Otherwise, if automatic
5497         #         publication is switched on, default value is used for result name.
5498         #
5499         #  @return List of all found sub-shapes.
5500         #
5501         #  @ref swig_GetShapesOnShape "Example"
5502         @ManageTransactions("ShapesOp")
5503         def GetShapesOnShape(self, theCheckShape, theShape, theShapeType, theState, theName=None):
5504             """
5505             Find in theShape all sub-shapes of type theShapeType,
5506             situated relatively the specified theCheckShape by the
5507             certain way, defined through theState parameter.
5508
5509             Parameters:
5510                 theCheckShape Shape for relative comparing. It must be a solid.
5511                 theShape Shape to find sub-shapes of.
5512                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5513                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5514                 theName Object name; when specified, this parameter is used
5515                         for result publication in the study. Otherwise, if automatic
5516                         publication is switched on, default value is used for result name.
5517
5518             Returns:
5519                 List of all found sub-shapes.
5520             """
5521             # Example: see GEOM_TestOthers.py
5522             aList = self.ShapesOp.GetShapesOnShape(theCheckShape, theShape,
5523                                                    theShapeType, theState)
5524             RaiseIfFailed("GetShapesOnShape", self.ShapesOp)
5525             self._autoPublish(aList, theName, "shapeOnShape")
5526             return aList
5527
5528         ## Find in \a theShape all sub-shapes of type \a theShapeType,
5529         #  situated relatively the specified \a theCheckShape by the
5530         #  certain way, defined through \a theState parameter.
5531         #  @param theCheckShape Shape for relative comparing. It must be a solid.
5532         #  @param theShape Shape to find sub-shapes of.
5533         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5534         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5535         #  @param theName Object name; when specified, this parameter is used
5536         #         for result publication in the study. Otherwise, if automatic
5537         #         publication is switched on, default value is used for result name.
5538         #
5539         #  @return All found sub-shapes as compound.
5540         #
5541         #  @ref swig_GetShapesOnShapeAsCompound "Example"
5542         @ManageTransactions("ShapesOp")
5543         def GetShapesOnShapeAsCompound(self, theCheckShape, theShape, theShapeType, theState, theName=None):
5544             """
5545             Find in theShape all sub-shapes of type theShapeType,
5546             situated relatively the specified theCheckShape by the
5547             certain way, defined through theState parameter.
5548
5549             Parameters:
5550                 theCheckShape Shape for relative comparing. It must be a solid.
5551                 theShape Shape to find sub-shapes of.
5552                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5553                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5554                 theName Object name; when specified, this parameter is used
5555                         for result publication in the study. Otherwise, if automatic
5556                         publication is switched on, default value is used for result name.
5557
5558             Returns:
5559                 All found sub-shapes as compound.
5560             """
5561             # Example: see GEOM_TestOthers.py
5562             anObj = self.ShapesOp.GetShapesOnShapeAsCompound(theCheckShape, theShape,
5563                                                              theShapeType, theState)
5564             RaiseIfFailed("GetShapesOnShapeAsCompound", self.ShapesOp)
5565             self._autoPublish(anObj, theName, "shapeOnShape")
5566             return anObj
5567
5568         ## Find in \a theShape all sub-shapes of type \a theShapeType,
5569         #  situated relatively the specified \a theCheckShape by the
5570         #  certain way, defined through \a theState parameter.
5571         #  @param theCheckShape Shape for relative comparing. It must be a solid.
5572         #  @param theShape Shape to find sub-shapes of.
5573         #  @param theShapeType Type of sub-shapes to be retrieved (see ShapeType())
5574         #  @param theState The state of the sub-shapes to find (see GEOM::shape_state)
5575         #
5576         #  @return List of all found sub-shapes indices.
5577         #
5578         #  @ref swig_GetShapesOnShapeIDs "Example"
5579         @ManageTransactions("ShapesOp")
5580         def GetShapesOnShapeIDs(self, theCheckShape, theShape, theShapeType, theState):
5581             """
5582             Find in theShape all sub-shapes of type theShapeType,
5583             situated relatively the specified theCheckShape by the
5584             certain way, defined through theState parameter.
5585
5586             Parameters:
5587                 theCheckShape Shape for relative comparing. It must be a solid.
5588                 theShape Shape to find sub-shapes of.
5589                 theShapeType Type of sub-shapes to be retrieved (see geompy.ShapeType)
5590                 theState The state of the sub-shapes to find (see GEOM::shape_state)
5591
5592             Returns:
5593                 List of all found sub-shapes indices.
5594             """
5595             # Example: see GEOM_TestOthers.py
5596             aList = self.ShapesOp.GetShapesOnShapeIDs(theCheckShape, theShape,
5597                                                       theShapeType, theState)
5598             RaiseIfFailed("GetShapesOnShapeIDs", self.ShapesOp)
5599             return aList
5600
5601         ## Get sub-shape(s) of theShapeWhere, which are
5602         #  coincident with \a theShapeWhat or could be a part of it.
5603         #  @param theShapeWhere Shape to find sub-shapes of.
5604         #  @param theShapeWhat Shape, specifying what to find.
5605         #  @param isNewImplementation implementation of GetInPlace functionality
5606         #             (default = False, old alghorithm based on shape properties)
5607         #  @param theName Object name; when specified, this parameter is used
5608         #         for result publication in the study. Otherwise, if automatic
5609         #         publication is switched on, default value is used for result name.
5610         #
5611         #  @return Group of all found sub-shapes or a single found sub-shape.
5612         #
5613         #  @note This function has a restriction on argument shapes.
5614         #        If \a theShapeWhere has curved parts with significantly
5615         #        outstanding centres (i.e. the mass centre of a part is closer to
5616         #        \a theShapeWhat than to the part), such parts will not be found.
5617         #        @image html get_in_place_lost_part.png
5618         #
5619         #  @ref swig_GetInPlace "Example"
5620         @ManageTransactions("ShapesOp")
5621         def GetInPlace(self, theShapeWhere, theShapeWhat, isNewImplementation = False, theName=None):
5622             """
5623             Get sub-shape(s) of theShapeWhere, which are
5624             coincident with  theShapeWhat or could be a part of it.
5625
5626             Parameters:
5627                 theShapeWhere Shape to find sub-shapes of.
5628                 theShapeWhat Shape, specifying what to find.
5629                 isNewImplementation Implementation of GetInPlace functionality
5630                                     (default = False, old alghorithm based on shape properties)
5631                 theName Object name; when specified, this parameter is used
5632                         for result publication in the study. Otherwise, if automatic
5633                         publication is switched on, default value is used for result name.
5634
5635             Returns:
5636                 Group of all found sub-shapes or a single found sub-shape.
5637
5638
5639             Note:
5640                 This function has a restriction on argument shapes.
5641                 If theShapeWhere has curved parts with significantly
5642                 outstanding centres (i.e. the mass centre of a part is closer to
5643                 theShapeWhat than to the part), such parts will not be found.
5644             """
5645             # Example: see GEOM_TestOthers.py
5646             anObj = None
5647             if isNewImplementation:
5648                 anObj = self.ShapesOp.GetInPlace(theShapeWhere, theShapeWhat)
5649             else:
5650                 anObj = self.ShapesOp.GetInPlaceOld(theShapeWhere, theShapeWhat)
5651                 pass
5652             RaiseIfFailed("GetInPlace", self.ShapesOp)
5653             self._autoPublish(anObj, theName, "inplace")
5654             return anObj
5655
5656         ## Get sub-shape(s) of \a theShapeWhere, which are
5657         #  coincident with \a theShapeWhat or could be a part of it.
5658         #
5659         #  Implementation of this method is based on a saved history of an operation,
5660         #  produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
5661         #  arguments (an argument shape or a sub-shape of an argument shape).
5662         #  The operation could be the Partition or one of boolean operations,
5663         #  performed on simple shapes (not on compounds).
5664         #
5665         #  @param theShapeWhere Shape to find sub-shapes of.
5666         #  @param theShapeWhat Shape, specifying what to find (must be in the
5667         #                      building history of the ShapeWhere).
5668         #  @param theName Object name; when specified, this parameter is used
5669         #         for result publication in the study. Otherwise, if automatic
5670         #         publication is switched on, default value is used for result name.
5671         #
5672         #  @return Group of all found sub-shapes or a single found sub-shape.
5673         #
5674         #  @ref swig_GetInPlace "Example"
5675         @ManageTransactions("ShapesOp")
5676         def GetInPlaceByHistory(self, theShapeWhere, theShapeWhat, theName=None):
5677             """
5678             Implementation of this method is based on a saved history of an operation,
5679             produced theShapeWhere. The theShapeWhat must be among this operation's
5680             arguments (an argument shape or a sub-shape of an argument shape).
5681             The operation could be the Partition or one of boolean operations,
5682             performed on simple shapes (not on compounds).
5683
5684             Parameters:
5685                 theShapeWhere Shape to find sub-shapes of.
5686                 theShapeWhat Shape, specifying what to find (must be in the
5687                                 building history of the ShapeWhere).
5688                 theName Object name; when specified, this parameter is used
5689                         for result publication in the study. Otherwise, if automatic
5690                         publication is switched on, default value is used for result name.
5691
5692             Returns:
5693                 Group of all found sub-shapes or a single found sub-shape.
5694             """
5695             # Example: see GEOM_TestOthers.py
5696             anObj = self.ShapesOp.GetInPlaceByHistory(theShapeWhere, theShapeWhat)
5697             RaiseIfFailed("GetInPlaceByHistory", self.ShapesOp)
5698             self._autoPublish(anObj, theName, "inplace")
5699             return anObj
5700
5701         ## Get sub-shape of theShapeWhere, which is
5702         #  equal to \a theShapeWhat.
5703         #  @param theShapeWhere Shape to find sub-shape of.
5704         #  @param theShapeWhat Shape, specifying what to find.
5705         #  @param theName Object name; when specified, this parameter is used
5706         #         for result publication in the study. Otherwise, if automatic
5707         #         publication is switched on, default value is used for result name.
5708         #
5709         #  @return New GEOM.GEOM_Object for found sub-shape.
5710         #
5711         #  @ref swig_GetSame "Example"
5712         @ManageTransactions("ShapesOp")
5713         def GetSame(self, theShapeWhere, theShapeWhat, theName=None):
5714             """
5715             Get sub-shape of theShapeWhere, which is
5716             equal to theShapeWhat.
5717
5718             Parameters:
5719                 theShapeWhere Shape to find sub-shape of.
5720                 theShapeWhat Shape, specifying what to find.
5721                 theName Object name; when specified, this parameter is used
5722                         for result publication in the study. Otherwise, if automatic
5723                         publication is switched on, default value is used for result name.
5724
5725             Returns:
5726                 New GEOM.GEOM_Object for found sub-shape.
5727             """
5728             anObj = self.ShapesOp.GetSame(theShapeWhere, theShapeWhat)
5729             RaiseIfFailed("GetSame", self.ShapesOp)
5730             self._autoPublish(anObj, theName, "sameShape")
5731             return anObj
5732
5733
5734         ## Get sub-shape indices of theShapeWhere, which is
5735         #  equal to \a theShapeWhat.
5736         #  @param theShapeWhere Shape to find sub-shape of.
5737         #  @param theShapeWhat Shape, specifying what to find.
5738         #  @return List of all found sub-shapes indices.
5739         #
5740         #  @ref swig_GetSame "Example"
5741         @ManageTransactions("ShapesOp")
5742         def GetSameIDs(self, theShapeWhere, theShapeWhat):
5743             """
5744             Get sub-shape indices of theShapeWhere, which is
5745             equal to theShapeWhat.
5746
5747             Parameters:
5748                 theShapeWhere Shape to find sub-shape of.
5749                 theShapeWhat Shape, specifying what to find.
5750
5751             Returns:
5752                 List of all found sub-shapes indices.
5753             """
5754             anObj = self.ShapesOp.GetSameIDs(theShapeWhere, theShapeWhat)
5755             RaiseIfFailed("GetSameIDs", self.ShapesOp)
5756             return anObj
5757
5758         ## Resize the input edge with the new Min and Max parameters.
5759         #  The input edge parameters range is [0, 1]. If theMin parameter is
5760         #  negative, the input edge is extended, otherwise it is shrinked by
5761         #  theMin parameter. If theMax is greater than 1, the edge is extended,
5762         #  otherwise it is shrinked by theMax parameter.
5763         #  @param theEdge the input edge to be resized.
5764         #  @param theMin the minimal parameter value.
5765         #  @param theMax the maximal parameter value.
5766         #  @param theName Object name; when specified, this parameter is used
5767         #         for result publication in the study. Otherwise, if automatic
5768         #         publication is switched on, default value is used for result name.
5769         #  @return New GEOM.GEOM_Object, containing the created edge.
5770         #
5771         #  @ref tui_extend "Example"
5772         @ManageTransactions("ShapesOp")
5773         def ExtendEdge(self, theEdge, theMin, theMax, theName=None):
5774             """
5775             Resize the input edge with the new Min and Max parameters.
5776             The input edge parameters range is [0, 1]. If theMin parameter is
5777             negative, the input edge is extended, otherwise it is shrinked by
5778             theMin parameter. If theMax is greater than 1, the edge is extended,
5779             otherwise it is shrinked by theMax parameter.
5780
5781             Parameters:
5782                 theEdge the input edge to be resized.
5783                 theMin the minimal parameter value.
5784                 theMax the maximal parameter value.
5785                 theName Object name; when specified, this parameter is used
5786                         for result publication in the study. Otherwise, if automatic
5787                         publication is switched on, default value is used for result name.
5788
5789             Returns:
5790                 New GEOM.GEOM_Object, containing the created edge.
5791             """
5792             anObj = self.ShapesOp.ExtendEdge(theEdge, theMin, theMax)
5793             RaiseIfFailed("ExtendEdge", self.ShapesOp)
5794             self._autoPublish(anObj, theName, "edge")
5795             return anObj
5796
5797         ## Resize the input face with the new UMin, UMax, VMin and VMax
5798         #  parameters. The input face U and V parameters range is [0, 1]. If
5799         #  theUMin parameter is negative, the input face is extended, otherwise
5800         #  it is shrinked along U direction by theUMin parameter. If theUMax is
5801         #  greater than 1, the face is extended, otherwise it is shrinked along
5802         #  U direction by theUMax parameter. So as for theVMin, theVMax and
5803         #  V direction of the input face.
5804         #  @param theFace the input face to be resized.
5805         #  @param theUMin the minimal U parameter value.
5806         #  @param theUMax the maximal U parameter value.
5807         #  @param theVMin the minimal V parameter value.
5808         #  @param theVMax the maximal V parameter value.
5809         #  @param theName Object name; when specified, this parameter is used
5810         #         for result publication in the study. Otherwise, if automatic
5811         #         publication is switched on, default value is used for result name.
5812         #  @return New GEOM.GEOM_Object, containing the created face.
5813         #
5814         #  @ref tui_extend "Example"
5815         @ManageTransactions("ShapesOp")
5816         def ExtendFace(self, theFace, theUMin, theUMax,
5817                        theVMin, theVMax, theName=None):
5818             """
5819             Resize the input face with the new UMin, UMax, VMin and VMax
5820             parameters. The input face U and V parameters range is [0, 1]. If
5821             theUMin parameter is negative, the input face is extended, otherwise
5822             it is shrinked along U direction by theUMin parameter. If theUMax is
5823             greater than 1, the face is extended, otherwise it is shrinked along
5824             U direction by theUMax parameter. So as for theVMin, theVMax and
5825             V direction of the input face.
5826
5827             Parameters:
5828                 theFace the input face to be resized.
5829                 theUMin the minimal U parameter value.
5830                 theUMax the maximal U parameter value.
5831                 theVMin the minimal V parameter value.
5832                 theVMax the maximal V parameter value.
5833                 theName Object name; when specified, this parameter is used
5834                         for result publication in the study. Otherwise, if automatic
5835                         publication is switched on, default value is used for result name.
5836
5837             Returns:
5838                 New GEOM.GEOM_Object, containing the created face.
5839             """
5840             anObj = self.ShapesOp.ExtendFace(theFace, theUMin, theUMax,
5841                                              theVMin, theVMax)
5842             RaiseIfFailed("ExtendFace", self.ShapesOp)
5843             self._autoPublish(anObj, theName, "face")
5844             return anObj
5845
5846         ## This function takes some face as input parameter and creates new
5847         #  GEOM_Object, i.e. topological shape by extracting underlying surface
5848         #  of the source face and limiting it by the Umin, Umax, Vmin, Vmax
5849         #  parameters of the source face (in the parametrical space).
5850         #  @param theFace the input face.
5851         #  @param theName Object name; when specified, this parameter is used
5852         #         for result publication in the study. Otherwise, if automatic
5853         #         publication is switched on, default value is used for result name.
5854         #  @return New GEOM.GEOM_Object, containing the created face.
5855         #
5856         #  @ref tui_creation_surface "Example"
5857         @ManageTransactions("ShapesOp")
5858         def MakeSurfaceFromFace(self, theFace, theName=None):
5859             """
5860             This function takes some face as input parameter and creates new
5861             GEOM_Object, i.e. topological shape by extracting underlying surface
5862             of the source face and limiting it by the Umin, Umax, Vmin, Vmax
5863             parameters of the source face (in the parametrical space).
5864
5865             Parameters:
5866                 theFace the input face.
5867                 theName Object name; when specified, this parameter is used
5868                         for result publication in the study. Otherwise, if automatic
5869                         publication is switched on, default value is used for result name.
5870
5871             Returns:
5872                 New GEOM.GEOM_Object, containing the created face.
5873             """
5874             anObj = self.ShapesOp.MakeSurfaceFromFace(theFace)
5875             RaiseIfFailed("MakeSurfaceFromFace", self.ShapesOp)
5876             self._autoPublish(anObj, theName, "surface")
5877             return anObj
5878
5879         # end of l4_obtain
5880         ## @}
5881
5882         ## @addtogroup l4_access
5883         ## @{
5884
5885         ## Obtain a composite sub-shape of <VAR>aShape</VAR>, composed from sub-shapes
5886         #  of aShape, selected by their unique IDs inside <VAR>aShape</VAR>
5887         #  @param aShape Shape to get sub-shape of.
5888         #  @param ListOfID List of sub-shapes indices.
5889         #  @param theName Object name; when specified, this parameter is used
5890         #         for result publication in the study. Otherwise, if automatic
5891         #         publication is switched on, default value is used for result name.
5892         #
5893         #  @return Found sub-shape.
5894         #
5895         #  @ref swig_all_decompose "Example"
5896         def GetSubShape(self, aShape, ListOfID, theName=None):
5897             """
5898             Obtain a composite sub-shape of aShape, composed from sub-shapes
5899             of aShape, selected by their unique IDs inside aShape
5900
5901             Parameters:
5902                 aShape Shape to get sub-shape of.
5903                 ListOfID List of sub-shapes indices.
5904                 theName Object name; when specified, this parameter is used
5905                         for result publication in the study. Otherwise, if automatic
5906                         publication is switched on, default value is used for result name.
5907
5908             Returns:
5909                 Found sub-shape.
5910             """
5911             # Example: see GEOM_TestAll.py
5912             anObj = self.AddSubShape(aShape,ListOfID)
5913             self._autoPublish(anObj, theName, "subshape")
5914             return anObj
5915
5916         ## Obtain unique ID of sub-shape <VAR>aSubShape</VAR> inside <VAR>aShape</VAR>
5917         #  of aShape, selected by their unique IDs inside <VAR>aShape</VAR>
5918         #  @param aShape Shape to get sub-shape of.
5919         #  @param aSubShape Sub-shapes of aShape.
5920         #  @return ID of found sub-shape.
5921         #
5922         #  @ref swig_all_decompose "Example"
5923         @ManageTransactions("LocalOp")
5924         def GetSubShapeID(self, aShape, aSubShape):
5925             """
5926             Obtain unique ID of sub-shape aSubShape inside aShape
5927             of aShape, selected by their unique IDs inside aShape
5928
5929             Parameters:
5930                aShape Shape to get sub-shape of.
5931                aSubShape Sub-shapes of aShape.
5932
5933             Returns:
5934                ID of found sub-shape.
5935             """
5936             # Example: see GEOM_TestAll.py
5937             anID = self.LocalOp.GetSubShapeIndex(aShape, aSubShape)
5938             RaiseIfFailed("GetSubShapeIndex", self.LocalOp)
5939             return anID
5940
5941         ## Obtain unique IDs of sub-shapes <VAR>aSubShapes</VAR> inside <VAR>aShape</VAR>
5942         #  This function is provided for performance purpose. The complexity is O(n) with n
5943         #  the number of subobjects of aShape
5944         #  @param aShape Shape to get sub-shape of.
5945         #  @param aSubShapes Sub-shapes of aShape.
5946         #  @return list of IDs of found sub-shapes.
5947         #
5948         #  @ref swig_all_decompose "Example"
5949         @ManageTransactions("ShapesOp")
5950         def GetSubShapesIDs(self, aShape, aSubShapes):
5951             """
5952             Obtain a list of IDs of sub-shapes aSubShapes inside aShape
5953             This function is provided for performance purpose. The complexity is O(n) with n
5954             the number of subobjects of aShape
5955
5956             Parameters:
5957                aShape Shape to get sub-shape of.
5958                aSubShapes Sub-shapes of aShape.
5959
5960             Returns:
5961                List of IDs of found sub-shape.
5962             """
5963             # Example: see GEOM_TestAll.py
5964             anIDs = self.ShapesOp.GetSubShapesIndices(aShape, aSubShapes)
5965             RaiseIfFailed("GetSubShapesIndices", self.ShapesOp)
5966             return anIDs
5967
5968         # end of l4_access
5969         ## @}
5970
5971         ## @addtogroup l4_decompose
5972         ## @{
5973
5974         ## Get all sub-shapes and groups of \a theShape,
5975         #  that were created already by any other methods.
5976         #  @param theShape Any shape.
5977         #  @param theGroupsOnly If this parameter is TRUE, only groups will be
5978         #                       returned, else all found sub-shapes and groups.
5979         #  @return List of existing sub-objects of \a theShape.
5980         #
5981         #  @ref swig_all_decompose "Example"
5982         @ManageTransactions("ShapesOp")
5983         def GetExistingSubObjects(self, theShape, theGroupsOnly = False):
5984             """
5985             Get all sub-shapes and groups of theShape,
5986             that were created already by any other methods.
5987
5988             Parameters:
5989                 theShape Any shape.
5990                 theGroupsOnly If this parameter is TRUE, only groups will be
5991                                  returned, else all found sub-shapes and groups.
5992
5993             Returns:
5994                 List of existing sub-objects of theShape.
5995             """
5996             # Example: see GEOM_TestAll.py
5997             ListObj = self.ShapesOp.GetExistingSubObjects(theShape, theGroupsOnly)
5998             RaiseIfFailed("GetExistingSubObjects", self.ShapesOp)
5999             return ListObj
6000
6001         ## Get all groups of \a theShape,
6002         #  that were created already by any other methods.
6003         #  @param theShape Any shape.
6004         #  @return List of existing groups of \a theShape.
6005         #
6006         #  @ref swig_all_decompose "Example"
6007         @ManageTransactions("ShapesOp")
6008         def GetGroups(self, theShape):
6009             """
6010             Get all groups of theShape,
6011             that were created already by any other methods.
6012
6013             Parameters:
6014                 theShape Any shape.
6015
6016             Returns:
6017                 List of existing groups of theShape.
6018             """
6019             # Example: see GEOM_TestAll.py
6020             ListObj = self.ShapesOp.GetExistingSubObjects(theShape, True)
6021             RaiseIfFailed("GetExistingSubObjects", self.ShapesOp)
6022             return ListObj
6023
6024         ## Explode a shape on sub-shapes of a given type.
6025         #  If the shape itself matches the type, it is also returned.
6026         #  @param aShape Shape to be exploded.
6027         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
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         #
6032         #  @return List of sub-shapes of type theShapeType, contained in theShape.
6033         #
6034         #  @ref swig_all_decompose "Example"
6035         @ManageTransactions("ShapesOp")
6036         def SubShapeAll(self, aShape, aType, theName=None):
6037             """
6038             Explode a shape on sub-shapes of a given type.
6039             If the shape itself matches the type, it is also returned.
6040
6041             Parameters:
6042                 aShape Shape to be exploded.
6043                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6044                 theName Object name; when specified, this parameter is used
6045                         for result publication in the study. Otherwise, if automatic
6046                         publication is switched on, default value is used for result name.
6047
6048             Returns:
6049                 List of sub-shapes of type theShapeType, contained in theShape.
6050             """
6051             # Example: see GEOM_TestAll.py
6052             ListObj = self.ShapesOp.MakeAllSubShapes(aShape, EnumToLong( aType ), False)
6053             RaiseIfFailed("SubShapeAll", self.ShapesOp)
6054             self._autoPublish(ListObj, theName, "subshape")
6055             return ListObj
6056
6057         ## Explode a shape on sub-shapes of a given type.
6058         #  @param aShape Shape to be exploded.
6059         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6060         #  @return List of IDs of sub-shapes.
6061         #
6062         #  @ref swig_all_decompose "Example"
6063         @ManageTransactions("ShapesOp")
6064         def SubShapeAllIDs(self, aShape, aType):
6065             """
6066             Explode a shape on sub-shapes of a given type.
6067
6068             Parameters:
6069                 aShape Shape to be exploded (see geompy.ShapeType)
6070                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6071
6072             Returns:
6073                 List of IDs of sub-shapes.
6074             """
6075             ListObj = self.ShapesOp.GetAllSubShapesIDs(aShape, EnumToLong( aType ), False)
6076             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
6077             return ListObj
6078
6079         ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
6080         #  selected by their indices in list of all sub-shapes of type <VAR>aType</VAR>.
6081         #  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6082         #  @param aShape Shape to get sub-shape of.
6083         #  @param ListOfInd List of sub-shapes indices.
6084         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6085         #  @param theName Object name; when specified, this parameter is used
6086         #         for result publication in the study. Otherwise, if automatic
6087         #         publication is switched on, default value is used for result name.
6088         #
6089         #  @return A compound of sub-shapes of aShape.
6090         #
6091         #  @ref swig_all_decompose "Example"
6092         def SubShape(self, aShape, aType, ListOfInd, theName=None):
6093             """
6094             Obtain a compound of sub-shapes of aShape,
6095             selected by their indices in list of all sub-shapes of type aType.
6096             Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6097
6098             Parameters:
6099                 aShape Shape to get sub-shape of.
6100                 ListOfID List of sub-shapes indices.
6101                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6102                 theName Object name; when specified, this parameter is used
6103                         for result publication in the study. Otherwise, if automatic
6104                         publication is switched on, default value is used for result name.
6105
6106             Returns:
6107                 A compound of sub-shapes of aShape.
6108             """
6109             # Example: see GEOM_TestAll.py
6110             ListOfIDs = []
6111             AllShapeIDsList = self.SubShapeAllIDs(aShape, EnumToLong( aType ))
6112             for ind in ListOfInd:
6113                 ListOfIDs.append(AllShapeIDsList[ind - 1])
6114             # note: auto-publishing is done in self.GetSubShape()
6115             anObj = self.GetSubShape(aShape, ListOfIDs, theName)
6116             return anObj
6117
6118         ## Explode a shape on sub-shapes of a given type.
6119         #  Sub-shapes will be sorted taking into account their gravity centers,
6120         #  to provide stable order of sub-shapes.
6121         #  If the shape itself matches the type, it is also returned.
6122         #  @param aShape Shape to be exploded.
6123         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6124         #  @param theName Object name; when specified, this parameter is used
6125         #         for result publication in the study. Otherwise, if automatic
6126         #         publication is switched on, default value is used for result name.
6127         #
6128         #  @return List of sub-shapes of type theShapeType, contained in theShape.
6129         #
6130         #  @ref swig_SubShapeAllSorted "Example"
6131         @ManageTransactions("ShapesOp")
6132         def SubShapeAllSortedCentres(self, aShape, aType, theName=None):
6133             """
6134             Explode a shape on sub-shapes of a given type.
6135             Sub-shapes will be sorted taking into account their gravity centers,
6136             to provide stable order of sub-shapes.
6137             If the shape itself matches the type, it is also returned.
6138
6139             Parameters:
6140                 aShape Shape to be exploded.
6141                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6142                 theName Object name; when specified, this parameter is used
6143                         for result publication in the study. Otherwise, if automatic
6144                         publication is switched on, default value is used for result name.
6145
6146             Returns:
6147                 List of sub-shapes of type theShapeType, contained in theShape.
6148             """
6149             # Example: see GEOM_TestAll.py
6150             ListObj = self.ShapesOp.MakeAllSubShapes(aShape, EnumToLong( aType ), True)
6151             RaiseIfFailed("SubShapeAllSortedCentres", self.ShapesOp)
6152             self._autoPublish(ListObj, theName, "subshape")
6153             return ListObj
6154
6155         ## Explode a shape on sub-shapes of a given type.
6156         #  Sub-shapes will be sorted taking into account their gravity centers,
6157         #  to provide stable order of sub-shapes.
6158         #  @param aShape Shape to be exploded.
6159         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6160         #  @return List of IDs of sub-shapes.
6161         #
6162         #  @ref swig_all_decompose "Example"
6163         @ManageTransactions("ShapesOp")
6164         def SubShapeAllSortedCentresIDs(self, aShape, aType):
6165             """
6166             Explode a shape on sub-shapes of a given type.
6167             Sub-shapes will be sorted taking into account their gravity centers,
6168             to provide stable order of sub-shapes.
6169
6170             Parameters:
6171                 aShape Shape to be exploded.
6172                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6173
6174             Returns:
6175                 List of IDs of sub-shapes.
6176             """
6177             ListIDs = self.ShapesOp.GetAllSubShapesIDs(aShape, EnumToLong( aType ), True)
6178             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
6179             return ListIDs
6180
6181         ## Obtain a compound of sub-shapes of <VAR>aShape</VAR>,
6182         #  selected by they indices in sorted list of all sub-shapes of type <VAR>aType</VAR>.
6183         #  Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6184         #  @param aShape Shape to get sub-shape of.
6185         #  @param ListOfInd List of sub-shapes indices.
6186         #  @param aType Type of sub-shapes to be retrieved (see ShapeType())
6187         #  @param theName Object name; when specified, this parameter is used
6188         #         for result publication in the study. Otherwise, if automatic
6189         #         publication is switched on, default value is used for result name.
6190         #
6191         #  @return A compound of sub-shapes of aShape.
6192         #
6193         #  @ref swig_all_decompose "Example"
6194         def SubShapeSortedCentres(self, aShape, aType, ListOfInd, theName=None):
6195             """
6196             Obtain a compound of sub-shapes of aShape,
6197             selected by they indices in sorted list of all sub-shapes of type aType.
6198             Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
6199
6200             Parameters:
6201                 aShape Shape to get sub-shape of.
6202                 ListOfID List of sub-shapes indices.
6203                 aType Type of sub-shapes to be retrieved (see geompy.ShapeType)
6204                 theName Object name; when specified, this parameter is used
6205                         for result publication in the study. Otherwise, if automatic
6206                         publication is switched on, default value is used for result name.
6207
6208             Returns:
6209                 A compound of sub-shapes of aShape.
6210             """
6211             # Example: see GEOM_TestAll.py
6212             ListOfIDs = []
6213             AllShapeIDsList = self.SubShapeAllSortedCentresIDs(aShape, EnumToLong( aType ))
6214             for ind in ListOfInd:
6215                 ListOfIDs.append(AllShapeIDsList[ind - 1])
6216             # note: auto-publishing is done in self.GetSubShape()
6217             anObj = self.GetSubShape(aShape, ListOfIDs, theName)
6218             return anObj
6219
6220         ## Extract shapes (excluding the main shape) of given type.
6221         #  @param aShape The shape.
6222         #  @param aType  The shape type (see ShapeType())
6223         #  @param isSorted Boolean flag to switch sorting on/off.
6224         #  @param theName Object name; when specified, this parameter is used
6225         #         for result publication in the study. Otherwise, if automatic
6226         #         publication is switched on, default value is used for result name.
6227         #
6228         #  @return List of sub-shapes of type aType, contained in aShape.
6229         #
6230         #  @ref swig_FilletChamfer "Example"
6231         @ManageTransactions("ShapesOp")
6232         def ExtractShapes(self, aShape, aType, isSorted = False, theName=None):
6233             """
6234             Extract shapes (excluding the main shape) of given type.
6235
6236             Parameters:
6237                 aShape The shape.
6238                 aType  The shape type (see geompy.ShapeType)
6239                 isSorted Boolean flag to switch sorting on/off.
6240                 theName Object name; when specified, this parameter is used
6241                         for result publication in the study. Otherwise, if automatic
6242                         publication is switched on, default value is used for result name.
6243
6244             Returns:
6245                 List of sub-shapes of type aType, contained in aShape.
6246             """
6247             # Example: see GEOM_TestAll.py
6248             ListObj = self.ShapesOp.ExtractSubShapes(aShape, EnumToLong( aType ), isSorted)
6249             RaiseIfFailed("ExtractSubShapes", self.ShapesOp)
6250             self._autoPublish(ListObj, theName, "subshape")
6251             return ListObj
6252
6253         ## Get a set of sub-shapes defined by their unique IDs inside <VAR>aShape</VAR>
6254         #  @param aShape Main shape.
6255         #  @param anIDs List of unique IDs of sub-shapes inside <VAR>aShape</VAR>.
6256         #  @param theName Object name; when specified, this parameter is used
6257         #         for result publication in the study. Otherwise, if automatic
6258         #         publication is switched on, default value is used for result name.
6259         #  @return List of GEOM.GEOM_Object, corresponding to found sub-shapes.
6260         #
6261         #  @ref swig_all_decompose "Example"
6262         @ManageTransactions("ShapesOp")
6263         def SubShapes(self, aShape, anIDs, theName=None):
6264             """
6265             Get a set of sub-shapes defined by their unique IDs inside theMainShape
6266
6267             Parameters:
6268                 aShape Main shape.
6269                 anIDs List of unique IDs of sub-shapes inside theMainShape.
6270                 theName Object name; when specified, this parameter is used
6271                         for result publication in the study. Otherwise, if automatic
6272                         publication is switched on, default value is used for result name.
6273
6274             Returns:
6275                 List of GEOM.GEOM_Object, corresponding to found sub-shapes.
6276             """
6277             # Example: see GEOM_TestAll.py
6278             ListObj = self.ShapesOp.MakeSubShapes(aShape, anIDs)
6279             RaiseIfFailed("SubShapes", self.ShapesOp)
6280             self._autoPublish(ListObj, theName, "subshape")
6281             return ListObj
6282
6283         ## Check if the object is a sub-object of another GEOM object.
6284         #  @param aSubObject Checked sub-object (or its parent object, in case if
6285         #         \a theSubObjectIndex is non-zero).
6286         #  @param anObject An object that is checked for ownership (or its parent object,
6287         #         in case if \a theObjectIndex is non-zero).
6288         #  @param aSubObjectIndex When non-zero, specifies a sub-shape index that
6289         #         identifies a sub-object within its parent specified via \a theSubObject.
6290         #  @param anObjectIndex When non-zero, specifies a sub-shape index that
6291         #         identifies an object within its parent specified via \a theObject.
6292         #  @return TRUE, if the given object contains sub-object.
6293         @ManageTransactions("ShapesOp")
6294         def IsSubShapeBelongsTo(self, aSubObject, anObject, aSubObjectIndex = 0, anObjectIndex = 0):
6295             """
6296             Check if the object is a sub-object of another GEOM object.
6297             
6298             Parameters:
6299                 aSubObject Checked sub-object (or its parent object, in case if
6300                     \a theSubObjectIndex is non-zero).
6301                 anObject An object that is checked for ownership (or its parent object,
6302                     in case if \a theObjectIndex is non-zero).
6303                 aSubObjectIndex When non-zero, specifies a sub-shape index that
6304                     identifies a sub-object within its parent specified via \a theSubObject.
6305                 anObjectIndex When non-zero, specifies a sub-shape index that
6306                     identifies an object within its parent specified via \a theObject.
6307
6308             Returns
6309                 TRUE, if the given object contains sub-object.
6310             """
6311             IsOk = self.ShapesOp.IsSubShapeBelongsTo(aSubObject, aSubObjectIndex, anObject, anObjectIndex)
6312             RaiseIfFailed("IsSubShapeBelongsTo", self.ShapesOp)
6313             return IsOk
6314
6315         # end of l4_decompose
6316         ## @}
6317
6318         ## @addtogroup l4_decompose_d
6319         ## @{
6320
6321         ## Deprecated method
6322         #  It works like SubShapeAllSortedCentres(), but wrongly
6323         #  defines centres of faces, shells and solids.
6324         @ManageTransactions("ShapesOp")
6325         def SubShapeAllSorted(self, aShape, aType, theName=None):
6326             """
6327             Deprecated method
6328             It works like geompy.SubShapeAllSortedCentres, but wrongly
6329             defines centres of faces, shells and solids.
6330             """
6331             ListObj = self.ShapesOp.MakeExplode(aShape, EnumToLong( aType ), True)
6332             RaiseIfFailed("MakeExplode", self.ShapesOp)
6333             self._autoPublish(ListObj, theName, "subshape")
6334             return ListObj
6335
6336         ## Deprecated method
6337         #  It works like SubShapeAllSortedCentresIDs(), but wrongly
6338         #  defines centres of faces, shells and solids.
6339         @ManageTransactions("ShapesOp")
6340         def SubShapeAllSortedIDs(self, aShape, aType):
6341             """
6342             Deprecated method
6343             It works like geompy.SubShapeAllSortedCentresIDs, but wrongly
6344             defines centres of faces, shells and solids.
6345             """
6346             ListIDs = self.ShapesOp.SubShapeAllIDs(aShape, EnumToLong( aType ), True)
6347             RaiseIfFailed("SubShapeAllIDs", self.ShapesOp)
6348             return ListIDs
6349
6350         ## Deprecated method
6351         #  It works like SubShapeSortedCentres(), but has a bug
6352         #  (wrongly defines centres of faces, shells and solids).
6353         def SubShapeSorted(self, aShape, aType, ListOfInd, theName=None):
6354             """
6355             Deprecated method
6356             It works like geompy.SubShapeSortedCentres, but has a bug
6357             (wrongly defines centres of faces, shells and solids).
6358             """
6359             ListOfIDs = []
6360             AllShapeIDsList = self.SubShapeAllSortedIDs(aShape, EnumToLong( aType ))
6361             for ind in ListOfInd:
6362                 ListOfIDs.append(AllShapeIDsList[ind - 1])
6363             # note: auto-publishing is done in self.GetSubShape()
6364             anObj = self.GetSubShape(aShape, ListOfIDs, theName)
6365             return anObj
6366
6367         # end of l4_decompose_d
6368         ## @}
6369
6370         ## @addtogroup l3_healing
6371         ## @{
6372
6373         ## Apply a sequence of Shape Healing operators to the given object.
6374         #  @param theShape Shape to be processed.
6375         #  @param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
6376         #  @param theParameters List of names of parameters
6377         #                    ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
6378         #  @param theValues List of values of parameters, in the same order
6379         #                    as parameters are listed in <VAR>theParameters</VAR> list.
6380         #  @param theName Object name; when specified, this parameter is used
6381         #         for result publication in the study. Otherwise, if automatic
6382         #         publication is switched on, default value is used for result name.
6383         #
6384         #  <b> Operators and Parameters: </b> \n
6385         #
6386         #  * \b FixShape - corrects invalid shapes. \n
6387         #  - \b FixShape.Tolerance3d - work tolerance for detection of the problems and correction of them. \n
6388         #  - \b FixShape.MaxTolerance3d - maximal possible tolerance of the shape after correction. \n
6389         #
6390         #  * \b FixFaceSize - removes small faces, such as spots and strips.\n
6391         #  - \b FixFaceSize.Tolerance - defines minimum possible face size. \n
6392         #  - \b DropSmallEdges - removes edges, which merge with neighbouring edges. \n
6393         #  - \b DropSmallEdges.Tolerance3d - defines minimum possible distance between two parallel edges.\n
6394         #  - \b DropSmallSolids - either removes small solids or merges them with neighboring ones. \n
6395         #  - \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
6396         #  - \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
6397         #  - \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
6398         #
6399         #  * \b SplitAngle - splits faces based on conical surfaces, surfaces of revolution and cylindrical
6400         #    surfaces in segments using a certain angle. \n
6401         #  - \b SplitAngle.Angle - the central angle of the resulting segments (i.e. we obtain two segments
6402         #    if Angle=180, four if Angle=90, etc). \n
6403         #  - \b SplitAngle.MaxTolerance - maximum possible tolerance among the resulting segments.\n
6404         #
6405         #  * \b SplitClosedFaces - splits closed faces in segments.
6406         #    The number of segments depends on the number of splitting points.\n
6407         #  - \b SplitClosedFaces.NbSplitPoints - the number of splitting points.\n
6408         #
6409         #  * \b SplitContinuity - splits shapes to reduce continuities of curves and surfaces.\n
6410         #  - \b SplitContinuity.Tolerance3d - 3D tolerance for correction of geometry.\n
6411         #  - \b SplitContinuity.SurfaceContinuity - required continuity for surfaces.\n
6412         #  - \b SplitContinuity.CurveContinuity - required continuity for curves.\n
6413         #   This and the previous parameters can take the following values:\n
6414         #   \b Parametric \b Continuity \n
6415         #   \b C0 (Positional Continuity): curves are joined (the end positions of curves or surfaces
6416         #   are coincidental. The curves or surfaces may still meet at an angle, giving rise to a sharp corner or edge).\n
6417         #   \b C1 (Tangential Continuity): first derivatives are equal (the end vectors of curves or surfaces are parallel,
6418         #    ruling out sharp edges).\n
6419         #   \b C2 (Curvature Continuity): first and second derivatives are equal (the end vectors of curves or surfaces
6420         #       are of the same magnitude).\n
6421         #   \b CN N-th derivatives are equal (both the direction and the magnitude of the Nth derivatives of curves
6422         #    or surfaces (d/du C(u)) are the same at junction. \n
6423         #   \b Geometric \b Continuity \n
6424         #   \b G1: first derivatives are proportional at junction.\n
6425         #   The curve tangents thus have the same direction, but not necessarily the same magnitude.
6426         #      i.e., C1'(1) = (a,b,c) and C2'(0) = (k*a, k*b, k*c).\n
6427         #   \b G2: first and second derivatives are proportional at junction.
6428         #   As the names imply, geometric continuity requires the geometry to be continuous, while parametric
6429         #    continuity requires that the underlying parameterization was continuous as well.
6430         #   Parametric continuity of order n implies geometric continuity of order n, but not vice-versa.\n
6431         #
6432         #  * \b BsplineRestriction - converts curves and surfaces to Bsplines and processes them with the following parameters:\n
6433         #  - \b BSplineRestriction.SurfaceMode - approximation of surfaces if restriction is necessary.\n
6434         #  - \b BSplineRestriction.Curve3dMode - conversion of any 3D curve to BSpline and approximation.\n
6435         #  - \b BSplineRestriction.Curve2dMode - conversion of any 2D curve to BSpline and approximation.\n
6436         #  - \b BSplineRestriction.Tolerance3d - defines the possibility of surfaces and 3D curves approximation
6437         #       with the specified parameters.\n
6438         #  - \b BSplineRestriction.Tolerance2d - defines the possibility of surfaces and 2D curves approximation
6439         #       with the specified parameters.\n
6440         #  - \b BSplineRestriction.RequiredDegree - required degree of the resulting BSplines.\n
6441         #  - \b BSplineRestriction.RequiredNbSegments - required maximum number of segments of resultant BSplines.\n
6442         #  - \b BSplineRestriction.Continuity3d - continuity of the resulting surfaces and 3D curves.\n
6443         #  - \b BSplineRestriction.Continuity2d - continuity of the resulting 2D curves.\n
6444         #
6445         #  * \b ToBezier - converts curves and surfaces of any type to Bezier curves and surfaces.\n
6446         #  - \b ToBezier.SurfaceMode - if checked in, allows conversion of surfaces.\n
6447         #  - \b ToBezier.Curve3dMode - if checked in, allows conversion of 3D curves.\n
6448         #  - \b ToBezier.Curve2dMode - if checked in, allows conversion of 2D curves.\n
6449         #  - \b ToBezier.MaxTolerance - defines tolerance for detection and correction of problems.\n
6450         #
6451         #  * \b SameParameter - fixes edges of 2D and 3D curves not having the same parameter.\n
6452         #  - \b SameParameter.Tolerance3d - defines tolerance for fixing of edges.\n
6453         #
6454         #
6455         #  @return New GEOM.GEOM_Object, containing processed shape.
6456         #
6457         #  \n @ref tui_shape_processing "Example"
6458         @ManageTransactions("HealOp")
6459         def ProcessShape(self, theShape, theOperators, theParameters, theValues, theName=None):
6460             """
6461             Apply a sequence of Shape Healing operators to the given object.
6462
6463             Parameters:
6464                 theShape Shape to be processed.
6465                 theValues List of values of parameters, in the same order
6466                           as parameters are listed in theParameters list.
6467                 theOperators List of names of operators ('FixShape', 'SplitClosedFaces', etc.).
6468                 theParameters List of names of parameters
6469                               ('FixShape.Tolerance3d', 'SplitClosedFaces.NbSplitPoints', etc.).
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                 Operators and Parameters:
6475
6476                  * FixShape - corrects invalid shapes.
6477                      * FixShape.Tolerance3d - work tolerance for detection of the problems and correction of them.
6478                      * FixShape.MaxTolerance3d - maximal possible tolerance of the shape after correction.
6479                  * FixFaceSize - removes small faces, such as spots and strips.
6480                      * FixFaceSize.Tolerance - defines minimum possible face size.
6481                  * DropSmallEdges - removes edges, which merge with neighbouring edges.
6482                      * DropSmallEdges.Tolerance3d - defines minimum possible distance between two parallel edges.
6483                  * DropSmallSolids - either removes small solids or merges them with neighboring ones.
6484                      * 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.
6485                      * 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.
6486                      * 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.
6487
6488                  * SplitAngle - splits faces based on conical surfaces, surfaces of revolution and cylindrical surfaces
6489                                 in segments using a certain angle.
6490                      * SplitAngle.Angle - the central angle of the resulting segments (i.e. we obtain two segments
6491                                           if Angle=180, four if Angle=90, etc).
6492                      * SplitAngle.MaxTolerance - maximum possible tolerance among the resulting segments.
6493                  * SplitClosedFaces - splits closed faces in segments. The number of segments depends on the number of
6494                                       splitting points.
6495                      * SplitClosedFaces.NbSplitPoints - the number of splitting points.
6496                  * SplitContinuity - splits shapes to reduce continuities of curves and surfaces.
6497                      * SplitContinuity.Tolerance3d - 3D tolerance for correction of geometry.
6498                      * SplitContinuity.SurfaceContinuity - required continuity for surfaces.
6499                      * SplitContinuity.CurveContinuity - required continuity for curves.
6500                        This and the previous parameters can take the following values:
6501
6502                        Parametric Continuity:
6503                        C0 (Positional Continuity): curves are joined (the end positions of curves or surfaces are
6504                                                    coincidental. The curves or surfaces may still meet at an angle,
6505                                                    giving rise to a sharp corner or edge).
6506                        C1 (Tangential Continuity): first derivatives are equal (the end vectors of curves or surfaces
6507                                                    are parallel, ruling out sharp edges).
6508                        C2 (Curvature Continuity): first and second derivatives are equal (the end vectors of curves
6509                                                   or surfaces are of the same magnitude).
6510                        CN N-th derivatives are equal (both the direction and the magnitude of the Nth derivatives of
6511                           curves or surfaces (d/du C(u)) are the same at junction.
6512
6513                        Geometric Continuity:
6514                        G1: first derivatives are proportional at junction.
6515                            The curve tangents thus have the same direction, but not necessarily the same magnitude.
6516                            i.e., C1'(1) = (a,b,c) and C2'(0) = (k*a, k*b, k*c).
6517                        G2: first and second derivatives are proportional at junction. As the names imply,
6518                            geometric continuity requires the geometry to be continuous, while parametric continuity requires
6519                            that the underlying parameterization was continuous as well. Parametric continuity of order n implies
6520                            geometric continuity of order n, but not vice-versa.
6521                  * BsplineRestriction - converts curves and surfaces to Bsplines and processes them with the following parameters:
6522                      * BSplineRestriction.SurfaceMode - approximation of surfaces if restriction is necessary.
6523                      * BSplineRestriction.Curve3dMode - conversion of any 3D curve to BSpline and approximation.
6524                      * BSplineRestriction.Curve2dMode - conversion of any 2D curve to BSpline and approximation.
6525                      * BSplineRestriction.Tolerance3d - defines the possibility of surfaces and 3D curves approximation with
6526                                                         the specified parameters.
6527                      * BSplineRestriction.Tolerance2d - defines the possibility of surfaces and 2D curves approximation with
6528                                                         the specified parameters.
6529                      * BSplineRestriction.RequiredDegree - required degree of the resulting BSplines.
6530                      * BSplineRestriction.RequiredNbSegments - required maximum number of segments of resultant BSplines.
6531                      * BSplineRestriction.Continuity3d - continuity of the resulting surfaces and 3D curves.
6532                      * BSplineRestriction.Continuity2d - continuity of the resulting 2D curves.
6533                  * ToBezier - converts curves and surfaces of any type to Bezier curves and surfaces.
6534                      * ToBezier.SurfaceMode - if checked in, allows conversion of surfaces.
6535                      * ToBezier.Curve3dMode - if checked in, allows conversion of 3D curves.
6536                      * ToBezier.Curve2dMode - if checked in, allows conversion of 2D curves.
6537                      * ToBezier.MaxTolerance - defines tolerance for detection and correction of problems.
6538                  * SameParameter - fixes edges of 2D and 3D curves not having the same parameter.
6539                      * SameParameter.Tolerance3d - defines tolerance for fixing of edges.
6540
6541             Returns:
6542                 New GEOM.GEOM_Object, containing processed shape.
6543
6544             Note: For more information look through SALOME Geometry User's Guide->
6545                   -> Introduction to Geometry-> Repairing Operations-> Shape Processing
6546             """
6547             # Example: see GEOM_TestHealing.py
6548             theValues,Parameters = ParseList(theValues)
6549             anObj = self.HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
6550             # To avoid script failure in case of good argument shape
6551             if self.HealOp.GetErrorCode() == "ShHealOper_NotError_msg":
6552                 return theShape
6553             RaiseIfFailed("ProcessShape", self.HealOp)
6554             for string in (theOperators + theParameters):
6555                 Parameters = ":" + Parameters
6556                 pass
6557             anObj.SetParameters(Parameters)
6558             self._autoPublish(anObj, theName, "healed")
6559             return anObj
6560
6561         ## Remove faces from the given object (shape).
6562         #  @param theObject Shape to be processed.
6563         #  @param theFaces Indices of faces to be removed, if EMPTY then the method
6564         #                  removes ALL faces of the given object.
6565         #  @param theName Object name; when specified, this parameter is used
6566         #         for result publication in the study. Otherwise, if automatic
6567         #         publication is switched on, default value is used for result name.
6568         #
6569         #  @return New GEOM.GEOM_Object, containing processed shape.
6570         #
6571         #  @ref tui_suppress_faces "Example"
6572         @ManageTransactions("HealOp")
6573         def SuppressFaces(self, theObject, theFaces, theName=None):
6574             """
6575             Remove faces from the given object (shape).
6576
6577             Parameters:
6578                 theObject Shape to be processed.
6579                 theFaces Indices of faces to be removed, if EMPTY then the method
6580                          removes ALL faces of the given object.
6581                 theName Object name; when specified, this parameter is used
6582                         for result publication in the study. Otherwise, if automatic
6583                         publication is switched on, default value is used for result name.
6584
6585             Returns:
6586                 New GEOM.GEOM_Object, containing processed shape.
6587             """
6588             # Example: see GEOM_TestHealing.py
6589             anObj = self.HealOp.SuppressFaces(theObject, theFaces)
6590             RaiseIfFailed("SuppressFaces", self.HealOp)
6591             self._autoPublish(anObj, theName, "suppressFaces")
6592             return anObj
6593
6594         ## Sewing of faces into a single shell.
6595         #  @param ListShape Shapes to be processed.
6596         #  @param theTolerance Required tolerance value.
6597         #  @param AllowNonManifold Flag that allows non-manifold sewing.
6598         #  @param theName Object name; when specified, this parameter is used
6599         #         for result publication in the study. Otherwise, if automatic
6600         #         publication is switched on, default value is used for result name.
6601         #
6602         #  @return New GEOM.GEOM_Object, containing a result shell.
6603         #
6604         #  @ref tui_sewing "Example"
6605         def MakeSewing(self, ListShape, theTolerance, AllowNonManifold=False, theName=None):
6606             """
6607             Sewing of faces into a single shell.
6608
6609             Parameters:
6610                 ListShape Shapes to be processed.
6611                 theTolerance Required tolerance value.
6612                 AllowNonManifold Flag that allows non-manifold sewing.
6613                 theName Object name; when specified, this parameter is used
6614                         for result publication in the study. Otherwise, if automatic
6615                         publication is switched on, default value is used for result name.
6616
6617             Returns:
6618                 New GEOM.GEOM_Object, containing containing a result shell.
6619             """
6620             # Example: see GEOM_TestHealing.py
6621             # note: auto-publishing is done in self.Sew()
6622             anObj = self.Sew(ListShape, theTolerance, AllowNonManifold, theName)
6623             return anObj
6624
6625         ## Sewing of faces into a single shell.
6626         #  @param ListShape Shapes to be processed.
6627         #  @param theTolerance Required tolerance value.
6628         #  @param AllowNonManifold Flag that allows non-manifold sewing.
6629         #  @param theName Object name; when specified, this parameter is used
6630         #         for result publication in the study. Otherwise, if automatic
6631         #         publication is switched on, default value is used for result name.
6632         #
6633         #  @return New GEOM.GEOM_Object, containing a result shell.
6634         @ManageTransactions("HealOp")
6635         def Sew(self, ListShape, theTolerance, AllowNonManifold=False, theName=None):
6636             """
6637             Sewing of faces into a single shell.
6638
6639             Parameters:
6640                 ListShape Shapes to be processed.
6641                 theTolerance Required tolerance value.
6642                 AllowNonManifold Flag that allows non-manifold sewing.
6643                 theName Object name; when specified, this parameter is used
6644                         for result publication in the study. Otherwise, if automatic
6645                         publication is switched on, default value is used for result name.
6646
6647             Returns:
6648                 New GEOM.GEOM_Object, containing a result shell.
6649             """
6650             # Example: see MakeSewing() above
6651             theTolerance,Parameters = ParseParameters(theTolerance)
6652             if AllowNonManifold:
6653                 anObj = self.HealOp.SewAllowNonManifold( ToList( ListShape ), theTolerance)
6654             else:
6655                 anObj = self.HealOp.Sew( ToList( ListShape ), theTolerance)
6656             # To avoid script failure in case of good argument shape
6657             # (Fix of test cases geom/bugs11/L7,L8)
6658             if self.HealOp.GetErrorCode() == "ShHealOper_NotError_msg":
6659                 return anObj
6660             RaiseIfFailed("Sew", self.HealOp)
6661             anObj.SetParameters(Parameters)
6662             self._autoPublish(anObj, theName, "sewed")
6663             return anObj
6664
6665         ## Rebuild the topology of theSolids by removing
6666         #  the faces that are shared by several solids.
6667         #  @param theSolids A compound or a list of solids to be processed.
6668         #  @param theName Object name; when specified, this parameter is used
6669         #         for result publication in the study. Otherwise, if automatic
6670         #         publication is switched on, default value is used for result name.
6671         #
6672         #  @return New GEOM.GEOM_Object, containing processed shape.
6673         #
6674         #  @ref tui_remove_webs "Example"
6675         @ManageTransactions("HealOp")
6676         def RemoveInternalFaces (self, theSolids, theName=None):
6677             """
6678             Rebuild the topology of theSolids by removing
6679             the faces that are shared by several solids.
6680
6681             Parameters:
6682                 theSolids A compound or a list of solids to be processed.
6683                 theName Object name; when specified, this parameter is used
6684                         for result publication in the study. Otherwise, if automatic
6685                         publication is switched on, default value is used for result name.
6686
6687             Returns:
6688                 New GEOM.GEOM_Object, containing processed shape.
6689             """
6690             # Example: see GEOM_TestHealing.py
6691             anObj = self.HealOp.RemoveInternalFaces(ToList(theSolids))
6692             RaiseIfFailed("RemoveInternalFaces", self.HealOp)
6693             self._autoPublish(anObj, theName, "removeWebs")
6694             return anObj
6695
6696         ## Remove internal wires and edges from the given object (face).
6697         #  @param theObject Shape to be processed.
6698         #  @param theWires Indices of wires to be removed, if EMPTY then the method
6699         #                  removes ALL internal wires of the given object.
6700         #  @param theName Object name; when specified, this parameter is used
6701         #         for result publication in the study. Otherwise, if automatic
6702         #         publication is switched on, default value is used for result name.
6703         #
6704         #  @return New GEOM.GEOM_Object, containing processed shape.
6705         #
6706         #  @ref tui_suppress_internal_wires "Example"
6707         @ManageTransactions("HealOp")
6708         def SuppressInternalWires(self, theObject, theWires, theName=None):
6709             """
6710             Remove internal wires and edges from the given object (face).
6711
6712             Parameters:
6713                 theObject Shape to be processed.
6714                 theWires Indices of wires to be removed, if EMPTY then the method
6715                          removes ALL internal wires of the given object.
6716                 theName Object name; when specified, this parameter is used
6717                         for result publication in the study. Otherwise, if automatic
6718                         publication is switched on, default value is used for result name.
6719
6720             Returns:
6721                 New GEOM.GEOM_Object, containing processed shape.
6722             """
6723             # Example: see GEOM_TestHealing.py
6724             anObj = self.HealOp.RemoveIntWires(theObject, theWires)
6725             RaiseIfFailed("RemoveIntWires", self.HealOp)
6726             self._autoPublish(anObj, theName, "suppressWires")
6727             return anObj
6728
6729         ## Remove internal closed contours (holes) from the given object.
6730         #  @param theObject Shape to be processed.
6731         #  @param theWires Indices of wires to be removed, if EMPTY then the method
6732         #                  removes ALL internal holes of the given object
6733         #  @param theName Object name; when specified, this parameter is used
6734         #         for result publication in the study. Otherwise, if automatic
6735         #         publication is switched on, default value is used for result name.
6736         #
6737         #  @return New GEOM.GEOM_Object, containing processed shape.
6738         #
6739         #  @ref tui_suppress_holes "Example"
6740         @ManageTransactions("HealOp")
6741         def SuppressHoles(self, theObject, theWires, theName=None):
6742             """
6743             Remove internal closed contours (holes) from the given object.
6744
6745             Parameters:
6746                 theObject Shape to be processed.
6747                 theWires Indices of wires to be removed, if EMPTY then the method
6748                          removes ALL internal holes of the given object
6749                 theName Object name; when specified, this parameter is used
6750                         for result publication in the study. Otherwise, if automatic
6751                         publication is switched on, default value is used for result name.
6752
6753             Returns:
6754                 New GEOM.GEOM_Object, containing processed shape.
6755             """
6756             # Example: see GEOM_TestHealing.py
6757             anObj = self.HealOp.FillHoles(theObject, theWires)
6758             RaiseIfFailed("FillHoles", self.HealOp)
6759             self._autoPublish(anObj, theName, "suppressHoles")
6760             return anObj
6761
6762         ## Close an open wire.
6763         #  @param theObject Shape to be processed.
6764         #  @param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
6765         #                  if [ ], then <VAR>theObject</VAR> itself is a wire.
6766         #  @param isCommonVertex If True  : closure by creation of a common vertex,
6767         #                        If False : closure by creation of an edge between ends.
6768         #  @param theName Object name; when specified, this parameter is used
6769         #         for result publication in the study. Otherwise, if automatic
6770         #         publication is switched on, default value is used for result name.
6771         #
6772         #  @return New GEOM.GEOM_Object, containing processed shape.
6773         #
6774         #  @ref tui_close_contour "Example"
6775         @ManageTransactions("HealOp")
6776         def CloseContour(self,theObject, theWires, isCommonVertex, theName=None):
6777             """
6778             Close an open wire.
6779
6780             Parameters:
6781                 theObject Shape to be processed.
6782                 theWires Indexes of edge(s) and wire(s) to be closed within theObject's shape,
6783                          if [ ], then theObject itself is a wire.
6784                 isCommonVertex If True  : closure by creation of a common vertex,
6785                                If False : closure by creation of an edge between ends.
6786                 theName Object name; when specified, this parameter is used
6787                         for result publication in the study. Otherwise, if automatic
6788                         publication is switched on, default value is used for result name.
6789
6790             Returns:
6791                 New GEOM.GEOM_Object, containing processed shape.
6792             """
6793             # Example: see GEOM_TestHealing.py
6794             anObj = self.HealOp.CloseContour(theObject, theWires, isCommonVertex)
6795             RaiseIfFailed("CloseContour", self.HealOp)
6796             self._autoPublish(anObj, theName, "closeContour")
6797             return anObj
6798
6799         ## Addition of a point to a given edge object.
6800         #  @param theObject Shape to be processed.
6801         #  @param theEdgeIndex Index of edge to be divided within theObject's shape,
6802         #                      if -1, then theObject itself is the edge.
6803         #  @param theValue Value of parameter on edge or length parameter,
6804         #                  depending on \a isByParameter.
6805         #  @param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1], \n
6806         #                       if FALSE : \a theValue is treated as a length parameter [0..1]
6807         #  @param theName Object name; when specified, this parameter is used
6808         #         for result publication in the study. Otherwise, if automatic
6809         #         publication is switched on, default value is used for result name.
6810         #
6811         #  @return New GEOM.GEOM_Object, containing processed shape.
6812         #
6813         #  @ref tui_add_point_on_edge "Example"
6814         @ManageTransactions("HealOp")
6815         def DivideEdge(self, theObject, theEdgeIndex, theValue, isByParameter, theName=None):
6816             """
6817             Addition of a point to a given edge object.
6818
6819             Parameters:
6820                 theObject Shape to be processed.
6821                 theEdgeIndex Index of edge to be divided within theObject's shape,
6822                              if -1, then theObject itself is the edge.
6823                 theValue Value of parameter on edge or length parameter,
6824                          depending on isByParameter.
6825                 isByParameter If TRUE :  theValue is treated as a curve parameter [0..1],
6826                               if FALSE : theValue is treated as a length parameter [0..1]
6827                 theName Object name; when specified, this parameter is used
6828                         for result publication in the study. Otherwise, if automatic
6829                         publication is switched on, default value is used for result name.
6830
6831             Returns:
6832                 New GEOM.GEOM_Object, containing processed shape.
6833             """
6834             # Example: see GEOM_TestHealing.py
6835             theEdgeIndex,theValue,isByParameter,Parameters = ParseParameters(theEdgeIndex,theValue,isByParameter)
6836             anObj = self.HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
6837             RaiseIfFailed("DivideEdge", self.HealOp)
6838             anObj.SetParameters(Parameters)
6839             self._autoPublish(anObj, theName, "divideEdge")
6840             return anObj
6841
6842         ## Addition of points to a given edge of \a theObject by projecting
6843         #  other points to the given edge.
6844         #  @param theObject Shape to be processed.
6845         #  @param theEdgeIndex Index of edge to be divided within theObject's shape,
6846         #                      if -1, then theObject itself is the edge.
6847         #  @param thePoints List of points to project to theEdgeIndex-th edge.
6848         #  @param theName Object name; when specified, this parameter is used
6849         #         for result publication in the study. Otherwise, if automatic
6850         #         publication is switched on, default value is used for result name.
6851         #
6852         #  @return New GEOM.GEOM_Object, containing processed shape.
6853         #
6854         #  @ref tui_add_point_on_edge "Example"
6855         @ManageTransactions("HealOp")
6856         def DivideEdgeByPoint(self, theObject, theEdgeIndex, thePoints, theName=None):
6857             """
6858             Addition of points to a given edge of \a theObject by projecting
6859             other points to the given edge.
6860
6861             Parameters:
6862                 theObject Shape to be processed.
6863                 theEdgeIndex The edge or its index to be divided within theObject's shape,
6864                              if -1, then theObject itself is the edge.
6865                 thePoints List of points to project to theEdgeIndex-th edge.
6866                 theName Object name; when specified, this parameter is used
6867                         for result publication in the study. Otherwise, if automatic
6868                         publication is switched on, default value is used for result name.
6869
6870             Returns:
6871                 New GEOM.GEOM_Object, containing processed shape.
6872             """
6873             # Example: see GEOM_TestHealing.py
6874             if isinstance( theEdgeIndex, GEOM._objref_GEOM_Object ):
6875                 theEdgeIndex = self.GetSubShapeID( theObject, theEdgeIndex )
6876             anObj = self.HealOp.DivideEdgeByPoint(theObject, theEdgeIndex, ToList( thePoints ))
6877             RaiseIfFailed("DivideEdgeByPoint", self.HealOp)
6878             self._autoPublish(anObj, theName, "divideEdge")
6879             return anObj
6880
6881         ## Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
6882         #  @param theWire Wire to minimize the number of C1 continuous edges in.
6883         #  @param theVertices A list of vertices to suppress. If the list
6884         #                     is empty, all vertices in a wire will be assumed.
6885         #  @param theName Object name; when specified, this parameter is used
6886         #         for result publication in the study. Otherwise, if automatic
6887         #         publication is switched on, default value is used for result name.
6888         #
6889         #  @return New GEOM.GEOM_Object with modified wire.
6890         #
6891         #  @ref tui_fuse_collinear_edges "Example"
6892         @ManageTransactions("HealOp")
6893         def FuseCollinearEdgesWithinWire(self, theWire, theVertices = [], theName=None):
6894             """
6895             Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
6896
6897             Parameters:
6898                 theWire Wire to minimize the number of C1 continuous edges in.
6899                 theVertices A list of vertices to suppress. If the list
6900                             is empty, all vertices in a wire will be assumed.
6901                 theName Object name; when specified, this parameter is used
6902                         for result publication in the study. Otherwise, if automatic
6903                         publication is switched on, default value is used for result name.
6904
6905             Returns:
6906                 New GEOM.GEOM_Object with modified wire.
6907             """
6908             anObj = self.HealOp.FuseCollinearEdgesWithinWire(theWire, theVertices)
6909             RaiseIfFailed("FuseCollinearEdgesWithinWire", self.HealOp)
6910             self._autoPublish(anObj, theName, "fuseEdges")
6911             return anObj
6912
6913         ## Change orientation of the given object. Updates given shape.
6914         #  @param theObject Shape to be processed.
6915         #  @return Updated <var>theObject</var>
6916         #
6917         #  @ref swig_todo "Example"
6918         @ManageTransactions("HealOp")
6919         def ChangeOrientationShell(self,theObject):
6920             """
6921             Change orientation of the given object. Updates given shape.
6922
6923             Parameters:
6924                 theObject Shape to be processed.
6925
6926             Returns:
6927                 Updated theObject
6928             """
6929             theObject = self.HealOp.ChangeOrientation(theObject)
6930             RaiseIfFailed("ChangeOrientation", self.HealOp)
6931             pass
6932
6933         ## Change orientation of the given object.
6934         #  @param theObject Shape to be processed.
6935         #  @param theName Object name; when specified, this parameter is used
6936         #         for result publication in the study. Otherwise, if automatic
6937         #         publication is switched on, default value is used for result name.
6938         #
6939         #  @return New GEOM.GEOM_Object, containing processed shape.
6940         #
6941         #  @ref swig_todo "Example"
6942         @ManageTransactions("HealOp")
6943         def ChangeOrientationShellCopy(self, theObject, theName=None):
6944             """
6945             Change orientation of the given object.
6946
6947             Parameters:
6948                 theObject Shape to be processed.
6949                 theName Object name; when specified, this parameter is used
6950                         for result publication in the study. Otherwise, if automatic
6951                         publication is switched on, default value is used for result name.
6952
6953             Returns:
6954                 New GEOM.GEOM_Object, containing processed shape.
6955             """
6956             anObj = self.HealOp.ChangeOrientationCopy(theObject)
6957             RaiseIfFailed("ChangeOrientationCopy", self.HealOp)
6958             self._autoPublish(anObj, theName, "reversed")
6959             return anObj
6960
6961         ## Try to limit tolerance of the given object by value \a theTolerance.
6962         #  @param theObject Shape to be processed.
6963         #  @param theTolerance Required tolerance value.
6964         #  @param theName Object name; when specified, this parameter is used
6965         #         for result publication in the study. Otherwise, if automatic
6966         #         publication is switched on, default value is used for result name.
6967         #
6968         #  @return New GEOM.GEOM_Object, containing processed shape.
6969         #
6970         #  @ref tui_limit_tolerance "Example"
6971         @ManageTransactions("HealOp")
6972         def LimitTolerance(self, theObject, theTolerance = 1e-07, theName=None):
6973             """
6974             Try to limit tolerance of the given object by value theTolerance.
6975
6976             Parameters:
6977                 theObject Shape to be processed.
6978                 theTolerance Required tolerance value.
6979                 theName Object name; when specified, this parameter is used
6980                         for result publication in the study. Otherwise, if automatic
6981                         publication is switched on, default value is used for result name.
6982
6983             Returns:
6984                 New GEOM.GEOM_Object, containing processed shape.
6985             """
6986             anObj = self.HealOp.LimitTolerance(theObject, theTolerance)
6987             RaiseIfFailed("LimitTolerance", self.HealOp)
6988             self._autoPublish(anObj, theName, "limitTolerance")
6989             return anObj
6990
6991         ## Get a list of wires (wrapped in GEOM.GEOM_Object-s),
6992         #  that constitute a free boundary of the given shape.
6993         #  @param theObject Shape to get free boundary of.
6994         #  @param theName Object name; when specified, this parameter is used
6995         #         for result publication in the study. Otherwise, if automatic
6996         #         publication is switched on, default value is used for result name.
6997         #
6998         #  @return [\a status, \a theClosedWires, \a theOpenWires]
6999         #  \n \a status: FALSE, if an error(s) occured during the method execution.
7000         #  \n \a theClosedWires: Closed wires on the free boundary of the given shape.
7001         #  \n \a theOpenWires: Open wires on the free boundary of the given shape.
7002         #
7003         #  @ref tui_free_boundaries_page "Example"
7004         @ManageTransactions("HealOp")
7005         def GetFreeBoundary(self, theObject, theName=None):
7006             """
7007             Get a list of wires (wrapped in GEOM.GEOM_Object-s),
7008             that constitute a free boundary of the given shape.
7009
7010             Parameters:
7011                 theObject Shape to get free boundary of.
7012                 theName Object name; when specified, this parameter is used
7013                         for result publication in the study. Otherwise, if automatic
7014                         publication is switched on, default value is used for result name.
7015
7016             Returns:
7017                 [status, theClosedWires, theOpenWires]
7018                  status: FALSE, if an error(s) occured during the method execution.
7019                  theClosedWires: Closed wires on the free boundary of the given shape.
7020                  theOpenWires: Open wires on the free boundary of the given shape.
7021             """
7022             # Example: see GEOM_TestHealing.py
7023             anObj = self.HealOp.GetFreeBoundary( ToList( theObject ))
7024             RaiseIfFailed("GetFreeBoundary", self.HealOp)
7025             self._autoPublish(anObj[1], theName, "closedWire")
7026             self._autoPublish(anObj[2], theName, "openWire")
7027             return anObj
7028
7029         ## Replace coincident faces in \a theShapes by one face.
7030         #  @param theShapes Initial shapes, either a list or compound of shapes.
7031         #  @param theTolerance Maximum distance between faces, which can be considered as coincident.
7032         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
7033         #                         otherwise all initial shapes.
7034         #  @param theName Object name; when specified, this parameter is used
7035         #         for result publication in the study. Otherwise, if automatic
7036         #         publication is switched on, default value is used for result name.
7037         #
7038         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7039         #
7040         #  @ref tui_glue_faces "Example"
7041         @ManageTransactions("ShapesOp")
7042         def MakeGlueFaces(self, theShapes, theTolerance, doKeepNonSolids=True, theName=None):
7043             """
7044             Replace coincident faces in theShapes by one face.
7045
7046             Parameters:
7047                 theShapes Initial shapes, either a list or compound of shapes.
7048                 theTolerance Maximum distance between faces, which can be considered as coincident.
7049                 doKeepNonSolids If FALSE, only solids will present in the result,
7050                                 otherwise all initial shapes.
7051                 theName Object name; when specified, this parameter is used
7052                         for result publication in the study. Otherwise, if automatic
7053                         publication is switched on, default value is used for result name.
7054
7055             Returns:
7056                 New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7057             """
7058             # Example: see GEOM_Spanner.py
7059             theTolerance,Parameters = ParseParameters(theTolerance)
7060             anObj = self.ShapesOp.MakeGlueFaces(ToList(theShapes), theTolerance, doKeepNonSolids)
7061             if anObj is None:
7062                 raise RuntimeError, "MakeGlueFaces : " + self.ShapesOp.GetErrorCode()
7063             anObj.SetParameters(Parameters)
7064             self._autoPublish(anObj, theName, "glueFaces")
7065             return anObj
7066
7067         ## Find coincident faces in \a theShapes for possible gluing.
7068         #  @param theShapes Initial shapes, either a list or compound of shapes.
7069         #  @param theTolerance Maximum distance between faces,
7070         #                      which can be considered as coincident.
7071         #  @param theName Object name; when specified, this parameter is used
7072         #         for result publication in the study. Otherwise, if automatic
7073         #         publication is switched on, default value is used for result name.
7074         #
7075         #  @return GEOM.ListOfGO
7076         #
7077         #  @ref tui_glue_faces "Example"
7078         @ManageTransactions("ShapesOp")
7079         def GetGlueFaces(self, theShapes, theTolerance, theName=None):
7080             """
7081             Find coincident faces in theShapes for possible gluing.
7082
7083             Parameters:
7084                 theShapes Initial shapes, either a list or compound of shapes.
7085                 theTolerance Maximum distance between faces,
7086                              which can be considered as coincident.
7087                 theName Object name; when specified, this parameter is used
7088                         for result publication in the study. Otherwise, if automatic
7089                         publication is switched on, default value is used for result name.
7090
7091             Returns:
7092                 GEOM.ListOfGO
7093             """
7094             anObj = self.ShapesOp.GetGlueFaces(ToList(theShapes), theTolerance)
7095             RaiseIfFailed("GetGlueFaces", self.ShapesOp)
7096             self._autoPublish(anObj, theName, "facesToGlue")
7097             return anObj
7098
7099         ## Replace coincident faces in \a theShapes by one face
7100         #  in compliance with given list of faces
7101         #  @param theShapes Initial shapes, either a list or compound of shapes.
7102         #  @param theTolerance Maximum distance between faces,
7103         #                      which can be considered as coincident.
7104         #  @param theFaces List of faces for gluing.
7105         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
7106         #                         otherwise all initial shapes.
7107         #  @param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
7108         #                        will be glued, otherwise only the edges,
7109         #                        belonging to <VAR>theFaces</VAR>.
7110         #  @param theName Object name; when specified, this parameter is used
7111         #         for result publication in the study. Otherwise, if automatic
7112         #         publication is switched on, default value is used for result name.
7113         #
7114         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7115         #
7116         #  @ref tui_glue_faces "Example"
7117         @ManageTransactions("ShapesOp")
7118         def MakeGlueFacesByList(self, theShapes, theTolerance, theFaces,
7119                                 doKeepNonSolids=True, doGlueAllEdges=True, theName=None):
7120             """
7121             Replace coincident faces in theShapes by one face
7122             in compliance with given list of faces
7123
7124             Parameters:
7125                 theShapes theShapes Initial shapes, either a list or compound of shapes.
7126                 theTolerance Maximum distance between faces,
7127                              which can be considered as coincident.
7128                 theFaces List of faces for gluing.
7129                 doKeepNonSolids If FALSE, only solids will present in the result,
7130                                 otherwise all initial shapes.
7131                 doGlueAllEdges If TRUE, all coincident edges of theShape
7132                                will be glued, otherwise only the edges,
7133                                belonging to theFaces.
7134                 theName Object name; when specified, this parameter is used
7135                         for result publication in the study. Otherwise, if automatic
7136                         publication is switched on, default value is used for result name.
7137
7138             Returns:
7139                 New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7140             """
7141             anObj = self.ShapesOp.MakeGlueFacesByList(ToList(theShapes), theTolerance, theFaces,
7142                                                       doKeepNonSolids, doGlueAllEdges)
7143             if anObj is None:
7144                 raise RuntimeError, "MakeGlueFacesByList : " + self.ShapesOp.GetErrorCode()
7145             self._autoPublish(anObj, theName, "glueFaces")
7146             return anObj
7147
7148         ## Replace coincident edges in \a theShapes by one edge.
7149         #  @param theShapes Initial shapes, either a list or compound of shapes.
7150         #  @param theTolerance Maximum distance between edges, which can be considered as coincident.
7151         #  @param theName Object name; when specified, this parameter is used
7152         #         for result publication in the study. Otherwise, if automatic
7153         #         publication is switched on, default value is used for result name.
7154         #
7155         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7156         #
7157         #  @ref tui_glue_edges "Example"
7158         @ManageTransactions("ShapesOp")
7159         def MakeGlueEdges(self, theShapes, theTolerance, theName=None):
7160             """
7161             Replace coincident edges in theShapes by one edge.
7162
7163             Parameters:
7164                 theShapes Initial shapes, either a list or compound of shapes.
7165                 theTolerance Maximum distance between edges, which can be considered as coincident.
7166                 theName Object name; when specified, this parameter is used
7167                         for result publication in the study. Otherwise, if automatic
7168                         publication is switched on, default value is used for result name.
7169
7170             Returns:
7171                 New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7172             """
7173             theTolerance,Parameters = ParseParameters(theTolerance)
7174             anObj = self.ShapesOp.MakeGlueEdges(ToList(theShapes), theTolerance)
7175             if anObj is None:
7176                 raise RuntimeError, "MakeGlueEdges : " + self.ShapesOp.GetErrorCode()
7177             anObj.SetParameters(Parameters)
7178             self._autoPublish(anObj, theName, "glueEdges")
7179             return anObj
7180
7181         ## Find coincident edges in \a theShapes for possible gluing.
7182         #  @param theShapes Initial shapes, either a list or compound of shapes.
7183         #  @param theTolerance Maximum distance between edges,
7184         #                      which can be considered as coincident.
7185         #  @param theName Object name; when specified, this parameter is used
7186         #         for result publication in the study. Otherwise, if automatic
7187         #         publication is switched on, default value is used for result name.
7188         #
7189         #  @return GEOM.ListOfGO
7190         #
7191         #  @ref tui_glue_edges "Example"
7192         @ManageTransactions("ShapesOp")
7193         def GetGlueEdges(self, theShapes, theTolerance, theName=None):
7194             """
7195             Find coincident edges in theShapes for possible gluing.
7196
7197             Parameters:
7198                 theShapes Initial shapes, either a list or compound of shapes.
7199                 theTolerance Maximum distance between edges,
7200                              which can be considered as coincident.
7201                 theName Object name; when specified, this parameter is used
7202                         for result publication in the study. Otherwise, if automatic
7203                         publication is switched on, default value is used for result name.
7204
7205             Returns:
7206                 GEOM.ListOfGO
7207             """
7208             anObj = self.ShapesOp.GetGlueEdges(ToList(theShapes), theTolerance)
7209             RaiseIfFailed("GetGlueEdges", self.ShapesOp)
7210             self._autoPublish(anObj, theName, "edgesToGlue")
7211             return anObj
7212
7213         ## Replace coincident edges in theShapes by one edge
7214         #  in compliance with given list of edges.
7215         #  @param theShapes Initial shapes, either a list or compound of shapes.
7216         #  @param theTolerance Maximum distance between edges,
7217         #                      which can be considered as coincident.
7218         #  @param theEdges List of edges for gluing.
7219         #  @param theName Object name; when specified, this parameter is used
7220         #         for result publication in the study. Otherwise, if automatic
7221         #         publication is switched on, default value is used for result name.
7222         #
7223         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7224         #
7225         #  @ref tui_glue_edges "Example"
7226         @ManageTransactions("ShapesOp")
7227         def MakeGlueEdgesByList(self, theShapes, theTolerance, theEdges, theName=None):
7228             """
7229             Replace coincident edges in theShapes by one edge
7230             in compliance with given list of edges.
7231
7232             Parameters:
7233                 theShapes Initial shapes, either a list or compound of shapes.
7234                 theTolerance Maximum distance between edges,
7235                              which can be considered as coincident.
7236                 theEdges List of edges for gluing.
7237                 theName Object name; when specified, this parameter is used
7238                         for result publication in the study. Otherwise, if automatic
7239                         publication is switched on, default value is used for result name.
7240
7241             Returns:
7242                 New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7243             """
7244             anObj = self.ShapesOp.MakeGlueEdgesByList(ToList(theShapes), theTolerance, theEdges)
7245             if anObj is None:
7246                 raise RuntimeError, "MakeGlueEdgesByList : " + self.ShapesOp.GetErrorCode()
7247             self._autoPublish(anObj, theName, "glueEdges")
7248             return anObj
7249
7250         # end of l3_healing
7251         ## @}
7252
7253         ## @addtogroup l3_boolean Boolean Operations
7254         ## @{
7255
7256         # -----------------------------------------------------------------------------
7257         # Boolean (Common, Cut, Fuse, Section)
7258         # -----------------------------------------------------------------------------
7259
7260         ## Perform one of boolean operations on two given shapes.
7261         #  @param theShape1 First argument for boolean operation.
7262         #  @param theShape2 Second argument for boolean operation.
7263         #  @param theOperation Indicates the operation to be done:\n
7264         #                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
7265         #  @param checkSelfInte The flag that tells if the arguments should
7266         #         be checked for self-intersection prior to the operation.
7267         #  @param theName Object name; when specified, this parameter is used
7268         #         for result publication in the study. Otherwise, if automatic
7269         #         publication is switched on, default value is used for result name.
7270         #
7271         #  @note This algorithm doesn't find all types of self-intersections.
7272         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7273         #        vertex/face and edge/face intersections. Face/face
7274         #        intersections detection is switched off as it is a
7275         #        time-consuming operation that gives an impact on performance.
7276         #        To find all self-intersections please use
7277         #        CheckSelfIntersections() method.
7278         #
7279         #  @return New GEOM.GEOM_Object, containing the result shape.
7280         #
7281         #  @ref tui_fuse "Example"
7282         @ManageTransactions("BoolOp")
7283         def MakeBoolean(self, theShape1, theShape2, theOperation, checkSelfInte=False, theName=None):
7284             """
7285             Perform one of boolean operations on two given shapes.
7286
7287             Parameters:
7288                 theShape1 First argument for boolean operation.
7289                 theShape2 Second argument for boolean operation.
7290                 theOperation Indicates the operation to be done:
7291                              1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
7292                 checkSelfInte The flag that tells if the arguments should
7293                               be checked for self-intersection prior to
7294                               the operation.
7295                 theName Object name; when specified, this parameter is used
7296                         for result publication in the study. Otherwise, if automatic
7297                         publication is switched on, default value is used for result name.
7298
7299             Note:
7300                     This algorithm doesn't find all types of self-intersections.
7301                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7302                     vertex/face and edge/face intersections. Face/face
7303                     intersections detection is switched off as it is a
7304                     time-consuming operation that gives an impact on performance.
7305                     To find all self-intersections please use
7306                     CheckSelfIntersections() method.
7307
7308             Returns:
7309                 New GEOM.GEOM_Object, containing the result shape.
7310             """
7311             # Example: see GEOM_TestAll.py
7312             anObj = self.BoolOp.MakeBoolean(theShape1, theShape2, theOperation, checkSelfInte)
7313             RaiseIfFailed("MakeBoolean", self.BoolOp)
7314             def_names = { 1: "common", 2: "cut", 3: "fuse", 4: "section" }
7315             self._autoPublish(anObj, theName, def_names[theOperation])
7316             return anObj
7317
7318         ## Perform Common boolean operation on two given shapes.
7319         #  @param theShape1 First argument for boolean operation.
7320         #  @param theShape2 Second argument for boolean operation.
7321         #  @param checkSelfInte The flag that tells if the arguments should
7322         #         be checked for self-intersection prior to the operation.
7323         #  @param theName Object name; when specified, this parameter is used
7324         #         for result publication in the study. Otherwise, if automatic
7325         #         publication is switched on, default value is used for result name.
7326         #
7327         #  @note This algorithm doesn't find all types of self-intersections.
7328         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7329         #        vertex/face and edge/face intersections. Face/face
7330         #        intersections detection is switched off as it is a
7331         #        time-consuming operation that gives an impact on performance.
7332         #        To find all self-intersections please use
7333         #        CheckSelfIntersections() method.
7334         #
7335         #  @return New GEOM.GEOM_Object, containing the result shape.
7336         #
7337         #  @ref tui_common "Example 1"
7338         #  \n @ref swig_MakeCommon "Example 2"
7339         def MakeCommon(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7340             """
7341             Perform Common boolean operation on two given shapes.
7342
7343             Parameters:
7344                 theShape1 First argument for boolean operation.
7345                 theShape2 Second argument for boolean operation.
7346                 checkSelfInte The flag that tells if the arguments should
7347                               be checked for self-intersection prior to
7348                               the operation.
7349                 theName Object name; when specified, this parameter is used
7350                         for result publication in the study. Otherwise, if automatic
7351                         publication is switched on, default value is used for result name.
7352
7353             Note:
7354                     This algorithm doesn't find all types of self-intersections.
7355                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7356                     vertex/face and edge/face intersections. Face/face
7357                     intersections detection is switched off as it is a
7358                     time-consuming operation that gives an impact on performance.
7359                     To find all self-intersections please use
7360                     CheckSelfIntersections() method.
7361
7362             Returns:
7363                 New GEOM.GEOM_Object, containing the result shape.
7364             """
7365             # Example: see GEOM_TestOthers.py
7366             # note: auto-publishing is done in self.MakeBoolean()
7367             return self.MakeBoolean(theShape1, theShape2, 1, checkSelfInte, theName)
7368
7369         ## Perform Cut boolean operation on two given shapes.
7370         #  @param theShape1 First argument for boolean operation.
7371         #  @param theShape2 Second argument for boolean operation.
7372         #  @param checkSelfInte The flag that tells if the arguments should
7373         #         be checked for self-intersection prior to the operation.
7374         #  @param theName Object name; when specified, this parameter is used
7375         #         for result publication in the study. Otherwise, if automatic
7376         #         publication is switched on, default value is used for result name.
7377         #
7378         #  @note This algorithm doesn't find all types of self-intersections.
7379         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7380         #        vertex/face and edge/face intersections. Face/face
7381         #        intersections detection is switched off as it is a
7382         #        time-consuming operation that gives an impact on performance.
7383         #        To find all self-intersections please use
7384         #        CheckSelfIntersections() method.
7385         #
7386         #  @return New GEOM.GEOM_Object, containing the result shape.
7387         #
7388         #  @ref tui_cut "Example 1"
7389         #  \n @ref swig_MakeCommon "Example 2"
7390         def MakeCut(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7391             """
7392             Perform Cut boolean operation on two given shapes.
7393
7394             Parameters:
7395                 theShape1 First argument for boolean operation.
7396                 theShape2 Second argument for boolean operation.
7397                 checkSelfInte The flag that tells if the arguments should
7398                               be checked for self-intersection prior to
7399                               the operation.
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             Note:
7405                     This algorithm doesn't find all types of self-intersections.
7406                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7407                     vertex/face and edge/face intersections. Face/face
7408                     intersections detection is switched off as it is a
7409                     time-consuming operation that gives an impact on performance.
7410                     To find all self-intersections please use
7411                     CheckSelfIntersections() method.
7412
7413             Returns:
7414                 New GEOM.GEOM_Object, containing the result shape.
7415
7416             """
7417             # Example: see GEOM_TestOthers.py
7418             # note: auto-publishing is done in self.MakeBoolean()
7419             return self.MakeBoolean(theShape1, theShape2, 2, checkSelfInte, theName)
7420
7421         ## Perform Fuse boolean operation on two given shapes.
7422         #  @param theShape1 First argument for boolean operation.
7423         #  @param theShape2 Second argument for boolean operation.
7424         #  @param checkSelfInte The flag that tells if the arguments should
7425         #         be checked for self-intersection prior to the operation.
7426         #  @param rmExtraEdges The flag that tells if Remove Extra Edges
7427         #         operation should be performed during the operation.
7428         #  @param theName Object name; when specified, this parameter is used
7429         #         for result publication in the study. Otherwise, if automatic
7430         #         publication is switched on, default value is used for result name.
7431         #
7432         #  @note This algorithm doesn't find all types of self-intersections.
7433         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7434         #        vertex/face and edge/face intersections. Face/face
7435         #        intersections detection is switched off as it is a
7436         #        time-consuming operation that gives an impact on performance.
7437         #        To find all self-intersections please use
7438         #        CheckSelfIntersections() method.
7439         #
7440         #  @return New GEOM.GEOM_Object, containing the result shape.
7441         #
7442         #  @ref tui_fuse "Example 1"
7443         #  \n @ref swig_MakeCommon "Example 2"
7444         @ManageTransactions("BoolOp")
7445         def MakeFuse(self, theShape1, theShape2, checkSelfInte=False,
7446                      rmExtraEdges=False, theName=None):
7447             """
7448             Perform Fuse boolean operation on two given shapes.
7449
7450             Parameters:
7451                 theShape1 First argument for boolean operation.
7452                 theShape2 Second argument for boolean operation.
7453                 checkSelfInte The flag that tells if the arguments should
7454                               be checked for self-intersection prior to
7455                               the operation.
7456                 rmExtraEdges The flag that tells if Remove Extra Edges
7457                              operation should be performed during the operation.
7458                 theName Object name; when specified, this parameter is used
7459                         for result publication in the study. Otherwise, if automatic
7460                         publication is switched on, default value is used for result name.
7461
7462             Note:
7463                     This algorithm doesn't find all types of self-intersections.
7464                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7465                     vertex/face and edge/face intersections. Face/face
7466                     intersections detection is switched off as it is a
7467                     time-consuming operation that gives an impact on performance.
7468                     To find all self-intersections please use
7469                     CheckSelfIntersections() method.
7470
7471             Returns:
7472                 New GEOM.GEOM_Object, containing the result shape.
7473
7474             """
7475             # Example: see GEOM_TestOthers.py
7476             anObj = self.BoolOp.MakeFuse(theShape1, theShape2,
7477                                          checkSelfInte, rmExtraEdges)
7478             RaiseIfFailed("MakeFuse", self.BoolOp)
7479             self._autoPublish(anObj, theName, "fuse")
7480             return anObj
7481
7482         ## Perform Section boolean operation on two given shapes.
7483         #  @param theShape1 First argument for boolean operation.
7484         #  @param theShape2 Second argument for boolean operation.
7485         #  @param checkSelfInte The flag that tells if the arguments should
7486         #         be checked for self-intersection prior to the operation.
7487         #         If a self-intersection detected the operation fails.
7488         #  @param theName Object name; when specified, this parameter is used
7489         #         for result publication in the study. Otherwise, if automatic
7490         #         publication is switched on, default value is used for result name.
7491         #  @return New GEOM.GEOM_Object, containing the result shape.
7492         #
7493         #  @ref tui_section "Example 1"
7494         #  \n @ref swig_MakeCommon "Example 2"
7495         def MakeSection(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7496             """
7497             Perform Section boolean operation on two given shapes.
7498
7499             Parameters:
7500                 theShape1 First argument for boolean operation.
7501                 theShape2 Second argument for boolean operation.
7502                 checkSelfInte The flag that tells if the arguments should
7503                               be checked for self-intersection prior to the operation.
7504                               If a self-intersection detected the operation fails.
7505                 theName Object name; when specified, this parameter is used
7506                         for result publication in the study. Otherwise, if automatic
7507                         publication is switched on, default value is used for result name.
7508             Returns:
7509                 New GEOM.GEOM_Object, containing the result shape.
7510
7511             """
7512             # Example: see GEOM_TestOthers.py
7513             # note: auto-publishing is done in self.MakeBoolean()
7514             return self.MakeBoolean(theShape1, theShape2, 4, checkSelfInte, theName)
7515
7516         ## Perform Fuse boolean operation on the list of shapes.
7517         #  @param theShapesList Shapes to be fused.
7518         #  @param checkSelfInte The flag that tells if the arguments should
7519         #         be checked for self-intersection prior to the operation.
7520         #  @param rmExtraEdges The flag that tells if Remove Extra Edges
7521         #         operation should be performed during the operation.
7522         #  @param theName Object name; when specified, this parameter is used
7523         #         for result publication in the study. Otherwise, if automatic
7524         #         publication is switched on, default value is used for result name.
7525         #
7526         #  @note This algorithm doesn't find all types of self-intersections.
7527         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7528         #        vertex/face and edge/face intersections. Face/face
7529         #        intersections detection is switched off as it is a
7530         #        time-consuming operation that gives an impact on performance.
7531         #        To find all self-intersections please use
7532         #        CheckSelfIntersections() method.
7533         #
7534         #  @return New GEOM.GEOM_Object, containing the result shape.
7535         #
7536         #  @ref tui_fuse "Example 1"
7537         #  \n @ref swig_MakeCommon "Example 2"
7538         @ManageTransactions("BoolOp")
7539         def MakeFuseList(self, theShapesList, checkSelfInte=False,
7540                          rmExtraEdges=False, theName=None):
7541             """
7542             Perform Fuse boolean operation on the list of shapes.
7543
7544             Parameters:
7545                 theShapesList Shapes to be fused.
7546                 checkSelfInte The flag that tells if the arguments should
7547                               be checked for self-intersection prior to
7548                               the operation.
7549                 rmExtraEdges The flag that tells if Remove Extra Edges
7550                              operation should be performed during the operation.
7551                 theName Object name; when specified, this parameter is used
7552                         for result publication in the study. Otherwise, if automatic
7553                         publication is switched on, default value is used for result name.
7554
7555             Note:
7556                     This algorithm doesn't find all types of self-intersections.
7557                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7558                     vertex/face and edge/face intersections. Face/face
7559                     intersections detection is switched off as it is a
7560                     time-consuming operation that gives an impact on performance.
7561                     To find all self-intersections please use
7562                     CheckSelfIntersections() method.
7563
7564             Returns:
7565                 New GEOM.GEOM_Object, containing the result shape.
7566
7567             """
7568             # Example: see GEOM_TestOthers.py
7569             anObj = self.BoolOp.MakeFuseList(theShapesList, checkSelfInte,
7570                                              rmExtraEdges)
7571             RaiseIfFailed("MakeFuseList", self.BoolOp)
7572             self._autoPublish(anObj, theName, "fuse")
7573             return anObj
7574
7575         ## Perform Common boolean operation on the list of shapes.
7576         #  @param theShapesList Shapes for Common operation.
7577         #  @param checkSelfInte The flag that tells if the arguments should
7578         #         be checked for self-intersection prior to the operation.
7579         #  @param theName Object name; when specified, this parameter is used
7580         #         for result publication in the study. Otherwise, if automatic
7581         #         publication is switched on, default value is used for result name.
7582         #
7583         #  @note This algorithm doesn't find all types of self-intersections.
7584         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7585         #        vertex/face and edge/face intersections. Face/face
7586         #        intersections detection is switched off as it is a
7587         #        time-consuming operation that gives an impact on performance.
7588         #        To find all self-intersections please use
7589         #        CheckSelfIntersections() method.
7590         #
7591         #  @return New GEOM.GEOM_Object, containing the result shape.
7592         #
7593         #  @ref tui_common "Example 1"
7594         #  \n @ref swig_MakeCommon "Example 2"
7595         @ManageTransactions("BoolOp")
7596         def MakeCommonList(self, theShapesList, checkSelfInte=False, theName=None):
7597             """
7598             Perform Common boolean operation on the list of shapes.
7599
7600             Parameters:
7601                 theShapesList Shapes for Common operation.
7602                 checkSelfInte The flag that tells if the arguments should
7603                               be checked for self-intersection prior to
7604                               the operation.
7605                 theName Object name; when specified, this parameter is used
7606                         for result publication in the study. Otherwise, if automatic
7607                         publication is switched on, default value is used for result name.
7608
7609             Note:
7610                     This algorithm doesn't find all types of self-intersections.
7611                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7612                     vertex/face and edge/face intersections. Face/face
7613                     intersections detection is switched off as it is a
7614                     time-consuming operation that gives an impact on performance.
7615                     To find all self-intersections please use
7616                     CheckSelfIntersections() method.
7617
7618             Returns:
7619                 New GEOM.GEOM_Object, containing the result shape.
7620
7621             """
7622             # Example: see GEOM_TestOthers.py
7623             anObj = self.BoolOp.MakeCommonList(theShapesList, checkSelfInte)
7624             RaiseIfFailed("MakeCommonList", self.BoolOp)
7625             self._autoPublish(anObj, theName, "common")
7626             return anObj
7627
7628         ## Perform Cut boolean operation on one object and the list of tools.
7629         #  @param theMainShape The object of the operation.
7630         #  @param theShapesList The list of tools of the operation.
7631         #  @param checkSelfInte The flag that tells if the arguments should
7632         #         be checked for self-intersection prior to the operation.
7633         #  @param theName Object name; when specified, this parameter is used
7634         #         for result publication in the study. Otherwise, if automatic
7635         #         publication is switched on, default value is used for result name.
7636         #
7637         #  @note This algorithm doesn't find all types of self-intersections.
7638         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7639         #        vertex/face and edge/face intersections. Face/face
7640         #        intersections detection is switched off as it is a
7641         #        time-consuming operation that gives an impact on performance.
7642         #        To find all self-intersections please use
7643         #        CheckSelfIntersections() method.
7644         #
7645         #  @return New GEOM.GEOM_Object, containing the result shape.
7646         #
7647         #  @ref tui_cut "Example 1"
7648         #  \n @ref swig_MakeCommon "Example 2"
7649         @ManageTransactions("BoolOp")
7650         def MakeCutList(self, theMainShape, theShapesList, checkSelfInte=False, theName=None):
7651             """
7652             Perform Cut boolean operation on one object and the list of tools.
7653
7654             Parameters:
7655                 theMainShape The object of the operation.
7656                 theShapesList The list of tools of the operation.
7657                 checkSelfInte The flag that tells if the arguments should
7658                               be checked for self-intersection prior to
7659                               the operation.
7660                 theName Object name; when specified, this parameter is used
7661                         for result publication in the study. Otherwise, if automatic
7662                         publication is switched on, default value is used for result name.
7663
7664             Note:
7665                     This algorithm doesn't find all types of self-intersections.
7666                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7667                     vertex/face and edge/face intersections. Face/face
7668                     intersections detection is switched off as it is a
7669                     time-consuming operation that gives an impact on performance.
7670                     To find all self-intersections please use
7671                     CheckSelfIntersections() method.
7672
7673             Returns:
7674                 New GEOM.GEOM_Object, containing the result shape.
7675
7676             """
7677             # Example: see GEOM_TestOthers.py
7678             anObj = self.BoolOp.MakeCutList(theMainShape, theShapesList, checkSelfInte)
7679             RaiseIfFailed("MakeCutList", self.BoolOp)
7680             self._autoPublish(anObj, theName, "cut")
7681             return anObj
7682
7683         # end of l3_boolean
7684         ## @}
7685
7686         ## @addtogroup l3_basic_op
7687         ## @{
7688
7689         ## Perform partition operation.
7690         #  @param ListShapes Shapes to be intersected.
7691         #  @param ListTools Shapes to intersect theShapes.
7692         #  @param Limit Type of resulting shapes (see ShapeType()).\n
7693         #         If this parameter is set to -1 ("Auto"), most appropriate shape limit
7694         #         type will be detected automatically.
7695         #  @param KeepNonlimitShapes if this parameter == 0, then only shapes of
7696         #                             target type (equal to Limit) are kept in the result,
7697         #                             else standalone shapes of lower dimension
7698         #                             are kept also (if they exist).
7699         #
7700         #  @param theName Object name; when specified, this parameter is used
7701         #         for result publication in the study. Otherwise, if automatic
7702         #         publication is switched on, default value is used for result name.
7703         #
7704         #  @note Each compound from ListShapes and ListTools will be exploded
7705         #        in order to avoid possible intersection between shapes from this compound.
7706         #
7707         #  After implementation new version of PartitionAlgo (October 2006)
7708         #  other parameters are ignored by current functionality. They are kept
7709         #  in this function only for support old versions.
7710         #      @param ListKeepInside Shapes, outside which the results will be deleted.
7711         #         Each shape from theKeepInside must belong to theShapes also.
7712         #      @param ListRemoveInside Shapes, inside which the results will be deleted.
7713         #         Each shape from theRemoveInside must belong to theShapes also.
7714         #      @param RemoveWebs If TRUE, perform Glue 3D algorithm.
7715         #      @param ListMaterials Material indices for each shape. Make sence,
7716         #         only if theRemoveWebs is TRUE.
7717         #
7718         #  @return New GEOM.GEOM_Object, containing the result shapes.
7719         #
7720         #  @ref tui_partition "Example"
7721         @ManageTransactions("BoolOp")
7722         def MakePartition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
7723                           Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
7724                           KeepNonlimitShapes=0, theName=None):
7725             """
7726             Perform partition operation.
7727
7728             Parameters:
7729                 ListShapes Shapes to be intersected.
7730                 ListTools Shapes to intersect theShapes.
7731                 Limit Type of resulting shapes (see geompy.ShapeType)
7732                       If this parameter is set to -1 ("Auto"), most appropriate shape limit
7733                       type will be detected automatically.
7734                 KeepNonlimitShapes if this parameter == 0, then only shapes of
7735                                     target type (equal to Limit) are kept in the result,
7736                                     else standalone shapes of lower dimension
7737                                     are kept also (if they exist).
7738
7739                 theName Object name; when specified, this parameter is used
7740                         for result publication in the study. Otherwise, if automatic
7741                         publication is switched on, default value is used for result name.
7742             Note:
7743                     Each compound from ListShapes and ListTools will be exploded
7744                     in order to avoid possible intersection between shapes from
7745                     this compound.
7746
7747             After implementation new version of PartitionAlgo (October 2006) other
7748             parameters are ignored by current functionality. They are kept in this
7749             function only for support old versions.
7750
7751             Ignored parameters:
7752                 ListKeepInside Shapes, outside which the results will be deleted.
7753                                Each shape from theKeepInside must belong to theShapes also.
7754                 ListRemoveInside Shapes, inside which the results will be deleted.
7755                                  Each shape from theRemoveInside must belong to theShapes also.
7756                 RemoveWebs If TRUE, perform Glue 3D algorithm.
7757                 ListMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
7758
7759             Returns:
7760                 New GEOM.GEOM_Object, containing the result shapes.
7761             """
7762             # Example: see GEOM_TestAll.py
7763             if Limit == self.ShapeType["AUTO"]:
7764                 # automatic detection of the most appropriate shape limit type
7765                 lim = GEOM.SHAPE
7766                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
7767                 Limit = EnumToLong(lim)
7768                 pass
7769             anObj = self.BoolOp.MakePartition(ListShapes, ListTools,
7770                                               ListKeepInside, ListRemoveInside,
7771                                               Limit, RemoveWebs, ListMaterials,
7772                                               KeepNonlimitShapes);
7773             RaiseIfFailed("MakePartition", self.BoolOp)
7774             self._autoPublish(anObj, theName, "partition")
7775             return anObj
7776
7777         ## Perform partition operation.
7778         #  This method may be useful if it is needed to make a partition for
7779         #  compound contains nonintersected shapes. Performance will be better
7780         #  since intersection between shapes from compound is not performed.
7781         #
7782         #  Description of all parameters as in previous method MakePartition().
7783         #  One additional parameter is provided:
7784         #  @param checkSelfInte The flag that tells if the arguments should
7785         #         be checked for self-intersection prior to the operation.
7786         #
7787         #  @note This algorithm doesn't find all types of self-intersections.
7788         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7789         #        vertex/face and edge/face intersections. Face/face
7790         #        intersections detection is switched off as it is a
7791         #        time-consuming operation that gives an impact on performance.
7792         #        To find all self-intersections please use
7793         #        CheckSelfIntersections() method.
7794         #
7795         #  @note Passed compounds (via ListShapes or via ListTools)
7796         #           have to consist of nonintersecting shapes.
7797         #
7798         #  @return New GEOM.GEOM_Object, containing the result shapes.
7799         #
7800         #  @ref swig_todo "Example"
7801         @ManageTransactions("BoolOp")
7802         def MakePartitionNonSelfIntersectedShape(self, ListShapes, ListTools=[],
7803                                                  ListKeepInside=[], ListRemoveInside=[],
7804                                                  Limit=ShapeType["AUTO"], RemoveWebs=0,
7805                                                  ListMaterials=[], KeepNonlimitShapes=0,
7806                                                  checkSelfInte=False, theName=None):
7807             """
7808             Perform partition operation.
7809             This method may be useful if it is needed to make a partition for
7810             compound contains nonintersected shapes. Performance will be better
7811             since intersection between shapes from compound is not performed.
7812
7813             Parameters:
7814                 Description of all parameters as in method geompy.MakePartition.
7815                 One additional parameter is provided:
7816                 checkSelfInte The flag that tells if the arguments should
7817                               be checked for self-intersection prior to
7818                               the operation.
7819
7820             Note:
7821                     This algorithm doesn't find all types of self-intersections.
7822                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7823                     vertex/face and edge/face intersections. Face/face
7824                     intersections detection is switched off as it is a
7825                     time-consuming operation that gives an impact on performance.
7826                     To find all self-intersections please use
7827                     CheckSelfIntersections() method.
7828
7829             NOTE:
7830                 Passed compounds (via ListShapes or via ListTools)
7831                 have to consist of nonintersecting shapes.
7832
7833             Returns:
7834                 New GEOM.GEOM_Object, containing the result shapes.
7835             """
7836             if Limit == self.ShapeType["AUTO"]:
7837                 # automatic detection of the most appropriate shape limit type
7838                 lim = GEOM.SHAPE
7839                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
7840                 Limit = EnumToLong(lim)
7841                 pass
7842             anObj = self.BoolOp.MakePartitionNonSelfIntersectedShape(ListShapes, ListTools,
7843                                                                      ListKeepInside, ListRemoveInside,
7844                                                                      Limit, RemoveWebs, ListMaterials,
7845                                                                      KeepNonlimitShapes, checkSelfInte);
7846             RaiseIfFailed("MakePartitionNonSelfIntersectedShape", self.BoolOp)
7847             self._autoPublish(anObj, theName, "partition")
7848             return anObj
7849
7850         ## See method MakePartition() for more information.
7851         #
7852         #  @ref tui_partition "Example 1"
7853         #  \n @ref swig_Partition "Example 2"
7854         def Partition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
7855                       Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
7856                       KeepNonlimitShapes=0, theName=None):
7857             """
7858             See method geompy.MakePartition for more information.
7859             """
7860             # Example: see GEOM_TestOthers.py
7861             # note: auto-publishing is done in self.MakePartition()
7862             anObj = self.MakePartition(ListShapes, ListTools,
7863                                        ListKeepInside, ListRemoveInside,
7864                                        Limit, RemoveWebs, ListMaterials,
7865                                        KeepNonlimitShapes, theName);
7866             return anObj
7867
7868         ## Perform partition of the Shape with the Plane
7869         #  @param theShape Shape to be intersected.
7870         #  @param thePlane Tool shape, to intersect theShape.
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         #  @return New GEOM.GEOM_Object, containing the result shape.
7876         #
7877         #  @ref tui_partition "Example"
7878         @ManageTransactions("BoolOp")
7879         def MakeHalfPartition(self, theShape, thePlane, theName=None):
7880             """
7881             Perform partition of the Shape with the Plane
7882
7883             Parameters:
7884                 theShape Shape to be intersected.
7885                 thePlane Tool shape, to intersect theShape.
7886                 theName Object name; when specified, this parameter is used
7887                         for result publication in the study. Otherwise, if automatic
7888                         publication is switched on, default value is used for result name.
7889
7890             Returns:
7891                 New GEOM.GEOM_Object, containing the result shape.
7892             """
7893             # Example: see GEOM_TestAll.py
7894             anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane)
7895             RaiseIfFailed("MakeHalfPartition", self.BoolOp)
7896             self._autoPublish(anObj, theName, "partition")
7897             return anObj
7898
7899         # end of l3_basic_op
7900         ## @}
7901
7902         ## @addtogroup l3_transform
7903         ## @{
7904
7905         ## Translate the given object along the vector, specified
7906         #  by its end points.
7907         #  @param theObject The object to be translated.
7908         #  @param thePoint1 Start point of translation vector.
7909         #  @param thePoint2 End point of translation vector.
7910         #  @param theCopy Flag used to translate object itself or create a copy.
7911         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
7912         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
7913         @ManageTransactions("TrsfOp")
7914         def TranslateTwoPoints(self, theObject, thePoint1, thePoint2, theCopy=False):
7915             """
7916             Translate the given object along the vector, specified by its end points.
7917
7918             Parameters:
7919                 theObject The object to be translated.
7920                 thePoint1 Start point of translation vector.
7921                 thePoint2 End point of translation vector.
7922                 theCopy Flag used to translate object itself or create a copy.
7923
7924             Returns:
7925                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
7926                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
7927             """
7928             if theCopy:
7929                 anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
7930             else:
7931                 anObj = self.TrsfOp.TranslateTwoPoints(theObject, thePoint1, thePoint2)
7932             RaiseIfFailed("TranslateTwoPoints", self.TrsfOp)
7933             return anObj
7934
7935         ## Translate the given object along the vector, specified
7936         #  by its end points, creating its copy before the translation.
7937         #  @param theObject The object to be translated.
7938         #  @param thePoint1 Start point of translation vector.
7939         #  @param thePoint2 End point of translation vector.
7940         #  @param theName Object name; when specified, this parameter is used
7941         #         for result publication in the study. Otherwise, if automatic
7942         #         publication is switched on, default value is used for result name.
7943         #
7944         #  @return New GEOM.GEOM_Object, containing the translated object.
7945         #
7946         #  @ref tui_translation "Example 1"
7947         #  \n @ref swig_MakeTranslationTwoPoints "Example 2"
7948         @ManageTransactions("TrsfOp")
7949         def MakeTranslationTwoPoints(self, theObject, thePoint1, thePoint2, theName=None):
7950             """
7951             Translate the given object along the vector, specified
7952             by its end points, creating its copy before the translation.
7953
7954             Parameters:
7955                 theObject The object to be translated.
7956                 thePoint1 Start point of translation vector.
7957                 thePoint2 End point of translation vector.
7958                 theName Object name; when specified, this parameter is used
7959                         for result publication in the study. Otherwise, if automatic
7960                         publication is switched on, default value is used for result name.
7961
7962             Returns:
7963                 New GEOM.GEOM_Object, containing the translated object.
7964             """
7965             # Example: see GEOM_TestAll.py
7966             anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
7967             RaiseIfFailed("TranslateTwoPointsCopy", self.TrsfOp)
7968             self._autoPublish(anObj, theName, "translated")
7969             return anObj
7970
7971         ## Translate the given object along the vector, specified by its components.
7972         #  @param theObject The object to be translated.
7973         #  @param theDX,theDY,theDZ Components of translation vector.
7974         #  @param theCopy Flag used to translate object itself or create a copy.
7975         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
7976         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
7977         #
7978         #  @ref tui_translation "Example"
7979         @ManageTransactions("TrsfOp")
7980         def TranslateDXDYDZ(self, theObject, theDX, theDY, theDZ, theCopy=False):
7981             """
7982             Translate the given object along the vector, specified by its components.
7983
7984             Parameters:
7985                 theObject The object to be translated.
7986                 theDX,theDY,theDZ Components of translation vector.
7987                 theCopy Flag used to translate object itself or create a copy.
7988
7989             Returns:
7990                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
7991                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
7992             """
7993             # Example: see GEOM_TestAll.py
7994             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
7995             if theCopy:
7996                 anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
7997             else:
7998                 anObj = self.TrsfOp.TranslateDXDYDZ(theObject, theDX, theDY, theDZ)
7999             anObj.SetParameters(Parameters)
8000             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
8001             return anObj
8002
8003         ## Translate the given object along the vector, specified
8004         #  by its components, creating its copy before the translation.
8005         #  @param theObject The object to be translated.
8006         #  @param theDX,theDY,theDZ Components of translation vector.
8007         #  @param theName Object name; when specified, this parameter is used
8008         #         for result publication in the study. Otherwise, if automatic
8009         #         publication is switched on, default value is used for result name.
8010         #
8011         #  @return New GEOM.GEOM_Object, containing the translated object.
8012         #
8013         #  @ref tui_translation "Example"
8014         @ManageTransactions("TrsfOp")
8015         def MakeTranslation(self,theObject, theDX, theDY, theDZ, theName=None):
8016             """
8017             Translate the given object along the vector, specified
8018             by its components, creating its copy before the translation.
8019
8020             Parameters:
8021                 theObject The object to be translated.
8022                 theDX,theDY,theDZ Components of translation vector.
8023                 theName Object name; when specified, this parameter is used
8024                         for result publication in the study. Otherwise, if automatic
8025                         publication is switched on, default value is used for result name.
8026
8027             Returns:
8028                 New GEOM.GEOM_Object, containing the translated object.
8029             """
8030             # Example: see GEOM_TestAll.py
8031             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
8032             anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
8033             anObj.SetParameters(Parameters)
8034             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
8035             self._autoPublish(anObj, theName, "translated")
8036             return anObj
8037
8038         ## Translate the given object along the given vector.
8039         #  @param theObject The object to be translated.
8040         #  @param theVector The translation vector.
8041         #  @param theCopy Flag used to translate object itself or create a copy.
8042         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8043         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8044         @ManageTransactions("TrsfOp")
8045         def TranslateVector(self, theObject, theVector, theCopy=False):
8046             """
8047             Translate the given object along the given vector.
8048
8049             Parameters:
8050                 theObject The object to be translated.
8051                 theVector The translation vector.
8052                 theCopy Flag used to translate object itself or create a copy.
8053
8054             Returns:
8055                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8056                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8057             """
8058             if theCopy:
8059                 anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
8060             else:
8061                 anObj = self.TrsfOp.TranslateVector(theObject, theVector)
8062             RaiseIfFailed("TranslateVector", self.TrsfOp)
8063             return anObj
8064
8065         ## Translate the given object along the given vector,
8066         #  creating its copy before the translation.
8067         #  @param theObject The object to be translated.
8068         #  @param theVector The translation vector.
8069         #  @param theName Object name; when specified, this parameter is used
8070         #         for result publication in the study. Otherwise, if automatic
8071         #         publication is switched on, default value is used for result name.
8072         #
8073         #  @return New GEOM.GEOM_Object, containing the translated object.
8074         #
8075         #  @ref tui_translation "Example"
8076         @ManageTransactions("TrsfOp")
8077         def MakeTranslationVector(self, theObject, theVector, theName=None):
8078             """
8079             Translate the given object along the given vector,
8080             creating its copy before the translation.
8081
8082             Parameters:
8083                 theObject The object to be translated.
8084                 theVector The translation vector.
8085                 theName Object name; when specified, this parameter is used
8086                         for result publication in the study. Otherwise, if automatic
8087                         publication is switched on, default value is used for result name.
8088
8089             Returns:
8090                 New GEOM.GEOM_Object, containing the translated object.
8091             """
8092             # Example: see GEOM_TestAll.py
8093             anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
8094             RaiseIfFailed("TranslateVectorCopy", self.TrsfOp)
8095             self._autoPublish(anObj, theName, "translated")
8096             return anObj
8097
8098         ## Translate the given object along the given vector on given distance.
8099         #  @param theObject The object to be translated.
8100         #  @param theVector The translation vector.
8101         #  @param theDistance The translation distance.
8102         #  @param theCopy Flag used to translate object itself or create a copy.
8103         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8104         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8105         #
8106         #  @ref tui_translation "Example"
8107         @ManageTransactions("TrsfOp")
8108         def TranslateVectorDistance(self, theObject, theVector, theDistance, theCopy=False):
8109             """
8110             Translate the given object along the given vector on given distance.
8111
8112             Parameters:
8113                 theObject The object to be translated.
8114                 theVector The translation vector.
8115                 theDistance The translation distance.
8116                 theCopy Flag used to translate object itself or create a copy.
8117
8118             Returns:
8119                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8120                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8121             """
8122             # Example: see GEOM_TestAll.py
8123             theDistance,Parameters = ParseParameters(theDistance)
8124             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, theCopy)
8125             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
8126             anObj.SetParameters(Parameters)
8127             return anObj
8128
8129         ## Translate the given object along the given vector on given distance,
8130         #  creating its copy before the translation.
8131         #  @param theObject The object to be translated.
8132         #  @param theVector The translation vector.
8133         #  @param theDistance The translation distance.
8134         #  @param theName Object name; when specified, this parameter is used
8135         #         for result publication in the study. Otherwise, if automatic
8136         #         publication is switched on, default value is used for result name.
8137         #
8138         #  @return New GEOM.GEOM_Object, containing the translated object.
8139         #
8140         #  @ref tui_translation "Example"
8141         @ManageTransactions("TrsfOp")
8142         def MakeTranslationVectorDistance(self, theObject, theVector, theDistance, theName=None):
8143             """
8144             Translate the given object along the given vector on given distance,
8145             creating its copy before the translation.
8146
8147             Parameters:
8148                 theObject The object to be translated.
8149                 theVector The translation vector.
8150                 theDistance The translation distance.
8151                 theName Object name; when specified, this parameter is used
8152                         for result publication in the study. Otherwise, if automatic
8153                         publication is switched on, default value is used for result name.
8154
8155             Returns:
8156                 New GEOM.GEOM_Object, containing the translated object.
8157             """
8158             # Example: see GEOM_TestAll.py
8159             theDistance,Parameters = ParseParameters(theDistance)
8160             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, 1)
8161             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
8162             anObj.SetParameters(Parameters)
8163             self._autoPublish(anObj, theName, "translated")
8164             return anObj
8165
8166         ## Rotate the given object around the given axis on the given angle.
8167         #  @param theObject The object to be rotated.
8168         #  @param theAxis Rotation axis.
8169         #  @param theAngle Rotation angle in radians.
8170         #  @param theCopy Flag used to rotate object itself or create a copy.
8171         #
8172         #  @return Rotated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8173         #  new GEOM.GEOM_Object, containing the rotated object if @a theCopy flag is @c True.
8174         #
8175         #  @ref tui_rotation "Example"
8176         @ManageTransactions("TrsfOp")
8177         def Rotate(self, theObject, theAxis, theAngle, theCopy=False):
8178             """
8179             Rotate the given object around the given axis on the given angle.
8180
8181             Parameters:
8182                 theObject The object to be rotated.
8183                 theAxis Rotation axis.
8184                 theAngle Rotation angle in radians.
8185                 theCopy Flag used to rotate object itself or create a copy.
8186
8187             Returns:
8188                 Rotated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8189                 new GEOM.GEOM_Object, containing the rotated object if theCopy flag is True.
8190             """
8191             # Example: see GEOM_TestAll.py
8192             flag = False
8193             if isinstance(theAngle,str):
8194                 flag = True
8195             theAngle, Parameters = ParseParameters(theAngle)
8196             if flag:
8197                 theAngle = theAngle*math.pi/180.0
8198             if theCopy:
8199                 anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
8200             else:
8201                 anObj = self.TrsfOp.Rotate(theObject, theAxis, theAngle)
8202             RaiseIfFailed("Rotate", self.TrsfOp)
8203             anObj.SetParameters(Parameters)
8204             return anObj
8205
8206         ## Rotate the given object around the given axis
8207         #  on the given angle, creating its copy before the rotation.
8208         #  @param theObject The object to be rotated.
8209         #  @param theAxis Rotation axis.
8210         #  @param theAngle Rotation angle in radians.
8211         #  @param theName Object name; when specified, this parameter is used
8212         #         for result publication in the study. Otherwise, if automatic
8213         #         publication is switched on, default value is used for result name.
8214         #
8215         #  @return New GEOM.GEOM_Object, containing the rotated object.
8216         #
8217         #  @ref tui_rotation "Example"
8218         @ManageTransactions("TrsfOp")
8219         def MakeRotation(self, theObject, theAxis, theAngle, theName=None):
8220             """
8221             Rotate the given object around the given axis
8222             on the given angle, creating its copy before the rotatation.
8223
8224             Parameters:
8225                 theObject The object to be rotated.
8226                 theAxis Rotation axis.
8227                 theAngle Rotation angle in radians.
8228                 theName Object name; when specified, this parameter is used
8229                         for result publication in the study. Otherwise, if automatic
8230                         publication is switched on, default value is used for result name.
8231
8232             Returns:
8233                 New GEOM.GEOM_Object, containing the rotated object.
8234             """
8235             # Example: see GEOM_TestAll.py
8236             flag = False
8237             if isinstance(theAngle,str):
8238                 flag = True
8239             theAngle, Parameters = ParseParameters(theAngle)
8240             if flag:
8241                 theAngle = theAngle*math.pi/180.0
8242             anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
8243             RaiseIfFailed("RotateCopy", self.TrsfOp)
8244             anObj.SetParameters(Parameters)
8245             self._autoPublish(anObj, theName, "rotated")
8246             return anObj
8247
8248         ## Rotate given object around vector perpendicular to plane
8249         #  containing three points.
8250         #  @param theObject The object to be rotated.
8251         #  @param theCentPoint central point the axis is the vector perpendicular to the plane
8252         #  containing the three points.
8253         #  @param thePoint1,thePoint2 points in a perpendicular plane of the axis.
8254         #  @param theCopy Flag used to rotate object itself or create a copy.
8255         #  @return Rotated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8256         #  new GEOM.GEOM_Object, containing the rotated object if @a theCopy flag is @c True.
8257         @ManageTransactions("TrsfOp")
8258         def RotateThreePoints(self, theObject, theCentPoint, thePoint1, thePoint2, theCopy=False):
8259             """
8260             Rotate given object around vector perpendicular to plane
8261             containing three points.
8262
8263             Parameters:
8264                 theObject The object to be rotated.
8265                 theCentPoint central point  the axis is the vector perpendicular to the plane
8266                              containing the three points.
8267                 thePoint1,thePoint2 points in a perpendicular plane of the axis.
8268                 theCopy Flag used to rotate object itself or create a copy.
8269
8270             Returns:
8271                 Rotated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8272                 new GEOM.GEOM_Object, containing the rotated object if theCopy flag is True.
8273             """
8274             if theCopy:
8275                 anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
8276             else:
8277                 anObj = self.TrsfOp.RotateThreePoints(theObject, theCentPoint, thePoint1, thePoint2)
8278             RaiseIfFailed("RotateThreePoints", self.TrsfOp)
8279             return anObj
8280
8281         ## Rotate given object around vector perpendicular to plane
8282         #  containing three points, creating its copy before the rotatation.
8283         #  @param theObject The object to be rotated.
8284         #  @param theCentPoint central point the axis is the vector perpendicular to the plane
8285         #  containing the three points.
8286         #  @param thePoint1,thePoint2 in a perpendicular plane of the axis.
8287         #  @param theName Object name; when specified, this parameter is used
8288         #         for result publication in the study. Otherwise, if automatic
8289         #         publication is switched on, default value is used for result name.
8290         #
8291         #  @return New GEOM.GEOM_Object, containing the rotated object.
8292         #
8293         #  @ref tui_rotation "Example"
8294         @ManageTransactions("TrsfOp")
8295         def MakeRotationThreePoints(self, theObject, theCentPoint, thePoint1, thePoint2, theName=None):
8296             """
8297             Rotate given object around vector perpendicular to plane
8298             containing three points, creating its copy before the rotatation.
8299
8300             Parameters:
8301                 theObject The object to be rotated.
8302                 theCentPoint central point  the axis is the vector perpendicular to the plane
8303                              containing the three points.
8304                 thePoint1,thePoint2  in a perpendicular plane of the axis.
8305                 theName Object name; when specified, this parameter is used
8306                         for result publication in the study. Otherwise, if automatic
8307                         publication is switched on, default value is used for result name.
8308
8309             Returns:
8310                 New GEOM.GEOM_Object, containing the rotated object.
8311             """
8312             # Example: see GEOM_TestAll.py
8313             anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
8314             RaiseIfFailed("RotateThreePointsCopy", self.TrsfOp)
8315             self._autoPublish(anObj, theName, "rotated")
8316             return anObj
8317
8318         ## Scale the given object by the specified factor.
8319         #  @param theObject The object to be scaled.
8320         #  @param thePoint Center point for scaling.
8321         #                  Passing None for it means scaling relatively the origin of global CS.
8322         #  @param theFactor Scaling factor value.
8323         #  @param theCopy Flag used to scale object itself or create a copy.
8324         #  @return Scaled @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8325         #  new GEOM.GEOM_Object, containing the scaled object if @a theCopy flag is @c True.
8326         @ManageTransactions("TrsfOp")
8327         def Scale(self, theObject, thePoint, theFactor, theCopy=False):
8328             """
8329             Scale the given object by the specified factor.
8330
8331             Parameters:
8332                 theObject The object to be scaled.
8333                 thePoint Center point for scaling.
8334                          Passing None for it means scaling relatively the origin of global CS.
8335                 theFactor Scaling factor value.
8336                 theCopy Flag used to scale object itself or create a copy.
8337
8338             Returns:
8339                 Scaled theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8340                 new GEOM.GEOM_Object, containing the scaled object if theCopy flag is True.
8341             """
8342             # Example: see GEOM_TestAll.py
8343             theFactor, Parameters = ParseParameters(theFactor)
8344             if theCopy:
8345                 anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
8346             else:
8347                 anObj = self.TrsfOp.ScaleShape(theObject, thePoint, theFactor)
8348             RaiseIfFailed("Scale", self.TrsfOp)
8349             anObj.SetParameters(Parameters)
8350             return anObj
8351
8352         ## Scale the given object by the factor, creating its copy before the scaling.
8353         #  @param theObject The object to be scaled.
8354         #  @param thePoint Center point for scaling.
8355         #                  Passing None for it means scaling relatively the origin of global CS.
8356         #  @param theFactor Scaling factor value.
8357         #  @param theName Object name; when specified, this parameter is used
8358         #         for result publication in the study. Otherwise, if automatic
8359         #         publication is switched on, default value is used for result name.
8360         #
8361         #  @return New GEOM.GEOM_Object, containing the scaled shape.
8362         #
8363         #  @ref tui_scale "Example"
8364         @ManageTransactions("TrsfOp")
8365         def MakeScaleTransform(self, theObject, thePoint, theFactor, theName=None):
8366             """
8367             Scale the given object by the factor, creating its copy before the scaling.
8368
8369             Parameters:
8370                 theObject The object to be scaled.
8371                 thePoint Center point for scaling.
8372                          Passing None for it means scaling relatively the origin of global CS.
8373                 theFactor Scaling factor value.
8374                 theName Object name; when specified, this parameter is used
8375                         for result publication in the study. Otherwise, if automatic
8376                         publication is switched on, default value is used for result name.
8377
8378             Returns:
8379                 New GEOM.GEOM_Object, containing the scaled shape.
8380             """
8381             # Example: see GEOM_TestAll.py
8382             theFactor, Parameters = ParseParameters(theFactor)
8383             anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
8384             RaiseIfFailed("ScaleShapeCopy", self.TrsfOp)
8385             anObj.SetParameters(Parameters)
8386             self._autoPublish(anObj, theName, "scaled")
8387             return anObj
8388
8389         ## Scale the given object by different factors along coordinate axes.
8390         #  @param theObject The object to be scaled.
8391         #  @param thePoint Center point for scaling.
8392         #                  Passing None for it means scaling relatively the origin of global CS.
8393         #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8394         #  @param theCopy Flag used to scale object itself or create a copy.
8395         #  @return Scaled @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8396         #  new GEOM.GEOM_Object, containing the scaled object if @a theCopy flag is @c True.
8397         @ManageTransactions("TrsfOp")
8398         def ScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ, theCopy=False):
8399             """
8400             Scale the given object by different factors along coordinate axes.
8401
8402             Parameters:
8403                 theObject The object to be scaled.
8404                 thePoint Center point for scaling.
8405                             Passing None for it means scaling relatively the origin of global CS.
8406                 theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8407                 theCopy Flag used to scale object itself or create a copy.
8408
8409             Returns:
8410                 Scaled theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8411                 new GEOM.GEOM_Object, containing the scaled object if theCopy flag is True.
8412             """
8413             # Example: see GEOM_TestAll.py
8414             theFactorX, theFactorY, theFactorZ, Parameters = ParseParameters(theFactorX, theFactorY, theFactorZ)
8415             if theCopy:
8416                 anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
8417                                                             theFactorX, theFactorY, theFactorZ)
8418             else:
8419                 anObj = self.TrsfOp.ScaleShapeAlongAxes(theObject, thePoint,
8420                                                         theFactorX, theFactorY, theFactorZ)
8421             RaiseIfFailed("ScaleAlongAxes", self.TrsfOp)
8422             anObj.SetParameters(Parameters)
8423             return anObj
8424
8425         ## Scale the given object by different factors along coordinate axes,
8426         #  creating its copy before the scaling.
8427         #  @param theObject The object to be scaled.
8428         #  @param thePoint Center point for scaling.
8429         #                  Passing None for it means scaling relatively the origin of global CS.
8430         #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8431         #  @param theName Object name; when specified, this parameter is used
8432         #         for result publication in the study. Otherwise, if automatic
8433         #         publication is switched on, default value is used for result name.
8434         #
8435         #  @return New GEOM.GEOM_Object, containing the scaled shape.
8436         #
8437         #  @ref swig_scale "Example"
8438         @ManageTransactions("TrsfOp")
8439         def MakeScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ, theName=None):
8440             """
8441             Scale the given object by different factors along coordinate axes,
8442             creating its copy before the scaling.
8443
8444             Parameters:
8445                 theObject The object to be scaled.
8446                 thePoint Center point for scaling.
8447                             Passing None for it means scaling relatively the origin of global CS.
8448                 theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8449                 theName Object name; when specified, this parameter is used
8450                         for result publication in the study. Otherwise, if automatic
8451                         publication is switched on, default value is used for result name.
8452
8453             Returns:
8454                 New GEOM.GEOM_Object, containing the scaled shape.
8455             """
8456             # Example: see GEOM_TestAll.py
8457             theFactorX, theFactorY, theFactorZ, Parameters = ParseParameters(theFactorX, theFactorY, theFactorZ)
8458             anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
8459                                                         theFactorX, theFactorY, theFactorZ)
8460             RaiseIfFailed("MakeScaleAlongAxes", self.TrsfOp)
8461             anObj.SetParameters(Parameters)
8462             self._autoPublish(anObj, theName, "scaled")
8463             return anObj
8464
8465         ## Mirror an object relatively the given plane.
8466         #  @param theObject The object to be mirrored.
8467         #  @param thePlane Plane of symmetry.
8468         #  @param theCopy Flag used to mirror object itself or create a copy.
8469         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8470         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8471         @ManageTransactions("TrsfOp")
8472         def MirrorByPlane(self, theObject, thePlane, theCopy=False):
8473             """
8474             Mirror an object relatively the given plane.
8475
8476             Parameters:
8477                 theObject The object to be mirrored.
8478                 thePlane Plane of symmetry.
8479                 theCopy Flag used to mirror object itself or create a copy.
8480
8481             Returns:
8482                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8483                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8484             """
8485             if theCopy:
8486                 anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
8487             else:
8488                 anObj = self.TrsfOp.MirrorPlane(theObject, thePlane)
8489             RaiseIfFailed("MirrorByPlane", self.TrsfOp)
8490             return anObj
8491
8492         ## Create an object, symmetrical
8493         #  to the given one relatively the given plane.
8494         #  @param theObject The object to be mirrored.
8495         #  @param thePlane Plane of symmetry.
8496         #  @param theName Object name; when specified, this parameter is used
8497         #         for result publication in the study. Otherwise, if automatic
8498         #         publication is switched on, default value is used for result name.
8499         #
8500         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8501         #
8502         #  @ref tui_mirror "Example"
8503         @ManageTransactions("TrsfOp")
8504         def MakeMirrorByPlane(self, theObject, thePlane, theName=None):
8505             """
8506             Create an object, symmetrical to the given one relatively the given plane.
8507
8508             Parameters:
8509                 theObject The object to be mirrored.
8510                 thePlane Plane of symmetry.
8511                 theName Object name; when specified, this parameter is used
8512                         for result publication in the study. Otherwise, if automatic
8513                         publication is switched on, default value is used for result name.
8514
8515             Returns:
8516                 New GEOM.GEOM_Object, containing the mirrored shape.
8517             """
8518             # Example: see GEOM_TestAll.py
8519             anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
8520             RaiseIfFailed("MirrorPlaneCopy", self.TrsfOp)
8521             self._autoPublish(anObj, theName, "mirrored")
8522             return anObj
8523
8524         ## Mirror an object relatively the given axis.
8525         #  @param theObject The object to be mirrored.
8526         #  @param theAxis Axis of symmetry.
8527         #  @param theCopy Flag used to mirror object itself or create a copy.
8528         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8529         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8530         @ManageTransactions("TrsfOp")
8531         def MirrorByAxis(self, theObject, theAxis, theCopy=False):
8532             """
8533             Mirror an object relatively the given axis.
8534
8535             Parameters:
8536                 theObject The object to be mirrored.
8537                 theAxis Axis of symmetry.
8538                 theCopy Flag used to mirror object itself or create a copy.
8539
8540             Returns:
8541                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8542                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8543             """
8544             if theCopy:
8545                 anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
8546             else:
8547                 anObj = self.TrsfOp.MirrorAxis(theObject, theAxis)
8548             RaiseIfFailed("MirrorByAxis", self.TrsfOp)
8549             return anObj
8550
8551         ## Create an object, symmetrical
8552         #  to the given one relatively the given axis.
8553         #  @param theObject The object to be mirrored.
8554         #  @param theAxis Axis of symmetry.
8555         #  @param theName Object name; when specified, this parameter is used
8556         #         for result publication in the study. Otherwise, if automatic
8557         #         publication is switched on, default value is used for result name.
8558         #
8559         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8560         #
8561         #  @ref tui_mirror "Example"
8562         @ManageTransactions("TrsfOp")
8563         def MakeMirrorByAxis(self, theObject, theAxis, theName=None):
8564             """
8565             Create an object, symmetrical to the given one relatively the given axis.
8566
8567             Parameters:
8568                 theObject The object to be mirrored.
8569                 theAxis Axis of symmetry.
8570                 theName Object name; when specified, this parameter is used
8571                         for result publication in the study. Otherwise, if automatic
8572                         publication is switched on, default value is used for result name.
8573
8574             Returns:
8575                 New GEOM.GEOM_Object, containing the mirrored shape.
8576             """
8577             # Example: see GEOM_TestAll.py
8578             anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
8579             RaiseIfFailed("MirrorAxisCopy", self.TrsfOp)
8580             self._autoPublish(anObj, theName, "mirrored")
8581             return anObj
8582
8583         ## Mirror an object relatively the given point.
8584         #  @param theObject The object to be mirrored.
8585         #  @param thePoint Point of symmetry.
8586         #  @param theCopy Flag used to mirror object itself or create a copy.
8587         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8588         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8589         @ManageTransactions("TrsfOp")
8590         def MirrorByPoint(self, theObject, thePoint, theCopy=False):
8591             """
8592             Mirror an object relatively the given point.
8593
8594             Parameters:
8595                 theObject The object to be mirrored.
8596                 thePoint Point of symmetry.
8597                 theCopy Flag used to mirror object itself or create a copy.
8598
8599             Returns:
8600                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8601                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8602             """
8603             # Example: see GEOM_TestAll.py
8604             if theCopy:
8605                 anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
8606             else:
8607                 anObj = self.TrsfOp.MirrorPoint(theObject, thePoint)
8608             RaiseIfFailed("MirrorByPoint", self.TrsfOp)
8609             return anObj
8610
8611         ## Create an object, symmetrical
8612         #  to the given one relatively the given point.
8613         #  @param theObject The object to be mirrored.
8614         #  @param thePoint Point of symmetry.
8615         #  @param theName Object name; when specified, this parameter is used
8616         #         for result publication in the study. Otherwise, if automatic
8617         #         publication is switched on, default value is used for result name.
8618         #
8619         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8620         #
8621         #  @ref tui_mirror "Example"
8622         @ManageTransactions("TrsfOp")
8623         def MakeMirrorByPoint(self, theObject, thePoint, theName=None):
8624             """
8625             Create an object, symmetrical
8626             to the given one relatively the given point.
8627
8628             Parameters:
8629                 theObject The object to be mirrored.
8630                 thePoint Point of symmetry.
8631                 theName Object name; when specified, this parameter is used
8632                         for result publication in the study. Otherwise, if automatic
8633                         publication is switched on, default value is used for result name.
8634
8635             Returns:
8636                 New GEOM.GEOM_Object, containing the mirrored shape.
8637             """
8638             # Example: see GEOM_TestAll.py
8639             anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
8640             RaiseIfFailed("MirrorPointCopy", self.TrsfOp)
8641             self._autoPublish(anObj, theName, "mirrored")
8642             return anObj
8643
8644         ## Modify the location of the given object.
8645         #  @param theObject The object to be displaced.
8646         #  @param theStartLCS Coordinate system to perform displacement from it.\n
8647         #                     If \a theStartLCS is NULL, displacement
8648         #                     will be performed from global CS.\n
8649         #                     If \a theObject itself is used as \a theStartLCS,
8650         #                     its location will be changed to \a theEndLCS.
8651         #  @param theEndLCS Coordinate system to perform displacement to it.
8652         #  @param theCopy Flag used to displace object itself or create a copy.
8653         #  @return Displaced @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8654         #  new GEOM.GEOM_Object, containing the displaced object if @a theCopy flag is @c True.
8655         @ManageTransactions("TrsfOp")
8656         def Position(self, theObject, theStartLCS, theEndLCS, theCopy=False):
8657             """
8658             Modify the Location of the given object by LCS, creating its copy before the setting.
8659
8660             Parameters:
8661                 theObject The object to be displaced.
8662                 theStartLCS Coordinate system to perform displacement from it.
8663                             If theStartLCS is NULL, displacement
8664                             will be performed from global CS.
8665                             If theObject itself is used as theStartLCS,
8666                             its location will be changed to theEndLCS.
8667                 theEndLCS Coordinate system to perform displacement to it.
8668                 theCopy Flag used to displace object itself or create a copy.
8669
8670             Returns:
8671                 Displaced theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8672                 new GEOM.GEOM_Object, containing the displaced object if theCopy flag is True.
8673             """
8674             # Example: see GEOM_TestAll.py
8675             if theCopy:
8676                 anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
8677             else:
8678                 anObj = self.TrsfOp.PositionShape(theObject, theStartLCS, theEndLCS)
8679             RaiseIfFailed("Displace", self.TrsfOp)
8680             return anObj
8681
8682         ## Modify the Location of the given object by LCS,
8683         #  creating its copy before the setting.
8684         #  @param theObject The object to be displaced.
8685         #  @param theStartLCS Coordinate system to perform displacement from it.\n
8686         #                     If \a theStartLCS is NULL, displacement
8687         #                     will be performed from global CS.\n
8688         #                     If \a theObject itself is used as \a theStartLCS,
8689         #                     its location will be changed to \a theEndLCS.
8690         #  @param theEndLCS Coordinate system to perform displacement to it.
8691         #  @param theName Object name; when specified, this parameter is used
8692         #         for result publication in the study. Otherwise, if automatic
8693         #         publication is switched on, default value is used for result name.
8694         #
8695         #  @return New GEOM.GEOM_Object, containing the displaced shape.
8696         #
8697         #  @ref tui_modify_location "Example"
8698         @ManageTransactions("TrsfOp")
8699         def MakePosition(self, theObject, theStartLCS, theEndLCS, theName=None):
8700             """
8701             Modify the Location of the given object by LCS, creating its copy before the setting.
8702
8703             Parameters:
8704                 theObject The object to be displaced.
8705                 theStartLCS Coordinate system to perform displacement from it.
8706                             If theStartLCS is NULL, displacement
8707                             will be performed from global CS.
8708                             If theObject itself is used as theStartLCS,
8709                             its location will be changed to theEndLCS.
8710                 theEndLCS Coordinate system to perform displacement to it.
8711                 theName Object name; when specified, this parameter is used
8712                         for result publication in the study. Otherwise, if automatic
8713                         publication is switched on, default value is used for result name.
8714
8715             Returns:
8716                 New GEOM.GEOM_Object, containing the displaced shape.
8717
8718             Example of usage:
8719                 # create local coordinate systems
8720                 cs1 = geompy.MakeMarker( 0, 0, 0, 1,0,0, 0,1,0)
8721                 cs2 = geompy.MakeMarker(30,40,40, 1,0,0, 0,1,0)
8722                 # modify the location of the given object
8723                 position = geompy.MakePosition(cylinder, cs1, cs2)
8724             """
8725             # Example: see GEOM_TestAll.py
8726             anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
8727             RaiseIfFailed("PositionShapeCopy", self.TrsfOp)
8728             self._autoPublish(anObj, theName, "displaced")
8729             return anObj
8730
8731         ## Modify the Location of the given object by Path.
8732         #  @param  theObject The object to be displaced.
8733         #  @param  thePath Wire or Edge along that the object will be translated.
8734         #  @param  theDistance progress of Path (0 = start location, 1 = end of path location).
8735         #  @param  theCopy is to create a copy objects if true.
8736         #  @param  theReverse  0 - for usual direction, 1 - to reverse path direction.
8737         #  @return Displaced @a theObject (GEOM.GEOM_Object) if @a theCopy is @c False or
8738         #          new GEOM.GEOM_Object, containing the displaced shape if @a theCopy is @c True.
8739         #
8740         #  @ref tui_modify_location "Example"
8741         @ManageTransactions("TrsfOp")
8742         def PositionAlongPath(self,theObject, thePath, theDistance, theCopy, theReverse):
8743             """
8744             Modify the Location of the given object by Path.
8745
8746             Parameters:
8747                  theObject The object to be displaced.
8748                  thePath Wire or Edge along that the object will be translated.
8749                  theDistance progress of Path (0 = start location, 1 = end of path location).
8750                  theCopy is to create a copy objects if true.
8751                  theReverse  0 - for usual direction, 1 - to reverse path direction.
8752
8753             Returns:
8754                  Displaced theObject (GEOM.GEOM_Object) if theCopy is False or
8755                  new GEOM.GEOM_Object, containing the displaced shape if theCopy is True.
8756
8757             Example of usage:
8758                 position = geompy.PositionAlongPath(cylinder, circle, 0.75, 1, 1)
8759             """
8760             # Example: see GEOM_TestAll.py
8761             anObj = self.TrsfOp.PositionAlongPath(theObject, thePath, theDistance, theCopy, theReverse)
8762             RaiseIfFailed("PositionAlongPath", self.TrsfOp)
8763             return anObj
8764
8765         ## Modify the Location of the given object by Path, creating its copy before the operation.
8766         #  @param theObject The object to be displaced.
8767         #  @param thePath Wire or Edge along that the object will be translated.
8768         #  @param theDistance progress of Path (0 = start location, 1 = end of path location).
8769         #  @param theReverse  0 - for usual direction, 1 - to reverse path direction.
8770         #  @param theName Object name; when specified, this parameter is used
8771         #         for result publication in the study. Otherwise, if automatic
8772         #         publication is switched on, default value is used for result name.
8773         #
8774         #  @return New GEOM.GEOM_Object, containing the displaced shape.
8775         @ManageTransactions("TrsfOp")
8776         def MakePositionAlongPath(self, theObject, thePath, theDistance, theReverse, theName=None):
8777             """
8778             Modify the Location of the given object by Path, creating its copy before the operation.
8779
8780             Parameters:
8781                  theObject The object to be displaced.
8782                  thePath Wire or Edge along that the object will be translated.
8783                  theDistance progress of Path (0 = start location, 1 = end of path location).
8784                  theReverse  0 - for usual direction, 1 - to reverse path direction.
8785                  theName Object name; when specified, this parameter is used
8786                          for result publication in the study. Otherwise, if automatic
8787                          publication is switched on, default value is used for result name.
8788
8789             Returns:
8790                 New GEOM.GEOM_Object, containing the displaced shape.
8791             """
8792             # Example: see GEOM_TestAll.py
8793             anObj = self.TrsfOp.PositionAlongPath(theObject, thePath, theDistance, 1, theReverse)
8794             RaiseIfFailed("PositionAlongPath", self.TrsfOp)
8795             self._autoPublish(anObj, theName, "displaced")
8796             return anObj
8797
8798         ## Offset given shape.
8799         #  @param theObject The base object for the offset.
8800         #  @param theOffset Offset value.
8801         #  @param theCopy Flag used to offset object itself or create a copy.
8802         #  @return Modified @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8803         #  new GEOM.GEOM_Object, containing the result of offset operation if @a theCopy flag is @c True.
8804         @ManageTransactions("TrsfOp")
8805         def Offset(self, theObject, theOffset, theCopy=False):
8806             """
8807             Offset given shape.
8808
8809             Parameters:
8810                 theObject The base object for the offset.
8811                 theOffset Offset value.
8812                 theCopy Flag used to offset object itself or create a copy.
8813
8814             Returns:
8815                 Modified theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8816                 new GEOM.GEOM_Object, containing the result of offset operation if theCopy flag is True.
8817             """
8818             theOffset, Parameters = ParseParameters(theOffset)
8819             if theCopy:
8820                 anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
8821             else:
8822                 anObj = self.TrsfOp.OffsetShape(theObject, theOffset)
8823             RaiseIfFailed("Offset", self.TrsfOp)
8824             anObj.SetParameters(Parameters)
8825             return anObj
8826
8827         ## Create new object as offset of the given one.
8828         #  @param theObject The base object for the offset.
8829         #  @param theOffset Offset value.
8830         #  @param theName Object name; when specified, this parameter is used
8831         #         for result publication in the study. Otherwise, if automatic
8832         #         publication is switched on, default value is used for result name.
8833         #
8834         #  @return New GEOM.GEOM_Object, containing the offset object.
8835         #
8836         #  @ref tui_offset "Example"
8837         @ManageTransactions("TrsfOp")
8838         def MakeOffset(self, theObject, theOffset, theName=None):
8839             """
8840             Create new object as offset of the given one.
8841
8842             Parameters:
8843                 theObject The base object for the offset.
8844                 theOffset Offset value.
8845                 theName Object name; when specified, this parameter is used
8846                         for result publication in the study. Otherwise, if automatic
8847                         publication is switched on, default value is used for result name.
8848
8849             Returns:
8850                 New GEOM.GEOM_Object, containing the offset object.
8851
8852             Example of usage:
8853                  box = geompy.MakeBox(20, 20, 20, 200, 200, 200)
8854                  # create a new object as offset of the given object
8855                  offset = geompy.MakeOffset(box, 70.)
8856             """
8857             # Example: see GEOM_TestAll.py
8858             theOffset, Parameters = ParseParameters(theOffset)
8859             anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
8860             RaiseIfFailed("OffsetShapeCopy", self.TrsfOp)
8861             anObj.SetParameters(Parameters)
8862             self._autoPublish(anObj, theName, "offset")
8863             return anObj
8864
8865         ## Create new object as projection of the given one on another.
8866         #  @param theSource The source object for the projection. It can be a point, edge or wire.
8867         #         Edge and wire are acceptable if @a theTarget is a face.
8868         #  @param theTarget The target object. It can be planar or cylindrical face, edge or wire.
8869         #  @param theName Object name; when specified, this parameter is used
8870         #         for result publication in the study. Otherwise, if automatic
8871         #         publication is switched on, default value is used for result name.
8872         #
8873         #  @return New GEOM.GEOM_Object, containing the projection.
8874         #
8875         #  @ref tui_projection "Example"
8876         @ManageTransactions("TrsfOp")
8877         def MakeProjection(self, theSource, theTarget, theName=None):
8878             """
8879             Create new object as projection of the given one on another.
8880
8881             Parameters:
8882                 theSource The source object for the projection. It can be a point, edge or wire.
8883                           Edge and wire are acceptable if theTarget is a face.
8884                 theTarget The target object. It can be planar or cylindrical face, edge or wire.
8885                 theName Object name; when specified, this parameter is used
8886                         for result publication in the study. Otherwise, if automatic
8887                         publication is switched on, default value is used for result name.
8888
8889             Returns:
8890                 New GEOM.GEOM_Object, containing the projection.
8891             """
8892             # Example: see GEOM_TestAll.py
8893             anObj = self.TrsfOp.ProjectShapeCopy(theSource, theTarget)
8894             RaiseIfFailed("ProjectShapeCopy", self.TrsfOp)
8895             self._autoPublish(anObj, theName, "projection")
8896             return anObj
8897
8898         ## Create a projection projection of the given point on a wire or an edge.
8899         #  If there are no solutions or there are 2 or more solutions It throws an
8900         #  exception.
8901         #  @param thePoint the point to be projected.
8902         #  @param theWire the wire. The edge is accepted as well.
8903         #  @param theName Object name; when specified, this parameter is used
8904         #         for result publication in the study. Otherwise, if automatic
8905         #         publication is switched on, default value is used for result name.
8906         #
8907         #  @return [\a u, \a PointOnEdge, \a EdgeInWireIndex]
8908         #  \n \a u: The parameter of projection point on edge.
8909         #  \n \a PointOnEdge: The projection point.
8910         #  \n \a EdgeInWireIndex: The index of an edge in a wire.
8911         #
8912         #  @ref tui_projection "Example"
8913         @ManageTransactions("TrsfOp")
8914         def MakeProjectionOnWire(self, thePoint, theWire, theName=None):
8915             """
8916             Create a projection projection of the given point on a wire or an edge.
8917             If there are no solutions or there are 2 or more solutions It throws an
8918             exception.
8919
8920             Parameters:
8921                 thePoint the point to be projected.
8922                 theWire the wire. The edge is accepted as well.
8923                 theName Object name; when specified, this parameter is used
8924                         for result publication in the study. Otherwise, if automatic
8925                         publication is switched on, default value is used for result name.
8926
8927             Returns:
8928                 [u, PointOnEdge, EdgeInWireIndex]
8929                  u: The parameter of projection point on edge.
8930                  PointOnEdge: The projection point.
8931                  EdgeInWireIndex: The index of an edge in a wire.
8932             """
8933             # Example: see GEOM_TestAll.py
8934             anObj = self.TrsfOp.ProjectPointOnWire(thePoint, theWire)
8935             RaiseIfFailed("ProjectPointOnWire", self.TrsfOp)
8936             self._autoPublish(anObj[1], theName, "projection")
8937             return anObj
8938
8939         # -----------------------------------------------------------------------------
8940         # Patterns
8941         # -----------------------------------------------------------------------------
8942
8943         ## Translate the given object along the given vector a given number times
8944         #  @param theObject The object to be translated.
8945         #  @param theVector Direction of the translation. DX if None.
8946         #  @param theStep Distance to translate on.
8947         #  @param theNbTimes Quantity of translations to be done.
8948         #  @param 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         #  @return New GEOM.GEOM_Object, containing compound of all
8953         #          the shapes, obtained after each translation.
8954         #
8955         #  @ref tui_multi_translation "Example"
8956         @ManageTransactions("TrsfOp")
8957         def MakeMultiTranslation1D(self, theObject, theVector, theStep, theNbTimes, theName=None):
8958             """
8959             Translate the given object along the given vector a given number times
8960
8961             Parameters:
8962                 theObject The object to be translated.
8963                 theVector Direction of the translation. DX if None.
8964                 theStep Distance to translate on.
8965                 theNbTimes Quantity of translations to be done.
8966                 theName Object name; when specified, this parameter is used
8967                         for result publication in the study. Otherwise, if automatic
8968                         publication is switched on, default value is used for result name.
8969
8970             Returns:
8971                 New GEOM.GEOM_Object, containing compound of all
8972                 the shapes, obtained after each translation.
8973
8974             Example of usage:
8975                 r1d = geompy.MakeMultiTranslation1D(prism, vect, 20, 4)
8976             """
8977             # Example: see GEOM_TestAll.py
8978             theStep, theNbTimes, Parameters = ParseParameters(theStep, theNbTimes)
8979             anObj = self.TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
8980             RaiseIfFailed("MultiTranslate1D", self.TrsfOp)
8981             anObj.SetParameters(Parameters)
8982             self._autoPublish(anObj, theName, "multitranslation")
8983             return anObj
8984
8985         ## Conseqently apply two specified translations to theObject specified number of times.
8986         #  @param theObject The object to be translated.
8987         #  @param theVector1 Direction of the first translation. DX if None.
8988         #  @param theStep1 Step of the first translation.
8989         #  @param theNbTimes1 Quantity of translations to be done along theVector1.
8990         #  @param theVector2 Direction of the second translation. DY if None.
8991         #  @param theStep2 Step of the second translation.
8992         #  @param theNbTimes2 Quantity of translations to be done along theVector2.
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 compound of all
8998         #          the shapes, obtained after each translation.
8999         #
9000         #  @ref tui_multi_translation "Example"
9001         @ManageTransactions("TrsfOp")
9002         def MakeMultiTranslation2D(self, theObject, theVector1, theStep1, theNbTimes1,
9003                                    theVector2, theStep2, theNbTimes2, theName=None):
9004             """
9005             Conseqently apply two specified translations to theObject specified number of times.
9006
9007             Parameters:
9008                 theObject The object to be translated.
9009                 theVector1 Direction of the first translation. DX if None.
9010                 theStep1 Step of the first translation.
9011                 theNbTimes1 Quantity of translations to be done along theVector1.
9012                 theVector2 Direction of the second translation. DY if None.
9013                 theStep2 Step of the second translation.
9014                 theNbTimes2 Quantity of translations to be done along theVector2.
9015                 theName Object name; when specified, this parameter is used
9016                         for result publication in the study. Otherwise, if automatic
9017                         publication is switched on, default value is used for result name.
9018
9019             Returns:
9020                 New GEOM.GEOM_Object, containing compound of all
9021                 the shapes, obtained after each translation.
9022
9023             Example of usage:
9024                 tr2d = geompy.MakeMultiTranslation2D(prism, vect1, 20, 4, vect2, 80, 3)
9025             """
9026             # Example: see GEOM_TestAll.py
9027             theStep1,theNbTimes1,theStep2,theNbTimes2, Parameters = ParseParameters(theStep1,theNbTimes1,theStep2,theNbTimes2)
9028             anObj = self.TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
9029                                                  theVector2, theStep2, theNbTimes2)
9030             RaiseIfFailed("MultiTranslate2D", self.TrsfOp)
9031             anObj.SetParameters(Parameters)
9032             self._autoPublish(anObj, theName, "multitranslation")
9033             return anObj
9034
9035         ## Rotate the given object around the given axis a given number times.
9036         #  Rotation angle will be 2*PI/theNbTimes.
9037         #  @param theObject The object to be rotated.
9038         #  @param theAxis The rotation axis. DZ if None.
9039         #  @param theNbTimes Quantity of rotations to be done.
9040         #  @param theName Object name; when specified, this parameter is used
9041         #         for result publication in the study. Otherwise, if automatic
9042         #         publication is switched on, default value is used for result name.
9043         #
9044         #  @return New GEOM.GEOM_Object, containing compound of all the
9045         #          shapes, obtained after each rotation.
9046         #
9047         #  @ref tui_multi_rotation "Example"
9048         @ManageTransactions("TrsfOp")
9049         def MultiRotate1DNbTimes (self, theObject, theAxis, theNbTimes, theName=None):
9050             """
9051             Rotate the given object around the given axis a given number times.
9052             Rotation angle will be 2*PI/theNbTimes.
9053
9054             Parameters:
9055                 theObject The object to be rotated.
9056                 theAxis The rotation axis. DZ if None.
9057                 theNbTimes Quantity of rotations to be done.
9058                 theName Object name; when specified, this parameter is used
9059                         for result publication in the study. Otherwise, if automatic
9060                         publication is switched on, default value is used for result name.
9061
9062             Returns:
9063                 New GEOM.GEOM_Object, containing compound of all the
9064                 shapes, obtained after each rotation.
9065
9066             Example of usage:
9067                 rot1d = geompy.MultiRotate1DNbTimes(prism, vect, 4)
9068             """
9069             # Example: see GEOM_TestAll.py
9070             theNbTimes, Parameters = ParseParameters(theNbTimes)
9071             anObj = self.TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
9072             RaiseIfFailed("MultiRotate1DNbTimes", self.TrsfOp)
9073             anObj.SetParameters(Parameters)
9074             self._autoPublish(anObj, theName, "multirotation")
9075             return anObj
9076
9077         ## Rotate the given object around the given axis
9078         #  a given number times on the given angle.
9079         #  @param theObject The object to be rotated.
9080         #  @param theAxis The rotation axis. DZ if None.
9081         #  @param theAngleStep Rotation angle in radians.
9082         #  @param theNbTimes Quantity of rotations to be done.
9083         #  @param theName Object name; when specified, this parameter is used
9084         #         for result publication in the study. Otherwise, if automatic
9085         #         publication is switched on, default value is used for result name.
9086         #
9087         #  @return New GEOM.GEOM_Object, containing compound of all the
9088         #          shapes, obtained after each rotation.
9089         #
9090         #  @ref tui_multi_rotation "Example"
9091         @ManageTransactions("TrsfOp")
9092         def MultiRotate1DByStep(self, theObject, theAxis, theAngleStep, theNbTimes, theName=None):
9093             """
9094             Rotate the given object around the given axis
9095             a given number times on the given angle.
9096
9097             Parameters:
9098                 theObject The object to be rotated.
9099                 theAxis The rotation axis. DZ if None.
9100                 theAngleStep Rotation angle in radians.
9101                 theNbTimes Quantity of rotations to be done.
9102                 theName Object name; when specified, this parameter is used
9103                         for result publication in the study. Otherwise, if automatic
9104                         publication is switched on, default value is used for result name.
9105
9106             Returns:
9107                 New GEOM.GEOM_Object, containing compound of all the
9108                 shapes, obtained after each rotation.
9109
9110             Example of usage:
9111                 rot1d = geompy.MultiRotate1DByStep(prism, vect, math.pi/4, 4)
9112             """
9113             # Example: see GEOM_TestAll.py
9114             theAngleStep, theNbTimes, Parameters = ParseParameters(theAngleStep, theNbTimes)
9115             anObj = self.TrsfOp.MultiRotate1DByStep(theObject, theAxis, theAngleStep, theNbTimes)
9116             RaiseIfFailed("MultiRotate1DByStep", self.TrsfOp)
9117             anObj.SetParameters(Parameters)
9118             self._autoPublish(anObj, theName, "multirotation")
9119             return anObj
9120
9121         ## Rotate the given object around the given axis a given
9122         #  number times and multi-translate each rotation result.
9123         #  Rotation angle will be 2*PI/theNbTimes1.
9124         #  Translation direction passes through center of gravity
9125         #  of rotated shape and its projection on the rotation axis.
9126         #  @param theObject The object to be rotated.
9127         #  @param theAxis Rotation axis. DZ if None.
9128         #  @param theNbTimes1 Quantity of rotations to be done.
9129         #  @param theRadialStep Translation distance.
9130         #  @param theNbTimes2 Quantity of translations to be done.
9131         #  @param theName Object name; when specified, this parameter is used
9132         #         for result publication in the study. Otherwise, if automatic
9133         #         publication is switched on, default value is used for result name.
9134         #
9135         #  @return New GEOM.GEOM_Object, containing compound of all the
9136         #          shapes, obtained after each transformation.
9137         #
9138         #  @ref tui_multi_rotation "Example"
9139         @ManageTransactions("TrsfOp")
9140         def MultiRotate2DNbTimes(self, theObject, theAxis, theNbTimes1, theRadialStep, theNbTimes2, theName=None):
9141             """
9142             Rotate the given object around the
9143             given axis on the given angle a given number
9144             times and multi-translate each rotation result.
9145             Translation direction passes through center of gravity
9146             of rotated shape and its projection on the rotation axis.
9147
9148             Parameters:
9149                 theObject The object to be rotated.
9150                 theAxis Rotation axis. DZ if None.
9151                 theNbTimes1 Quantity of rotations to be done.
9152                 theRadialStep Translation distance.
9153                 theNbTimes2 Quantity of translations to be done.
9154                 theName Object name; when specified, this parameter is used
9155                         for result publication in the study. Otherwise, if automatic
9156                         publication is switched on, default value is used for result name.
9157
9158             Returns:
9159                 New GEOM.GEOM_Object, containing compound of all the
9160                 shapes, obtained after each transformation.
9161
9162             Example of usage:
9163                 rot2d = geompy.MultiRotate2D(prism, vect, 60, 4, 50, 5)
9164             """
9165             # Example: see GEOM_TestAll.py
9166             theNbTimes1, theRadialStep, theNbTimes2, Parameters = ParseParameters(theNbTimes1, theRadialStep, theNbTimes2)
9167             anObj = self.TrsfOp.MultiRotate2DNbTimes(theObject, theAxis, theNbTimes1, theRadialStep, theNbTimes2)
9168             RaiseIfFailed("MultiRotate2DNbTimes", self.TrsfOp)
9169             anObj.SetParameters(Parameters)
9170             self._autoPublish(anObj, theName, "multirotation")
9171             return anObj
9172
9173         ## Rotate the given object around the
9174         #  given axis on the given angle a given number
9175         #  times and multi-translate each rotation result.
9176         #  Translation direction passes through center of gravity
9177         #  of rotated shape and its projection on the rotation axis.
9178         #  @param theObject The object to be rotated.
9179         #  @param theAxis Rotation axis. DZ if None.
9180         #  @param theAngleStep Rotation angle in radians.
9181         #  @param theNbTimes1 Quantity of rotations to be done.
9182         #  @param theRadialStep Translation distance.
9183         #  @param theNbTimes2 Quantity of translations to be done.
9184         #  @param theName Object name; when specified, this parameter is used
9185         #         for result publication in the study. Otherwise, if automatic
9186         #         publication is switched on, default value is used for result name.
9187         #
9188         #  @return New GEOM.GEOM_Object, containing compound of all the
9189         #          shapes, obtained after each transformation.
9190         #
9191         #  @ref tui_multi_rotation "Example"
9192         @ManageTransactions("TrsfOp")
9193         def MultiRotate2DByStep (self, theObject, theAxis, theAngleStep, theNbTimes1, theRadialStep, theNbTimes2, theName=None):
9194             """
9195             Rotate the given object around the
9196             given axis on the given angle a given number
9197             times and multi-translate each rotation result.
9198             Translation direction passes through center of gravity
9199             of rotated shape and its projection on the rotation axis.
9200
9201             Parameters:
9202                 theObject The object to be rotated.
9203                 theAxis Rotation axis. DZ if None.
9204                 theAngleStep Rotation angle in radians.
9205                 theNbTimes1 Quantity of rotations to be done.
9206                 theRadialStep Translation distance.
9207                 theNbTimes2 Quantity of translations to be done.
9208                 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             Returns:
9213                 New GEOM.GEOM_Object, containing compound of all the
9214                 shapes, obtained after each transformation.
9215
9216             Example of usage:
9217                 rot2d = geompy.MultiRotate2D(prism, vect, math.pi/3, 4, 50, 5)
9218             """
9219             # Example: see GEOM_TestAll.py
9220             theAngleStep, theNbTimes1, theRadialStep, theNbTimes2, Parameters = ParseParameters(theAngleStep, theNbTimes1, theRadialStep, theNbTimes2)
9221             anObj = self.TrsfOp.MultiRotate2DByStep(theObject, theAxis, theAngleStep, theNbTimes1, theRadialStep, theNbTimes2)
9222             RaiseIfFailed("MultiRotate2DByStep", self.TrsfOp)
9223             anObj.SetParameters(Parameters)
9224             self._autoPublish(anObj, theName, "multirotation")
9225             return anObj
9226
9227         ## The same, as MultiRotate1DNbTimes(), but axis is given by direction and point
9228         #
9229         #  @ref swig_MakeMultiRotation "Example"
9230         def MakeMultiRotation1DNbTimes(self, aShape, aDir, aPoint, aNbTimes, theName=None):
9231             """
9232             The same, as geompy.MultiRotate1DNbTimes, but axis is given by direction and point
9233
9234             Example of usage:
9235                 pz = geompy.MakeVertex(0, 0, 100)
9236                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9237                 MultiRot1D = geompy.MakeMultiRotation1DNbTimes(prism, vy, pz, 6)
9238             """
9239             # Example: see GEOM_TestOthers.py
9240             aVec = self.MakeLine(aPoint,aDir)
9241             # note: auto-publishing is done in self.MultiRotate1D()
9242             anObj = self.MultiRotate1DNbTimes(aShape, aVec, aNbTimes, theName)
9243             return anObj
9244
9245         ## The same, as MultiRotate1DByStep(), but axis is given by direction and point
9246         #
9247         #  @ref swig_MakeMultiRotation "Example"
9248         def MakeMultiRotation1DByStep(self, aShape, aDir, aPoint, anAngle, aNbTimes, theName=None):
9249             """
9250             The same, as geompy.MultiRotate1D, but axis is given by direction and point
9251
9252             Example of usage:
9253                 pz = geompy.MakeVertex(0, 0, 100)
9254                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9255                 MultiRot1D = geompy.MakeMultiRotation1DByStep(prism, vy, pz, math.pi/3, 6)
9256             """
9257             # Example: see GEOM_TestOthers.py
9258             aVec = self.MakeLine(aPoint,aDir)
9259             # note: auto-publishing is done in self.MultiRotate1D()
9260             anObj = self.MultiRotate1DByStep(aShape, aVec, anAngle, aNbTimes, theName)
9261             return anObj
9262
9263         ## The same, as MultiRotate2DNbTimes(), but axis is given by direction and point
9264         #
9265         #  @ref swig_MakeMultiRotation "Example"
9266         def MakeMultiRotation2DNbTimes(self, aShape, aDir, aPoint, nbtimes1, aStep, nbtimes2, theName=None):
9267             """
9268             The same, as MultiRotate2DNbTimes(), but axis is given by direction and point
9269
9270             Example of usage:
9271                 pz = geompy.MakeVertex(0, 0, 100)
9272                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9273                 MultiRot2D = geompy.MakeMultiRotation2DNbTimes(f12, vy, pz, 6, 30, 3)
9274             """
9275             # Example: see GEOM_TestOthers.py
9276             aVec = self.MakeLine(aPoint,aDir)
9277             # note: auto-publishing is done in self.MultiRotate2DNbTimes()
9278             anObj = self.MultiRotate2DNbTimes(aShape, aVec, nbtimes1, aStep, nbtimes2, theName)
9279             return anObj
9280
9281         ## The same, as MultiRotate2DByStep(), but axis is given by direction and point
9282         #
9283         #  @ref swig_MakeMultiRotation "Example"
9284         def MakeMultiRotation2DByStep(self, aShape, aDir, aPoint, anAngle, nbtimes1, aStep, nbtimes2, theName=None):
9285             """
9286             The same, as MultiRotate2DByStep(), but axis is given by direction and point
9287
9288             Example of usage:
9289                 pz = geompy.MakeVertex(0, 0, 100)
9290                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9291                 MultiRot2D = geompy.MakeMultiRotation2DByStep(f12, vy, pz, math.pi/4, 6, 30, 3)
9292             """
9293             # Example: see GEOM_TestOthers.py
9294             aVec = self.MakeLine(aPoint,aDir)
9295             # note: auto-publishing is done in self.MultiRotate2D()
9296             anObj = self.MultiRotate2DByStep(aShape, aVec, anAngle, nbtimes1, aStep, nbtimes2, theName)
9297             return anObj
9298
9299         # end of l3_transform
9300         ## @}
9301
9302         ## @addtogroup l3_transform_d
9303         ## @{
9304
9305         ## Deprecated method. Use MultiRotate1DNbTimes instead.
9306         def MultiRotate1D(self, theObject, theAxis, theNbTimes, theName=None):
9307             """
9308             Deprecated method. Use MultiRotate1DNbTimes instead.
9309             """
9310             print "The method MultiRotate1D is DEPRECATED. Use MultiRotate1DNbTimes instead."
9311             return self.MultiRotate1DNbTimes(theObject, theAxis, theNbTimes, theName)
9312
9313         ## The same, as MultiRotate2DByStep(), but theAngle is in degrees.
9314         #  This method is DEPRECATED. Use MultiRotate2DByStep() instead.
9315         @ManageTransactions("TrsfOp")
9316         def MultiRotate2D(self, theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2, theName=None):
9317             """
9318             The same, as MultiRotate2DByStep(), but theAngle is in degrees.
9319             This method is DEPRECATED. Use MultiRotate2DByStep() instead.
9320
9321             Example of usage:
9322                 rot2d = geompy.MultiRotate2D(prism, vect, 60, 4, 50, 5)
9323             """
9324             print "The method MultiRotate2D is DEPRECATED. Use MultiRotate2DByStep instead."
9325             theAngle, theNbTimes1, theStep, theNbTimes2, Parameters = ParseParameters(theAngle, theNbTimes1, theStep, theNbTimes2)
9326             anObj = self.TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
9327             RaiseIfFailed("MultiRotate2D", self.TrsfOp)
9328             anObj.SetParameters(Parameters)
9329             self._autoPublish(anObj, theName, "multirotation")
9330             return anObj
9331
9332         ## The same, as MultiRotate1D(), but axis is given by direction and point
9333         #  This method is DEPRECATED. Use MakeMultiRotation1DNbTimes instead.
9334         def MakeMultiRotation1D(self, aShape, aDir, aPoint, aNbTimes, theName=None):
9335             """
9336             The same, as geompy.MultiRotate1D, but axis is given by direction and point.
9337             This method is DEPRECATED. Use MakeMultiRotation1DNbTimes instead.
9338
9339             Example of usage:
9340                 pz = geompy.MakeVertex(0, 0, 100)
9341                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9342                 MultiRot1D = geompy.MakeMultiRotation1D(prism, vy, pz, 6)
9343             """
9344             print "The method MakeMultiRotation1D is DEPRECATED. Use MakeMultiRotation1DNbTimes instead."
9345             aVec = self.MakeLine(aPoint,aDir)
9346             # note: auto-publishing is done in self.MultiRotate1D()
9347             anObj = self.MultiRotate1D(aShape, aVec, aNbTimes, theName)
9348             return anObj
9349
9350         ## The same, as MultiRotate2D(), but axis is given by direction and point
9351         #  This method is DEPRECATED. Use MakeMultiRotation2DByStep instead.
9352         def MakeMultiRotation2D(self, aShape, aDir, aPoint, anAngle, nbtimes1, aStep, nbtimes2, theName=None):
9353             """
9354             The same, as MultiRotate2D(), but axis is given by direction and point
9355             This method is DEPRECATED. Use MakeMultiRotation2DByStep instead.
9356
9357             Example of usage:
9358                 pz = geompy.MakeVertex(0, 0, 100)
9359                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9360                 MultiRot2D = geompy.MakeMultiRotation2D(f12, vy, pz, 45, 6, 30, 3)
9361             """
9362             print "The method MakeMultiRotation2D is DEPRECATED. Use MakeMultiRotation2DByStep instead."
9363             aVec = self.MakeLine(aPoint,aDir)
9364             # note: auto-publishing is done in self.MultiRotate2D()
9365             anObj = self.MultiRotate2D(aShape, aVec, anAngle, nbtimes1, aStep, nbtimes2, theName)
9366             return anObj
9367
9368         # end of l3_transform_d
9369         ## @}
9370
9371         ## @addtogroup l3_local
9372         ## @{
9373
9374         ## Perform a fillet on all edges of the given shape.
9375         #  @param theShape Shape, to perform fillet on.
9376         #  @param theR Fillet radius.
9377         #  @param theName Object name; when specified, this parameter is used
9378         #         for result publication in the study. Otherwise, if automatic
9379         #         publication is switched on, default value is used for result name.
9380         #
9381         #  @return New GEOM.GEOM_Object, containing the result shape.
9382         #
9383         #  @ref tui_fillet "Example 1"
9384         #  \n @ref swig_MakeFilletAll "Example 2"
9385         @ManageTransactions("LocalOp")
9386         def MakeFilletAll(self, theShape, theR, theName=None):
9387             """
9388             Perform a fillet on all edges of the given shape.
9389
9390             Parameters:
9391                 theShape Shape, to perform fillet on.
9392                 theR Fillet radius.
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 the result shape.
9399
9400             Example of usage:
9401                filletall = geompy.MakeFilletAll(prism, 10.)
9402             """
9403             # Example: see GEOM_TestOthers.py
9404             theR,Parameters = ParseParameters(theR)
9405             anObj = self.LocalOp.MakeFilletAll(theShape, theR)
9406             RaiseIfFailed("MakeFilletAll", self.LocalOp)
9407             anObj.SetParameters(Parameters)
9408             self._autoPublish(anObj, theName, "fillet")
9409             return anObj
9410
9411         ## Perform a fillet on the specified edges/faces of the given shape
9412         #  @param theShape Shape, to perform fillet on.
9413         #  @param theR Fillet radius.
9414         #  @param theShapeType Type of shapes in <VAR>theListShapes</VAR> (see ShapeType())
9415         #  @param theListShapes Global indices of edges/faces to perform fillet on.
9416         #  @param theName Object name; when specified, this parameter is used
9417         #         for result publication in the study. Otherwise, if automatic
9418         #         publication is switched on, default value is used for result name.
9419         #
9420         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9421         #
9422         #  @return New GEOM.GEOM_Object, containing the result shape.
9423         #
9424         #  @ref tui_fillet "Example"
9425         @ManageTransactions("LocalOp")
9426         def MakeFillet(self, theShape, theR, theShapeType, theListShapes, theName=None):
9427             """
9428             Perform a fillet on the specified edges/faces of the given shape
9429
9430             Parameters:
9431                 theShape Shape, to perform fillet on.
9432                 theR Fillet radius.
9433                 theShapeType Type of shapes in theListShapes (see geompy.ShapeTypes)
9434                 theListShapes Global indices of edges/faces to perform fillet on.
9435                 theName Object name; when specified, this parameter is used
9436                         for result publication in the study. Otherwise, if automatic
9437                         publication is switched on, default value is used for result name.
9438
9439             Note:
9440                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9441
9442             Returns:
9443                 New GEOM.GEOM_Object, containing the result shape.
9444
9445             Example of usage:
9446                 # get the list of IDs (IDList) for the fillet
9447                 prism_edges = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["EDGE"])
9448                 IDlist_e = []
9449                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[0]))
9450                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[1]))
9451                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[2]))
9452                 # make a fillet on the specified edges of the given shape
9453                 fillet = geompy.MakeFillet(prism, 10., geompy.ShapeType["EDGE"], IDlist_e)
9454             """
9455             # Example: see GEOM_TestAll.py
9456             theR,Parameters = ParseParameters(theR)
9457             anObj = None
9458             if theShapeType == self.ShapeType["EDGE"]:
9459                 anObj = self.LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
9460                 RaiseIfFailed("MakeFilletEdges", self.LocalOp)
9461             else:
9462                 anObj = self.LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
9463                 RaiseIfFailed("MakeFilletFaces", self.LocalOp)
9464             anObj.SetParameters(Parameters)
9465             self._autoPublish(anObj, theName, "fillet")
9466             return anObj
9467
9468         ## The same that MakeFillet() but with two Fillet Radius R1 and R2
9469         @ManageTransactions("LocalOp")
9470         def MakeFilletR1R2(self, theShape, theR1, theR2, theShapeType, theListShapes, theName=None):
9471             """
9472             The same that geompy.MakeFillet but with two Fillet Radius R1 and R2
9473
9474             Example of usage:
9475                 # get the list of IDs (IDList) for the fillet
9476                 prism_edges = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["EDGE"])
9477                 IDlist_e = []
9478                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[0]))
9479                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[1]))
9480                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[2]))
9481                 # make a fillet on the specified edges of the given shape
9482                 fillet = geompy.MakeFillet(prism, 10., 15., geompy.ShapeType["EDGE"], IDlist_e)
9483             """
9484             theR1,theR2,Parameters = ParseParameters(theR1,theR2)
9485             anObj = None
9486             if theShapeType == self.ShapeType["EDGE"]:
9487                 anObj = self.LocalOp.MakeFilletEdgesR1R2(theShape, theR1, theR2, theListShapes)
9488                 RaiseIfFailed("MakeFilletEdgesR1R2", self.LocalOp)
9489             else:
9490                 anObj = self.LocalOp.MakeFilletFacesR1R2(theShape, theR1, theR2, theListShapes)
9491                 RaiseIfFailed("MakeFilletFacesR1R2", self.LocalOp)
9492             anObj.SetParameters(Parameters)
9493             self._autoPublish(anObj, theName, "fillet")
9494             return anObj
9495
9496         ## Perform a fillet on the specified edges of the given shape
9497         #  @param theShape  Wire Shape to perform fillet on.
9498         #  @param theR  Fillet radius.
9499         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
9500         #    \note Global index of sub-shape can be obtained, using method GetSubShapeID()
9501         #    \note The list of vertices could be empty,
9502         #          in this case fillet will done done at all vertices in wire
9503         #  @param doIgnoreSecantVertices If FALSE, fillet radius is always limited
9504         #         by the length of the edges, nearest to the fillet vertex.
9505         #         But sometimes the next edge is C1 continuous with the one, nearest to
9506         #         the fillet point, and such two (or more) edges can be united to allow
9507         #         bigger radius. Set this flag to TRUE to allow collinear edges union,
9508         #         thus ignoring the secant vertex (vertices).
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 the result shape.
9514         #
9515         #  @ref tui_fillet2d "Example"
9516         @ManageTransactions("LocalOp")
9517         def MakeFillet1D(self, theShape, theR, theListOfVertexes, doIgnoreSecantVertices = True, theName=None):
9518             """
9519             Perform a fillet on the specified edges of the given shape
9520
9521             Parameters:
9522                 theShape  Wire Shape to perform fillet on.
9523                 theR  Fillet radius.
9524                 theListOfVertexes Global indices of vertexes to perform fillet on.
9525                 doIgnoreSecantVertices If FALSE, fillet radius is always limited
9526                     by the length of the edges, nearest to the fillet vertex.
9527                     But sometimes the next edge is C1 continuous with the one, nearest to
9528                     the fillet point, and such two (or more) edges can be united to allow
9529                     bigger radius. Set this flag to TRUE to allow collinear edges union,
9530                     thus ignoring the secant vertex (vertices).
9531                 theName Object name; when specified, this parameter is used
9532                         for result publication in the study. Otherwise, if automatic
9533                         publication is switched on, default value is used for result name.
9534             Note:
9535                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9536
9537                 The list of vertices could be empty,in this case fillet will done done at all vertices in wire
9538
9539             Returns:
9540                 New GEOM.GEOM_Object, containing the result shape.
9541
9542             Example of usage:
9543                 # create wire
9544                 Wire_1 = geompy.MakeWire([Edge_12, Edge_7, Edge_11, Edge_6, Edge_1,Edge_4])
9545                 # make fillet at given wire vertices with giver radius
9546                 Fillet_1D_1 = geompy.MakeFillet1D(Wire_1, 55, [3, 4, 6, 8, 10])
9547             """
9548             # Example: see GEOM_TestAll.py
9549             theR,doIgnoreSecantVertices,Parameters = ParseParameters(theR,doIgnoreSecantVertices)
9550             anObj = self.LocalOp.MakeFillet1D(theShape, theR, theListOfVertexes, doIgnoreSecantVertices)
9551             RaiseIfFailed("MakeFillet1D", self.LocalOp)
9552             anObj.SetParameters(Parameters)
9553             self._autoPublish(anObj, theName, "fillet")
9554             return anObj
9555
9556         ## Perform a fillet at the specified vertices of the given face/shell.
9557         #  @param theShape Face or Shell shape to perform fillet on.
9558         #  @param theR Fillet radius.
9559         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
9560         #  @param theName Object name; when specified, this parameter is used
9561         #         for result publication in the study. Otherwise, if automatic
9562         #         publication is switched on, default value is used for result name.
9563         #
9564         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9565         #
9566         #  @return New GEOM.GEOM_Object, containing the result shape.
9567         #
9568         #  @ref tui_fillet2d "Example"
9569         @ManageTransactions("LocalOp")
9570         def MakeFillet2D(self, theShape, theR, theListOfVertexes, theName=None):
9571             """
9572             Perform a fillet at the specified vertices of the given face/shell.
9573
9574             Parameters:
9575                 theShape  Face or Shell shape to perform fillet on.
9576                 theR  Fillet radius.
9577                 theListOfVertexes Global indices of vertexes to perform fillet on.
9578                 theName Object name; when specified, this parameter is used
9579                         for result publication in the study. Otherwise, if automatic
9580                         publication is switched on, default value is used for result name.
9581             Note:
9582                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9583
9584             Returns:
9585                 New GEOM.GEOM_Object, containing the result shape.
9586
9587             Example of usage:
9588                 face = geompy.MakeFaceHW(100, 100, 1)
9589                 fillet2d = geompy.MakeFillet2D(face, 30, [7, 9])
9590             """
9591             # Example: see GEOM_TestAll.py
9592             theR,Parameters = ParseParameters(theR)
9593             anObj = self.LocalOp.MakeFillet2D(theShape, theR, theListOfVertexes)
9594             RaiseIfFailed("MakeFillet2D", self.LocalOp)
9595             anObj.SetParameters(Parameters)
9596             self._autoPublish(anObj, theName, "fillet")
9597             return anObj
9598
9599         ## Perform a symmetric chamfer on all edges of the given shape.
9600         #  @param theShape Shape, to perform chamfer on.
9601         #  @param theD Chamfer size along each face.
9602         #  @param theName Object name; when specified, this parameter is used
9603         #         for result publication in the study. Otherwise, if automatic
9604         #         publication is switched on, default value is used for result name.
9605         #
9606         #  @return New GEOM.GEOM_Object, containing the result shape.
9607         #
9608         #  @ref tui_chamfer "Example 1"
9609         #  \n @ref swig_MakeChamferAll "Example 2"
9610         @ManageTransactions("LocalOp")
9611         def MakeChamferAll(self, theShape, theD, theName=None):
9612             """
9613             Perform a symmetric chamfer on all edges of the given shape.
9614
9615             Parameters:
9616                 theShape Shape, to perform chamfer on.
9617                 theD Chamfer size along each face.
9618                 theName Object name; when specified, this parameter is used
9619                         for result publication in the study. Otherwise, if automatic
9620                         publication is switched on, default value is used for result name.
9621
9622             Returns:
9623                 New GEOM.GEOM_Object, containing the result shape.
9624
9625             Example of usage:
9626                 chamfer_all = geompy.MakeChamferAll(prism, 10.)
9627             """
9628             # Example: see GEOM_TestOthers.py
9629             theD,Parameters = ParseParameters(theD)
9630             anObj = self.LocalOp.MakeChamferAll(theShape, theD)
9631             RaiseIfFailed("MakeChamferAll", self.LocalOp)
9632             anObj.SetParameters(Parameters)
9633             self._autoPublish(anObj, theName, "chamfer")
9634             return anObj
9635
9636         ## Perform a chamfer on edges, common to the specified faces,
9637         #  with distance D1 on the Face1
9638         #  @param theShape Shape, to perform chamfer on.
9639         #  @param theD1 Chamfer size along \a theFace1.
9640         #  @param theD2 Chamfer size along \a theFace2.
9641         #  @param theFace1,theFace2 Global indices of two faces of \a theShape.
9642         #  @param theName Object name; when specified, this parameter is used
9643         #         for result publication in the study. Otherwise, if automatic
9644         #         publication is switched on, default value is used for result name.
9645         #
9646         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9647         #
9648         #  @return New GEOM.GEOM_Object, containing the result shape.
9649         #
9650         #  @ref tui_chamfer "Example"
9651         @ManageTransactions("LocalOp")
9652         def MakeChamferEdge(self, theShape, theD1, theD2, theFace1, theFace2, theName=None):
9653             """
9654             Perform a chamfer on edges, common to the specified faces,
9655             with distance D1 on the Face1
9656
9657             Parameters:
9658                 theShape Shape, to perform chamfer on.
9659                 theD1 Chamfer size along theFace1.
9660                 theD2 Chamfer size along theFace2.
9661                 theFace1,theFace2 Global indices of two faces of theShape.
9662                 theName Object name; when specified, this parameter is used
9663                         for result publication in the study. Otherwise, if automatic
9664                         publication is switched on, default value is used for result name.
9665
9666             Note:
9667                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9668
9669             Returns:
9670                 New GEOM.GEOM_Object, containing the result shape.
9671
9672             Example of usage:
9673                 prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
9674                 f_ind_1 = geompy.GetSubShapeID(prism, prism_faces[0])
9675                 f_ind_2 = geompy.GetSubShapeID(prism, prism_faces[1])
9676                 chamfer_e = geompy.MakeChamferEdge(prism, 10., 10., f_ind_1, f_ind_2)
9677             """
9678             # Example: see GEOM_TestAll.py
9679             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
9680             anObj = self.LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
9681             RaiseIfFailed("MakeChamferEdge", self.LocalOp)
9682             anObj.SetParameters(Parameters)
9683             self._autoPublish(anObj, theName, "chamfer")
9684             return anObj
9685
9686         ## Perform a chamfer on edges
9687         #  @param theShape Shape, to perform chamfer on.
9688         #  @param theD Chamfer length
9689         #  @param theAngle Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9690         #  @param theFace1,theFace2 Global indices of two faces of \a theShape.
9691         #  @param theName Object name; when specified, this parameter is used
9692         #         for result publication in the study. Otherwise, if automatic
9693         #         publication is switched on, default value is used for result name.
9694         #
9695         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9696         #
9697         #  @return New GEOM.GEOM_Object, containing the result shape.
9698         @ManageTransactions("LocalOp")
9699         def MakeChamferEdgeAD(self, theShape, theD, theAngle, theFace1, theFace2, theName=None):
9700             """
9701             Perform a chamfer on edges
9702
9703             Parameters:
9704                 theShape Shape, to perform chamfer on.
9705                 theD1 Chamfer size along theFace1.
9706                 theAngle Angle of chamfer (angle in radians or a name of variable which defines angle in degrees).
9707                 theFace1,theFace2 Global indices of two faces of theShape.
9708                 theName Object name; when specified, this parameter is used
9709                         for result publication in the study. Otherwise, if automatic
9710                         publication is switched on, default value is used for result name.
9711
9712             Note:
9713                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9714
9715             Returns:
9716                 New GEOM.GEOM_Object, containing the result shape.
9717
9718             Example of usage:
9719                 prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
9720                 f_ind_1 = geompy.GetSubShapeID(prism, prism_faces[0])
9721                 f_ind_2 = geompy.GetSubShapeID(prism, prism_faces[1])
9722                 ang = 30
9723                 chamfer_e = geompy.MakeChamferEdge(prism, 10., ang, f_ind_1, f_ind_2)
9724             """
9725             flag = False
9726             if isinstance(theAngle,str):
9727                 flag = True
9728             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
9729             if flag:
9730                 theAngle = theAngle*math.pi/180.0
9731             anObj = self.LocalOp.MakeChamferEdgeAD(theShape, theD, theAngle, theFace1, theFace2)
9732             RaiseIfFailed("MakeChamferEdgeAD", self.LocalOp)
9733             anObj.SetParameters(Parameters)
9734             self._autoPublish(anObj, theName, "chamfer")
9735             return anObj
9736
9737         ## Perform a chamfer on all edges of the specified faces,
9738         #  with distance D1 on the first specified face (if several for one edge)
9739         #  @param theShape Shape, to perform chamfer on.
9740         #  @param theD1 Chamfer size along face from \a theFaces. If both faces,
9741         #               connected to the edge, are in \a theFaces, \a theD1
9742         #               will be get along face, which is nearer to \a theFaces beginning.
9743         #  @param theD2 Chamfer size along another of two faces, connected to the edge.
9744         #  @param theFaces Sequence of global indices of faces of \a theShape.
9745         #  @param theName Object name; when specified, this parameter is used
9746         #         for result publication in the study. Otherwise, if automatic
9747         #         publication is switched on, default value is used for result name.
9748         #
9749         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9750         #
9751         #  @return New GEOM.GEOM_Object, containing the result shape.
9752         #
9753         #  @ref tui_chamfer "Example"
9754         @ManageTransactions("LocalOp")
9755         def MakeChamferFaces(self, theShape, theD1, theD2, theFaces, theName=None):
9756             """
9757             Perform a chamfer on all edges of the specified faces,
9758             with distance D1 on the first specified face (if several for one edge)
9759
9760             Parameters:
9761                 theShape Shape, to perform chamfer on.
9762                 theD1 Chamfer size along face from  theFaces. If both faces,
9763                       connected to the edge, are in theFaces, theD1
9764                       will be get along face, which is nearer to theFaces beginning.
9765                 theD2 Chamfer size along another of two faces, connected to the edge.
9766                 theFaces Sequence of global indices of faces of theShape.
9767                 theName Object name; when specified, this parameter is used
9768                         for result publication in the study. Otherwise, if automatic
9769                         publication is switched on, default value is used for result name.
9770
9771             Note: Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
9772
9773             Returns:
9774                 New GEOM.GEOM_Object, containing the result shape.
9775             """
9776             # Example: see GEOM_TestAll.py
9777             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
9778             anObj = self.LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
9779             RaiseIfFailed("MakeChamferFaces", self.LocalOp)
9780             anObj.SetParameters(Parameters)
9781             self._autoPublish(anObj, theName, "chamfer")
9782             return anObj
9783
9784         ## The Same that MakeChamferFaces() but with params theD is chamfer lenght and
9785         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9786         #
9787         #  @ref swig_FilletChamfer "Example"
9788         @ManageTransactions("LocalOp")
9789         def MakeChamferFacesAD(self, theShape, theD, theAngle, theFaces, theName=None):
9790             """
9791             The Same that geompy.MakeChamferFaces but with params theD is chamfer lenght and
9792             theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9793             """
9794             flag = False
9795             if isinstance(theAngle,str):
9796                 flag = True
9797             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
9798             if flag:
9799                 theAngle = theAngle*math.pi/180.0
9800             anObj = self.LocalOp.MakeChamferFacesAD(theShape, theD, theAngle, theFaces)
9801             RaiseIfFailed("MakeChamferFacesAD", self.LocalOp)
9802             anObj.SetParameters(Parameters)
9803             self._autoPublish(anObj, theName, "chamfer")
9804             return anObj
9805
9806         ## Perform a chamfer on edges,
9807         #  with distance D1 on the first specified face (if several for one edge)
9808         #  @param theShape Shape, to perform chamfer on.
9809         #  @param theD1,theD2 Chamfer size
9810         #  @param theEdges Sequence of edges of \a theShape.
9811         #  @param theName Object name; when specified, this parameter is used
9812         #         for result publication in the study. Otherwise, if automatic
9813         #         publication is switched on, default value is used for result name.
9814         #
9815         #  @return New GEOM.GEOM_Object, containing the result shape.
9816         #
9817         #  @ref swig_FilletChamfer "Example"
9818         @ManageTransactions("LocalOp")
9819         def MakeChamferEdges(self, theShape, theD1, theD2, theEdges, theName=None):
9820             """
9821             Perform a chamfer on edges,
9822             with distance D1 on the first specified face (if several for one edge)
9823
9824             Parameters:
9825                 theShape Shape, to perform chamfer on.
9826                 theD1,theD2 Chamfer size
9827                 theEdges Sequence of edges of theShape.
9828                 theName Object name; when specified, this parameter is used
9829                         for result publication in the study. Otherwise, if automatic
9830                         publication is switched on, default value is used for result name.
9831
9832             Returns:
9833                 New GEOM.GEOM_Object, containing the result shape.
9834             """
9835             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
9836             anObj = self.LocalOp.MakeChamferEdges(theShape, theD1, theD2, theEdges)
9837             RaiseIfFailed("MakeChamferEdges", self.LocalOp)
9838             anObj.SetParameters(Parameters)
9839             self._autoPublish(anObj, theName, "chamfer")
9840             return anObj
9841
9842         ## The Same that MakeChamferEdges() but with params theD is chamfer lenght and
9843         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9844         @ManageTransactions("LocalOp")
9845         def MakeChamferEdgesAD(self, theShape, theD, theAngle, theEdges, theName=None):
9846             """
9847             The Same that geompy.MakeChamferEdges but with params theD is chamfer lenght and
9848             theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9849             """
9850             flag = False
9851             if isinstance(theAngle,str):
9852                 flag = True
9853             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
9854             if flag:
9855                 theAngle = theAngle*math.pi/180.0
9856             anObj = self.LocalOp.MakeChamferEdgesAD(theShape, theD, theAngle, theEdges)
9857             RaiseIfFailed("MakeChamferEdgesAD", self.LocalOp)
9858             anObj.SetParameters(Parameters)
9859             self._autoPublish(anObj, theName, "chamfer")
9860             return anObj
9861
9862         ## @sa MakeChamferEdge(), MakeChamferFaces()
9863         #
9864         #  @ref swig_MakeChamfer "Example"
9865         def MakeChamfer(self, aShape, d1, d2, aShapeType, ListShape, theName=None):
9866             """
9867             See geompy.MakeChamferEdge() and geompy.MakeChamferFaces() functions for more information.
9868             """
9869             # Example: see GEOM_TestOthers.py
9870             anObj = None
9871             # note: auto-publishing is done in self.MakeChamferEdge() or self.MakeChamferFaces()
9872             if aShapeType == self.ShapeType["EDGE"]:
9873                 anObj = self.MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1],theName)
9874             else:
9875                 anObj = self.MakeChamferFaces(aShape,d1,d2,ListShape,theName)
9876             return anObj
9877
9878         ## Remove material from a solid by extrusion of the base shape on the given distance.
9879         #  @param theInit Shape to remove material from. It must be a solid or
9880         #  a compound made of a single solid.
9881         #  @param theBase Closed edge or wire defining the base shape to be extruded.
9882         #  @param theH Prism dimension along the normal to theBase
9883         #  @param theAngle Draft angle in degrees.
9884         #  @param theName Object name; when specified, this parameter is used
9885         #         for result publication in the study. Otherwise, if automatic
9886         #         publication is switched on, default value is used for result name.
9887         #
9888         #  @return New GEOM.GEOM_Object, containing the initial shape with removed material
9889         #
9890         #  @ref tui_creation_prism "Example"
9891         @ManageTransactions("PrimOp")
9892         def MakeExtrudedCut(self, theInit, theBase, theH, theAngle, theName=None):
9893             """
9894             Add material to a solid by extrusion of the base shape on the given distance.
9895
9896             Parameters:
9897                 theInit Shape to remove material from. It must be a solid or a compound made of a single solid.
9898                 theBase Closed edge or wire defining the base shape to be extruded.
9899                 theH Prism dimension along the normal  to theBase
9900                 theAngle Draft angle in degrees.
9901                 theName Object name; when specified, this parameter is used
9902                         for result publication in the study. Otherwise, if automatic
9903                         publication is switched on, default value is used for result name.
9904
9905             Returns:
9906                 New GEOM.GEOM_Object,  containing the initial shape with removed material.
9907             """
9908             # Example: see GEOM_TestAll.py
9909             #theH,Parameters = ParseParameters(theH)
9910             anObj = self.PrimOp.MakeDraftPrism(theInit, theBase, theH, theAngle, False)
9911             RaiseIfFailed("MakeExtrudedBoss", self.PrimOp)
9912             #anObj.SetParameters(Parameters)
9913             self._autoPublish(anObj, theName, "extrudedCut")
9914             return anObj
9915
9916         ## Add material to a solid by extrusion of the base shape on the given distance.
9917         #  @param theInit Shape to add material to. It must be a solid or
9918         #  a compound made of a single solid.
9919         #  @param theBase Closed edge or wire defining the base shape to be extruded.
9920         #  @param theH Prism dimension along the normal to theBase
9921         #  @param theAngle Draft angle in degrees.
9922         #  @param theName Object name; when specified, this parameter is used
9923         #         for result publication in the study. Otherwise, if automatic
9924         #         publication is switched on, default value is used for result name.
9925         #
9926         #  @return New GEOM.GEOM_Object, containing the initial shape with added material
9927         #
9928         #  @ref tui_creation_prism "Example"
9929         @ManageTransactions("PrimOp")
9930         def MakeExtrudedBoss(self, theInit, theBase, theH, theAngle, theName=None):
9931             """
9932             Add material to a solid by extrusion of the base shape on the given distance.
9933
9934             Parameters:
9935                 theInit Shape to add material to. It must be a solid or a compound made of a single solid.
9936                 theBase Closed edge or wire defining the base shape to be extruded.
9937                 theH Prism dimension along the normal  to theBase
9938                 theAngle Draft angle in degrees.
9939                 theName Object name; when specified, this parameter is used
9940                         for result publication in the study. Otherwise, if automatic
9941                         publication is switched on, default value is used for result name.
9942
9943             Returns:
9944                 New GEOM.GEOM_Object,  containing the initial shape with added material.
9945             """
9946             # Example: see GEOM_TestAll.py
9947             #theH,Parameters = ParseParameters(theH)
9948             anObj = self.PrimOp.MakeDraftPrism(theInit, theBase, theH, theAngle, True)
9949             RaiseIfFailed("MakeExtrudedBoss", self.PrimOp)
9950             #anObj.SetParameters(Parameters)
9951             self._autoPublish(anObj, theName, "extrudedBoss")
9952             return anObj
9953
9954         # end of l3_local
9955         ## @}
9956
9957         ## @addtogroup l3_basic_op
9958         ## @{
9959
9960         ## Perform an Archimde operation on the given shape with given parameters.
9961         #  The object presenting the resulting face is returned.
9962         #  @param theShape Shape to be put in water.
9963         #  @param theWeight Weight of the shape.
9964         #  @param theWaterDensity Density of the water.
9965         #  @param theMeshDeflection Deflection of the mesh, using to compute the section.
9966         #  @param theName Object name; when specified, this parameter is used
9967         #         for result publication in the study. Otherwise, if automatic
9968         #         publication is switched on, default value is used for result name.
9969         #
9970         #  @return New GEOM.GEOM_Object, containing a section of \a theShape
9971         #          by a plane, corresponding to water level.
9972         #
9973         #  @ref tui_archimede "Example"
9974         @ManageTransactions("LocalOp")
9975         def Archimede(self, theShape, theWeight, theWaterDensity, theMeshDeflection, theName=None):
9976             """
9977             Perform an Archimde operation on the given shape with given parameters.
9978             The object presenting the resulting face is returned.
9979
9980             Parameters:
9981                 theShape Shape to be put in water.
9982                 theWeight Weight of the shape.
9983                 theWaterDensity Density of the water.
9984                 theMeshDeflection Deflection of the mesh, using to compute the section.
9985                 theName Object name; when specified, this parameter is used
9986                         for result publication in the study. Otherwise, if automatic
9987                         publication is switched on, default value is used for result name.
9988
9989             Returns:
9990                 New GEOM.GEOM_Object, containing a section of theShape
9991                 by a plane, corresponding to water level.
9992             """
9993             # Example: see GEOM_TestAll.py
9994             theWeight,theWaterDensity,theMeshDeflection,Parameters = ParseParameters(
9995               theWeight,theWaterDensity,theMeshDeflection)
9996             anObj = self.LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
9997             RaiseIfFailed("MakeArchimede", self.LocalOp)
9998             anObj.SetParameters(Parameters)
9999             self._autoPublish(anObj, theName, "archimede")
10000             return anObj
10001
10002         # end of l3_basic_op
10003         ## @}
10004
10005         ## @addtogroup l2_measure
10006         ## @{
10007
10008         ## Get point coordinates
10009         #  @return [x, y, z]
10010         #
10011         #  @ref tui_point_coordinates_page "Example"
10012         @ManageTransactions("MeasuOp")
10013         def PointCoordinates(self,Point):
10014             """
10015             Get point coordinates
10016
10017             Returns:
10018                 [x, y, z]
10019             """
10020             # Example: see GEOM_TestMeasures.py
10021             aTuple = self.MeasuOp.PointCoordinates(Point)
10022             RaiseIfFailed("PointCoordinates", self.MeasuOp)
10023             return aTuple
10024
10025         ## Get vector coordinates
10026         #  @return [x, y, z]
10027         #
10028         #  @ref tui_measurement_tools_page "Example"
10029         def VectorCoordinates(self,Vector):
10030             """
10031             Get vector coordinates
10032
10033             Returns:
10034                 [x, y, z]
10035             """
10036
10037             p1=self.GetFirstVertex(Vector)
10038             p2=self.GetLastVertex(Vector)
10039
10040             X1=self.PointCoordinates(p1)
10041             X2=self.PointCoordinates(p2)
10042
10043             return (X2[0]-X1[0],X2[1]-X1[1],X2[2]-X1[2])
10044
10045
10046         ## Compute cross product
10047         #  @return vector w=u^v
10048         #
10049         #  @ref tui_measurement_tools_page "Example"
10050         def CrossProduct(self, Vector1, Vector2):
10051             """
10052             Compute cross product
10053
10054             Returns: vector w=u^v
10055             """
10056             u=self.VectorCoordinates(Vector1)
10057             v=self.VectorCoordinates(Vector2)
10058             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])
10059
10060             return w
10061
10062         ## Compute cross product
10063         #  @return dot product  p=u.v
10064         #
10065         #  @ref tui_measurement_tools_page "Example"
10066         def DotProduct(self, Vector1, Vector2):
10067             """
10068             Compute cross product
10069
10070             Returns: dot product  p=u.v
10071             """
10072             u=self.VectorCoordinates(Vector1)
10073             v=self.VectorCoordinates(Vector2)
10074             p=u[0]*v[0]+u[1]*v[1]+u[2]*v[2]
10075
10076             return p
10077
10078
10079         ## Get summarized length of all wires,
10080         #  area of surface and volume of the given shape.
10081         #  @param theShape Shape to define properties of.
10082         #  @return [theLength, theSurfArea, theVolume]\n
10083         #  theLength:   Summarized length of all wires of the given shape.\n
10084         #  theSurfArea: Area of surface of the given shape.\n
10085         #  theVolume:   Volume of the given shape.
10086         #
10087         #  @ref tui_basic_properties_page "Example"
10088         @ManageTransactions("MeasuOp")
10089         def BasicProperties(self,theShape):
10090             """
10091             Get summarized length of all wires,
10092             area of surface and volume of the given shape.
10093
10094             Parameters:
10095                 theShape Shape to define properties of.
10096
10097             Returns:
10098                 [theLength, theSurfArea, theVolume]
10099                  theLength:   Summarized length of all wires of the given shape.
10100                  theSurfArea: Area of surface of the given shape.
10101                  theVolume:   Volume of the given shape.
10102             """
10103             # Example: see GEOM_TestMeasures.py
10104             aTuple = self.MeasuOp.GetBasicProperties(theShape)
10105             RaiseIfFailed("GetBasicProperties", self.MeasuOp)
10106             return aTuple
10107
10108         ## Get parameters of bounding box of the given shape
10109         #  @param theShape Shape to obtain bounding box of.
10110         #  @param precise TRUE for precise computation; FALSE for fast one.
10111         #  @return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
10112         #  Xmin,Xmax: Limits of shape along OX axis.
10113         #  Ymin,Ymax: Limits of shape along OY axis.
10114         #  Zmin,Zmax: Limits of shape along OZ axis.
10115         #
10116         #  @ref tui_bounding_box_page "Example"
10117         @ManageTransactions("MeasuOp")
10118         def BoundingBox (self, theShape, precise=False):
10119             """
10120             Get parameters of bounding box of the given shape
10121
10122             Parameters:
10123                 theShape Shape to obtain bounding box of.
10124                 precise TRUE for precise computation; FALSE for fast one.
10125
10126             Returns:
10127                 [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
10128                  Xmin,Xmax: Limits of shape along OX axis.
10129                  Ymin,Ymax: Limits of shape along OY axis.
10130                  Zmin,Zmax: Limits of shape along OZ axis.
10131             """
10132             # Example: see GEOM_TestMeasures.py
10133             aTuple = self.MeasuOp.GetBoundingBox(theShape, precise)
10134             RaiseIfFailed("GetBoundingBox", self.MeasuOp)
10135             return aTuple
10136
10137         ## Get bounding box of the given shape
10138         #  @param theShape Shape to obtain bounding box of.
10139         #  @param precise TRUE for precise computation; FALSE for fast one.
10140         #  @param theName Object name; when specified, this parameter is used
10141         #         for result publication in the study. Otherwise, if automatic
10142         #         publication is switched on, default value is used for result name.
10143         #
10144         #  @return New GEOM.GEOM_Object, containing the created box.
10145         #
10146         #  @ref tui_bounding_box_page "Example"
10147         @ManageTransactions("MeasuOp")
10148         def MakeBoundingBox (self, theShape, precise=False, theName=None):
10149             """
10150             Get bounding box of the given shape
10151
10152             Parameters:
10153                 theShape Shape to obtain bounding box of.
10154                 precise TRUE for precise computation; FALSE for fast one.
10155                 theName Object name; when specified, this parameter is used
10156                         for result publication in the study. Otherwise, if automatic
10157                         publication is switched on, default value is used for result name.
10158
10159             Returns:
10160                 New GEOM.GEOM_Object, containing the created box.
10161             """
10162             # Example: see GEOM_TestMeasures.py
10163             anObj = self.MeasuOp.MakeBoundingBox(theShape, precise)
10164             RaiseIfFailed("MakeBoundingBox", self.MeasuOp)
10165             self._autoPublish(anObj, theName, "bndbox")
10166             return anObj
10167
10168         ## Get inertia matrix and moments of inertia of theShape.
10169         #  @param theShape Shape to calculate inertia of.
10170         #  @return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
10171         #  I(1-3)(1-3): Components of the inertia matrix of the given shape.
10172         #  Ix,Iy,Iz:    Moments of inertia of the given shape.
10173         #
10174         #  @ref tui_inertia_page "Example"
10175         @ManageTransactions("MeasuOp")
10176         def Inertia(self,theShape):
10177             """
10178             Get inertia matrix and moments of inertia of theShape.
10179
10180             Parameters:
10181                 theShape Shape to calculate inertia of.
10182
10183             Returns:
10184                 [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
10185                  I(1-3)(1-3): Components of the inertia matrix of the given shape.
10186                  Ix,Iy,Iz:    Moments of inertia of the given shape.
10187             """
10188             # Example: see GEOM_TestMeasures.py
10189             aTuple = self.MeasuOp.GetInertia(theShape)
10190             RaiseIfFailed("GetInertia", self.MeasuOp)
10191             return aTuple
10192
10193         ## Get if coords are included in the shape (ST_IN or ST_ON)
10194         #  @param theShape Shape
10195         #  @param coords list of points coordinates [x1, y1, z1, x2, y2, z2, ...]
10196         #  @param tolerance to be used (default is 1.0e-7)
10197         #  @return list_of_boolean = [res1, res2, ...]
10198         @ManageTransactions("MeasuOp")
10199         def AreCoordsInside(self, theShape, coords, tolerance=1.e-7):
10200             """
10201             Get if coords are included in the shape (ST_IN or ST_ON)
10202
10203             Parameters:
10204                 theShape Shape
10205                 coords list of points coordinates [x1, y1, z1, x2, y2, z2, ...]
10206                 tolerance to be used (default is 1.0e-7)
10207
10208             Returns:
10209                 list_of_boolean = [res1, res2, ...]
10210             """
10211             return self.MeasuOp.AreCoordsInside(theShape, coords, tolerance)
10212
10213         ## Get minimal distance between the given shapes.
10214         #  @param theShape1,theShape2 Shapes to find minimal distance between.
10215         #  @return Value of the minimal distance between the given shapes.
10216         #
10217         #  @ref tui_min_distance_page "Example"
10218         @ManageTransactions("MeasuOp")
10219         def MinDistance(self, theShape1, theShape2):
10220             """
10221             Get minimal distance between the given shapes.
10222
10223             Parameters:
10224                 theShape1,theShape2 Shapes to find minimal distance between.
10225
10226             Returns:
10227                 Value of the minimal distance between the given shapes.
10228             """
10229             # Example: see GEOM_TestMeasures.py
10230             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
10231             RaiseIfFailed("GetMinDistance", self.MeasuOp)
10232             return aTuple[0]
10233
10234         ## Get minimal distance between the given shapes.
10235         #  @param theShape1,theShape2 Shapes to find minimal distance between.
10236         #  @return Value of the minimal distance between the given shapes, in form of list
10237         #          [Distance, DX, DY, DZ].
10238         #
10239         #  @ref tui_min_distance_page "Example"
10240         @ManageTransactions("MeasuOp")
10241         def MinDistanceComponents(self, theShape1, theShape2):
10242             """
10243             Get minimal distance between the given shapes.
10244
10245             Parameters:
10246                 theShape1,theShape2 Shapes to find minimal distance between.
10247
10248             Returns:
10249                 Value of the minimal distance between the given shapes, in form of list
10250                 [Distance, DX, DY, DZ]
10251             """
10252             # Example: see GEOM_TestMeasures.py
10253             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
10254             RaiseIfFailed("GetMinDistance", self.MeasuOp)
10255             aRes = [aTuple[0], aTuple[4] - aTuple[1], aTuple[5] - aTuple[2], aTuple[6] - aTuple[3]]
10256             return aRes
10257
10258         ## Get closest points of the given shapes.
10259         #  @param theShape1,theShape2 Shapes to find closest points of.
10260         #  @return The number of found solutions (-1 in case of infinite number of
10261         #          solutions) and a list of (X, Y, Z) coordinates for all couples of points.
10262         #
10263         #  @ref tui_min_distance_page "Example"
10264         @ManageTransactions("MeasuOp")
10265         def ClosestPoints (self, theShape1, theShape2):
10266             """
10267             Get closest points of the given shapes.
10268
10269             Parameters:
10270                 theShape1,theShape2 Shapes to find closest points of.
10271
10272             Returns:
10273                 The number of found solutions (-1 in case of infinite number of
10274                 solutions) and a list of (X, Y, Z) coordinates for all couples of points.
10275             """
10276             # Example: see GEOM_TestMeasures.py
10277             aTuple = self.MeasuOp.ClosestPoints(theShape1, theShape2)
10278             RaiseIfFailed("ClosestPoints", self.MeasuOp)
10279             return aTuple
10280
10281         ## Get angle between the given shapes in degrees.
10282         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
10283         #  @note If both arguments are vectors, the angle is computed in accordance
10284         #        with their orientations, otherwise the minimum angle is computed.
10285         #  @return Value of the angle between the given shapes in degrees.
10286         #
10287         #  @ref tui_angle_page "Example"
10288         @ManageTransactions("MeasuOp")
10289         def GetAngle(self, theShape1, theShape2):
10290             """
10291             Get angle between the given shapes in degrees.
10292
10293             Parameters:
10294                 theShape1,theShape2 Lines or linear edges to find angle between.
10295
10296             Note:
10297                 If both arguments are vectors, the angle is computed in accordance
10298                 with their orientations, otherwise the minimum angle is computed.
10299
10300             Returns:
10301                 Value of the angle between the given shapes in degrees.
10302             """
10303             # Example: see GEOM_TestMeasures.py
10304             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)
10305             RaiseIfFailed("GetAngle", self.MeasuOp)
10306             return anAngle
10307
10308         ## Get angle between the given shapes in radians.
10309         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
10310         #  @note If both arguments are vectors, the angle is computed in accordance
10311         #        with their orientations, otherwise the minimum angle is computed.
10312         #  @return Value of the angle between the given shapes in radians.
10313         #
10314         #  @ref tui_angle_page "Example"
10315         @ManageTransactions("MeasuOp")
10316         def GetAngleRadians(self, theShape1, theShape2):
10317             """
10318             Get angle between the given shapes in radians.
10319
10320             Parameters:
10321                 theShape1,theShape2 Lines or linear edges to find angle between.
10322
10323
10324             Note:
10325                 If both arguments are vectors, the angle is computed in accordance
10326                 with their orientations, otherwise the minimum angle is computed.
10327
10328             Returns:
10329                 Value of the angle between the given shapes in radians.
10330             """
10331             # Example: see GEOM_TestMeasures.py
10332             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)*math.pi/180.
10333             RaiseIfFailed("GetAngle", self.MeasuOp)
10334             return anAngle
10335
10336         ## Get angle between the given vectors in degrees.
10337         #  @param theShape1,theShape2 Vectors to find angle between.
10338         #  @param theFlag If True, the normal vector is defined by the two vectors cross,
10339         #                 if False, the opposite vector to the normal vector is used.
10340         #  @return Value of the angle between the given vectors in degrees.
10341         #
10342         #  @ref tui_angle_page "Example"
10343         @ManageTransactions("MeasuOp")
10344         def GetAngleVectors(self, theShape1, theShape2, theFlag = True):
10345             """
10346             Get angle between the given vectors in degrees.
10347
10348             Parameters:
10349                 theShape1,theShape2 Vectors to find angle between.
10350                 theFlag If True, the normal vector is defined by the two vectors cross,
10351                         if False, the opposite vector to the normal vector is used.
10352
10353             Returns:
10354                 Value of the angle between the given vectors in degrees.
10355             """
10356             anAngle = self.MeasuOp.GetAngleBtwVectors(theShape1, theShape2)
10357             if not theFlag:
10358                 anAngle = 360. - anAngle
10359             RaiseIfFailed("GetAngleVectors", self.MeasuOp)
10360             return anAngle
10361
10362         ## The same as GetAngleVectors, but the result is in radians.
10363         def GetAngleRadiansVectors(self, theShape1, theShape2, theFlag = True):
10364             """
10365             Get angle between the given vectors in radians.
10366
10367             Parameters:
10368                 theShape1,theShape2 Vectors to find angle between.
10369                 theFlag If True, the normal vector is defined by the two vectors cross,
10370                         if False, the opposite vector to the normal vector is used.
10371
10372             Returns:
10373                 Value of the angle between the given vectors in radians.
10374             """
10375             anAngle = self.GetAngleVectors(theShape1, theShape2, theFlag)*math.pi/180.
10376             return anAngle
10377
10378         ## @name Curve Curvature Measurement
10379         #  Methods for receiving radius of curvature of curves
10380         #  in the given point
10381         ## @{
10382
10383         ## Measure curvature of a curve at a point, set by parameter.
10384         #  @param theCurve a curve.
10385         #  @param theParam parameter.
10386         #  @return radius of curvature of \a theCurve.
10387         #
10388         #  @ref swig_todo "Example"
10389         @ManageTransactions("MeasuOp")
10390         def CurveCurvatureByParam(self, theCurve, theParam):
10391             """
10392             Measure curvature of a curve at a point, set by parameter.
10393
10394             Parameters:
10395                 theCurve a curve.
10396                 theParam parameter.
10397
10398             Returns:
10399                 radius of curvature of theCurve.
10400             """
10401             # Example: see GEOM_TestMeasures.py
10402             aCurv = self.MeasuOp.CurveCurvatureByParam(theCurve,theParam)
10403             RaiseIfFailed("CurveCurvatureByParam", self.MeasuOp)
10404             return aCurv
10405
10406         ## Measure curvature of a curve at a point.
10407         #  @param theCurve a curve.
10408         #  @param thePoint given point.
10409         #  @return radius of curvature of \a theCurve.
10410         #
10411         #  @ref swig_todo "Example"
10412         @ManageTransactions("MeasuOp")
10413         def CurveCurvatureByPoint(self, theCurve, thePoint):
10414             """
10415             Measure curvature of a curve at a point.
10416
10417             Parameters:
10418                 theCurve a curve.
10419                 thePoint given point.
10420
10421             Returns:
10422                 radius of curvature of theCurve.
10423             """
10424             aCurv = self.MeasuOp.CurveCurvatureByPoint(theCurve,thePoint)
10425             RaiseIfFailed("CurveCurvatureByPoint", self.MeasuOp)
10426             return aCurv
10427         ## @}
10428
10429         ## @name Surface Curvature Measurement
10430         #  Methods for receiving max and min radius of curvature of surfaces
10431         #  in the given point
10432         ## @{
10433
10434         ## Measure max radius of curvature of surface.
10435         #  @param theSurf the given surface.
10436         #  @param theUParam Value of U-parameter on the referenced surface.
10437         #  @param theVParam Value of V-parameter on the referenced surface.
10438         #  @return max radius of curvature of theSurf.
10439         #
10440         ## @ref swig_todo "Example"
10441         @ManageTransactions("MeasuOp")
10442         def MaxSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
10443             """
10444             Measure max radius of curvature of surface.
10445
10446             Parameters:
10447                 theSurf the given surface.
10448                 theUParam Value of U-parameter on the referenced surface.
10449                 theVParam Value of V-parameter on the referenced surface.
10450
10451             Returns:
10452                 max radius of curvature of theSurf.
10453             """
10454             # Example: see GEOM_TestMeasures.py
10455             aSurf = self.MeasuOp.MaxSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
10456             RaiseIfFailed("MaxSurfaceCurvatureByParam", self.MeasuOp)
10457             return aSurf
10458
10459         ## Measure max radius of curvature of surface in the given point
10460         #  @param theSurf the given surface.
10461         #  @param thePoint given point.
10462         #  @return max radius of curvature of theSurf.
10463         #
10464         ## @ref swig_todo "Example"
10465         @ManageTransactions("MeasuOp")
10466         def MaxSurfaceCurvatureByPoint(self, theSurf, thePoint):
10467             """
10468             Measure max radius of curvature of surface in the given point.
10469
10470             Parameters:
10471                 theSurf the given surface.
10472                 thePoint given point.
10473
10474             Returns:
10475                 max radius of curvature of theSurf.
10476             """
10477             aSurf = self.MeasuOp.MaxSurfaceCurvatureByPoint(theSurf,thePoint)
10478             RaiseIfFailed("MaxSurfaceCurvatureByPoint", self.MeasuOp)
10479             return aSurf
10480
10481         ## Measure min radius of curvature of surface.
10482         #  @param theSurf the given surface.
10483         #  @param theUParam Value of U-parameter on the referenced surface.
10484         #  @param theVParam Value of V-parameter on the referenced surface.
10485         #  @return min radius of curvature of theSurf.
10486         #
10487         ## @ref swig_todo "Example"
10488         @ManageTransactions("MeasuOp")
10489         def MinSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
10490             """
10491             Measure min radius of curvature of surface.
10492
10493             Parameters:
10494                 theSurf the given surface.
10495                 theUParam Value of U-parameter on the referenced surface.
10496                 theVParam Value of V-parameter on the referenced surface.
10497
10498             Returns:
10499                 Min radius of curvature of theSurf.
10500             """
10501             aSurf = self.MeasuOp.MinSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
10502             RaiseIfFailed("MinSurfaceCurvatureByParam", self.MeasuOp)
10503             return aSurf
10504
10505         ## Measure min radius of curvature of surface in the given point
10506         #  @param theSurf the given surface.
10507         #  @param thePoint given point.
10508         #  @return min radius of curvature of theSurf.
10509         #
10510         ## @ref swig_todo "Example"
10511         @ManageTransactions("MeasuOp")
10512         def MinSurfaceCurvatureByPoint(self, theSurf, thePoint):
10513             """
10514             Measure min radius of curvature of surface in the given point.
10515
10516             Parameters:
10517                 theSurf the given surface.
10518                 thePoint given point.
10519
10520             Returns:
10521                 Min radius of curvature of theSurf.
10522             """
10523             aSurf = self.MeasuOp.MinSurfaceCurvatureByPoint(theSurf,thePoint)
10524             RaiseIfFailed("MinSurfaceCurvatureByPoint", self.MeasuOp)
10525             return aSurf
10526         ## @}
10527
10528         ## Get min and max tolerances of sub-shapes of theShape
10529         #  @param theShape Shape, to get tolerances of.
10530         #  @return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]\n
10531         #  FaceMin,FaceMax: Min and max tolerances of the faces.\n
10532         #  EdgeMin,EdgeMax: Min and max tolerances of the edges.\n
10533         #  VertMin,VertMax: Min and max tolerances of the vertices.
10534         #
10535         #  @ref tui_tolerance_page "Example"
10536         @ManageTransactions("MeasuOp")
10537         def Tolerance(self,theShape):
10538             """
10539             Get min and max tolerances of sub-shapes of theShape
10540
10541             Parameters:
10542                 theShape Shape, to get tolerances of.
10543
10544             Returns:
10545                 [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
10546                  FaceMin,FaceMax: Min and max tolerances of the faces.
10547                  EdgeMin,EdgeMax: Min and max tolerances of the edges.
10548                  VertMin,VertMax: Min and max tolerances of the vertices.
10549             """
10550             # Example: see GEOM_TestMeasures.py
10551             aTuple = self.MeasuOp.GetTolerance(theShape)
10552             RaiseIfFailed("GetTolerance", self.MeasuOp)
10553             return aTuple
10554
10555         ## Obtain description of the given shape (number of sub-shapes of each type)
10556         #  @param theShape Shape to be described.
10557         #  @return Description of the given shape.
10558         #
10559         #  @ref tui_whatis_page "Example"
10560         @ManageTransactions("MeasuOp")
10561         def WhatIs(self,theShape):
10562             """
10563             Obtain description of the given shape (number of sub-shapes of each type)
10564
10565             Parameters:
10566                 theShape Shape to be described.
10567
10568             Returns:
10569                 Description of the given shape.
10570             """
10571             # Example: see GEOM_TestMeasures.py
10572             aDescr = self.MeasuOp.WhatIs(theShape)
10573             RaiseIfFailed("WhatIs", self.MeasuOp)
10574             return aDescr
10575
10576         ## Obtain quantity of shapes of the given type in \a theShape.
10577         #  If \a theShape is of type \a theType, it is also counted.
10578         #  @param theShape Shape to be described.
10579         #  @param theType the given ShapeType().
10580         #  @return Quantity of shapes of type \a theType in \a theShape.
10581         #
10582         #  @ref tui_measurement_tools_page "Example"
10583         def NbShapes (self, theShape, theType):
10584             """
10585             Obtain quantity of shapes of the given type in theShape.
10586             If theShape is of type theType, it is also counted.
10587
10588             Parameters:
10589                 theShape Shape to be described.
10590                 theType the given geompy.ShapeType
10591
10592             Returns:
10593                 Quantity of shapes of type theType in theShape.
10594             """
10595             # Example: see GEOM_TestMeasures.py
10596             listSh = self.SubShapeAllIDs(theShape, theType)
10597             Nb = len(listSh)
10598             return Nb
10599
10600         ## Obtain quantity of shapes of each type in \a theShape.
10601         #  The \a theShape is also counted.
10602         #  @param theShape Shape to be described.
10603         #  @return Dictionary of ShapeType() with bound quantities of shapes.
10604         #
10605         #  @ref tui_measurement_tools_page "Example"
10606         def ShapeInfo (self, theShape):
10607             """
10608             Obtain quantity of shapes of each type in theShape.
10609             The theShape is also counted.
10610
10611             Parameters:
10612                 theShape Shape to be described.
10613
10614             Returns:
10615                 Dictionary of geompy.ShapeType with bound quantities of shapes.
10616             """
10617             # Example: see GEOM_TestMeasures.py
10618             aDict = {}
10619             for typeSh in self.ShapeType:
10620                 if typeSh in ( "AUTO", "SHAPE" ): continue
10621                 listSh = self.SubShapeAllIDs(theShape, self.ShapeType[typeSh])
10622                 Nb = len(listSh)
10623                 aDict[typeSh] = Nb
10624                 pass
10625             return aDict
10626
10627         def GetCreationInformation(self, theShape):
10628             info = theShape.GetCreationInformation()
10629             # operationName
10630             opName = info.operationName
10631             if not opName: opName = "no info available"
10632             res = "Operation: " + opName
10633             # parameters
10634             for parVal in info.params:
10635                 res += " \n %s = %s" % ( parVal.name, parVal.value )
10636             return res
10637
10638         ## Get a point, situated at the centre of mass of theShape.
10639         #  @param theShape Shape to define centre of mass of.
10640         #  @param theName Object name; when specified, this parameter is used
10641         #         for result publication in the study. Otherwise, if automatic
10642         #         publication is switched on, default value is used for result name.
10643         #
10644         #  @return New GEOM.GEOM_Object, containing the created point.
10645         #
10646         #  @ref tui_center_of_mass_page "Example"
10647         @ManageTransactions("MeasuOp")
10648         def MakeCDG(self, theShape, theName=None):
10649             """
10650             Get a point, situated at the centre of mass of theShape.
10651
10652             Parameters:
10653                 theShape Shape to define centre of mass of.
10654                 theName Object name; when specified, this parameter is used
10655                         for result publication in the study. Otherwise, if automatic
10656                         publication is switched on, default value is used for result name.
10657
10658             Returns:
10659                 New GEOM.GEOM_Object, containing the created point.
10660             """
10661             # Example: see GEOM_TestMeasures.py
10662             anObj = self.MeasuOp.GetCentreOfMass(theShape)
10663             RaiseIfFailed("GetCentreOfMass", self.MeasuOp)
10664             self._autoPublish(anObj, theName, "centerOfMass")
10665             return anObj
10666
10667         ## Get a vertex sub-shape by index depended with orientation.
10668         #  @param theShape Shape to find sub-shape.
10669         #  @param theIndex Index to find vertex by this index (starting from zero)
10670         #  @param theName Object name; when specified, this parameter is used
10671         #         for result publication in the study. Otherwise, if automatic
10672         #         publication is switched on, default value is used for result name.
10673         #
10674         #  @return New GEOM.GEOM_Object, containing the created vertex.
10675         #
10676         #  @ref tui_measurement_tools_page "Example"
10677         @ManageTransactions("MeasuOp")
10678         def GetVertexByIndex(self, theShape, theIndex, theName=None):
10679             """
10680             Get a vertex sub-shape by index depended with orientation.
10681
10682             Parameters:
10683                 theShape Shape to find sub-shape.
10684                 theIndex Index to find vertex by this index (starting from zero)
10685                 theName Object name; when specified, this parameter is used
10686                         for result publication in the study. Otherwise, if automatic
10687                         publication is switched on, default value is used for result name.
10688
10689             Returns:
10690                 New GEOM.GEOM_Object, containing the created vertex.
10691             """
10692             # Example: see GEOM_TestMeasures.py
10693             anObj = self.MeasuOp.GetVertexByIndex(theShape, theIndex)
10694             RaiseIfFailed("GetVertexByIndex", self.MeasuOp)
10695             self._autoPublish(anObj, theName, "vertex")
10696             return anObj
10697
10698         ## Get the first vertex of wire/edge depended orientation.
10699         #  @param theShape Shape to find first vertex.
10700         #  @param theName Object name; when specified, this parameter is used
10701         #         for result publication in the study. Otherwise, if automatic
10702         #         publication is switched on, default value is used for result name.
10703         #
10704         #  @return New GEOM.GEOM_Object, containing the created vertex.
10705         #
10706         #  @ref tui_measurement_tools_page "Example"
10707         def GetFirstVertex(self, theShape, theName=None):
10708             """
10709             Get the first vertex of wire/edge depended orientation.
10710
10711             Parameters:
10712                 theShape Shape to find first vertex.
10713                 theName Object name; when specified, this parameter is used
10714                         for result publication in the study. Otherwise, if automatic
10715                         publication is switched on, default value is used for result name.
10716
10717             Returns:
10718                 New GEOM.GEOM_Object, containing the created vertex.
10719             """
10720             # Example: see GEOM_TestMeasures.py
10721             # note: auto-publishing is done in self.GetVertexByIndex()
10722             return self.GetVertexByIndex(theShape, 0, theName)
10723
10724         ## Get the last vertex of wire/edge depended orientation.
10725         #  @param theShape Shape to find last vertex.
10726         #  @param theName Object name; when specified, this parameter is used
10727         #         for result publication in the study. Otherwise, if automatic
10728         #         publication is switched on, default value is used for result name.
10729         #
10730         #  @return New GEOM.GEOM_Object, containing the created vertex.
10731         #
10732         #  @ref tui_measurement_tools_page "Example"
10733         def GetLastVertex(self, theShape, theName=None):
10734             """
10735             Get the last vertex of wire/edge depended orientation.
10736
10737             Parameters:
10738                 theShape Shape to find last vertex.
10739                 theName Object name; when specified, this parameter is used
10740                         for result publication in the study. Otherwise, if automatic
10741                         publication is switched on, default value is used for result name.
10742
10743             Returns:
10744                 New GEOM.GEOM_Object, containing the created vertex.
10745             """
10746             # Example: see GEOM_TestMeasures.py
10747             nb_vert =  self.NumberOfSubShapes(theShape, self.ShapeType["VERTEX"])
10748             # note: auto-publishing is done in self.GetVertexByIndex()
10749             return self.GetVertexByIndex(theShape, (nb_vert-1), theName)
10750
10751         ## Get a normale to the given face. If the point is not given,
10752         #  the normale is calculated at the center of mass.
10753         #  @param theFace Face to define normale of.
10754         #  @param theOptionalPoint Point to compute the normale at.
10755         #  @param theName Object name; when specified, this parameter is used
10756         #         for result publication in the study. Otherwise, if automatic
10757         #         publication is switched on, default value is used for result name.
10758         #
10759         #  @return New GEOM.GEOM_Object, containing the created vector.
10760         #
10761         #  @ref swig_todo "Example"
10762         @ManageTransactions("MeasuOp")
10763         def GetNormal(self, theFace, theOptionalPoint = None, theName=None):
10764             """
10765             Get a normale to the given face. If the point is not given,
10766             the normale is calculated at the center of mass.
10767
10768             Parameters:
10769                 theFace Face to define normale of.
10770                 theOptionalPoint Point to compute the normale at.
10771                 theName Object name; when specified, this parameter is used
10772                         for result publication in the study. Otherwise, if automatic
10773                         publication is switched on, default value is used for result name.
10774
10775             Returns:
10776                 New GEOM.GEOM_Object, containing the created vector.
10777             """
10778             # Example: see GEOM_TestMeasures.py
10779             anObj = self.MeasuOp.GetNormal(theFace, theOptionalPoint)
10780             RaiseIfFailed("GetNormal", self.MeasuOp)
10781             self._autoPublish(anObj, theName, "normal")
10782             return anObj
10783
10784         ## Print shape errors obtained from CheckShape.
10785         #  @param theShape Shape that was checked.
10786         #  @param theShapeErrors the shape errors obtained by CheckShape.
10787         #  @param theReturnStatus If 0 the description of problem is printed.
10788         #                         If 1 the description of problem is returned.
10789         #  @return If theReturnStatus is equal to 1 the description is returned.
10790         #          Otherwise doesn't return anything.
10791         #
10792         #  @ref tui_check_shape_page "Example"
10793         @ManageTransactions("MeasuOp")
10794         def PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0):
10795             """
10796             Print shape errors obtained from CheckShape.
10797
10798             Parameters:
10799                 theShape Shape that was checked.
10800                 theShapeErrors the shape errors obtained by CheckShape.
10801                 theReturnStatus If 0 the description of problem is printed.
10802                                 If 1 the description of problem is returned.
10803
10804             Returns:
10805                 If theReturnStatus is equal to 1 the description is returned.
10806                   Otherwise doesn't return anything.
10807             """
10808             # Example: see GEOM_TestMeasures.py
10809             Descr = self.MeasuOp.PrintShapeErrors(theShape, theShapeErrors)
10810             if theReturnStatus == 1:
10811                 return Descr
10812             print Descr
10813             pass
10814
10815         ## Check a topology of the given shape.
10816         #  @param theShape Shape to check validity of.
10817         #  @param theIsCheckGeom If FALSE, only the shape's topology will be checked, \n
10818         #                        if TRUE, the shape's geometry will be checked also.
10819         #  @param theReturnStatus If 0 and if theShape is invalid, a description
10820         #                         of problem is printed.
10821         #                         If 1 isValid flag and the description of
10822         #                         problem is returned.
10823         #                         If 2 isValid flag and the list of error data
10824         #                         is returned.
10825         #  @return TRUE, if the shape "seems to be valid".
10826         #          If theShape is invalid, prints a description of problem.
10827         #          If theReturnStatus is equal to 1 the description is returned
10828         #          along with IsValid flag.
10829         #          If theReturnStatus is equal to 2 the list of error data is
10830         #          returned along with IsValid flag.
10831         #
10832         #  @ref tui_check_shape_page "Example"
10833         @ManageTransactions("MeasuOp")
10834         def CheckShape(self,theShape, theIsCheckGeom = 0, theReturnStatus = 0):
10835             """
10836             Check a topology of the given shape.
10837
10838             Parameters:
10839                 theShape Shape to check validity of.
10840                 theIsCheckGeom If FALSE, only the shape's topology will be checked,
10841                                if TRUE, the shape's geometry will be checked also.
10842                 theReturnStatus If 0 and if theShape is invalid, a description
10843                                 of problem is printed.
10844                                 If 1 IsValid flag and the description of
10845                                 problem is returned.
10846                                 If 2 IsValid flag and the list of error data
10847                                 is returned.
10848
10849             Returns:
10850                 TRUE, if the shape "seems to be valid".
10851                 If theShape is invalid, prints a description of problem.
10852                 If theReturnStatus is equal to 1 the description is returned
10853                 along with IsValid flag.
10854                 If theReturnStatus is equal to 2 the list of error data is
10855                 returned along with IsValid flag.
10856             """
10857             # Example: see GEOM_TestMeasures.py
10858             if theIsCheckGeom:
10859                 (IsValid, ShapeErrors) = self.MeasuOp.CheckShapeWithGeometry(theShape)
10860                 RaiseIfFailed("CheckShapeWithGeometry", self.MeasuOp)
10861             else:
10862                 (IsValid, ShapeErrors) = self.MeasuOp.CheckShape(theShape)
10863                 RaiseIfFailed("CheckShape", self.MeasuOp)
10864             if IsValid == 0:
10865                 if theReturnStatus == 0:
10866                     Descr = self.MeasuOp.PrintShapeErrors(theShape, ShapeErrors)
10867                     print Descr
10868             if theReturnStatus == 1:
10869               Descr = self.MeasuOp.PrintShapeErrors(theShape, ShapeErrors)
10870               return (IsValid, Descr)
10871             elif theReturnStatus == 2:
10872               return (IsValid, ShapeErrors)
10873             return IsValid
10874
10875         ## Detect self-intersections in the given shape.
10876         #  @param theShape Shape to check.
10877         #  @param theCheckLevel is the level of self-intersection check.
10878         #         Possible input values are:
10879         #         - GEOM.SI_V_V(0) - only V/V interferences
10880         #         - GEOM.SI_V_E(1) - V/V and V/E interferences
10881         #         - GEOM.SI_E_E(2) - V/V, V/E and E/E interferences
10882         #         - GEOM.SI_V_F(3) - V/V, V/E, E/E and V/F interferences
10883         #         - GEOM.SI_E_F(4) - V/V, V/E, E/E, V/F and E/F interferences
10884         #         - GEOM.SI_ALL(5) - all interferences.
10885         #  @return TRUE, if the shape contains no self-intersections.
10886         #
10887         #  @ref tui_check_self_intersections_page "Example"
10888         @ManageTransactions("MeasuOp")
10889         def CheckSelfIntersections(self, theShape, theCheckLevel = GEOM.SI_ALL):
10890             """
10891             Detect self-intersections in the given shape.
10892
10893             Parameters:
10894                 theShape Shape to check.
10895                 theCheckLevel is the level of self-intersection check.
10896                   Possible input values are:
10897                    - GEOM.SI_V_V(0) - only V/V interferences
10898                    - GEOM.SI_V_E(1) - V/V and V/E interferences
10899                    - GEOM.SI_E_E(2) - V/V, V/E and E/E interferences
10900                    - GEOM.SI_V_F(3) - V/V, V/E, E/E and V/F interferences
10901                    - GEOM.SI_E_F(4) - V/V, V/E, E/E, V/F and E/F interferences
10902                    - GEOM.SI_ALL(5) - all interferences.
10903  
10904             Returns:
10905                 TRUE, if the shape contains no self-intersections.
10906             """
10907             # Example: see GEOM_TestMeasures.py
10908             (IsValid, Pairs) = self.MeasuOp.CheckSelfIntersections(theShape, EnumToLong(theCheckLevel))
10909             RaiseIfFailed("CheckSelfIntersections", self.MeasuOp)
10910             return IsValid
10911
10912         ## Detect intersections of the given shapes with algorithm based on mesh intersections.
10913         #  @param theShape1 First source object
10914         #  @param theShape2 Second source object
10915         #  @param theTolerance Specifies a distance between shapes used for detecting gaps:
10916         #         - if \a theTolerance <= 0, algorithm detects intersections (default behavior)
10917         #         - if \a theTolerance > 0, algorithm detects gaps
10918         #  @param theDeflection Linear deflection coefficient that specifies quality of tesselation:
10919         #         - if \a theDeflection <= 0, default deflection 0.001 is used
10920         #  @return TRUE, if there are intersections (gaps) between source shapes
10921         #  @return List of sub-shapes IDs from 1st shape that localize intersection.
10922         #  @return List of sub-shapes IDs from 2nd shape that localize intersection.
10923         #
10924         #  @ref tui_fast_intersection_page "Example"
10925         @ManageTransactions("MeasuOp")
10926         def FastIntersect(self, theShape1, theShape2, theTolerance = 0.0, theDeflection = 0.001):
10927             """
10928             Detect intersections of the given shapes with algorithm based on mesh intersections.
10929
10930             Parameters:
10931                 theShape1 First source object
10932                 theShape2 Second source object
10933                 theTolerance Specifies a distance between shapes used for detecting gaps:
10934                     - if theTolerance <= 0, algorithm detects intersections (default behavior)
10935                     - if theTolerance > 0, algorithm detects gaps
10936                 theDeflection Linear deflection coefficient that specifies quality of tesselation:
10937                     - if theDeflection <= 0, default deflection 0.001 is used
10938  
10939             Returns:
10940                 TRUE, if there are intersections (gaps) between source shapes
10941                 List of sub-shapes IDs from 1st shape that localize intersection.
10942                 List of sub-shapes IDs from 2nd shape that localize intersection.
10943             """
10944             # Example: see GEOM_TestMeasures.py
10945             IsOk, Res1, Res2 = self.MeasuOp.FastIntersect(theShape1, theShape2, theTolerance, theDeflection)
10946             RaiseIfFailed("FastIntersect", self.MeasuOp)
10947             return IsOk, Res1, Res2
10948
10949         ## Get position (LCS) of theShape.
10950         #
10951         #  Origin of the LCS is situated at the shape's center of mass.
10952         #  Axes of the LCS are obtained from shape's location or,
10953         #  if the shape is a planar face, from position of its plane.
10954         #
10955         #  @param theShape Shape to calculate position of.
10956         #  @return [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
10957         #          Ox,Oy,Oz: Coordinates of shape's LCS origin.
10958         #          Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
10959         #          Xx,Xy,Xz: Coordinates of shape's LCS X direction.
10960         #
10961         #  @ref swig_todo "Example"
10962         @ManageTransactions("MeasuOp")
10963         def GetPosition(self,theShape):
10964             """
10965             Get position (LCS) of theShape.
10966             Origin of the LCS is situated at the shape's center of mass.
10967             Axes of the LCS are obtained from shape's location or,
10968             if the shape is a planar face, from position of its plane.
10969
10970             Parameters:
10971                 theShape Shape to calculate position of.
10972
10973             Returns:
10974                 [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
10975                  Ox,Oy,Oz: Coordinates of shape's LCS origin.
10976                  Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
10977                  Xx,Xy,Xz: Coordinates of shape's LCS X direction.
10978             """
10979             # Example: see GEOM_TestMeasures.py
10980             aTuple = self.MeasuOp.GetPosition(theShape)
10981             RaiseIfFailed("GetPosition", self.MeasuOp)
10982             return aTuple
10983
10984         ## Get kind of theShape.
10985         #
10986         #  @param theShape Shape to get a kind of.
10987         #  @return Returns a kind of shape in terms of <VAR>GEOM.GEOM_IKindOfShape.shape_kind</VAR> enumeration
10988         #          and a list of parameters, describing the shape.
10989         #  @note  Concrete meaning of each value, returned via \a theIntegers
10990         #         or \a theDoubles list depends on the kind() of the shape.
10991         #
10992         #  @ref swig_todo "Example"
10993         @ManageTransactions("MeasuOp")
10994         def KindOfShape(self,theShape):
10995             """
10996             Get kind of theShape.
10997
10998             Parameters:
10999                 theShape Shape to get a kind of.
11000
11001             Returns:
11002                 a kind of shape in terms of GEOM_IKindOfShape.shape_kind enumeration
11003                     and a list of parameters, describing the shape.
11004             Note:
11005                 Concrete meaning of each value, returned via theIntegers
11006                 or theDoubles list depends on the geompy.kind of the shape
11007             """
11008             # Example: see GEOM_TestMeasures.py
11009             aRoughTuple = self.MeasuOp.KindOfShape(theShape)
11010             RaiseIfFailed("KindOfShape", self.MeasuOp)
11011
11012             aKind  = aRoughTuple[0]
11013             anInts = aRoughTuple[1]
11014             aDbls  = aRoughTuple[2]
11015
11016             # Now there is no exception from this rule:
11017             aKindTuple = [aKind] + aDbls + anInts
11018
11019             # If they are we will regroup parameters for such kind of shape.
11020             # For example:
11021             #if aKind == kind.SOME_KIND:
11022             #    #  SOME_KIND     int int double int double double
11023             #    aKindTuple = [aKind, anInts[0], anInts[1], aDbls[0], anInts[2], aDbls[1], aDbls[2]]
11024
11025             return aKindTuple
11026
11027         ## Returns the string that describes if the shell is good for solid.
11028         #  This is a support method for MakeSolid.
11029         #
11030         #  @param theShell the shell to be checked.
11031         #  @return Returns a string that describes the shell validity for
11032         #          solid construction.
11033         @ManageTransactions("MeasuOp")
11034         def _IsGoodForSolid(self, theShell):
11035             """
11036             Returns the string that describes if the shell is good for solid.
11037             This is a support method for MakeSolid.
11038
11039             Parameter:
11040                 theShell the shell to be checked.
11041
11042             Returns:
11043                 Returns a string that describes the shell validity for
11044                 solid construction.
11045             """
11046             aDescr = self.MeasuOp.IsGoodForSolid(theShell)
11047             return aDescr
11048
11049         # end of l2_measure
11050         ## @}
11051
11052         ## @addtogroup l2_import_export
11053         ## @{
11054
11055         ## Import a shape from the BREP, IGES, STEP or other file
11056         #  (depends on given format) with given name.
11057         #
11058         #  Note: this function is deprecated, it is kept for backward compatibility only
11059         #  Use Import<FormatName> instead, where <FormatName> is a name of desirable format to import.
11060         #
11061         #  @param theFileName The file, containing the shape.
11062         #  @param theFormatName Specify format for the file reading.
11063         #         Available formats can be obtained with InsertOp.ImportTranslators() method.
11064         #         If format 'IGES_SCALE' is used instead of 'IGES' or
11065         #            format 'STEP_SCALE' is used instead of 'STEP',
11066         #            length unit will be set to 'meter' and result model will be scaled.
11067         #  @param theName Object name; when specified, this parameter is used
11068         #         for result publication in the study. Otherwise, if automatic
11069         #         publication is switched on, default value is used for result name.
11070         #
11071         #  @return New GEOM.GEOM_Object, containing the imported shape.
11072         #          If material names are imported it returns the list of
11073         #          objects. The first one is the imported object followed by
11074         #          material groups.
11075         #  @note Auto publishing is allowed for the shape itself. Imported
11076         #        material groups are not automatically published.
11077         #
11078         #  @ref swig_Import_Export "Example"
11079         @ManageTransactions("InsertOp")
11080         def ImportFile(self, theFileName, theFormatName, theName=None):
11081             """
11082             Import a shape from the BREP, IGES, STEP or other file
11083             (depends on given format) with given name.
11084
11085             Note: this function is deprecated, it is kept for backward compatibility only
11086             Use Import<FormatName> instead, where <FormatName> is a name of desirable format to import.
11087
11088             Parameters: 
11089                 theFileName The file, containing the shape.
11090                 theFormatName Specify format for the file reading.
11091                     Available formats can be obtained with geompy.InsertOp.ImportTranslators() method.
11092                     If format 'IGES_SCALE' is used instead of 'IGES' or
11093                        format 'STEP_SCALE' is used instead of 'STEP',
11094                        length unit will be set to 'meter' and result model will be scaled.
11095                 theName Object name; when specified, this parameter is used
11096                         for result publication in the study. Otherwise, if automatic
11097                         publication is switched on, default value is used for result name.
11098
11099             Returns:
11100                 New GEOM.GEOM_Object, containing the imported shape.
11101                 If material names are imported it returns the list of
11102                 objects. The first one is the imported object followed by
11103                 material groups.
11104             Note:
11105                 Auto publishing is allowed for the shape itself. Imported
11106                 material groups are not automatically published.
11107             """
11108             # Example: see GEOM_TestOthers.py
11109             print """
11110             WARNING: Function ImportFile is deprecated, use Import<FormatName> instead,
11111             where <FormatName> is a name of desirable format for importing.
11112             """
11113             aListObj = self.InsertOp.ImportFile(theFileName, theFormatName)
11114             RaiseIfFailed("ImportFile", self.InsertOp)
11115             aNbObj = len(aListObj)
11116             if aNbObj > 0:
11117                 self._autoPublish(aListObj[0], theName, "imported")
11118             if aNbObj == 1:
11119                 return aListObj[0]
11120             return aListObj
11121
11122         ## Deprecated analog of ImportFile()
11123         def Import(self, theFileName, theFormatName, theName=None):
11124             """
11125             Deprecated analog of geompy.ImportFile, kept for backward compatibility only.
11126             """
11127             # note: auto-publishing is done in self.ImportFile()
11128             return self.ImportFile(theFileName, theFormatName, theName)
11129
11130         ## Read a shape from the binary stream, containing its bounding representation (BRep).
11131         #  @note This method will not be dumped to the python script by DumpStudy functionality.
11132         #  @note GEOM.GEOM_Object.GetShapeStream() method can be used to obtain the shape's BRep stream.
11133         #  @param theStream The BRep binary stream.
11134         #  @param theName Object name; when specified, this parameter is used
11135         #         for result publication in the study. Otherwise, if automatic
11136         #         publication is switched on, default value is used for result name.
11137         #
11138         #  @return New GEOM_Object, containing the shape, read from theStream.
11139         #
11140         #  @ref swig_Import_Export "Example"
11141         @ManageTransactions("InsertOp")
11142         def RestoreShape (self, theStream, theName=None):
11143             """
11144             Read a shape from the binary stream, containing its bounding representation (BRep).
11145
11146             Note:
11147                 shape.GetShapeStream() method can be used to obtain the shape's BRep stream.
11148
11149             Parameters:
11150                 theStream The BRep binary stream.
11151                 theName Object name; when specified, this parameter is used
11152                         for result publication in the study. Otherwise, if automatic
11153                         publication is switched on, default value is used for result name.
11154
11155             Returns:
11156                 New GEOM_Object, containing the shape, read from theStream.
11157             """
11158             # Example: see GEOM_TestOthers.py
11159             anObj = self.InsertOp.RestoreShape(theStream)
11160             RaiseIfFailed("RestoreShape", self.InsertOp)
11161             self._autoPublish(anObj, theName, "restored")
11162             return anObj
11163
11164         ## Export the given shape into a file with given name.
11165         #
11166         #  Note: this function is deprecated, it is kept for backward compatibility only
11167         #  Use Export<FormatName> instead, where <FormatName> is a name of desirable format to export.
11168         #
11169         #  @param theObject Shape to be stored in the file.
11170         #  @param theFileName Name of the file to store the given shape in.
11171         #  @param theFormatName Specify format for the shape storage.
11172         #         Available formats can be obtained with
11173         #         geompy.InsertOp.ExportTranslators()[0] method.
11174         #
11175         #  @ref swig_Import_Export "Example"
11176         @ManageTransactions("InsertOp")
11177         def Export(self, theObject, theFileName, theFormatName):
11178             """
11179             Export the given shape into a file with given name.
11180
11181             Note: this function is deprecated, it is kept for backward compatibility only
11182             Use Export<FormatName> instead, where <FormatName> is a name of desirable format to export.
11183             
11184             Parameters: 
11185                 theObject Shape to be stored in the file.
11186                 theFileName Name of the file to store the given shape in.
11187                 theFormatName Specify format for the shape storage.
11188                               Available formats can be obtained with
11189                               geompy.InsertOp.ExportTranslators()[0] method.
11190             """
11191             # Example: see GEOM_TestOthers.py
11192             print """
11193             WARNING: Function Export is deprecated, use Export<FormatName> instead,
11194             where <FormatName> is a name of desirable format for exporting.
11195             """
11196             self.InsertOp.Export(theObject, theFileName, theFormatName)
11197             if self.InsertOp.IsDone() == 0:
11198                 raise RuntimeError,  "Export : " + self.InsertOp.GetErrorCode()
11199                 pass
11200             pass
11201
11202         # end of l2_import_export
11203         ## @}
11204
11205         ## @addtogroup l3_blocks
11206         ## @{
11207
11208         ## Create a quadrangle face from four edges. Order of Edges is not
11209         #  important. It is  not necessary that edges share the same vertex.
11210         #  @param E1,E2,E3,E4 Edges for the face bound.
11211         #  @param theName Object name; when specified, this parameter is used
11212         #         for result publication in the study. Otherwise, if automatic
11213         #         publication is switched on, default value is used for result name.
11214         #
11215         #  @return New GEOM.GEOM_Object, containing the created face.
11216         #
11217         #  @ref tui_building_by_blocks_page "Example"
11218         @ManageTransactions("BlocksOp")
11219         def MakeQuad(self, E1, E2, E3, E4, theName=None):
11220             """
11221             Create a quadrangle face from four edges. Order of Edges is not
11222             important. It is  not necessary that edges share the same vertex.
11223
11224             Parameters:
11225                 E1,E2,E3,E4 Edges for the face bound.
11226                 theName Object name; when specified, this parameter is used
11227                         for result publication in the study. Otherwise, if automatic
11228                         publication is switched on, default value is used for result name.
11229
11230             Returns:
11231                 New GEOM.GEOM_Object, containing the created face.
11232
11233             Example of usage:
11234                 qface1 = geompy.MakeQuad(edge1, edge2, edge3, edge4)
11235             """
11236             # Example: see GEOM_Spanner.py
11237             anObj = self.BlocksOp.MakeQuad(E1, E2, E3, E4)
11238             RaiseIfFailed("MakeQuad", self.BlocksOp)
11239             self._autoPublish(anObj, theName, "quad")
11240             return anObj
11241
11242         ## Create a quadrangle face on two edges.
11243         #  The missing edges will be built by creating the shortest ones.
11244         #  @param E1,E2 Two opposite edges for the face.
11245         #  @param theName Object name; when specified, this parameter is used
11246         #         for result publication in the study. Otherwise, if automatic
11247         #         publication is switched on, default value is used for result name.
11248         #
11249         #  @return New GEOM.GEOM_Object, containing the created face.
11250         #
11251         #  @ref tui_building_by_blocks_page "Example"
11252         @ManageTransactions("BlocksOp")
11253         def MakeQuad2Edges(self, E1, E2, theName=None):
11254             """
11255             Create a quadrangle face on two edges.
11256             The missing edges will be built by creating the shortest ones.
11257
11258             Parameters:
11259                 E1,E2 Two opposite edges for the face.
11260                 theName Object name; when specified, this parameter is used
11261                         for result publication in the study. Otherwise, if automatic
11262                         publication is switched on, default value is used for result name.
11263
11264             Returns:
11265                 New GEOM.GEOM_Object, containing the created face.
11266
11267             Example of usage:
11268                 # create vertices
11269                 p1 = geompy.MakeVertex(  0.,   0.,   0.)
11270                 p2 = geompy.MakeVertex(150.,  30.,   0.)
11271                 p3 = geompy.MakeVertex(  0., 120.,  50.)
11272                 p4 = geompy.MakeVertex(  0.,  40.,  70.)
11273                 # create edges
11274                 edge1 = geompy.MakeEdge(p1, p2)
11275                 edge2 = geompy.MakeEdge(p3, p4)
11276                 # create a quadrangle face from two edges
11277                 qface2 = geompy.MakeQuad2Edges(edge1, edge2)
11278             """
11279             # Example: see GEOM_Spanner.py
11280             anObj = self.BlocksOp.MakeQuad2Edges(E1, E2)
11281             RaiseIfFailed("MakeQuad2Edges", self.BlocksOp)
11282             self._autoPublish(anObj, theName, "quad")
11283             return anObj
11284
11285         ## Create a quadrangle face with specified corners.
11286         #  The missing edges will be built by creating the shortest ones.
11287         #  @param V1,V2,V3,V4 Corner vertices for the face.
11288         #  @param theName Object name; when specified, this parameter is used
11289         #         for result publication in the study. Otherwise, if automatic
11290         #         publication is switched on, default value is used for result name.
11291         #
11292         #  @return New GEOM.GEOM_Object, containing the created face.
11293         #
11294         #  @ref tui_building_by_blocks_page "Example 1"
11295         #  \n @ref swig_MakeQuad4Vertices "Example 2"
11296         @ManageTransactions("BlocksOp")
11297         def MakeQuad4Vertices(self, V1, V2, V3, V4, theName=None):
11298             """
11299             Create a quadrangle face with specified corners.
11300             The missing edges will be built by creating the shortest ones.
11301
11302             Parameters:
11303                 V1,V2,V3,V4 Corner vertices for the face.
11304                 theName Object name; when specified, this parameter is used
11305                         for result publication in the study. Otherwise, if automatic
11306                         publication is switched on, default value is used for result name.
11307
11308             Returns:
11309                 New GEOM.GEOM_Object, containing the created face.
11310
11311             Example of usage:
11312                 # create vertices
11313                 p1 = geompy.MakeVertex(  0.,   0.,   0.)
11314                 p2 = geompy.MakeVertex(150.,  30.,   0.)
11315                 p3 = geompy.MakeVertex(  0., 120.,  50.)
11316                 p4 = geompy.MakeVertex(  0.,  40.,  70.)
11317                 # create a quadrangle from four points in its corners
11318                 qface3 = geompy.MakeQuad4Vertices(p1, p2, p3, p4)
11319             """
11320             # Example: see GEOM_Spanner.py
11321             anObj = self.BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
11322             RaiseIfFailed("MakeQuad4Vertices", self.BlocksOp)
11323             self._autoPublish(anObj, theName, "quad")
11324             return anObj
11325
11326         ## Create a hexahedral solid, bounded by the six given faces. Order of
11327         #  faces is not important. It is  not necessary that Faces share the same edge.
11328         #  @param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
11329         #  @param theName Object name; when specified, this parameter is used
11330         #         for result publication in the study. Otherwise, if automatic
11331         #         publication is switched on, default value is used for result name.
11332         #
11333         #  @return New GEOM.GEOM_Object, containing the created solid.
11334         #
11335         #  @ref tui_building_by_blocks_page "Example 1"
11336         #  \n @ref swig_MakeHexa "Example 2"
11337         @ManageTransactions("BlocksOp")
11338         def MakeHexa(self, F1, F2, F3, F4, F5, F6, theName=None):
11339             """
11340             Create a hexahedral solid, bounded by the six given faces. Order of
11341             faces is not important. It is  not necessary that Faces share the same edge.
11342
11343             Parameters:
11344                 F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
11345                 theName Object name; when specified, this parameter is used
11346                         for result publication in the study. Otherwise, if automatic
11347                         publication is switched on, default value is used for result name.
11348
11349             Returns:
11350                 New GEOM.GEOM_Object, containing the created solid.
11351
11352             Example of usage:
11353                 solid = geompy.MakeHexa(qface1, qface2, qface3, qface4, qface5, qface6)
11354             """
11355             # Example: see GEOM_Spanner.py
11356             anObj = self.BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
11357             RaiseIfFailed("MakeHexa", self.BlocksOp)
11358             self._autoPublish(anObj, theName, "hexa")
11359             return anObj
11360
11361         ## Create a hexahedral solid between two given faces.
11362         #  The missing faces will be built by creating the smallest ones.
11363         #  @param F1,F2 Two opposite faces for the hexahedral solid.
11364         #  @param theName Object name; when specified, this parameter is used
11365         #         for result publication in the study. Otherwise, if automatic
11366         #         publication is switched on, default value is used for result name.
11367         #
11368         #  @return New GEOM.GEOM_Object, containing the created solid.
11369         #
11370         #  @ref tui_building_by_blocks_page "Example 1"
11371         #  \n @ref swig_MakeHexa2Faces "Example 2"
11372         @ManageTransactions("BlocksOp")
11373         def MakeHexa2Faces(self, F1, F2, theName=None):
11374             """
11375             Create a hexahedral solid between two given faces.
11376             The missing faces will be built by creating the smallest ones.
11377
11378             Parameters:
11379                 F1,F2 Two opposite faces for the hexahedral solid.
11380                 theName Object name; when specified, this parameter is used
11381                         for result publication in the study. Otherwise, if automatic
11382                         publication is switched on, default value is used for result name.
11383
11384             Returns:
11385                 New GEOM.GEOM_Object, containing the created solid.
11386
11387             Example of usage:
11388                 solid1 = geompy.MakeHexa2Faces(qface1, qface2)
11389             """
11390             # Example: see GEOM_Spanner.py
11391             anObj = self.BlocksOp.MakeHexa2Faces(F1, F2)
11392             RaiseIfFailed("MakeHexa2Faces", self.BlocksOp)
11393             self._autoPublish(anObj, theName, "hexa")
11394             return anObj
11395
11396         # end of l3_blocks
11397         ## @}
11398
11399         ## @addtogroup l3_blocks_op
11400         ## @{
11401
11402         ## Get a vertex, found in the given shape by its coordinates.
11403         #  @param theShape Block or a compound of blocks.
11404         #  @param theX,theY,theZ Coordinates of the sought vertex.
11405         #  @param theEpsilon Maximum allowed distance between the resulting
11406         #                    vertex and point with the given coordinates.
11407         #  @param theName Object name; when specified, this parameter is used
11408         #         for result publication in the study. Otherwise, if automatic
11409         #         publication is switched on, default value is used for result name.
11410         #
11411         #  @return New GEOM.GEOM_Object, containing the found vertex.
11412         #
11413         #  @ref swig_GetPoint "Example"
11414         @ManageTransactions("BlocksOp")
11415         def GetPoint(self, theShape, theX, theY, theZ, theEpsilon, theName=None):
11416             """
11417             Get a vertex, found in the given shape by its coordinates.
11418
11419             Parameters:
11420                 theShape Block or a compound of blocks.
11421                 theX,theY,theZ Coordinates of the sought vertex.
11422                 theEpsilon Maximum allowed distance between the resulting
11423                            vertex and point with the given coordinates.
11424                 theName Object name; when specified, this parameter is used
11425                         for result publication in the study. Otherwise, if automatic
11426                         publication is switched on, default value is used for result name.
11427
11428             Returns:
11429                 New GEOM.GEOM_Object, containing the found vertex.
11430
11431             Example of usage:
11432                 pnt = geompy.GetPoint(shape, -50,  50,  50, 0.01)
11433             """
11434             # Example: see GEOM_TestOthers.py
11435             anObj = self.BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
11436             RaiseIfFailed("GetPoint", self.BlocksOp)
11437             self._autoPublish(anObj, theName, "vertex")
11438             return anObj
11439
11440         ## Find a vertex of the given shape, which has minimal distance to the given point.
11441         #  @param theShape Any shape.
11442         #  @param thePoint Point, close to the desired vertex.
11443         #  @param theName Object name; when specified, this parameter is used
11444         #         for result publication in the study. Otherwise, if automatic
11445         #         publication is switched on, default value is used for result name.
11446         #
11447         #  @return New GEOM.GEOM_Object, containing the found vertex.
11448         #
11449         #  @ref swig_GetVertexNearPoint "Example"
11450         @ManageTransactions("BlocksOp")
11451         def GetVertexNearPoint(self, theShape, thePoint, theName=None):
11452             """
11453             Find a vertex of the given shape, which has minimal distance to the given point.
11454
11455             Parameters:
11456                 theShape Any shape.
11457                 thePoint Point, close to the desired vertex.
11458                 theName Object name; when specified, this parameter is used
11459                         for result publication in the study. Otherwise, if automatic
11460                         publication is switched on, default value is used for result name.
11461
11462             Returns:
11463                 New GEOM.GEOM_Object, containing the found vertex.
11464
11465             Example of usage:
11466                 pmidle = geompy.MakeVertex(50, 0, 50)
11467                 edge1 = geompy.GetEdgeNearPoint(blocksComp, pmidle)
11468             """
11469             # Example: see GEOM_TestOthers.py
11470             anObj = self.BlocksOp.GetVertexNearPoint(theShape, thePoint)
11471             RaiseIfFailed("GetVertexNearPoint", self.BlocksOp)
11472             self._autoPublish(anObj, theName, "vertex")
11473             return anObj
11474
11475         ## Get an edge, found in the given shape by two given vertices.
11476         #  @param theShape Block or a compound of blocks.
11477         #  @param thePoint1,thePoint2 Points, close to the ends of the desired edge.
11478         #  @param theName Object name; when specified, this parameter is used
11479         #         for result publication in the study. Otherwise, if automatic
11480         #         publication is switched on, default value is used for result name.
11481         #
11482         #  @return New GEOM.GEOM_Object, containing the found edge.
11483         #
11484         #  @ref swig_GetEdge "Example"
11485         @ManageTransactions("BlocksOp")
11486         def GetEdge(self, theShape, thePoint1, thePoint2, theName=None):
11487             """
11488             Get an edge, found in the given shape by two given vertices.
11489
11490             Parameters:
11491                 theShape Block or a compound of blocks.
11492                 thePoint1,thePoint2 Points, close to the ends of the desired edge.
11493                 theName Object name; when specified, this parameter is used
11494                         for result publication in the study. Otherwise, if automatic
11495                         publication is switched on, default value is used for result name.
11496
11497             Returns:
11498                 New GEOM.GEOM_Object, containing the found edge.
11499             """
11500             # Example: see GEOM_Spanner.py
11501             anObj = self.BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
11502             RaiseIfFailed("GetEdge", self.BlocksOp)
11503             self._autoPublish(anObj, theName, "edge")
11504             return anObj
11505
11506         ## Find an edge of the given shape, which has minimal distance to the given point.
11507         #  @param theShape Block or a compound of blocks.
11508         #  @param thePoint Point, close to the desired edge.
11509         #  @param theName Object name; when specified, this parameter is used
11510         #         for result publication in the study. Otherwise, if automatic
11511         #         publication is switched on, default value is used for result name.
11512         #
11513         #  @return New GEOM.GEOM_Object, containing the found edge.
11514         #
11515         #  @ref swig_GetEdgeNearPoint "Example"
11516         @ManageTransactions("BlocksOp")
11517         def GetEdgeNearPoint(self, theShape, thePoint, theName=None):
11518             """
11519             Find an edge of the given shape, which has minimal distance to the given point.
11520
11521             Parameters:
11522                 theShape Block or a compound of blocks.
11523                 thePoint Point, close to the desired edge.
11524                 theName Object name; when specified, this parameter is used
11525                         for result publication in the study. Otherwise, if automatic
11526                         publication is switched on, default value is used for result name.
11527
11528             Returns:
11529                 New GEOM.GEOM_Object, containing the found edge.
11530             """
11531             # Example: see GEOM_TestOthers.py
11532             anObj = self.BlocksOp.GetEdgeNearPoint(theShape, thePoint)
11533             RaiseIfFailed("GetEdgeNearPoint", self.BlocksOp)
11534             self._autoPublish(anObj, theName, "edge")
11535             return anObj
11536
11537         ## Returns a face, found in the given shape by four given corner vertices.
11538         #  @param theShape Block or a compound of blocks.
11539         #  @param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
11540         #  @param theName Object name; when specified, this parameter is used
11541         #         for result publication in the study. Otherwise, if automatic
11542         #         publication is switched on, default value is used for result name.
11543         #
11544         #  @return New GEOM.GEOM_Object, containing the found face.
11545         #
11546         #  @ref swig_todo "Example"
11547         @ManageTransactions("BlocksOp")
11548         def GetFaceByPoints(self, theShape, thePoint1, thePoint2, thePoint3, thePoint4, theName=None):
11549             """
11550             Returns a face, found in the given shape by four given corner vertices.
11551
11552             Parameters:
11553                 theShape Block or a compound of blocks.
11554                 thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
11555                 theName Object name; when specified, this parameter is used
11556                         for result publication in the study. Otherwise, if automatic
11557                         publication is switched on, default value is used for result name.
11558
11559             Returns:
11560                 New GEOM.GEOM_Object, containing the found face.
11561             """
11562             # Example: see GEOM_Spanner.py
11563             anObj = self.BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
11564             RaiseIfFailed("GetFaceByPoints", self.BlocksOp)
11565             self._autoPublish(anObj, theName, "face")
11566             return anObj
11567
11568         ## Get a face of block, found in the given shape by two given edges.
11569         #  @param theShape Block or a compound of blocks.
11570         #  @param theEdge1,theEdge2 Edges, close to the edges of the desired face.
11571         #  @param theName Object name; when specified, this parameter is used
11572         #         for result publication in the study. Otherwise, if automatic
11573         #         publication is switched on, default value is used for result name.
11574         #
11575         #  @return New GEOM.GEOM_Object, containing the found face.
11576         #
11577         #  @ref swig_todo "Example"
11578         @ManageTransactions("BlocksOp")
11579         def GetFaceByEdges(self, theShape, theEdge1, theEdge2, theName=None):
11580             """
11581             Get a face of block, found in the given shape by two given edges.
11582
11583             Parameters:
11584                 theShape Block or a compound of blocks.
11585                 theEdge1,theEdge2 Edges, close to the edges of the desired face.
11586                 theName Object name; when specified, this parameter is used
11587                         for result publication in the study. Otherwise, if automatic
11588                         publication is switched on, default value is used for result name.
11589
11590             Returns:
11591                 New GEOM.GEOM_Object, containing the found face.
11592             """
11593             # Example: see GEOM_Spanner.py
11594             anObj = self.BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
11595             RaiseIfFailed("GetFaceByEdges", self.BlocksOp)
11596             self._autoPublish(anObj, theName, "face")
11597             return anObj
11598
11599         ## Find a face, opposite to the given one in the given block.
11600         #  @param theBlock Must be a hexahedral solid.
11601         #  @param theFace Face of \a theBlock, opposite to the desired face.
11602         #  @param theName Object name; when specified, this parameter is used
11603         #         for result publication in the study. Otherwise, if automatic
11604         #         publication is switched on, default value is used for result name.
11605         #
11606         #  @return New GEOM.GEOM_Object, containing the found face.
11607         #
11608         #  @ref swig_GetOppositeFace "Example"
11609         @ManageTransactions("BlocksOp")
11610         def GetOppositeFace(self, theBlock, theFace, theName=None):
11611             """
11612             Find a face, opposite to the given one in the given block.
11613
11614             Parameters:
11615                 theBlock Must be a hexahedral solid.
11616                 theFace Face of theBlock, opposite to the desired face.
11617                 theName Object name; when specified, this parameter is used
11618                         for result publication in the study. Otherwise, if automatic
11619                         publication is switched on, default value is used for result name.
11620
11621             Returns:
11622                 New GEOM.GEOM_Object, containing the found face.
11623             """
11624             # Example: see GEOM_Spanner.py
11625             anObj = self.BlocksOp.GetOppositeFace(theBlock, theFace)
11626             RaiseIfFailed("GetOppositeFace", self.BlocksOp)
11627             self._autoPublish(anObj, theName, "face")
11628             return anObj
11629
11630         ## Find a face of the given shape, which has minimal distance to the given point.
11631         #  @param theShape Block or a compound of blocks.
11632         #  @param thePoint Point, close to the desired face.
11633         #  @param theName Object name; when specified, this parameter is used
11634         #         for result publication in the study. Otherwise, if automatic
11635         #         publication is switched on, default value is used for result name.
11636         #
11637         #  @return New GEOM.GEOM_Object, containing the found face.
11638         #
11639         #  @ref swig_GetFaceNearPoint "Example"
11640         @ManageTransactions("BlocksOp")
11641         def GetFaceNearPoint(self, theShape, thePoint, theName=None):
11642             """
11643             Find a face of the given shape, which has minimal distance to the given point.
11644
11645             Parameters:
11646                 theShape Block or a compound of blocks.
11647                 thePoint Point, close to the desired face.
11648                 theName Object name; when specified, this parameter is used
11649                         for result publication in the study. Otherwise, if automatic
11650                         publication is switched on, default value is used for result name.
11651
11652             Returns:
11653                 New GEOM.GEOM_Object, containing the found face.
11654             """
11655             # Example: see GEOM_Spanner.py
11656             anObj = self.BlocksOp.GetFaceNearPoint(theShape, thePoint)
11657             RaiseIfFailed("GetFaceNearPoint", self.BlocksOp)
11658             self._autoPublish(anObj, theName, "face")
11659             return anObj
11660
11661         ## Find a face of block, whose outside normale has minimal angle with the given vector.
11662         #  @param theBlock Block or a compound of blocks.
11663         #  @param theVector Vector, close to the normale of the desired face.
11664         #  @param theName Object name; when specified, this parameter is used
11665         #         for result publication in the study. Otherwise, if automatic
11666         #         publication is switched on, default value is used for result name.
11667         #
11668         #  @return New GEOM.GEOM_Object, containing the found face.
11669         #
11670         #  @ref swig_todo "Example"
11671         @ManageTransactions("BlocksOp")
11672         def GetFaceByNormale(self, theBlock, theVector, theName=None):
11673             """
11674             Find a face of block, whose outside normale has minimal angle with the given vector.
11675
11676             Parameters:
11677                 theBlock Block or a compound of blocks.
11678                 theVector Vector, close to the normale of the desired face.
11679                 theName Object name; when specified, this parameter is used
11680                         for result publication in the study. Otherwise, if automatic
11681                         publication is switched on, default value is used for result name.
11682
11683             Returns:
11684                 New GEOM.GEOM_Object, containing the found face.
11685             """
11686             # Example: see GEOM_Spanner.py
11687             anObj = self.BlocksOp.GetFaceByNormale(theBlock, theVector)
11688             RaiseIfFailed("GetFaceByNormale", self.BlocksOp)
11689             self._autoPublish(anObj, theName, "face")
11690             return anObj
11691
11692         ## Find all sub-shapes of type \a theShapeType of the given shape,
11693         #  which have minimal distance to the given point.
11694         #  @param theShape Any shape.
11695         #  @param thePoint Point, close to the desired shape.
11696         #  @param theShapeType Defines what kind of sub-shapes is searched GEOM::shape_type
11697         #  @param theTolerance The tolerance for distances comparison. All shapes
11698         #                      with distances to the given point in interval
11699         #                      [minimal_distance, minimal_distance + theTolerance] will be gathered.
11700         #  @param theName Object name; when specified, this parameter is used
11701         #         for result publication in the study. Otherwise, if automatic
11702         #         publication is switched on, default value is used for result name.
11703         #
11704         #  @return New GEOM_Object, containing a group of all found shapes.
11705         #
11706         #  @ref swig_GetShapesNearPoint "Example"
11707         @ManageTransactions("BlocksOp")
11708         def GetShapesNearPoint(self, theShape, thePoint, theShapeType, theTolerance = 1e-07, theName=None):
11709             """
11710             Find all sub-shapes of type theShapeType of the given shape,
11711             which have minimal distance to the given point.
11712
11713             Parameters:
11714                 theShape Any shape.
11715                 thePoint Point, close to the desired shape.
11716                 theShapeType Defines what kind of sub-shapes is searched (see GEOM::shape_type)
11717                 theTolerance The tolerance for distances comparison. All shapes
11718                                 with distances to the given point in interval
11719                                 [minimal_distance, minimal_distance + theTolerance] will be gathered.
11720                 theName Object name; when specified, this parameter is used
11721                         for result publication in the study. Otherwise, if automatic
11722                         publication is switched on, default value is used for result name.
11723
11724             Returns:
11725                 New GEOM_Object, containing a group of all found shapes.
11726             """
11727             # Example: see GEOM_TestOthers.py
11728             anObj = self.BlocksOp.GetShapesNearPoint(theShape, thePoint, theShapeType, theTolerance)
11729             RaiseIfFailed("GetShapesNearPoint", self.BlocksOp)
11730             self._autoPublish(anObj, theName, "group")
11731             return anObj
11732
11733         # end of l3_blocks_op
11734         ## @}
11735
11736         ## @addtogroup l4_blocks_measure
11737         ## @{
11738
11739         ## Check, if the compound of blocks is given.
11740         #  To be considered as a compound of blocks, the
11741         #  given shape must satisfy the following conditions:
11742         #  - Each element of the compound should be a Block (6 faces and 12 edges).
11743         #  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
11744         #  - The compound should be connexe.
11745         #  - The glue between two quadrangle faces should be applied.
11746         #  @param theCompound The compound to check.
11747         #  @return TRUE, if the given shape is a compound of blocks.
11748         #  If theCompound is not valid, prints all discovered errors.
11749         #
11750         #  @ref tui_check_compound_of_blocks_page "Example 1"
11751         #  \n @ref swig_CheckCompoundOfBlocks "Example 2"
11752         @ManageTransactions("BlocksOp")
11753         def CheckCompoundOfBlocks(self,theCompound):
11754             """
11755             Check, if the compound of blocks is given.
11756             To be considered as a compound of blocks, the
11757             given shape must satisfy the following conditions:
11758             - Each element of the compound should be a Block (6 faces and 12 edges).
11759             - A connection between two Blocks should be an entire quadrangle face or an entire edge.
11760             - The compound should be connexe.
11761             - The glue between two quadrangle faces should be applied.
11762
11763             Parameters:
11764                 theCompound The compound to check.
11765
11766             Returns:
11767                 TRUE, if the given shape is a compound of blocks.
11768                 If theCompound is not valid, prints all discovered errors.
11769             """
11770             # Example: see GEOM_Spanner.py
11771             (IsValid, BCErrors) = self.BlocksOp.CheckCompoundOfBlocks(theCompound)
11772             RaiseIfFailed("CheckCompoundOfBlocks", self.BlocksOp)
11773             if IsValid == 0:
11774                 Descr = self.BlocksOp.PrintBCErrors(theCompound, BCErrors)
11775                 print Descr
11776             return IsValid
11777
11778         ## Retrieve all non blocks solids and faces from \a theShape.
11779         #  @param theShape The shape to explore.
11780         #  @param theName Object name; when specified, this parameter is used
11781         #         for result publication in the study. Otherwise, if automatic
11782         #         publication is switched on, default value is used for result name.
11783         #
11784         #  @return A tuple of two GEOM_Objects. The first object is a group of all
11785         #          non block solids (= not 6 faces, or with 6 faces, but with the
11786         #          presence of non-quadrangular faces). The second object is a
11787         #          group of all non quadrangular faces.
11788         #
11789         #  @ref tui_get_non_blocks_page "Example 1"
11790         #  \n @ref swig_GetNonBlocks "Example 2"
11791         @ManageTransactions("BlocksOp")
11792         def GetNonBlocks (self, theShape, theName=None):
11793             """
11794             Retrieve all non blocks solids and faces from theShape.
11795
11796             Parameters:
11797                 theShape The shape to explore.
11798                 theName Object name; when specified, this parameter is used
11799                         for result publication in the study. Otherwise, if automatic
11800                         publication is switched on, default value is used for result name.
11801
11802             Returns:
11803                 A tuple of two GEOM_Objects. The first object is a group of all
11804                 non block solids (= not 6 faces, or with 6 faces, but with the
11805                 presence of non-quadrangular faces). The second object is a
11806                 group of all non quadrangular faces.
11807
11808             Usage:
11809                 (res_sols, res_faces) = geompy.GetNonBlocks(myShape1)
11810             """
11811             # Example: see GEOM_Spanner.py
11812             aTuple = self.BlocksOp.GetNonBlocks(theShape)
11813             RaiseIfFailed("GetNonBlocks", self.BlocksOp)
11814             self._autoPublish(aTuple, theName, ("groupNonHexas", "groupNonQuads"))
11815             return aTuple
11816
11817         ## Remove all seam and degenerated edges from \a theShape.
11818         #  Unite faces and edges, sharing one surface. It means that
11819         #  this faces must have references to one C++ surface object (handle).
11820         #  @param theShape The compound or single solid to remove irregular edges from.
11821         #  @param doUnionFaces If True, then unite faces. If False (the default value),
11822         #         do not unite faces.
11823         #  @param theName Object name; when specified, this parameter is used
11824         #         for result publication in the study. Otherwise, if automatic
11825         #         publication is switched on, default value is used for result name.
11826         #
11827         #  @return Improved shape.
11828         #
11829         #  @ref swig_RemoveExtraEdges "Example"
11830         @ManageTransactions("BlocksOp")
11831         def RemoveExtraEdges(self, theShape, doUnionFaces=False, theName=None):
11832             """
11833             Remove all seam and degenerated edges from theShape.
11834             Unite faces and edges, sharing one surface. It means that
11835             this faces must have references to one C++ surface object (handle).
11836
11837             Parameters:
11838                 theShape The compound or single solid to remove irregular edges from.
11839                 doUnionFaces If True, then unite faces. If False (the default value),
11840                              do not unite faces.
11841                 theName Object name; when specified, this parameter is used
11842                         for result publication in the study. Otherwise, if automatic
11843                         publication is switched on, default value is used for result name.
11844
11845             Returns:
11846                 Improved shape.
11847             """
11848             # Example: see GEOM_TestOthers.py
11849             nbFacesOptimum = -1 # -1 means do not unite faces
11850             if doUnionFaces is True: nbFacesOptimum = 0 # 0 means unite faces
11851             anObj = self.BlocksOp.RemoveExtraEdges(theShape, nbFacesOptimum)
11852             RaiseIfFailed("RemoveExtraEdges", self.BlocksOp)
11853             self._autoPublish(anObj, theName, "removeExtraEdges")
11854             return anObj
11855
11856         ## Performs union faces of \a theShape
11857         #  Unite faces sharing one surface. It means that
11858         #  these faces must have references to one C++ surface object (handle).
11859         #  @param theShape The compound or single solid that contains faces
11860         #         to perform union.
11861         #  @param theName Object name; when specified, this parameter is used
11862         #         for result publication in the study. Otherwise, if automatic
11863         #         publication is switched on, default value is used for result name.
11864         #
11865         #  @return Improved shape.
11866         #
11867         #  @ref swig_UnionFaces "Example"
11868         @ManageTransactions("BlocksOp")
11869         def UnionFaces(self, theShape, theName=None):
11870             """
11871             Performs union faces of theShape.
11872             Unite faces sharing one surface. It means that
11873             these faces must have references to one C++ surface object (handle).
11874
11875             Parameters:
11876                 theShape The compound or single solid that contains faces
11877                          to perform union.
11878                 theName Object name; when specified, this parameter is used
11879                         for result publication in the study. Otherwise, if automatic
11880                         publication is switched on, default value is used for result name.
11881
11882             Returns:
11883                 Improved shape.
11884             """
11885             # Example: see GEOM_TestOthers.py
11886             anObj = self.BlocksOp.UnionFaces(theShape)
11887             RaiseIfFailed("UnionFaces", self.BlocksOp)
11888             self._autoPublish(anObj, theName, "unionFaces")
11889             return anObj
11890
11891         ## Check, if the given shape is a blocks compound.
11892         #  Fix all detected errors.
11893         #    \note Single block can be also fixed by this method.
11894         #  @param theShape The compound to check and improve.
11895         #  @param theName Object name; when specified, this parameter is used
11896         #         for result publication in the study. Otherwise, if automatic
11897         #         publication is switched on, default value is used for result name.
11898         #
11899         #  @return Improved compound.
11900         #
11901         #  @ref swig_CheckAndImprove "Example"
11902         @ManageTransactions("BlocksOp")
11903         def CheckAndImprove(self, theShape, theName=None):
11904             """
11905             Check, if the given shape is a blocks compound.
11906             Fix all detected errors.
11907
11908             Note:
11909                 Single block can be also fixed by this method.
11910
11911             Parameters:
11912                 theShape The compound to check and improve.
11913                 theName Object name; when specified, this parameter is used
11914                         for result publication in the study. Otherwise, if automatic
11915                         publication is switched on, default value is used for result name.
11916
11917             Returns:
11918                 Improved compound.
11919             """
11920             # Example: see GEOM_TestOthers.py
11921             anObj = self.BlocksOp.CheckAndImprove(theShape)
11922             RaiseIfFailed("CheckAndImprove", self.BlocksOp)
11923             self._autoPublish(anObj, theName, "improved")
11924             return anObj
11925
11926         # end of l4_blocks_measure
11927         ## @}
11928
11929         ## @addtogroup l3_blocks_op
11930         ## @{
11931
11932         ## Get all the blocks, contained in the given compound.
11933         #  @param theCompound The compound to explode.
11934         #  @param theMinNbFaces If solid has lower number of faces, it is not a block.
11935         #  @param theMaxNbFaces If solid has higher number of faces, it is not a block.
11936         #  @param theName Object name; when specified, this parameter is used
11937         #         for result publication in the study. Otherwise, if automatic
11938         #         publication is switched on, default value is used for result name.
11939         #
11940         #  @note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
11941         #
11942         #  @return List of GEOM.GEOM_Object, containing the retrieved blocks.
11943         #
11944         #  @ref tui_explode_on_blocks "Example 1"
11945         #  \n @ref swig_MakeBlockExplode "Example 2"
11946         @ManageTransactions("BlocksOp")
11947         def MakeBlockExplode(self, theCompound, theMinNbFaces, theMaxNbFaces, theName=None):
11948             """
11949             Get all the blocks, contained in the given compound.
11950
11951             Parameters:
11952                 theCompound The compound to explode.
11953                 theMinNbFaces If solid has lower number of faces, it is not a block.
11954                 theMaxNbFaces If solid has higher number of faces, it is not a block.
11955                 theName Object name; when specified, this parameter is used
11956                         for result publication in the study. Otherwise, if automatic
11957                         publication is switched on, default value is used for result name.
11958
11959             Note:
11960                 If theMaxNbFaces = 0, the maximum number of faces is not restricted.
11961
11962             Returns:
11963                 List of GEOM.GEOM_Object, containing the retrieved blocks.
11964             """
11965             # Example: see GEOM_TestOthers.py
11966             theMinNbFaces,theMaxNbFaces,Parameters = ParseParameters(theMinNbFaces,theMaxNbFaces)
11967             aList = self.BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
11968             RaiseIfFailed("ExplodeCompoundOfBlocks", self.BlocksOp)
11969             for anObj in aList:
11970                 anObj.SetParameters(Parameters)
11971                 pass
11972             self._autoPublish(aList, theName, "block")
11973             return aList
11974
11975         ## Find block, containing the given point inside its volume or on boundary.
11976         #  @param theCompound Compound, to find block in.
11977         #  @param thePoint Point, close to the desired block. If the point lays on
11978         #         boundary between some blocks, we return block with nearest center.
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 block.
11984         #
11985         #  @ref swig_todo "Example"
11986         @ManageTransactions("BlocksOp")
11987         def GetBlockNearPoint(self, theCompound, thePoint, theName=None):
11988             """
11989             Find block, containing the given point inside its volume or on boundary.
11990
11991             Parameters:
11992                 theCompound Compound, to find block in.
11993                 thePoint Point, close to the desired block. If the point lays on
11994                          boundary between some blocks, we return block with nearest center.
11995                 theName Object name; when specified, this parameter is used
11996                         for result publication in the study. Otherwise, if automatic
11997                         publication is switched on, default value is used for result name.
11998
11999             Returns:
12000                 New GEOM.GEOM_Object, containing the found block.
12001             """
12002             # Example: see GEOM_Spanner.py
12003             anObj = self.BlocksOp.GetBlockNearPoint(theCompound, thePoint)
12004             RaiseIfFailed("GetBlockNearPoint", self.BlocksOp)
12005             self._autoPublish(anObj, theName, "block")
12006             return anObj
12007
12008         ## Find block, containing all the elements, passed as the parts, or maximum quantity of them.
12009         #  @param theCompound Compound, to find block in.
12010         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found block.
12011         #  @param theName Object name; when specified, this parameter is used
12012         #         for result publication in the study. Otherwise, if automatic
12013         #         publication is switched on, default value is used for result name.
12014         #
12015         #  @return New GEOM.GEOM_Object, containing the found block.
12016         #
12017         #  @ref swig_GetBlockByParts "Example"
12018         @ManageTransactions("BlocksOp")
12019         def GetBlockByParts(self, theCompound, theParts, theName=None):
12020             """
12021              Find block, containing all the elements, passed as the parts, or maximum quantity of them.
12022
12023              Parameters:
12024                 theCompound Compound, to find block in.
12025                 theParts List of faces and/or edges and/or vertices to be parts of the found block.
12026                 theName Object name; when specified, this parameter is used
12027                         for result publication in the study. Otherwise, if automatic
12028                         publication is switched on, default value is used for result name.
12029
12030             Returns:
12031                 New GEOM_Object, containing the found block.
12032             """
12033             # Example: see GEOM_TestOthers.py
12034             anObj = self.BlocksOp.GetBlockByParts(theCompound, theParts)
12035             RaiseIfFailed("GetBlockByParts", self.BlocksOp)
12036             self._autoPublish(anObj, theName, "block")
12037             return anObj
12038
12039         ## Return all blocks, containing all the elements, passed as the parts.
12040         #  @param theCompound Compound, to find blocks in.
12041         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
12042         #  @param theName Object name; when specified, this parameter is used
12043         #         for result publication in the study. Otherwise, if automatic
12044         #         publication is switched on, default value is used for result name.
12045         #
12046         #  @return List of GEOM.GEOM_Object, containing the found blocks.
12047         #
12048         #  @ref swig_todo "Example"
12049         @ManageTransactions("BlocksOp")
12050         def GetBlocksByParts(self, theCompound, theParts, theName=None):
12051             """
12052             Return all blocks, containing all the elements, passed as the parts.
12053
12054             Parameters:
12055                 theCompound Compound, to find blocks in.
12056                 theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
12057                 theName Object name; when specified, this parameter is used
12058                         for result publication in the study. Otherwise, if automatic
12059                         publication is switched on, default value is used for result name.
12060
12061             Returns:
12062                 List of GEOM.GEOM_Object, containing the found blocks.
12063             """
12064             # Example: see GEOM_Spanner.py
12065             aList = self.BlocksOp.GetBlocksByParts(theCompound, theParts)
12066             RaiseIfFailed("GetBlocksByParts", self.BlocksOp)
12067             self._autoPublish(aList, theName, "block")
12068             return aList
12069
12070         ## Multi-transformate block and glue the result.
12071         #  Transformation is defined so, as to superpose direction faces.
12072         #  @param Block Hexahedral solid to be multi-transformed.
12073         #  @param DirFace1 ID of First direction face.
12074         #  @param DirFace2 ID of Second direction face.
12075         #  @param NbTimes Quantity of transformations to be done.
12076         #  @param theName Object name; when specified, this parameter is used
12077         #         for result publication in the study. Otherwise, if automatic
12078         #         publication is switched on, default value is used for result name.
12079         #
12080         #  @note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
12081         #
12082         #  @return New GEOM.GEOM_Object, containing the result shape.
12083         #
12084         #  @ref tui_multi_transformation "Example"
12085         @ManageTransactions("BlocksOp")
12086         def MakeMultiTransformation1D(self, Block, DirFace1, DirFace2, NbTimes, theName=None):
12087             """
12088             Multi-transformate block and glue the result.
12089             Transformation is defined so, as to superpose direction faces.
12090
12091             Parameters:
12092                 Block Hexahedral solid to be multi-transformed.
12093                 DirFace1 ID of First direction face.
12094                 DirFace2 ID of Second direction face.
12095                 NbTimes Quantity of transformations to be done.
12096                 theName Object name; when specified, this parameter is used
12097                         for result publication in the study. Otherwise, if automatic
12098                         publication is switched on, default value is used for result name.
12099
12100             Note:
12101                 Unique ID of sub-shape can be obtained, using method GetSubShapeID().
12102
12103             Returns:
12104                 New GEOM.GEOM_Object, containing the result shape.
12105             """
12106             # Example: see GEOM_Spanner.py
12107             DirFace1,DirFace2,NbTimes,Parameters = ParseParameters(DirFace1,DirFace2,NbTimes)
12108             anObj = self.BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
12109             RaiseIfFailed("MakeMultiTransformation1D", self.BlocksOp)
12110             anObj.SetParameters(Parameters)
12111             self._autoPublish(anObj, theName, "transformed")
12112             return anObj
12113
12114         ## Multi-transformate block and glue the result.
12115         #  @param Block Hexahedral solid to be multi-transformed.
12116         #  @param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
12117         #  @param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
12118         #  @param NbTimesU,NbTimesV Quantity of transformations to be done.
12119         #  @param theName Object name; when specified, this parameter is used
12120         #         for result publication in the study. Otherwise, if automatic
12121         #         publication is switched on, default value is used for result name.
12122         #
12123         #  @return New GEOM.GEOM_Object, containing the result shape.
12124         #
12125         #  @ref tui_multi_transformation "Example"
12126         @ManageTransactions("BlocksOp")
12127         def MakeMultiTransformation2D(self, Block, DirFace1U, DirFace2U, NbTimesU,
12128                                       DirFace1V, DirFace2V, NbTimesV, theName=None):
12129             """
12130             Multi-transformate block and glue the result.
12131
12132             Parameters:
12133                 Block Hexahedral solid to be multi-transformed.
12134                 DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
12135                 DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
12136                 NbTimesU,NbTimesV Quantity of transformations to be done.
12137                 theName Object name; when specified, this parameter is used
12138                         for result publication in the study. Otherwise, if automatic
12139                         publication is switched on, default value is used for result name.
12140
12141             Returns:
12142                 New GEOM.GEOM_Object, containing the result shape.
12143             """
12144             # Example: see GEOM_Spanner.py
12145             DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV,Parameters = ParseParameters(
12146               DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV)
12147             anObj = self.BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
12148                                                             DirFace1V, DirFace2V, NbTimesV)
12149             RaiseIfFailed("MakeMultiTransformation2D", self.BlocksOp)
12150             anObj.SetParameters(Parameters)
12151             self._autoPublish(anObj, theName, "transformed")
12152             return anObj
12153
12154         ## Build all possible propagation groups.
12155         #  Propagation group is a set of all edges, opposite to one (main)
12156         #  edge of this group directly or through other opposite edges.
12157         #  Notion of Opposite Edge make sence only on quadrangle face.
12158         #  @param theShape Shape to build propagation groups on.
12159         #  @param theName Object name; when specified, this parameter is used
12160         #         for result publication in the study. Otherwise, if automatic
12161         #         publication is switched on, default value is used for result name.
12162         #
12163         #  @return List of GEOM.GEOM_Object, each of them is a propagation group.
12164         #
12165         #  @ref swig_Propagate "Example"
12166         @ManageTransactions("BlocksOp")
12167         def Propagate(self, theShape, theName=None):
12168             """
12169             Build all possible propagation groups.
12170             Propagation group is a set of all edges, opposite to one (main)
12171             edge of this group directly or through other opposite edges.
12172             Notion of Opposite Edge make sence only on quadrangle face.
12173
12174             Parameters:
12175                 theShape Shape to build propagation groups on.
12176                 theName Object name; when specified, this parameter is used
12177                         for result publication in the study. Otherwise, if automatic
12178                         publication is switched on, default value is used for result name.
12179
12180             Returns:
12181                 List of GEOM.GEOM_Object, each of them is a propagation group.
12182             """
12183             # Example: see GEOM_TestOthers.py
12184             listChains = self.BlocksOp.Propagate(theShape)
12185             RaiseIfFailed("Propagate", self.BlocksOp)
12186             self._autoPublish(listChains, theName, "propagate")
12187             return listChains
12188
12189         # end of l3_blocks_op
12190         ## @}
12191
12192         ## @addtogroup l3_groups
12193         ## @{
12194
12195         ## Creates a new group which will store sub-shapes of theMainShape
12196         #  @param theMainShape is a GEOM object on which the group is selected
12197         #  @param theShapeType defines a shape type of the group (see GEOM::shape_type)
12198         #  @param theName Object name; when specified, this parameter is used
12199         #         for result publication in the study. Otherwise, if automatic
12200         #         publication is switched on, default value is used for result name.
12201         #
12202         #  @return a newly created GEOM group (GEOM.GEOM_Object)
12203         #
12204         #  @ref tui_working_with_groups_page "Example 1"
12205         #  \n @ref swig_CreateGroup "Example 2"
12206         @ManageTransactions("GroupOp")
12207         def CreateGroup(self, theMainShape, theShapeType, theName=None):
12208             """
12209             Creates a new group which will store sub-shapes of theMainShape
12210
12211             Parameters:
12212                theMainShape is a GEOM object on which the group is selected
12213                theShapeType defines a shape type of the group:"COMPOUND", "COMPSOLID",
12214                             "SOLID", "SHELL", "FACE", "WIRE", "EDGE", "VERTEX", "SHAPE".
12215                 theName Object name; when specified, this parameter is used
12216                         for result publication in the study. Otherwise, if automatic
12217                         publication is switched on, default value is used for result name.
12218
12219             Returns:
12220                a newly created GEOM group
12221
12222             Example of usage:
12223                 group = geompy.CreateGroup(Box, geompy.ShapeType["FACE"])
12224
12225             """
12226             # Example: see GEOM_TestOthers.py
12227             anObj = self.GroupOp.CreateGroup(theMainShape, theShapeType)
12228             RaiseIfFailed("CreateGroup", self.GroupOp)
12229             self._autoPublish(anObj, theName, "group")
12230             return anObj
12231
12232         ## Adds a sub-object with ID theSubShapeId to the group
12233         #  @param theGroup is a GEOM group to which the new sub-shape is added
12234         #  @param theSubShapeID is a sub-shape ID in the main object.
12235         #  \note Use method GetSubShapeID() to get an unique ID of the sub-shape
12236         #
12237         #  @ref tui_working_with_groups_page "Example"
12238         @ManageTransactions("GroupOp")
12239         def AddObject(self,theGroup, theSubShapeID):
12240             """
12241             Adds a sub-object with ID theSubShapeId to the group
12242
12243             Parameters:
12244                 theGroup       is a GEOM group to which the new sub-shape is added
12245                 theSubShapeID  is a sub-shape ID in the main object.
12246
12247             Note:
12248                 Use method GetSubShapeID() to get an unique ID of the sub-shape
12249             """
12250             # Example: see GEOM_TestOthers.py
12251             self.GroupOp.AddObject(theGroup, theSubShapeID)
12252             if self.GroupOp.GetErrorCode() != "PAL_ELEMENT_ALREADY_PRESENT":
12253                 RaiseIfFailed("AddObject", self.GroupOp)
12254                 pass
12255             pass
12256
12257         ## Removes a sub-object with ID \a theSubShapeId from the group
12258         #  @param theGroup is a GEOM group from which the new sub-shape is removed
12259         #  @param theSubShapeID is a sub-shape ID in the main object.
12260         #  \note Use method GetSubShapeID() to get an unique ID of the sub-shape
12261         #
12262         #  @ref tui_working_with_groups_page "Example"
12263         @ManageTransactions("GroupOp")
12264         def RemoveObject(self,theGroup, theSubShapeID):
12265             """
12266             Removes a sub-object with ID theSubShapeId from the group
12267
12268             Parameters:
12269                 theGroup is a GEOM group from which the new sub-shape is removed
12270                 theSubShapeID is a sub-shape ID in the main object.
12271
12272             Note:
12273                 Use method GetSubShapeID() to get an unique ID of the sub-shape
12274             """
12275             # Example: see GEOM_TestOthers.py
12276             self.GroupOp.RemoveObject(theGroup, theSubShapeID)
12277             RaiseIfFailed("RemoveObject", self.GroupOp)
12278             pass
12279
12280         ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12281         #  @param theGroup is a GEOM group to which the new sub-shapes are added.
12282         #  @param theSubShapes is a list of sub-shapes to be added.
12283         #
12284         #  @ref tui_working_with_groups_page "Example"
12285         @ManageTransactions("GroupOp")
12286         def UnionList (self,theGroup, theSubShapes):
12287             """
12288             Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12289
12290             Parameters:
12291                 theGroup is a GEOM group to which the new sub-shapes are added.
12292                 theSubShapes is a list of sub-shapes to be added.
12293             """
12294             # Example: see GEOM_TestOthers.py
12295             self.GroupOp.UnionList(theGroup, theSubShapes)
12296             RaiseIfFailed("UnionList", self.GroupOp)
12297             pass
12298
12299         ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12300         #  @param theGroup is a GEOM group to which the new sub-shapes are added.
12301         #  @param theSubShapes is a list of indices of sub-shapes to be added.
12302         #
12303         #  @ref swig_UnionIDs "Example"
12304         @ManageTransactions("GroupOp")
12305         def UnionIDs(self,theGroup, theSubShapes):
12306             """
12307             Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12308
12309             Parameters:
12310                 theGroup is a GEOM group to which the new sub-shapes are added.
12311                 theSubShapes is a list of indices of sub-shapes to be added.
12312             """
12313             # Example: see GEOM_TestOthers.py
12314             self.GroupOp.UnionIDs(theGroup, theSubShapes)
12315             RaiseIfFailed("UnionIDs", self.GroupOp)
12316             pass
12317
12318         ## Removes from the group all the given shapes. No errors, if some shapes are not included.
12319         #  @param theGroup is a GEOM group from which the sub-shapes are removed.
12320         #  @param theSubShapes is a list of sub-shapes to be removed.
12321         #
12322         #  @ref tui_working_with_groups_page "Example"
12323         @ManageTransactions("GroupOp")
12324         def DifferenceList (self,theGroup, theSubShapes):
12325             """
12326             Removes from the group all the given shapes. No errors, if some shapes are not included.
12327
12328             Parameters:
12329                 theGroup is a GEOM group from which the sub-shapes are removed.
12330                 theSubShapes is a list of sub-shapes to be removed.
12331             """
12332             # Example: see GEOM_TestOthers.py
12333             self.GroupOp.DifferenceList(theGroup, theSubShapes)
12334             RaiseIfFailed("DifferenceList", self.GroupOp)
12335             pass
12336
12337         ## Removes from the group all the given shapes. No errors, if some shapes are not included.
12338         #  @param theGroup is a GEOM group from which the sub-shapes are removed.
12339         #  @param theSubShapes is a list of indices of sub-shapes to be removed.
12340         #
12341         #  @ref swig_DifferenceIDs "Example"
12342         @ManageTransactions("GroupOp")
12343         def DifferenceIDs(self,theGroup, theSubShapes):
12344             """
12345             Removes from the group all the given shapes. No errors, if some shapes are not included.
12346
12347             Parameters:
12348                 theGroup is a GEOM group from which the sub-shapes are removed.
12349                 theSubShapes is a list of indices of sub-shapes to be removed.
12350             """
12351             # Example: see GEOM_TestOthers.py
12352             self.GroupOp.DifferenceIDs(theGroup, theSubShapes)
12353             RaiseIfFailed("DifferenceIDs", self.GroupOp)
12354             pass
12355
12356         ## Union of two groups.
12357         #  New group is created. It will contain all entities
12358         #  which are present in groups theGroup1 and theGroup2.
12359         #  @param theGroup1, theGroup2 are the initial GEOM groups
12360         #                              to create the united group from.
12361         #  @param theName Object name; when specified, this parameter is used
12362         #         for result publication in the study. Otherwise, if automatic
12363         #         publication is switched on, default value is used for result name.
12364         #
12365         #  @return a newly created GEOM group.
12366         #
12367         #  @ref tui_union_groups_anchor "Example"
12368         @ManageTransactions("GroupOp")
12369         def UnionGroups (self, theGroup1, theGroup2, theName=None):
12370             """
12371             Union of two groups.
12372             New group is created. It will contain all entities
12373             which are present in groups theGroup1 and theGroup2.
12374
12375             Parameters:
12376                 theGroup1, theGroup2 are the initial GEOM groups
12377                                      to create the united group from.
12378                 theName Object name; when specified, this parameter is used
12379                         for result publication in the study. Otherwise, if automatic
12380                         publication is switched on, default value is used for result name.
12381
12382             Returns:
12383                 a newly created GEOM group.
12384             """
12385             # Example: see GEOM_TestOthers.py
12386             aGroup = self.GroupOp.UnionGroups(theGroup1, theGroup2)
12387             RaiseIfFailed("UnionGroups", self.GroupOp)
12388             self._autoPublish(aGroup, theName, "group")
12389             return aGroup
12390
12391         ## Intersection of two groups.
12392         #  New group is created. It will contain only those entities
12393         #  which are present in both groups theGroup1 and theGroup2.
12394         #  @param theGroup1, theGroup2 are the initial GEOM groups to get common part of.
12395         #  @param theName Object name; when specified, this parameter is used
12396         #         for result publication in the study. Otherwise, if automatic
12397         #         publication is switched on, default value is used for result name.
12398         #
12399         #  @return a newly created GEOM group.
12400         #
12401         #  @ref tui_intersect_groups_anchor "Example"
12402         @ManageTransactions("GroupOp")
12403         def IntersectGroups (self, theGroup1, theGroup2, theName=None):
12404             """
12405             Intersection of two groups.
12406             New group is created. It will contain only those entities
12407             which are present in both groups theGroup1 and theGroup2.
12408
12409             Parameters:
12410                 theGroup1, theGroup2 are the initial GEOM groups to get common part of.
12411                 theName Object name; when specified, this parameter is used
12412                         for result publication in the study. Otherwise, if automatic
12413                         publication is switched on, default value is used for result name.
12414
12415             Returns:
12416                 a newly created GEOM group.
12417             """
12418             # Example: see GEOM_TestOthers.py
12419             aGroup = self.GroupOp.IntersectGroups(theGroup1, theGroup2)
12420             RaiseIfFailed("IntersectGroups", self.GroupOp)
12421             self._autoPublish(aGroup, theName, "group")
12422             return aGroup
12423
12424         ## Cut of two groups.
12425         #  New group is created. It will contain entities which are
12426         #  present in group theGroup1 but are not present in group theGroup2.
12427         #  @param theGroup1 is a GEOM group to include elements of.
12428         #  @param theGroup2 is a GEOM group to exclude elements of.
12429         #  @param theName Object name; when specified, this parameter is used
12430         #         for result publication in the study. Otherwise, if automatic
12431         #         publication is switched on, default value is used for result name.
12432         #
12433         #  @return a newly created GEOM group.
12434         #
12435         #  @ref tui_cut_groups_anchor "Example"
12436         @ManageTransactions("GroupOp")
12437         def CutGroups (self, theGroup1, theGroup2, theName=None):
12438             """
12439             Cut of two groups.
12440             New group is created. It will contain entities which are
12441             present in group theGroup1 but are not present in group theGroup2.
12442
12443             Parameters:
12444                 theGroup1 is a GEOM group to include elements of.
12445                 theGroup2 is a GEOM group to exclude elements of.
12446                 theName Object name; when specified, this parameter is used
12447                         for result publication in the study. Otherwise, if automatic
12448                         publication is switched on, default value is used for result name.
12449
12450             Returns:
12451                 a newly created GEOM group.
12452             """
12453             # Example: see GEOM_TestOthers.py
12454             aGroup = self.GroupOp.CutGroups(theGroup1, theGroup2)
12455             RaiseIfFailed("CutGroups", self.GroupOp)
12456             self._autoPublish(aGroup, theName, "group")
12457             return aGroup
12458
12459         ## Union of list of groups.
12460         #  New group is created. It will contain all entities that are
12461         #  present in groups listed in theGList.
12462         #  @param theGList is a list of GEOM groups to create the united group from.
12463         #  @param theName Object name; when specified, this parameter is used
12464         #         for result publication in the study. Otherwise, if automatic
12465         #         publication is switched on, default value is used for result name.
12466         #
12467         #  @return a newly created GEOM group.
12468         #
12469         #  @ref tui_union_groups_anchor "Example"
12470         @ManageTransactions("GroupOp")
12471         def UnionListOfGroups (self, theGList, theName=None):
12472             """
12473             Union of list of groups.
12474             New group is created. It will contain all entities that are
12475             present in groups listed in theGList.
12476
12477             Parameters:
12478                 theGList is a list of GEOM groups to create the united group from.
12479                 theName Object name; when specified, this parameter is used
12480                         for result publication in the study. Otherwise, if automatic
12481                         publication is switched on, default value is used for result name.
12482
12483             Returns:
12484                 a newly created GEOM group.
12485             """
12486             # Example: see GEOM_TestOthers.py
12487             aGroup = self.GroupOp.UnionListOfGroups(theGList)
12488             RaiseIfFailed("UnionListOfGroups", self.GroupOp)
12489             self._autoPublish(aGroup, theName, "group")
12490             return aGroup
12491
12492         ## Cut of lists of groups.
12493         #  New group is created. It will contain only entities
12494         #  which are present in groups listed in theGList.
12495         #  @param theGList is a list of GEOM groups to include elements of.
12496         #  @param theName Object name; when specified, this parameter is used
12497         #         for result publication in the study. Otherwise, if automatic
12498         #         publication is switched on, default value is used for result name.
12499         #
12500         #  @return a newly created GEOM group.
12501         #
12502         #  @ref tui_intersect_groups_anchor "Example"
12503         @ManageTransactions("GroupOp")
12504         def IntersectListOfGroups (self, theGList, theName=None):
12505             """
12506             Cut of lists of groups.
12507             New group is created. It will contain only entities
12508             which are present in groups listed in theGList.
12509
12510             Parameters:
12511                 theGList is a list of GEOM groups to include elements of.
12512                 theName Object name; when specified, this parameter is used
12513                         for result publication in the study. Otherwise, if automatic
12514                         publication is switched on, default value is used for result name.
12515
12516             Returns:
12517                 a newly created GEOM group.
12518             """
12519             # Example: see GEOM_TestOthers.py
12520             aGroup = self.GroupOp.IntersectListOfGroups(theGList)
12521             RaiseIfFailed("IntersectListOfGroups", self.GroupOp)
12522             self._autoPublish(aGroup, theName, "group")
12523             return aGroup
12524
12525         ## Cut of lists of groups.
12526         #  New group is created. It will contain only entities
12527         #  which are present in groups listed in theGList1 but
12528         #  are not present in groups from theGList2.
12529         #  @param theGList1 is a list of GEOM groups to include elements of.
12530         #  @param theGList2 is a list of GEOM groups to exclude elements of.
12531         #  @param theName Object name; when specified, this parameter is used
12532         #         for result publication in the study. Otherwise, if automatic
12533         #         publication is switched on, default value is used for result name.
12534         #
12535         #  @return a newly created GEOM group.
12536         #
12537         #  @ref tui_cut_groups_anchor "Example"
12538         @ManageTransactions("GroupOp")
12539         def CutListOfGroups (self, theGList1, theGList2, theName=None):
12540             """
12541             Cut of lists of groups.
12542             New group is created. It will contain only entities
12543             which are present in groups listed in theGList1 but
12544             are not present in groups from theGList2.
12545
12546             Parameters:
12547                 theGList1 is a list of GEOM groups to include elements of.
12548                 theGList2 is a list of GEOM groups to exclude elements of.
12549                 theName Object name; when specified, this parameter is used
12550                         for result publication in the study. Otherwise, if automatic
12551                         publication is switched on, default value is used for result name.
12552
12553             Returns:
12554                 a newly created GEOM group.
12555             """
12556             # Example: see GEOM_TestOthers.py
12557             aGroup = self.GroupOp.CutListOfGroups(theGList1, theGList2)
12558             RaiseIfFailed("CutListOfGroups", self.GroupOp)
12559             self._autoPublish(aGroup, theName, "group")
12560             return aGroup
12561
12562         ## Returns a list of sub-objects ID stored in the group
12563         #  @param theGroup is a GEOM group for which a list of IDs is requested
12564         #
12565         #  @ref swig_GetObjectIDs "Example"
12566         @ManageTransactions("GroupOp")
12567         def GetObjectIDs(self,theGroup):
12568             """
12569             Returns a list of sub-objects ID stored in the group
12570
12571             Parameters:
12572                 theGroup is a GEOM group for which a list of IDs is requested
12573             """
12574             # Example: see GEOM_TestOthers.py
12575             ListIDs = self.GroupOp.GetObjects(theGroup)
12576             RaiseIfFailed("GetObjects", self.GroupOp)
12577             return ListIDs
12578
12579         ## Returns a type of sub-objects stored in the group
12580         #  @param theGroup is a GEOM group which type is returned.
12581         #
12582         #  @ref swig_GetType "Example"
12583         @ManageTransactions("GroupOp")
12584         def GetType(self,theGroup):
12585             """
12586             Returns a type of sub-objects stored in the group
12587
12588             Parameters:
12589                 theGroup is a GEOM group which type is returned.
12590             """
12591             # Example: see GEOM_TestOthers.py
12592             aType = self.GroupOp.GetType(theGroup)
12593             RaiseIfFailed("GetType", self.GroupOp)
12594             return aType
12595
12596         ## Convert a type of geom object from id to string value
12597         #  @param theId is a GEOM obect type id.
12598         #  @return type of geom object (POINT, VECTOR, PLANE, LINE, TORUS, ... )
12599         #  @ref swig_GetType "Example"
12600         def ShapeIdToType(self, theId):
12601             """
12602             Convert a type of geom object from id to string value
12603
12604             Parameters:
12605                 theId is a GEOM obect type id.
12606
12607             Returns:
12608                 type of geom object (POINT, VECTOR, PLANE, LINE, TORUS, ... )
12609             """
12610             if theId == 0:
12611                 return "COPY"
12612             if theId == 1:
12613                 return "IMPORT"
12614             if theId == 2:
12615                 return "POINT"
12616             if theId == 3:
12617                 return "VECTOR"
12618             if theId == 4:
12619                 return "PLANE"
12620             if theId == 5:
12621                 return "LINE"
12622             if theId == 6:
12623                 return "TORUS"
12624             if theId == 7:
12625                 return "BOX"
12626             if theId == 8:
12627                 return "CYLINDER"
12628             if theId == 9:
12629                 return "CONE"
12630             if theId == 10:
12631                 return "SPHERE"
12632             if theId == 11:
12633                 return "PRISM"
12634             if theId == 12:
12635                 return "REVOLUTION"
12636             if theId == 13:
12637                 return "BOOLEAN"
12638             if theId == 14:
12639                 return "PARTITION"
12640             if theId == 15:
12641                 return "POLYLINE"
12642             if theId == 16:
12643                 return "CIRCLE"
12644             if theId == 17:
12645                 return "SPLINE"
12646             if theId == 18:
12647                 return "ELLIPSE"
12648             if theId == 19:
12649                 return "CIRC_ARC"
12650             if theId == 20:
12651                 return "FILLET"
12652             if theId == 21:
12653                 return "CHAMFER"
12654             if theId == 22:
12655                 return "EDGE"
12656             if theId == 23:
12657                 return "WIRE"
12658             if theId == 24:
12659                 return "FACE"
12660             if theId == 25:
12661                 return "SHELL"
12662             if theId == 26:
12663                 return "SOLID"
12664             if theId == 27:
12665                 return "COMPOUND"
12666             if theId == 28:
12667                 return "SUBSHAPE"
12668             if theId == 29:
12669                 return "PIPE"
12670             if theId == 30:
12671                 return "ARCHIMEDE"
12672             if theId == 31:
12673                 return "FILLING"
12674             if theId == 32:
12675                 return "EXPLODE"
12676             if theId == 33:
12677                 return "GLUED"
12678             if theId == 34:
12679                 return "SKETCHER"
12680             if theId == 35:
12681                 return "CDG"
12682             if theId == 36:
12683                 return "FREE_BOUNDS"
12684             if theId == 37:
12685                 return "GROUP"
12686             if theId == 38:
12687                 return "BLOCK"
12688             if theId == 39:
12689                 return "MARKER"
12690             if theId == 40:
12691                 return "THRUSECTIONS"
12692             if theId == 41:
12693                 return "COMPOUNDFILTER"
12694             if theId == 42:
12695                 return "SHAPES_ON_SHAPE"
12696             if theId == 43:
12697                 return "ELLIPSE_ARC"
12698             if theId == 44:
12699                 return "3DSKETCHER"
12700             if theId == 45:
12701                 return "FILLET_2D"
12702             if theId == 46:
12703                 return "FILLET_1D"
12704             if theId == 201:
12705                 return "PIPETSHAPE"
12706             return "Shape Id not exist."
12707
12708         ## Returns a main shape associated with the group
12709         #  @param theGroup is a GEOM group for which a main shape object is requested
12710         #  @return a GEOM object which is a main shape for theGroup
12711         #
12712         #  @ref swig_GetMainShape "Example"
12713         @ManageTransactions("GroupOp")
12714         def GetMainShape(self,theGroup):
12715             """
12716             Returns a main shape associated with the group
12717
12718             Parameters:
12719                 theGroup is a GEOM group for which a main shape object is requested
12720
12721             Returns:
12722                 a GEOM object which is a main shape for theGroup
12723
12724             Example of usage: BoxCopy = geompy.GetMainShape(CreateGroup)
12725             """
12726             # Example: see GEOM_TestOthers.py
12727             anObj = self.GroupOp.GetMainShape(theGroup)
12728             RaiseIfFailed("GetMainShape", self.GroupOp)
12729             return anObj
12730
12731         ## Create group of edges of theShape, whose length is in range [min_length, max_length].
12732         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
12733         #  @param theShape given shape (see GEOM.GEOM_Object)
12734         #  @param min_length minimum length of edges of theShape
12735         #  @param max_length maximum length of edges of theShape
12736         #  @param include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12737         #  @param include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12738         #  @param theName Object name; when specified, this parameter is used
12739         #         for result publication in the study. Otherwise, if automatic
12740         #         publication is switched on, default value is used for result name.
12741         #
12742         #  @return a newly created GEOM group of edges
12743         #
12744         #  @@ref swig_todo "Example"
12745         def GetEdgesByLength (self, theShape, min_length, max_length, include_min = 1, include_max = 1, theName=None):
12746             """
12747             Create group of edges of theShape, whose length is in range [min_length, max_length].
12748             If include_min/max == 0, edges with length == min/max_length will not be included in result.
12749
12750             Parameters:
12751                 theShape given shape
12752                 min_length minimum length of edges of theShape
12753                 max_length maximum length of edges of theShape
12754                 include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12755                 include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12756                 theName Object name; when specified, this parameter is used
12757                         for result publication in the study. Otherwise, if automatic
12758                         publication is switched on, default value is used for result name.
12759
12760              Returns:
12761                 a newly created GEOM group of edges.
12762             """
12763             edges = self.SubShapeAll(theShape, self.ShapeType["EDGE"])
12764             edges_in_range = []
12765             for edge in edges:
12766                 Props = self.BasicProperties(edge)
12767                 if min_length <= Props[0] and Props[0] <= max_length:
12768                     if (not include_min) and (min_length == Props[0]):
12769                         skip = 1
12770                     else:
12771                         if (not include_max) and (Props[0] == max_length):
12772                             skip = 1
12773                         else:
12774                             edges_in_range.append(edge)
12775
12776             if len(edges_in_range) <= 0:
12777                 print "No edges found by given criteria"
12778                 return None
12779
12780             # note: auto-publishing is done in self.CreateGroup()
12781             group_edges = self.CreateGroup(theShape, self.ShapeType["EDGE"], theName)
12782             self.UnionList(group_edges, edges_in_range)
12783
12784             return group_edges
12785
12786         ## Create group of edges of selected shape, whose length is in range [min_length, max_length].
12787         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
12788         #  @param min_length minimum length of edges of selected shape
12789         #  @param max_length maximum length of edges of selected shape
12790         #  @param include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12791         #  @param include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12792         #  @return a newly created GEOM group of edges
12793         #  @ref swig_todo "Example"
12794         def SelectEdges (self, min_length, max_length, include_min = 1, include_max = 1):
12795             """
12796             Create group of edges of selected shape, whose length is in range [min_length, max_length].
12797             If include_min/max == 0, edges with length == min/max_length will not be included in result.
12798
12799             Parameters:
12800                 min_length minimum length of edges of selected shape
12801                 max_length maximum length of edges of selected shape
12802                 include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12803                 include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12804
12805              Returns:
12806                 a newly created GEOM group of edges.
12807             """
12808             nb_selected = sg.SelectedCount()
12809             if nb_selected < 1:
12810                 print "Select a shape before calling this function, please."
12811                 return 0
12812             if nb_selected > 1:
12813                 print "Only one shape must be selected"
12814                 return 0
12815
12816             id_shape = sg.getSelected(0)
12817             shape = IDToObject( id_shape )
12818
12819             group_edges = self.GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
12820
12821             left_str  = " < "
12822             right_str = " < "
12823             if include_min: left_str  = " <= "
12824             if include_max: right_str  = " <= "
12825
12826             self.addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
12827                                     + left_str + "length" + right_str + `max_length`)
12828
12829             sg.updateObjBrowser(1)
12830
12831             return group_edges
12832
12833         # end of l3_groups
12834         ## @}
12835
12836         #@@ insert new functions before this line @@ do not remove this line @@#
12837
12838         ## Create a copy of the given object
12839         #
12840         #  @param theOriginal geometry object for copy
12841         #  @param theName Object name; when specified, this parameter is used
12842         #         for result publication in the study. Otherwise, if automatic
12843         #         publication is switched on, default value is used for result name.
12844         #
12845         #  @return New GEOM_Object, containing the copied shape.
12846         #
12847         #  @ingroup l1_geomBuilder_auxiliary
12848         #  @ref swig_MakeCopy "Example"
12849         @ManageTransactions("InsertOp")
12850         def MakeCopy(self, theOriginal, theName=None):
12851             """
12852             Create a copy of the given object
12853
12854             Parameters:
12855                 theOriginal geometry object for copy
12856                 theName Object name; when specified, this parameter is used
12857                         for result publication in the study. Otherwise, if automatic
12858                         publication is switched on, default value is used for result name.
12859
12860             Returns:
12861                 New GEOM_Object, containing the copied shape.
12862
12863             Example of usage: Copy = geompy.MakeCopy(Box)
12864             """
12865             # Example: see GEOM_TestAll.py
12866             anObj = self.InsertOp.MakeCopy(theOriginal)
12867             RaiseIfFailed("MakeCopy", self.InsertOp)
12868             self._autoPublish(anObj, theName, "copy")
12869             return anObj
12870
12871         ## Add Path to load python scripts from
12872         #  @param Path a path to load python scripts from
12873         #  @ingroup l1_geomBuilder_auxiliary
12874         def addPath(self,Path):
12875             """
12876             Add Path to load python scripts from
12877
12878             Parameters:
12879                 Path a path to load python scripts from
12880             """
12881             if (sys.path.count(Path) < 1):
12882                 sys.path.append(Path)
12883                 pass
12884             pass
12885
12886         ## Load marker texture from the file
12887         #  @param Path a path to the texture file
12888         #  @return unique texture identifier
12889         #  @ingroup l1_geomBuilder_auxiliary
12890         @ManageTransactions("InsertOp")
12891         def LoadTexture(self, Path):
12892             """
12893             Load marker texture from the file
12894
12895             Parameters:
12896                 Path a path to the texture file
12897
12898             Returns:
12899                 unique texture identifier
12900             """
12901             # Example: see GEOM_TestAll.py
12902             ID = self.InsertOp.LoadTexture(Path)
12903             RaiseIfFailed("LoadTexture", self.InsertOp)
12904             return ID
12905
12906         ## Get internal name of the object based on its study entry
12907         #  @note This method does not provide an unique identifier of the geometry object.
12908         #  @note This is internal function of GEOM component, though it can be used outside it for
12909         #  appropriate reason (e.g. for identification of geometry object).
12910         #  @param obj geometry object
12911         #  @return unique object identifier
12912         #  @ingroup l1_geomBuilder_auxiliary
12913         def getObjectID(self, obj):
12914             """
12915             Get internal name of the object based on its study entry.
12916             Note: this method does not provide an unique identifier of the geometry object.
12917             It is an internal function of GEOM component, though it can be used outside GEOM for
12918             appropriate reason (e.g. for identification of geometry object).
12919
12920             Parameters:
12921                 obj geometry object
12922
12923             Returns:
12924                 unique object identifier
12925             """
12926             ID = ""
12927             entry = salome.ObjectToID(obj)
12928             if entry is not None:
12929                 lst = entry.split(":")
12930                 if len(lst) > 0:
12931                     ID = lst[-1] # -1 means last item in the list
12932                     return "GEOM_" + ID
12933             return ID
12934
12935
12936
12937         ## Add marker texture. @a Width and @a Height parameters
12938         #  specify width and height of the texture in pixels.
12939         #  If @a RowData is @c True, @a Texture parameter should represent texture data
12940         #  packed into the byte array. If @a RowData is @c False (default), @a Texture
12941         #  parameter should be unpacked string, in which '1' symbols represent opaque
12942         #  pixels and '0' represent transparent pixels of the texture bitmap.
12943         #
12944         #  @param Width texture width in pixels
12945         #  @param Height texture height in pixels
12946         #  @param Texture texture data
12947         #  @param RowData if @c True, @a Texture data are packed in the byte stream
12948         #  @return unique texture identifier
12949         #  @ingroup l1_geomBuilder_auxiliary
12950         @ManageTransactions("InsertOp")
12951         def AddTexture(self, Width, Height, Texture, RowData=False):
12952             """
12953             Add marker texture. Width and Height parameters
12954             specify width and height of the texture in pixels.
12955             If RowData is True, Texture parameter should represent texture data
12956             packed into the byte array. If RowData is False (default), Texture
12957             parameter should be unpacked string, in which '1' symbols represent opaque
12958             pixels and '0' represent transparent pixels of the texture bitmap.
12959
12960             Parameters:
12961                 Width texture width in pixels
12962                 Height texture height in pixels
12963                 Texture texture data
12964                 RowData if True, Texture data are packed in the byte stream
12965
12966             Returns:
12967                 return unique texture identifier
12968             """
12969             if not RowData: Texture = PackData(Texture)
12970             ID = self.InsertOp.AddTexture(Width, Height, Texture)
12971             RaiseIfFailed("AddTexture", self.InsertOp)
12972             return ID
12973
12974         ## Transfer not topological data from one GEOM object to another.
12975         #
12976         #  @param theObjectFrom the source object of non-topological data
12977         #  @param theObjectTo the destination object of non-topological data
12978         #  @param theFindMethod method to search sub-shapes of theObjectFrom
12979         #         in shape theObjectTo. Possible values are: GEOM.FSM_GetInPlace,
12980         #         GEOM.FSM_GetInPlaceByHistory and GEOM.FSM_GetInPlace_Old.
12981         #         Other values of GEOM.find_shape_method are not supported.
12982         #
12983         #  @return True in case of success; False otherwise.
12984         #
12985         #  @ingroup l1_geomBuilder_auxiliary
12986         #
12987         #  @ref swig_TransferData "Example"
12988         @ManageTransactions("InsertOp")
12989         def TransferData(self, theObjectFrom, theObjectTo,
12990                          theFindMethod=GEOM.FSM_GetInPlace):
12991             """
12992             Transfer not topological data from one GEOM object to another.
12993
12994             Parameters:
12995                 theObjectFrom the source object of non-topological data
12996                 theObjectTo the destination object of non-topological data
12997                 theFindMethod method to search sub-shapes of theObjectFrom
12998                               in shape theObjectTo. Possible values are:
12999                               GEOM.FSM_GetInPlace, GEOM.FSM_GetInPlaceByHistory
13000                               and GEOM.FSM_GetInPlace_Old. Other values of
13001                               GEOM.find_shape_method are not supported.
13002
13003             Returns:
13004                 True in case of success; False otherwise.
13005
13006             # Example: see GEOM_TestOthers.py
13007             """
13008             # Example: see GEOM_TestAll.py
13009             isOk = self.InsertOp.TransferData(theObjectFrom,
13010                                                theObjectTo, theFindMethod)
13011             RaiseIfFailed("TransferData", self.InsertOp)
13012             return isOk
13013
13014         ## Creates a new folder object. It is a container for any GEOM objects.
13015         #  @param Name name of the container
13016         #  @param Father parent object. If None,
13017         #         folder under 'Geometry' root object will be created.
13018         #  @return a new created folder
13019         #  @ingroup l1_publish_data
13020         def NewFolder(self, Name, Father=None):
13021             """
13022             Create a new folder object. It is an auxiliary container for any GEOM objects.
13023
13024             Parameters:
13025                 Name name of the container
13026                 Father parent object. If None,
13027                 folder under 'Geometry' root object will be created.
13028
13029             Returns:
13030                 a new created folder
13031             """
13032             if not Father: Father = self.father
13033             return self.CreateFolder(Name, Father)
13034
13035         ## Move object to the specified folder
13036         #  @param Object object to move
13037         #  @param Folder target folder
13038         #  @ingroup l1_publish_data
13039         def PutToFolder(self, Object, Folder):
13040             """
13041             Move object to the specified folder
13042
13043             Parameters:
13044                 Object object to move
13045                 Folder target folder
13046             """
13047             self.MoveToFolder(Object, Folder)
13048             pass
13049
13050         ## Move list of objects to the specified folder
13051         #  @param ListOfSO list of objects to move
13052         #  @param Folder target folder
13053         #  @ingroup l1_publish_data
13054         def PutListToFolder(self, ListOfSO, Folder):
13055             """
13056             Move list of objects to the specified folder
13057
13058             Parameters:
13059                 ListOfSO list of objects to move
13060                 Folder target folder
13061             """
13062             self.MoveListToFolder(ListOfSO, Folder)
13063             pass
13064
13065         ## @addtogroup l2_field
13066         ## @{
13067
13068         ## Creates a field
13069         #  @param shape the shape the field lies on
13070         #  @param name the field name
13071         #  @param type type of field data: 0 - bool, 1 - int, 2 - double, 3 - string
13072         #  @param dimension dimension of the shape the field lies on
13073         #         0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13074         #  @param componentNames names of components
13075         #  @return a created field
13076         @ManageTransactions("FieldOp")
13077         def CreateField(self, shape, name, type, dimension, componentNames):
13078             """
13079             Creates a field
13080
13081             Parameters:
13082                 shape the shape the field lies on
13083                 name  the field name
13084                 type  type of field data
13085                 dimension dimension of the shape the field lies on
13086                           0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13087                 componentNames names of components
13088
13089             Returns:
13090                 a created field
13091             """
13092             if isinstance( type, int ):
13093                 if type < 0 or type > 3:
13094                     raise RuntimeError, "CreateField : Error: data type must be within [0-3] range"
13095                 type = [GEOM.FDT_Bool,GEOM.FDT_Int,GEOM.FDT_Double,GEOM.FDT_String][type]
13096
13097             f = self.FieldOp.CreateField( shape, name, type, dimension, componentNames)
13098             RaiseIfFailed("CreateField", self.FieldOp)
13099             global geom
13100             geom._autoPublish( f, "", name)
13101             return f
13102
13103         ## Removes a field from the GEOM component
13104         #  @param field the field to remove
13105         def RemoveField(self, field):
13106             "Removes a field from the GEOM component"
13107             global geom
13108             if isinstance( field, GEOM._objref_GEOM_Field ):
13109                 geom.RemoveObject( field )
13110             elif isinstance( field, geomField ):
13111                 geom.RemoveObject( field.field )
13112             else:
13113                 raise RuntimeError, "RemoveField() : the object is not a field"
13114             return
13115
13116         ## Returns number of fields on a shape
13117         @ManageTransactions("FieldOp")
13118         def CountFields(self, shape):
13119             "Returns number of fields on a shape"
13120             nb = self.FieldOp.CountFields( shape )
13121             RaiseIfFailed("CountFields", self.FieldOp)
13122             return nb
13123
13124         ## Returns all fields on a shape
13125         @ManageTransactions("FieldOp")
13126         def GetFields(self, shape):
13127             "Returns all fields on a shape"
13128             ff = self.FieldOp.GetFields( shape )
13129             RaiseIfFailed("GetFields", self.FieldOp)
13130             return ff
13131
13132         ## Returns a field on a shape by its name
13133         @ManageTransactions("FieldOp")
13134         def GetField(self, shape, name):
13135             "Returns a field on a shape by its name"
13136             f = self.FieldOp.GetField( shape, name )
13137             RaiseIfFailed("GetField", self.FieldOp)
13138             return f
13139
13140         # end of l2_field
13141         ## @}
13142
13143
13144 import omniORB
13145 # Register the new proxy for GEOM_Gen
13146 omniORB.registerObjref(GEOM._objref_GEOM_Gen._NP_RepositoryId, geomBuilder)
13147
13148
13149 ## Field on Geometry
13150 #  @ingroup l2_field
13151 class geomField( GEOM._objref_GEOM_Field ):
13152
13153     def __init__(self):
13154         GEOM._objref_GEOM_Field.__init__(self)
13155         self.field = GEOM._objref_GEOM_Field
13156         return
13157
13158     ## Returns the shape the field lies on
13159     def getShape(self):
13160         "Returns the shape the field lies on"
13161         return self.field.GetShape(self)
13162
13163     ## Returns the field name
13164     def getName(self):
13165         "Returns the field name"
13166         return self.field.GetName(self)
13167
13168     ## Returns type of field data as integer [0-3]
13169     def getType(self):
13170         "Returns type of field data"
13171         return self.field.GetDataType(self)._v
13172
13173     ## Returns type of field data:
13174     #  one of GEOM.FDT_Bool, GEOM.FDT_Int, GEOM.FDT_Double, GEOM.FDT_String
13175     def getTypeEnum(self):
13176         "Returns type of field data"
13177         return self.field.GetDataType(self)
13178
13179     ## Returns dimension of the shape the field lies on:
13180     #  0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13181     def getDimension(self):
13182         """Returns dimension of the shape the field lies on:
13183         0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape"""
13184         return self.field.GetDimension(self)
13185
13186     ## Returns names of components
13187     def getComponents(self):
13188         "Returns names of components"
13189         return self.field.GetComponents(self)
13190
13191     ## Adds a time step to the field
13192     #  @param step the time step number further used as the step identifier
13193     #  @param stamp the time step time
13194     #  @param values the values of the time step
13195     def addStep(self, step, stamp, values):
13196         "Adds a time step to the field"
13197         stp = self.field.AddStep( self, step, stamp )
13198         if not stp:
13199             raise RuntimeError, \
13200                   "Field.addStep() : Error: step %s already exists in this field"%step
13201         global geom
13202         geom._autoPublish( stp, "", "Step %s, %s"%(step,stamp))
13203         self.setValues( step, values )
13204         return stp
13205
13206     ## Remove a time step from the field
13207     def removeStep(self,step):
13208         "Remove a time step from the field"
13209         stepSO = None
13210         try:
13211             stepObj = self.field.GetStep( self, step )
13212             if stepObj:
13213                 stepSO = geom.myStudy.FindObjectID( stepObj.GetStudyEntry() )
13214         except:
13215             #import traceback
13216             #traceback.print_exc()
13217             pass
13218         self.field.RemoveStep( self, step )
13219         if stepSO:
13220             geom.myBuilder.RemoveObjectWithChildren( stepSO )
13221         return
13222
13223     ## Returns number of time steps in the field
13224     def countSteps(self):
13225         "Returns number of time steps in the field"
13226         return self.field.CountSteps(self)
13227
13228     ## Returns a list of time step IDs in the field
13229     def getSteps(self):
13230         "Returns a list of time step IDs in the field"
13231         return self.field.GetSteps(self)
13232
13233     ## Returns a time step by its ID
13234     def getStep(self,step):
13235         "Returns a time step by its ID"
13236         stp = self.field.GetStep(self, step)
13237         if not stp:
13238             raise RuntimeError, "Step %s is missing from this field"%step
13239         return stp
13240
13241     ## Returns the time of the field step
13242     def getStamp(self,step):
13243         "Returns the time of the field step"
13244         return self.getStep(step).GetStamp()
13245
13246     ## Changes the time of the field step
13247     def setStamp(self, step, stamp):
13248         "Changes the time of the field step"
13249         return self.getStep(step).SetStamp(stamp)
13250
13251     ## Returns values of the field step
13252     def getValues(self, step):
13253         "Returns values of the field step"
13254         return self.getStep(step).GetValues()
13255
13256     ## Changes values of the field step
13257     def setValues(self, step, values):
13258         "Changes values of the field step"
13259         stp = self.getStep(step)
13260         errBeg = "Field.setValues(values) : Error: "
13261         try:
13262             ok = stp.SetValues( values )
13263         except Exception, e:
13264             excStr = str(e)
13265             if excStr.find("WrongPythonType") > 0:
13266                 raise RuntimeError, errBeg +\
13267                       "wrong type of values, %s values are expected"%str(self.getTypeEnum())[4:]
13268             raise RuntimeError, errBeg + str(e)
13269         if not ok:
13270             nbOK = self.field.GetArraySize(self)
13271             nbKO = len(values)
13272             if nbOK != nbKO:
13273                 raise RuntimeError, errBeg + "len(values) must be %s but not %s"%(nbOK,nbKO)
13274             else:
13275                 raise RuntimeError, errBeg + "failed"
13276         return
13277
13278     pass # end of class geomField
13279
13280 # Register the new proxy for GEOM_Field
13281 omniORB.registerObjref(GEOM._objref_GEOM_Field._NP_RepositoryId, geomField)
13282
13283
13284 ## Create a new geomBuilder instance.The geomBuilder class provides the Python
13285 #  interface to GEOM operations.
13286 #
13287 #  Typical use is:
13288 #  \code
13289 #    import salome
13290 #    salome.salome_init()
13291 #    from salome.geom import geomBuilder
13292 #    geompy = geomBuilder.New(salome.myStudy)
13293 #  \endcode
13294 #  @param  study     SALOME study, generally obtained by salome.myStudy.
13295 #  @param  instance  CORBA proxy of GEOM Engine. If None, the default Engine is used.
13296 #  @return geomBuilder instance
13297 def New( study, instance=None):
13298     """
13299     Create a new geomBuilder instance.The geomBuilder class provides the Python
13300     interface to GEOM operations.
13301
13302     Typical use is:
13303         import salome
13304         salome.salome_init()
13305         from salome.geom import geomBuilder
13306         geompy = geomBuilder.New(salome.myStudy)
13307
13308     Parameters:
13309         study     SALOME study, generally obtained by salome.myStudy.
13310         instance  CORBA proxy of GEOM Engine. If None, the default Engine is used.
13311     Returns:
13312         geomBuilder instance
13313     """
13314     #print "New geomBuilder ", study, instance
13315     global engine
13316     global geom
13317     global doLcc
13318     engine = instance
13319     if engine is None:
13320       doLcc = True
13321     geom = geomBuilder()
13322     assert isinstance(geom,geomBuilder), "Geom engine class is %s but should be geomBuilder.geomBuilder. Import geomBuilder before creating the instance."%geom.__class__
13323     geom.init_geom(study)
13324     return geom
13325
13326
13327 # Register methods from the plug-ins in the geomBuilder class 
13328 plugins_var = os.environ.get( "GEOM_PluginsList" )
13329
13330 plugins = None
13331 if plugins_var is not None:
13332     plugins = plugins_var.split( ":" )
13333     plugins=filter(lambda x: len(x)>0, plugins)
13334 if plugins is not None:
13335     for pluginName in plugins:
13336         pluginBuilderName = pluginName + "Builder"
13337         try:
13338             exec( "from salome.%s.%s import *" % (pluginName, pluginBuilderName))
13339         except Exception, e:
13340             from salome_utils import verbose
13341             print "Exception while loading %s: %s" % ( pluginBuilderName, e )
13342             continue
13343         exec( "from salome.%s import %s" % (pluginName, pluginBuilderName))
13344         plugin = eval( pluginBuilderName )
13345         
13346         # add methods from plugin module to the geomBuilder class
13347         for k in dir( plugin ):
13348             if k[0] == '_': continue
13349             method = getattr( plugin, k )
13350             if type( method ).__name__ == 'function':
13351                 if not hasattr( geomBuilder, k ):
13352                     setattr( geomBuilder, k, method )
13353                 pass
13354             pass
13355         del pluginName
13356         pass
13357     pass