Salome HOME
22752: [EDF] Provide explicit feedback on what has been done by Shape Processing...
[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_measurement_tools_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         #
6395         #  * \b SplitAngle - splits faces based on conical surfaces, surfaces of revolution and cylindrical
6396         #    surfaces in segments using a certain angle. \n
6397         #  - \b SplitAngle.Angle - the central angle of the resulting segments (i.e. we obtain two segments
6398         #    if Angle=180, four if Angle=90, etc). \n
6399         #  - \b SplitAngle.MaxTolerance - maximum possible tolerance among the resulting segments.\n
6400         #
6401         #  * \b SplitClosedFaces - splits closed faces in segments.
6402         #    The number of segments depends on the number of splitting points.\n
6403         #  - \b SplitClosedFaces.NbSplitPoints - the number of splitting points.\n
6404         #
6405         #  * \b SplitContinuity - splits shapes to reduce continuities of curves and surfaces.\n
6406         #  - \b SplitContinuity.Tolerance3d - 3D tolerance for correction of geometry.\n
6407         #  - \b SplitContinuity.SurfaceContinuity - required continuity for surfaces.\n
6408         #  - \b SplitContinuity.CurveContinuity - required continuity for curves.\n
6409         #   This and the previous parameters can take the following values:\n
6410         #   \b Parametric \b Continuity \n
6411         #   \b C0 (Positional Continuity): curves are joined (the end positions of curves or surfaces
6412         #   are coincidental. The curves or surfaces may still meet at an angle, giving rise to a sharp corner or edge).\n
6413         #   \b C1 (Tangential Continuity): first derivatives are equal (the end vectors of curves or surfaces are parallel,
6414         #    ruling out sharp edges).\n
6415         #   \b C2 (Curvature Continuity): first and second derivatives are equal (the end vectors of curves or surfaces
6416         #       are of the same magnitude).\n
6417         #   \b CN N-th derivatives are equal (both the direction and the magnitude of the Nth derivatives of curves
6418         #    or surfaces (d/du C(u)) are the same at junction. \n
6419         #   \b Geometric \b Continuity \n
6420         #   \b G1: first derivatives are proportional at junction.\n
6421         #   The curve tangents thus have the same direction, but not necessarily the same magnitude.
6422         #      i.e., C1'(1) = (a,b,c) and C2'(0) = (k*a, k*b, k*c).\n
6423         #   \b G2: first and second derivatives are proportional at junction.
6424         #   As the names imply, geometric continuity requires the geometry to be continuous, while parametric
6425         #    continuity requires that the underlying parameterization was continuous as well.
6426         #   Parametric continuity of order n implies geometric continuity of order n, but not vice-versa.\n
6427         #
6428         #  * \b BsplineRestriction - converts curves and surfaces to Bsplines and processes them with the following parameters:\n
6429         #  - \b BSplineRestriction.SurfaceMode - approximation of surfaces if restriction is necessary.\n
6430         #  - \b BSplineRestriction.Curve3dMode - conversion of any 3D curve to BSpline and approximation.\n
6431         #  - \b BSplineRestriction.Curve2dMode - conversion of any 2D curve to BSpline and approximation.\n
6432         #  - \b BSplineRestriction.Tolerance3d - defines the possibility of surfaces and 3D curves approximation
6433         #       with the specified parameters.\n
6434         #  - \b BSplineRestriction.Tolerance2d - defines the possibility of surfaces and 2D curves approximation
6435         #       with the specified parameters.\n
6436         #  - \b BSplineRestriction.RequiredDegree - required degree of the resulting BSplines.\n
6437         #  - \b BSplineRestriction.RequiredNbSegments - required maximum number of segments of resultant BSplines.\n
6438         #  - \b BSplineRestriction.Continuity3d - continuity of the resulting surfaces and 3D curves.\n
6439         #  - \b BSplineRestriction.Continuity2d - continuity of the resulting 2D curves.\n
6440         #
6441         #  * \b ToBezier - converts curves and surfaces of any type to Bezier curves and surfaces.\n
6442         #  - \b ToBezier.SurfaceMode - if checked in, allows conversion of surfaces.\n
6443         #  - \b ToBezier.Curve3dMode - if checked in, allows conversion of 3D curves.\n
6444         #  - \b ToBezier.Curve2dMode - if checked in, allows conversion of 2D curves.\n
6445         #  - \b ToBezier.MaxTolerance - defines tolerance for detection and correction of problems.\n
6446         #
6447         #  * \b SameParameter - fixes edges of 2D and 3D curves not having the same parameter.\n
6448         #  - \b SameParameter.Tolerance3d - defines tolerance for fixing of edges.\n
6449         #
6450         #
6451         #  @return New GEOM.GEOM_Object, containing processed shape.
6452         #
6453         #  \n @ref tui_shape_processing "Example"
6454         @ManageTransactions("HealOp")
6455         def ProcessShape(self, theShape, theOperators, theParameters, theValues, theName=None):
6456             """
6457             Apply a sequence of Shape Healing operators to the given object.
6458
6459             Parameters:
6460                 theShape Shape to be processed.
6461                 theValues List of values of parameters, in the same order
6462                           as parameters are listed in theParameters list.
6463                 theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
6464                 theParameters List of names of parameters
6465                               ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
6466                 theName Object name; when specified, this parameter is used
6467                         for result publication in the study. Otherwise, if automatic
6468                         publication is switched on, default value is used for result name.
6469
6470                 Operators and Parameters:
6471
6472                  * FixShape - corrects invalid shapes.
6473                      * FixShape.Tolerance3d - work tolerance for detection of the problems and correction of them.
6474                      * FixShape.MaxTolerance3d - maximal possible tolerance of the shape after correction.
6475                  * FixFaceSize - removes small faces, such as spots and strips.
6476                      * FixFaceSize.Tolerance - defines minimum possible face size.
6477                      * DropSmallEdges - removes edges, which merge with neighbouring edges.
6478                      * DropSmallEdges.Tolerance3d - defines minimum possible distance between two parallel edges.
6479                  * SplitAngle - splits faces based on conical surfaces, surfaces of revolution and cylindrical surfaces
6480                                 in segments using a certain angle.
6481                      * SplitAngle.Angle - the central angle of the resulting segments (i.e. we obtain two segments
6482                                           if Angle=180, four if Angle=90, etc).
6483                      * SplitAngle.MaxTolerance - maximum possible tolerance among the resulting segments.
6484                  * SplitClosedFaces - splits closed faces in segments. The number of segments depends on the number of
6485                                       splitting points.
6486                      * SplitClosedFaces.NbSplitPoints - the number of splitting points.
6487                  * SplitContinuity - splits shapes to reduce continuities of curves and surfaces.
6488                      * SplitContinuity.Tolerance3d - 3D tolerance for correction of geometry.
6489                      * SplitContinuity.SurfaceContinuity - required continuity for surfaces.
6490                      * SplitContinuity.CurveContinuity - required continuity for curves.
6491                        This and the previous parameters can take the following values:
6492
6493                        Parametric Continuity:
6494                        C0 (Positional Continuity): curves are joined (the end positions of curves or surfaces are
6495                                                    coincidental. The curves or surfaces may still meet at an angle,
6496                                                    giving rise to a sharp corner or edge).
6497                        C1 (Tangential Continuity): first derivatives are equal (the end vectors of curves or surfaces
6498                                                    are parallel, ruling out sharp edges).
6499                        C2 (Curvature Continuity): first and second derivatives are equal (the end vectors of curves
6500                                                   or surfaces are of the same magnitude).
6501                        CN N-th derivatives are equal (both the direction and the magnitude of the Nth derivatives of
6502                           curves or surfaces (d/du C(u)) are the same at junction.
6503
6504                        Geometric Continuity:
6505                        G1: first derivatives are proportional at junction.
6506                            The curve tangents thus have the same direction, but not necessarily the same magnitude.
6507                            i.e., C1'(1) = (a,b,c) and C2'(0) = (k*a, k*b, k*c).
6508                        G2: first and second derivatives are proportional at junction. As the names imply,
6509                            geometric continuity requires the geometry to be continuous, while parametric continuity requires
6510                            that the underlying parameterization was continuous as well. Parametric continuity of order n implies
6511                            geometric continuity of order n, but not vice-versa.
6512                  * BsplineRestriction - converts curves and surfaces to Bsplines and processes them with the following parameters:
6513                      * BSplineRestriction.SurfaceMode - approximation of surfaces if restriction is necessary.
6514                      * BSplineRestriction.Curve3dMode - conversion of any 3D curve to BSpline and approximation.
6515                      * BSplineRestriction.Curve2dMode - conversion of any 2D curve to BSpline and approximation.
6516                      * BSplineRestriction.Tolerance3d - defines the possibility of surfaces and 3D curves approximation with
6517                                                         the specified parameters.
6518                      * BSplineRestriction.Tolerance2d - defines the possibility of surfaces and 2D curves approximation with
6519                                                         the specified parameters.
6520                      * BSplineRestriction.RequiredDegree - required degree of the resulting BSplines.
6521                      * BSplineRestriction.RequiredNbSegments - required maximum number of segments of resultant BSplines.
6522                      * BSplineRestriction.Continuity3d - continuity of the resulting surfaces and 3D curves.
6523                      * BSplineRestriction.Continuity2d - continuity of the resulting 2D curves.
6524                  * ToBezier - converts curves and surfaces of any type to Bezier curves and surfaces.
6525                      * ToBezier.SurfaceMode - if checked in, allows conversion of surfaces.
6526                      * ToBezier.Curve3dMode - if checked in, allows conversion of 3D curves.
6527                      * ToBezier.Curve2dMode - if checked in, allows conversion of 2D curves.
6528                      * ToBezier.MaxTolerance - defines tolerance for detection and correction of problems.
6529                  * SameParameter - fixes edges of 2D and 3D curves not having the same parameter.
6530                      * SameParameter.Tolerance3d - defines tolerance for fixing of edges.
6531
6532             Returns:
6533                 New GEOM.GEOM_Object, containing processed shape.
6534
6535             Note: For more information look through SALOME Geometry User's Guide->
6536                   -> Introduction to Geometry-> Repairing Operations-> Shape Processing
6537             """
6538             # Example: see GEOM_TestHealing.py
6539             theValues,Parameters = ParseList(theValues)
6540             anObj = self.HealOp.ProcessShape(theShape, theOperators, theParameters, theValues)
6541             # To avoid script failure in case of good argument shape
6542             if self.HealOp.GetErrorCode() == "ShHealOper_NotError_msg":
6543                 return theShape
6544             RaiseIfFailed("ProcessShape", self.HealOp)
6545             for string in (theOperators + theParameters):
6546                 Parameters = ":" + Parameters
6547                 pass
6548             anObj.SetParameters(Parameters)
6549             self._autoPublish(anObj, theName, "healed")
6550             return anObj
6551
6552         ## Remove faces from the given object (shape).
6553         #  @param theObject Shape to be processed.
6554         #  @param theFaces Indices of faces to be removed, if EMPTY then the method
6555         #                  removes ALL faces of the given object.
6556         #  @param theName Object name; when specified, this parameter is used
6557         #         for result publication in the study. Otherwise, if automatic
6558         #         publication is switched on, default value is used for result name.
6559         #
6560         #  @return New GEOM.GEOM_Object, containing processed shape.
6561         #
6562         #  @ref tui_suppress_faces "Example"
6563         @ManageTransactions("HealOp")
6564         def SuppressFaces(self, theObject, theFaces, theName=None):
6565             """
6566             Remove faces from the given object (shape).
6567
6568             Parameters:
6569                 theObject Shape to be processed.
6570                 theFaces Indices of faces to be removed, if EMPTY then the method
6571                          removes ALL faces of the given object.
6572                 theName Object name; when specified, this parameter is used
6573                         for result publication in the study. Otherwise, if automatic
6574                         publication is switched on, default value is used for result name.
6575
6576             Returns:
6577                 New GEOM.GEOM_Object, containing processed shape.
6578             """
6579             # Example: see GEOM_TestHealing.py
6580             anObj = self.HealOp.SuppressFaces(theObject, theFaces)
6581             RaiseIfFailed("SuppressFaces", self.HealOp)
6582             self._autoPublish(anObj, theName, "suppressFaces")
6583             return anObj
6584
6585         ## Sewing of faces into a single shell.
6586         #  @param ListShape Shapes to be processed.
6587         #  @param theTolerance Required tolerance value.
6588         #  @param AllowNonManifold Flag that allows non-manifold sewing.
6589         #  @param theName Object name; when specified, this parameter is used
6590         #         for result publication in the study. Otherwise, if automatic
6591         #         publication is switched on, default value is used for result name.
6592         #
6593         #  @return New GEOM.GEOM_Object, containing a result shell.
6594         #
6595         #  @ref tui_sewing "Example"
6596         def MakeSewing(self, ListShape, theTolerance, AllowNonManifold=False, theName=None):
6597             """
6598             Sewing of faces into a single shell.
6599
6600             Parameters:
6601                 ListShape Shapes to be processed.
6602                 theTolerance Required tolerance value.
6603                 AllowNonManifold Flag that allows non-manifold sewing.
6604                 theName Object name; when specified, this parameter is used
6605                         for result publication in the study. Otherwise, if automatic
6606                         publication is switched on, default value is used for result name.
6607
6608             Returns:
6609                 New GEOM.GEOM_Object, containing containing a result shell.
6610             """
6611             # Example: see GEOM_TestHealing.py
6612             # note: auto-publishing is done in self.Sew()
6613             anObj = self.Sew(ListShape, theTolerance, AllowNonManifold, theName)
6614             return anObj
6615
6616         ## Sewing of faces into a single shell.
6617         #  @param ListShape Shapes to be processed.
6618         #  @param theTolerance Required tolerance value.
6619         #  @param AllowNonManifold Flag that allows non-manifold sewing.
6620         #  @param theName Object name; when specified, this parameter is used
6621         #         for result publication in the study. Otherwise, if automatic
6622         #         publication is switched on, default value is used for result name.
6623         #
6624         #  @return New GEOM.GEOM_Object, containing a result shell.
6625         @ManageTransactions("HealOp")
6626         def Sew(self, ListShape, theTolerance, AllowNonManifold=False, theName=None):
6627             """
6628             Sewing of faces into a single shell.
6629
6630             Parameters:
6631                 ListShape Shapes to be processed.
6632                 theTolerance Required tolerance value.
6633                 AllowNonManifold Flag that allows non-manifold sewing.
6634                 theName Object name; when specified, this parameter is used
6635                         for result publication in the study. Otherwise, if automatic
6636                         publication is switched on, default value is used for result name.
6637
6638             Returns:
6639                 New GEOM.GEOM_Object, containing a result shell.
6640             """
6641             # Example: see MakeSewing() above
6642             theTolerance,Parameters = ParseParameters(theTolerance)
6643             if AllowNonManifold:
6644                 anObj = self.HealOp.SewAllowNonManifold( ToList( ListShape ), theTolerance)
6645             else:
6646                 anObj = self.HealOp.Sew( ToList( ListShape ), theTolerance)
6647             # To avoid script failure in case of good argument shape
6648             # (Fix of test cases geom/bugs11/L7,L8)
6649             if self.HealOp.GetErrorCode() == "ShHealOper_NotError_msg":
6650                 return anObj
6651             RaiseIfFailed("Sew", self.HealOp)
6652             anObj.SetParameters(Parameters)
6653             self._autoPublish(anObj, theName, "sewed")
6654             return anObj
6655
6656         ## Rebuild the topology of theSolids by removing
6657         #  the faces that are shared by several solids.
6658         #  @param theSolids A compound or a list of solids to be processed.
6659         #  @param theName Object name; when specified, this parameter is used
6660         #         for result publication in the study. Otherwise, if automatic
6661         #         publication is switched on, default value is used for result name.
6662         #
6663         #  @return New GEOM.GEOM_Object, containing processed shape.
6664         #
6665         #  @ref tui_remove_webs "Example"
6666         @ManageTransactions("HealOp")
6667         def RemoveInternalFaces (self, theSolids, theName=None):
6668             """
6669             Rebuild the topology of theSolids by removing
6670             the faces that are shared by several solids.
6671
6672             Parameters:
6673                 theSolids A compound or a list of solids to be processed.
6674                 theName Object name; when specified, this parameter is used
6675                         for result publication in the study. Otherwise, if automatic
6676                         publication is switched on, default value is used for result name.
6677
6678             Returns:
6679                 New GEOM.GEOM_Object, containing processed shape.
6680             """
6681             # Example: see GEOM_TestHealing.py
6682             anObj = self.HealOp.RemoveInternalFaces(ToList(theSolids))
6683             RaiseIfFailed("RemoveInternalFaces", self.HealOp)
6684             self._autoPublish(anObj, theName, "removeWebs")
6685             return anObj
6686
6687         ## Remove internal wires and edges from the given object (face).
6688         #  @param theObject Shape to be processed.
6689         #  @param theWires Indices of wires to be removed, if EMPTY then the method
6690         #                  removes ALL internal wires of the given object.
6691         #  @param theName Object name; when specified, this parameter is used
6692         #         for result publication in the study. Otherwise, if automatic
6693         #         publication is switched on, default value is used for result name.
6694         #
6695         #  @return New GEOM.GEOM_Object, containing processed shape.
6696         #
6697         #  @ref tui_suppress_internal_wires "Example"
6698         @ManageTransactions("HealOp")
6699         def SuppressInternalWires(self, theObject, theWires, theName=None):
6700             """
6701             Remove internal wires and edges from the given object (face).
6702
6703             Parameters:
6704                 theObject Shape to be processed.
6705                 theWires Indices of wires to be removed, if EMPTY then the method
6706                          removes ALL internal wires of the given object.
6707                 theName Object name; when specified, this parameter is used
6708                         for result publication in the study. Otherwise, if automatic
6709                         publication is switched on, default value is used for result name.
6710
6711             Returns:
6712                 New GEOM.GEOM_Object, containing processed shape.
6713             """
6714             # Example: see GEOM_TestHealing.py
6715             anObj = self.HealOp.RemoveIntWires(theObject, theWires)
6716             RaiseIfFailed("RemoveIntWires", self.HealOp)
6717             self._autoPublish(anObj, theName, "suppressWires")
6718             return anObj
6719
6720         ## Remove internal closed contours (holes) from the given object.
6721         #  @param theObject Shape to be processed.
6722         #  @param theWires Indices of wires to be removed, if EMPTY then the method
6723         #                  removes ALL internal holes of the given object
6724         #  @param theName Object name; when specified, this parameter is used
6725         #         for result publication in the study. Otherwise, if automatic
6726         #         publication is switched on, default value is used for result name.
6727         #
6728         #  @return New GEOM.GEOM_Object, containing processed shape.
6729         #
6730         #  @ref tui_suppress_holes "Example"
6731         @ManageTransactions("HealOp")
6732         def SuppressHoles(self, theObject, theWires, theName=None):
6733             """
6734             Remove internal closed contours (holes) from the given object.
6735
6736             Parameters:
6737                 theObject Shape to be processed.
6738                 theWires Indices of wires to be removed, if EMPTY then the method
6739                          removes ALL internal holes of the given object
6740                 theName Object name; when specified, this parameter is used
6741                         for result publication in the study. Otherwise, if automatic
6742                         publication is switched on, default value is used for result name.
6743
6744             Returns:
6745                 New GEOM.GEOM_Object, containing processed shape.
6746             """
6747             # Example: see GEOM_TestHealing.py
6748             anObj = self.HealOp.FillHoles(theObject, theWires)
6749             RaiseIfFailed("FillHoles", self.HealOp)
6750             self._autoPublish(anObj, theName, "suppressHoles")
6751             return anObj
6752
6753         ## Close an open wire.
6754         #  @param theObject Shape to be processed.
6755         #  @param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
6756         #                  if [ ], then <VAR>theObject</VAR> itself is a wire.
6757         #  @param isCommonVertex If True  : closure by creation of a common vertex,
6758         #                        If False : closure by creation of an edge between ends.
6759         #  @param theName Object name; when specified, this parameter is used
6760         #         for result publication in the study. Otherwise, if automatic
6761         #         publication is switched on, default value is used for result name.
6762         #
6763         #  @return New GEOM.GEOM_Object, containing processed shape.
6764         #
6765         #  @ref tui_close_contour "Example"
6766         @ManageTransactions("HealOp")
6767         def CloseContour(self,theObject, theWires, isCommonVertex, theName=None):
6768             """
6769             Close an open wire.
6770
6771             Parameters:
6772                 theObject Shape to be processed.
6773                 theWires Indexes of edge(s) and wire(s) to be closed within theObject's shape,
6774                          if [ ], then theObject itself is a wire.
6775                 isCommonVertex If True  : closure by creation of a common vertex,
6776                                If False : closure by creation of an edge between ends.
6777                 theName Object name; when specified, this parameter is used
6778                         for result publication in the study. Otherwise, if automatic
6779                         publication is switched on, default value is used for result name.
6780
6781             Returns:
6782                 New GEOM.GEOM_Object, containing processed shape.
6783             """
6784             # Example: see GEOM_TestHealing.py
6785             anObj = self.HealOp.CloseContour(theObject, theWires, isCommonVertex)
6786             RaiseIfFailed("CloseContour", self.HealOp)
6787             self._autoPublish(anObj, theName, "closeContour")
6788             return anObj
6789
6790         ## Addition of a point to a given edge object.
6791         #  @param theObject Shape to be processed.
6792         #  @param theEdgeIndex Index of edge to be divided within theObject's shape,
6793         #                      if -1, then theObject itself is the edge.
6794         #  @param theValue Value of parameter on edge or length parameter,
6795         #                  depending on \a isByParameter.
6796         #  @param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1], \n
6797         #                       if FALSE : \a theValue is treated as a length parameter [0..1]
6798         #  @param theName Object name; when specified, this parameter is used
6799         #         for result publication in the study. Otherwise, if automatic
6800         #         publication is switched on, default value is used for result name.
6801         #
6802         #  @return New GEOM.GEOM_Object, containing processed shape.
6803         #
6804         #  @ref tui_add_point_on_edge "Example"
6805         @ManageTransactions("HealOp")
6806         def DivideEdge(self, theObject, theEdgeIndex, theValue, isByParameter, theName=None):
6807             """
6808             Addition of a point to a given edge object.
6809
6810             Parameters:
6811                 theObject Shape to be processed.
6812                 theEdgeIndex Index of edge to be divided within theObject's shape,
6813                              if -1, then theObject itself is the edge.
6814                 theValue Value of parameter on edge or length parameter,
6815                          depending on isByParameter.
6816                 isByParameter If TRUE :  theValue is treated as a curve parameter [0..1],
6817                               if FALSE : theValue is treated as a length parameter [0..1]
6818                 theName Object name; when specified, this parameter is used
6819                         for result publication in the study. Otherwise, if automatic
6820                         publication is switched on, default value is used for result name.
6821
6822             Returns:
6823                 New GEOM.GEOM_Object, containing processed shape.
6824             """
6825             # Example: see GEOM_TestHealing.py
6826             theEdgeIndex,theValue,isByParameter,Parameters = ParseParameters(theEdgeIndex,theValue,isByParameter)
6827             anObj = self.HealOp.DivideEdge(theObject, theEdgeIndex, theValue, isByParameter)
6828             RaiseIfFailed("DivideEdge", self.HealOp)
6829             anObj.SetParameters(Parameters)
6830             self._autoPublish(anObj, theName, "divideEdge")
6831             return anObj
6832
6833         ## Addition of points to a given edge of \a theObject by projecting
6834         #  other points to the given edge.
6835         #  @param theObject Shape to be processed.
6836         #  @param theEdgeIndex Index of edge to be divided within theObject's shape,
6837         #                      if -1, then theObject itself is the edge.
6838         #  @param thePoints List of points to project to theEdgeIndex-th edge.
6839         #  @param theName Object name; when specified, this parameter is used
6840         #         for result publication in the study. Otherwise, if automatic
6841         #         publication is switched on, default value is used for result name.
6842         #
6843         #  @return New GEOM.GEOM_Object, containing processed shape.
6844         #
6845         #  @ref tui_add_point_on_edge "Example"
6846         @ManageTransactions("HealOp")
6847         def DivideEdgeByPoint(self, theObject, theEdgeIndex, thePoints, theName=None):
6848             """
6849             Addition of points to a given edge of \a theObject by projecting
6850             other points to the given edge.
6851
6852             Parameters:
6853                 theObject Shape to be processed.
6854                 theEdgeIndex The edge or its index to be divided within theObject's shape,
6855                              if -1, then theObject itself is the edge.
6856                 thePoints List of points to project to theEdgeIndex-th edge.
6857                 theName Object name; when specified, this parameter is used
6858                         for result publication in the study. Otherwise, if automatic
6859                         publication is switched on, default value is used for result name.
6860
6861             Returns:
6862                 New GEOM.GEOM_Object, containing processed shape.
6863             """
6864             # Example: see GEOM_TestHealing.py
6865             if isinstance( theEdgeIndex, GEOM._objref_GEOM_Object ):
6866                 theEdgeIndex = self.GetSubShapeID( theObject, theEdgeIndex )
6867             anObj = self.HealOp.DivideEdgeByPoint(theObject, theEdgeIndex, ToList( thePoints ))
6868             RaiseIfFailed("DivideEdgeByPoint", self.HealOp)
6869             self._autoPublish(anObj, theName, "divideEdge")
6870             return anObj
6871
6872         ## Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
6873         #  @param theWire Wire to minimize the number of C1 continuous edges in.
6874         #  @param theVertices A list of vertices to suppress. If the list
6875         #                     is empty, all vertices in a wire will be assumed.
6876         #  @param theName Object name; when specified, this parameter is used
6877         #         for result publication in the study. Otherwise, if automatic
6878         #         publication is switched on, default value is used for result name.
6879         #
6880         #  @return New GEOM.GEOM_Object with modified wire.
6881         #
6882         #  @ref tui_fuse_collinear_edges "Example"
6883         @ManageTransactions("HealOp")
6884         def FuseCollinearEdgesWithinWire(self, theWire, theVertices = [], theName=None):
6885             """
6886             Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
6887
6888             Parameters:
6889                 theWire Wire to minimize the number of C1 continuous edges in.
6890                 theVertices A list of vertices to suppress. If the list
6891                             is empty, all vertices in a wire will be assumed.
6892                 theName Object name; when specified, this parameter is used
6893                         for result publication in the study. Otherwise, if automatic
6894                         publication is switched on, default value is used for result name.
6895
6896             Returns:
6897                 New GEOM.GEOM_Object with modified wire.
6898             """
6899             anObj = self.HealOp.FuseCollinearEdgesWithinWire(theWire, theVertices)
6900             RaiseIfFailed("FuseCollinearEdgesWithinWire", self.HealOp)
6901             self._autoPublish(anObj, theName, "fuseEdges")
6902             return anObj
6903
6904         ## Change orientation of the given object. Updates given shape.
6905         #  @param theObject Shape to be processed.
6906         #  @return Updated <var>theObject</var>
6907         #
6908         #  @ref swig_todo "Example"
6909         @ManageTransactions("HealOp")
6910         def ChangeOrientationShell(self,theObject):
6911             """
6912             Change orientation of the given object. Updates given shape.
6913
6914             Parameters:
6915                 theObject Shape to be processed.
6916
6917             Returns:
6918                 Updated theObject
6919             """
6920             theObject = self.HealOp.ChangeOrientation(theObject)
6921             RaiseIfFailed("ChangeOrientation", self.HealOp)
6922             pass
6923
6924         ## Change orientation of the given object.
6925         #  @param theObject Shape to be processed.
6926         #  @param theName Object name; when specified, this parameter is used
6927         #         for result publication in the study. Otherwise, if automatic
6928         #         publication is switched on, default value is used for result name.
6929         #
6930         #  @return New GEOM.GEOM_Object, containing processed shape.
6931         #
6932         #  @ref swig_todo "Example"
6933         @ManageTransactions("HealOp")
6934         def ChangeOrientationShellCopy(self, theObject, theName=None):
6935             """
6936             Change orientation of the given object.
6937
6938             Parameters:
6939                 theObject Shape to be processed.
6940                 theName Object name; when specified, this parameter is used
6941                         for result publication in the study. Otherwise, if automatic
6942                         publication is switched on, default value is used for result name.
6943
6944             Returns:
6945                 New GEOM.GEOM_Object, containing processed shape.
6946             """
6947             anObj = self.HealOp.ChangeOrientationCopy(theObject)
6948             RaiseIfFailed("ChangeOrientationCopy", self.HealOp)
6949             self._autoPublish(anObj, theName, "reversed")
6950             return anObj
6951
6952         ## Try to limit tolerance of the given object by value \a theTolerance.
6953         #  @param theObject Shape to be processed.
6954         #  @param theTolerance Required tolerance value.
6955         #  @param theName Object name; when specified, this parameter is used
6956         #         for result publication in the study. Otherwise, if automatic
6957         #         publication is switched on, default value is used for result name.
6958         #
6959         #  @return New GEOM.GEOM_Object, containing processed shape.
6960         #
6961         #  @ref tui_limit_tolerance "Example"
6962         @ManageTransactions("HealOp")
6963         def LimitTolerance(self, theObject, theTolerance = 1e-07, theName=None):
6964             """
6965             Try to limit tolerance of the given object by value theTolerance.
6966
6967             Parameters:
6968                 theObject Shape to be processed.
6969                 theTolerance Required tolerance value.
6970                 theName Object name; when specified, this parameter is used
6971                         for result publication in the study. Otherwise, if automatic
6972                         publication is switched on, default value is used for result name.
6973
6974             Returns:
6975                 New GEOM.GEOM_Object, containing processed shape.
6976             """
6977             anObj = self.HealOp.LimitTolerance(theObject, theTolerance)
6978             RaiseIfFailed("LimitTolerance", self.HealOp)
6979             self._autoPublish(anObj, theName, "limitTolerance")
6980             return anObj
6981
6982         ## Get a list of wires (wrapped in GEOM.GEOM_Object-s),
6983         #  that constitute a free boundary of the given shape.
6984         #  @param theObject Shape to get free boundary of.
6985         #  @param theName Object name; when specified, this parameter is used
6986         #         for result publication in the study. Otherwise, if automatic
6987         #         publication is switched on, default value is used for result name.
6988         #
6989         #  @return [\a status, \a theClosedWires, \a theOpenWires]
6990         #  \n \a status: FALSE, if an error(s) occured during the method execution.
6991         #  \n \a theClosedWires: Closed wires on the free boundary of the given shape.
6992         #  \n \a theOpenWires: Open wires on the free boundary of the given shape.
6993         #
6994         #  @ref tui_measurement_tools_page "Example"
6995         @ManageTransactions("HealOp")
6996         def GetFreeBoundary(self, theObject, theName=None):
6997             """
6998             Get a list of wires (wrapped in GEOM.GEOM_Object-s),
6999             that constitute a free boundary of the given shape.
7000
7001             Parameters:
7002                 theObject Shape to get free boundary of.
7003                 theName Object name; when specified, this parameter is used
7004                         for result publication in the study. Otherwise, if automatic
7005                         publication is switched on, default value is used for result name.
7006
7007             Returns:
7008                 [status, theClosedWires, theOpenWires]
7009                  status: FALSE, if an error(s) occured during the method execution.
7010                  theClosedWires: Closed wires on the free boundary of the given shape.
7011                  theOpenWires: Open wires on the free boundary of the given shape.
7012             """
7013             # Example: see GEOM_TestHealing.py
7014             anObj = self.HealOp.GetFreeBoundary( ToList( theObject ))
7015             RaiseIfFailed("GetFreeBoundary", self.HealOp)
7016             self._autoPublish(anObj[1], theName, "closedWire")
7017             self._autoPublish(anObj[2], theName, "openWire")
7018             return anObj
7019
7020         ## Replace coincident faces in \a theShapes by one face.
7021         #  @param theShapes Initial shapes, either a list or compound of shapes.
7022         #  @param theTolerance Maximum distance between faces, which can be considered as coincident.
7023         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
7024         #                         otherwise all initial shapes.
7025         #  @param theName Object name; when specified, this parameter is used
7026         #         for result publication in the study. Otherwise, if automatic
7027         #         publication is switched on, default value is used for result name.
7028         #
7029         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7030         #
7031         #  @ref tui_glue_faces "Example"
7032         @ManageTransactions("ShapesOp")
7033         def MakeGlueFaces(self, theShapes, theTolerance, doKeepNonSolids=True, theName=None):
7034             """
7035             Replace coincident faces in theShapes by one face.
7036
7037             Parameters:
7038                 theShapes Initial shapes, either a list or compound of shapes.
7039                 theTolerance Maximum distance between faces, which can be considered as coincident.
7040                 doKeepNonSolids If FALSE, only solids will present in the result,
7041                                 otherwise all initial shapes.
7042                 theName Object name; when specified, this parameter is used
7043                         for result publication in the study. Otherwise, if automatic
7044                         publication is switched on, default value is used for result name.
7045
7046             Returns:
7047                 New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7048             """
7049             # Example: see GEOM_Spanner.py
7050             theTolerance,Parameters = ParseParameters(theTolerance)
7051             anObj = self.ShapesOp.MakeGlueFaces(ToList(theShapes), theTolerance, doKeepNonSolids)
7052             if anObj is None:
7053                 raise RuntimeError, "MakeGlueFaces : " + self.ShapesOp.GetErrorCode()
7054             anObj.SetParameters(Parameters)
7055             self._autoPublish(anObj, theName, "glueFaces")
7056             return anObj
7057
7058         ## Find coincident faces in \a theShapes for possible gluing.
7059         #  @param theShapes Initial shapes, either a list or compound of shapes.
7060         #  @param theTolerance Maximum distance between faces,
7061         #                      which can be considered as coincident.
7062         #  @param theName Object name; when specified, this parameter is used
7063         #         for result publication in the study. Otherwise, if automatic
7064         #         publication is switched on, default value is used for result name.
7065         #
7066         #  @return GEOM.ListOfGO
7067         #
7068         #  @ref tui_glue_faces "Example"
7069         @ManageTransactions("ShapesOp")
7070         def GetGlueFaces(self, theShapes, theTolerance, theName=None):
7071             """
7072             Find coincident faces in theShapes for possible gluing.
7073
7074             Parameters:
7075                 theShapes Initial shapes, either a list or compound of shapes.
7076                 theTolerance Maximum distance between faces,
7077                              which can be considered as coincident.
7078                 theName Object name; when specified, this parameter is used
7079                         for result publication in the study. Otherwise, if automatic
7080                         publication is switched on, default value is used for result name.
7081
7082             Returns:
7083                 GEOM.ListOfGO
7084             """
7085             anObj = self.ShapesOp.GetGlueFaces(ToList(theShapes), theTolerance)
7086             RaiseIfFailed("GetGlueFaces", self.ShapesOp)
7087             self._autoPublish(anObj, theName, "facesToGlue")
7088             return anObj
7089
7090         ## Replace coincident faces in \a theShapes by one face
7091         #  in compliance with given list of faces
7092         #  @param theShapes Initial shapes, either a list or compound of shapes.
7093         #  @param theTolerance Maximum distance between faces,
7094         #                      which can be considered as coincident.
7095         #  @param theFaces List of faces for gluing.
7096         #  @param doKeepNonSolids If FALSE, only solids will present in the result,
7097         #                         otherwise all initial shapes.
7098         #  @param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
7099         #                        will be glued, otherwise only the edges,
7100         #                        belonging to <VAR>theFaces</VAR>.
7101         #  @param theName Object name; when specified, this parameter is used
7102         #         for result publication in the study. Otherwise, if automatic
7103         #         publication is switched on, default value is used for result name.
7104         #
7105         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7106         #
7107         #  @ref tui_glue_faces "Example"
7108         @ManageTransactions("ShapesOp")
7109         def MakeGlueFacesByList(self, theShapes, theTolerance, theFaces,
7110                                 doKeepNonSolids=True, doGlueAllEdges=True, theName=None):
7111             """
7112             Replace coincident faces in theShapes by one face
7113             in compliance with given list of faces
7114
7115             Parameters:
7116                 theShapes theShapes Initial shapes, either a list or compound of shapes.
7117                 theTolerance Maximum distance between faces,
7118                              which can be considered as coincident.
7119                 theFaces List of faces for gluing.
7120                 doKeepNonSolids If FALSE, only solids will present in the result,
7121                                 otherwise all initial shapes.
7122                 doGlueAllEdges If TRUE, all coincident edges of theShape
7123                                will be glued, otherwise only the edges,
7124                                belonging to theFaces.
7125                 theName Object name; when specified, this parameter is used
7126                         for result publication in the study. Otherwise, if automatic
7127                         publication is switched on, default value is used for result name.
7128
7129             Returns:
7130                 New GEOM.GEOM_Object, containing copies of theShapes without coincident faces.
7131             """
7132             anObj = self.ShapesOp.MakeGlueFacesByList(ToList(theShapes), theTolerance, theFaces,
7133                                                       doKeepNonSolids, doGlueAllEdges)
7134             if anObj is None:
7135                 raise RuntimeError, "MakeGlueFacesByList : " + self.ShapesOp.GetErrorCode()
7136             self._autoPublish(anObj, theName, "glueFaces")
7137             return anObj
7138
7139         ## Replace coincident edges in \a theShapes by one edge.
7140         #  @param theShapes Initial shapes, either a list or compound of shapes.
7141         #  @param theTolerance Maximum distance between edges, which can be considered as coincident.
7142         #  @param theName Object name; when specified, this parameter is used
7143         #         for result publication in the study. Otherwise, if automatic
7144         #         publication is switched on, default value is used for result name.
7145         #
7146         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7147         #
7148         #  @ref tui_glue_edges "Example"
7149         @ManageTransactions("ShapesOp")
7150         def MakeGlueEdges(self, theShapes, theTolerance, theName=None):
7151             """
7152             Replace coincident edges in theShapes by one edge.
7153
7154             Parameters:
7155                 theShapes Initial shapes, either a list or compound of shapes.
7156                 theTolerance Maximum distance between edges, which can be considered as coincident.
7157                 theName Object name; when specified, this parameter is used
7158                         for result publication in the study. Otherwise, if automatic
7159                         publication is switched on, default value is used for result name.
7160
7161             Returns:
7162                 New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7163             """
7164             theTolerance,Parameters = ParseParameters(theTolerance)
7165             anObj = self.ShapesOp.MakeGlueEdges(ToList(theShapes), theTolerance)
7166             if anObj is None:
7167                 raise RuntimeError, "MakeGlueEdges : " + self.ShapesOp.GetErrorCode()
7168             anObj.SetParameters(Parameters)
7169             self._autoPublish(anObj, theName, "glueEdges")
7170             return anObj
7171
7172         ## Find coincident edges in \a theShapes for possible gluing.
7173         #  @param theShapes Initial shapes, either a list or compound of shapes.
7174         #  @param theTolerance Maximum distance between edges,
7175         #                      which can be considered as coincident.
7176         #  @param theName Object name; when specified, this parameter is used
7177         #         for result publication in the study. Otherwise, if automatic
7178         #         publication is switched on, default value is used for result name.
7179         #
7180         #  @return GEOM.ListOfGO
7181         #
7182         #  @ref tui_glue_edges "Example"
7183         @ManageTransactions("ShapesOp")
7184         def GetGlueEdges(self, theShapes, theTolerance, theName=None):
7185             """
7186             Find coincident edges in theShapes for possible gluing.
7187
7188             Parameters:
7189                 theShapes Initial shapes, either a list or compound of shapes.
7190                 theTolerance Maximum distance between edges,
7191                              which can be considered as coincident.
7192                 theName Object name; when specified, this parameter is used
7193                         for result publication in the study. Otherwise, if automatic
7194                         publication is switched on, default value is used for result name.
7195
7196             Returns:
7197                 GEOM.ListOfGO
7198             """
7199             anObj = self.ShapesOp.GetGlueEdges(ToList(theShapes), theTolerance)
7200             RaiseIfFailed("GetGlueEdges", self.ShapesOp)
7201             self._autoPublish(anObj, theName, "edgesToGlue")
7202             return anObj
7203
7204         ## Replace coincident edges in theShapes by one edge
7205         #  in compliance with given list of edges.
7206         #  @param theShapes Initial shapes, either a list or compound of shapes.
7207         #  @param theTolerance Maximum distance between edges,
7208         #                      which can be considered as coincident.
7209         #  @param theEdges List of edges for gluing.
7210         #  @param theName Object name; when specified, this parameter is used
7211         #         for result publication in the study. Otherwise, if automatic
7212         #         publication is switched on, default value is used for result name.
7213         #
7214         #  @return New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7215         #
7216         #  @ref tui_glue_edges "Example"
7217         @ManageTransactions("ShapesOp")
7218         def MakeGlueEdgesByList(self, theShapes, theTolerance, theEdges, theName=None):
7219             """
7220             Replace coincident edges in theShapes by one edge
7221             in compliance with given list of edges.
7222
7223             Parameters:
7224                 theShapes Initial shapes, either a list or compound of shapes.
7225                 theTolerance Maximum distance between edges,
7226                              which can be considered as coincident.
7227                 theEdges List of edges for gluing.
7228                 theName Object name; when specified, this parameter is used
7229                         for result publication in the study. Otherwise, if automatic
7230                         publication is switched on, default value is used for result name.
7231
7232             Returns:
7233                 New GEOM.GEOM_Object, containing copies of theShapes without coincident edges.
7234             """
7235             anObj = self.ShapesOp.MakeGlueEdgesByList(ToList(theShapes), theTolerance, theEdges)
7236             if anObj is None:
7237                 raise RuntimeError, "MakeGlueEdgesByList : " + self.ShapesOp.GetErrorCode()
7238             self._autoPublish(anObj, theName, "glueEdges")
7239             return anObj
7240
7241         # end of l3_healing
7242         ## @}
7243
7244         ## @addtogroup l3_boolean Boolean Operations
7245         ## @{
7246
7247         # -----------------------------------------------------------------------------
7248         # Boolean (Common, Cut, Fuse, Section)
7249         # -----------------------------------------------------------------------------
7250
7251         ## Perform one of boolean operations on two given shapes.
7252         #  @param theShape1 First argument for boolean operation.
7253         #  @param theShape2 Second argument for boolean operation.
7254         #  @param theOperation Indicates the operation to be done:\n
7255         #                      1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
7256         #  @param checkSelfInte The flag that tells if the arguments should
7257         #         be checked for self-intersection prior to the operation.
7258         #  @param theName Object name; when specified, this parameter is used
7259         #         for result publication in the study. Otherwise, if automatic
7260         #         publication is switched on, default value is used for result name.
7261         #
7262         #  @note This algorithm doesn't find all types of self-intersections.
7263         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7264         #        vertex/face and edge/face intersections. Face/face
7265         #        intersections detection is switched off as it is a
7266         #        time-consuming operation that gives an impact on performance.
7267         #        To find all self-intersections please use
7268         #        CheckSelfIntersections() method.
7269         #
7270         #  @return New GEOM.GEOM_Object, containing the result shape.
7271         #
7272         #  @ref tui_fuse "Example"
7273         @ManageTransactions("BoolOp")
7274         def MakeBoolean(self, theShape1, theShape2, theOperation, checkSelfInte=False, theName=None):
7275             """
7276             Perform one of boolean operations on two given shapes.
7277
7278             Parameters:
7279                 theShape1 First argument for boolean operation.
7280                 theShape2 Second argument for boolean operation.
7281                 theOperation Indicates the operation to be done:
7282                              1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
7283                 checkSelfInte The flag that tells if the arguments should
7284                               be checked for self-intersection prior to
7285                               the operation.
7286                 theName Object name; when specified, this parameter is used
7287                         for result publication in the study. Otherwise, if automatic
7288                         publication is switched on, default value is used for result name.
7289
7290             Note:
7291                     This algorithm doesn't find all types of self-intersections.
7292                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7293                     vertex/face and edge/face intersections. Face/face
7294                     intersections detection is switched off as it is a
7295                     time-consuming operation that gives an impact on performance.
7296                     To find all self-intersections please use
7297                     CheckSelfIntersections() method.
7298
7299             Returns:
7300                 New GEOM.GEOM_Object, containing the result shape.
7301             """
7302             # Example: see GEOM_TestAll.py
7303             anObj = self.BoolOp.MakeBoolean(theShape1, theShape2, theOperation, checkSelfInte)
7304             RaiseIfFailed("MakeBoolean", self.BoolOp)
7305             def_names = { 1: "common", 2: "cut", 3: "fuse", 4: "section" }
7306             self._autoPublish(anObj, theName, def_names[theOperation])
7307             return anObj
7308
7309         ## Perform Common boolean operation on two given shapes.
7310         #  @param theShape1 First argument for boolean operation.
7311         #  @param theShape2 Second argument for boolean operation.
7312         #  @param checkSelfInte The flag that tells if the arguments should
7313         #         be checked for self-intersection prior to the operation.
7314         #  @param theName Object name; when specified, this parameter is used
7315         #         for result publication in the study. Otherwise, if automatic
7316         #         publication is switched on, default value is used for result name.
7317         #
7318         #  @note This algorithm doesn't find all types of self-intersections.
7319         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7320         #        vertex/face and edge/face intersections. Face/face
7321         #        intersections detection is switched off as it is a
7322         #        time-consuming operation that gives an impact on performance.
7323         #        To find all self-intersections please use
7324         #        CheckSelfIntersections() method.
7325         #
7326         #  @return New GEOM.GEOM_Object, containing the result shape.
7327         #
7328         #  @ref tui_common "Example 1"
7329         #  \n @ref swig_MakeCommon "Example 2"
7330         def MakeCommon(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7331             """
7332             Perform Common boolean operation on two given shapes.
7333
7334             Parameters:
7335                 theShape1 First argument for boolean operation.
7336                 theShape2 Second argument for boolean operation.
7337                 checkSelfInte The flag that tells if the arguments should
7338                               be checked for self-intersection prior to
7339                               the operation.
7340                 theName Object name; when specified, this parameter is used
7341                         for result publication in the study. Otherwise, if automatic
7342                         publication is switched on, default value is used for result name.
7343
7344             Note:
7345                     This algorithm doesn't find all types of self-intersections.
7346                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7347                     vertex/face and edge/face intersections. Face/face
7348                     intersections detection is switched off as it is a
7349                     time-consuming operation that gives an impact on performance.
7350                     To find all self-intersections please use
7351                     CheckSelfIntersections() method.
7352
7353             Returns:
7354                 New GEOM.GEOM_Object, containing the result shape.
7355             """
7356             # Example: see GEOM_TestOthers.py
7357             # note: auto-publishing is done in self.MakeBoolean()
7358             return self.MakeBoolean(theShape1, theShape2, 1, checkSelfInte, theName)
7359
7360         ## Perform Cut boolean operation on two given shapes.
7361         #  @param theShape1 First argument for boolean operation.
7362         #  @param theShape2 Second argument for boolean operation.
7363         #  @param checkSelfInte The flag that tells if the arguments should
7364         #         be checked for self-intersection prior to the operation.
7365         #  @param theName Object name; when specified, this parameter is used
7366         #         for result publication in the study. Otherwise, if automatic
7367         #         publication is switched on, default value is used for result name.
7368         #
7369         #  @note This algorithm doesn't find all types of self-intersections.
7370         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7371         #        vertex/face and edge/face intersections. Face/face
7372         #        intersections detection is switched off as it is a
7373         #        time-consuming operation that gives an impact on performance.
7374         #        To find all self-intersections please use
7375         #        CheckSelfIntersections() method.
7376         #
7377         #  @return New GEOM.GEOM_Object, containing the result shape.
7378         #
7379         #  @ref tui_cut "Example 1"
7380         #  \n @ref swig_MakeCommon "Example 2"
7381         def MakeCut(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7382             """
7383             Perform Cut boolean operation on two given shapes.
7384
7385             Parameters:
7386                 theShape1 First argument for boolean operation.
7387                 theShape2 Second argument for boolean operation.
7388                 checkSelfInte The flag that tells if the arguments should
7389                               be checked for self-intersection prior to
7390                               the operation.
7391                 theName Object name; when specified, this parameter is used
7392                         for result publication in the study. Otherwise, if automatic
7393                         publication is switched on, default value is used for result name.
7394
7395             Note:
7396                     This algorithm doesn't find all types of self-intersections.
7397                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7398                     vertex/face and edge/face intersections. Face/face
7399                     intersections detection is switched off as it is a
7400                     time-consuming operation that gives an impact on performance.
7401                     To find all self-intersections please use
7402                     CheckSelfIntersections() method.
7403
7404             Returns:
7405                 New GEOM.GEOM_Object, containing the result shape.
7406
7407             """
7408             # Example: see GEOM_TestOthers.py
7409             # note: auto-publishing is done in self.MakeBoolean()
7410             return self.MakeBoolean(theShape1, theShape2, 2, checkSelfInte, theName)
7411
7412         ## Perform Fuse boolean operation on two given shapes.
7413         #  @param theShape1 First argument for boolean operation.
7414         #  @param theShape2 Second argument for boolean operation.
7415         #  @param checkSelfInte The flag that tells if the arguments should
7416         #         be checked for self-intersection prior to the operation.
7417         #  @param rmExtraEdges The flag that tells if Remove Extra Edges
7418         #         operation should be performed during the operation.
7419         #  @param theName Object name; when specified, this parameter is used
7420         #         for result publication in the study. Otherwise, if automatic
7421         #         publication is switched on, default value is used for result name.
7422         #
7423         #  @note This algorithm doesn't find all types of self-intersections.
7424         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7425         #        vertex/face and edge/face intersections. Face/face
7426         #        intersections detection is switched off as it is a
7427         #        time-consuming operation that gives an impact on performance.
7428         #        To find all self-intersections please use
7429         #        CheckSelfIntersections() method.
7430         #
7431         #  @return New GEOM.GEOM_Object, containing the result shape.
7432         #
7433         #  @ref tui_fuse "Example 1"
7434         #  \n @ref swig_MakeCommon "Example 2"
7435         @ManageTransactions("BoolOp")
7436         def MakeFuse(self, theShape1, theShape2, checkSelfInte=False,
7437                      rmExtraEdges=False, theName=None):
7438             """
7439             Perform Fuse boolean operation on two given shapes.
7440
7441             Parameters:
7442                 theShape1 First argument for boolean operation.
7443                 theShape2 Second argument for boolean operation.
7444                 checkSelfInte The flag that tells if the arguments should
7445                               be checked for self-intersection prior to
7446                               the operation.
7447                 rmExtraEdges The flag that tells if Remove Extra Edges
7448                              operation should be performed during the operation.
7449                 theName Object name; when specified, this parameter is used
7450                         for result publication in the study. Otherwise, if automatic
7451                         publication is switched on, default value is used for result name.
7452
7453             Note:
7454                     This algorithm doesn't find all types of self-intersections.
7455                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7456                     vertex/face and edge/face intersections. Face/face
7457                     intersections detection is switched off as it is a
7458                     time-consuming operation that gives an impact on performance.
7459                     To find all self-intersections please use
7460                     CheckSelfIntersections() method.
7461
7462             Returns:
7463                 New GEOM.GEOM_Object, containing the result shape.
7464
7465             """
7466             # Example: see GEOM_TestOthers.py
7467             anObj = self.BoolOp.MakeFuse(theShape1, theShape2,
7468                                          checkSelfInte, rmExtraEdges)
7469             RaiseIfFailed("MakeFuse", self.BoolOp)
7470             self._autoPublish(anObj, theName, "fuse")
7471             return anObj
7472
7473         ## Perform Section boolean operation on two given shapes.
7474         #  @param theShape1 First argument for boolean operation.
7475         #  @param theShape2 Second argument for boolean operation.
7476         #  @param checkSelfInte The flag that tells if the arguments should
7477         #         be checked for self-intersection prior to the operation.
7478         #         If a self-intersection detected the operation fails.
7479         #  @param theName Object name; when specified, this parameter is used
7480         #         for result publication in the study. Otherwise, if automatic
7481         #         publication is switched on, default value is used for result name.
7482         #  @return New GEOM.GEOM_Object, containing the result shape.
7483         #
7484         #  @ref tui_section "Example 1"
7485         #  \n @ref swig_MakeCommon "Example 2"
7486         def MakeSection(self, theShape1, theShape2, checkSelfInte=False, theName=None):
7487             """
7488             Perform Section boolean operation on two given shapes.
7489
7490             Parameters:
7491                 theShape1 First argument for boolean operation.
7492                 theShape2 Second argument for boolean operation.
7493                 checkSelfInte The flag that tells if the arguments should
7494                               be checked for self-intersection prior to the operation.
7495                               If a self-intersection detected the operation fails.
7496                 theName Object name; when specified, this parameter is used
7497                         for result publication in the study. Otherwise, if automatic
7498                         publication is switched on, default value is used for result name.
7499             Returns:
7500                 New GEOM.GEOM_Object, containing the result shape.
7501
7502             """
7503             # Example: see GEOM_TestOthers.py
7504             # note: auto-publishing is done in self.MakeBoolean()
7505             return self.MakeBoolean(theShape1, theShape2, 4, checkSelfInte, theName)
7506
7507         ## Perform Fuse boolean operation on the list of shapes.
7508         #  @param theShapesList Shapes to be fused.
7509         #  @param checkSelfInte The flag that tells if the arguments should
7510         #         be checked for self-intersection prior to the operation.
7511         #  @param rmExtraEdges The flag that tells if Remove Extra Edges
7512         #         operation should be performed during the operation.
7513         #  @param theName Object name; when specified, this parameter is used
7514         #         for result publication in the study. Otherwise, if automatic
7515         #         publication is switched on, default value is used for result name.
7516         #
7517         #  @note This algorithm doesn't find all types of self-intersections.
7518         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7519         #        vertex/face and edge/face intersections. Face/face
7520         #        intersections detection is switched off as it is a
7521         #        time-consuming operation that gives an impact on performance.
7522         #        To find all self-intersections please use
7523         #        CheckSelfIntersections() method.
7524         #
7525         #  @return New GEOM.GEOM_Object, containing the result shape.
7526         #
7527         #  @ref tui_fuse "Example 1"
7528         #  \n @ref swig_MakeCommon "Example 2"
7529         @ManageTransactions("BoolOp")
7530         def MakeFuseList(self, theShapesList, checkSelfInte=False,
7531                          rmExtraEdges=False, theName=None):
7532             """
7533             Perform Fuse boolean operation on the list of shapes.
7534
7535             Parameters:
7536                 theShapesList Shapes to be fused.
7537                 checkSelfInte The flag that tells if the arguments should
7538                               be checked for self-intersection prior to
7539                               the operation.
7540                 rmExtraEdges The flag that tells if Remove Extra Edges
7541                              operation should be performed during the operation.
7542                 theName Object name; when specified, this parameter is used
7543                         for result publication in the study. Otherwise, if automatic
7544                         publication is switched on, default value is used for result name.
7545
7546             Note:
7547                     This algorithm doesn't find all types of self-intersections.
7548                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7549                     vertex/face and edge/face intersections. Face/face
7550                     intersections detection is switched off as it is a
7551                     time-consuming operation that gives an impact on performance.
7552                     To find all self-intersections please use
7553                     CheckSelfIntersections() method.
7554
7555             Returns:
7556                 New GEOM.GEOM_Object, containing the result shape.
7557
7558             """
7559             # Example: see GEOM_TestOthers.py
7560             anObj = self.BoolOp.MakeFuseList(theShapesList, checkSelfInte,
7561                                              rmExtraEdges)
7562             RaiseIfFailed("MakeFuseList", self.BoolOp)
7563             self._autoPublish(anObj, theName, "fuse")
7564             return anObj
7565
7566         ## Perform Common boolean operation on the list of shapes.
7567         #  @param theShapesList Shapes for Common operation.
7568         #  @param checkSelfInte The flag that tells if the arguments should
7569         #         be checked for self-intersection prior to the operation.
7570         #  @param theName Object name; when specified, this parameter is used
7571         #         for result publication in the study. Otherwise, if automatic
7572         #         publication is switched on, default value is used for result name.
7573         #
7574         #  @note This algorithm doesn't find all types of self-intersections.
7575         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7576         #        vertex/face and edge/face intersections. Face/face
7577         #        intersections detection is switched off as it is a
7578         #        time-consuming operation that gives an impact on performance.
7579         #        To find all self-intersections please use
7580         #        CheckSelfIntersections() method.
7581         #
7582         #  @return New GEOM.GEOM_Object, containing the result shape.
7583         #
7584         #  @ref tui_common "Example 1"
7585         #  \n @ref swig_MakeCommon "Example 2"
7586         @ManageTransactions("BoolOp")
7587         def MakeCommonList(self, theShapesList, checkSelfInte=False, theName=None):
7588             """
7589             Perform Common boolean operation on the list of shapes.
7590
7591             Parameters:
7592                 theShapesList Shapes for Common operation.
7593                 checkSelfInte The flag that tells if the arguments should
7594                               be checked for self-intersection prior to
7595                               the operation.
7596                 theName Object name; when specified, this parameter is used
7597                         for result publication in the study. Otherwise, if automatic
7598                         publication is switched on, default value is used for result name.
7599
7600             Note:
7601                     This algorithm doesn't find all types of self-intersections.
7602                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7603                     vertex/face and edge/face intersections. Face/face
7604                     intersections detection is switched off as it is a
7605                     time-consuming operation that gives an impact on performance.
7606                     To find all self-intersections please use
7607                     CheckSelfIntersections() method.
7608
7609             Returns:
7610                 New GEOM.GEOM_Object, containing the result shape.
7611
7612             """
7613             # Example: see GEOM_TestOthers.py
7614             anObj = self.BoolOp.MakeCommonList(theShapesList, checkSelfInte)
7615             RaiseIfFailed("MakeCommonList", self.BoolOp)
7616             self._autoPublish(anObj, theName, "common")
7617             return anObj
7618
7619         ## Perform Cut boolean operation on one object and the list of tools.
7620         #  @param theMainShape The object of the operation.
7621         #  @param theShapesList The list of tools of the operation.
7622         #  @param checkSelfInte The flag that tells if the arguments should
7623         #         be checked for self-intersection prior to the operation.
7624         #  @param theName Object name; when specified, this parameter is used
7625         #         for result publication in the study. Otherwise, if automatic
7626         #         publication is switched on, default value is used for result name.
7627         #
7628         #  @note This algorithm doesn't find all types of self-intersections.
7629         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7630         #        vertex/face and edge/face intersections. Face/face
7631         #        intersections detection is switched off as it is a
7632         #        time-consuming operation that gives an impact on performance.
7633         #        To find all self-intersections please use
7634         #        CheckSelfIntersections() method.
7635         #
7636         #  @return New GEOM.GEOM_Object, containing the result shape.
7637         #
7638         #  @ref tui_cut "Example 1"
7639         #  \n @ref swig_MakeCommon "Example 2"
7640         @ManageTransactions("BoolOp")
7641         def MakeCutList(self, theMainShape, theShapesList, checkSelfInte=False, theName=None):
7642             """
7643             Perform Cut boolean operation on one object and the list of tools.
7644
7645             Parameters:
7646                 theMainShape The object of the operation.
7647                 theShapesList The list of tools of the operation.
7648                 checkSelfInte The flag that tells if the arguments should
7649                               be checked for self-intersection prior to
7650                               the operation.
7651                 theName Object name; when specified, this parameter is used
7652                         for result publication in the study. Otherwise, if automatic
7653                         publication is switched on, default value is used for result name.
7654
7655             Note:
7656                     This algorithm doesn't find all types of self-intersections.
7657                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7658                     vertex/face and edge/face intersections. Face/face
7659                     intersections detection is switched off as it is a
7660                     time-consuming operation that gives an impact on performance.
7661                     To find all self-intersections please use
7662                     CheckSelfIntersections() method.
7663
7664             Returns:
7665                 New GEOM.GEOM_Object, containing the result shape.
7666
7667             """
7668             # Example: see GEOM_TestOthers.py
7669             anObj = self.BoolOp.MakeCutList(theMainShape, theShapesList, checkSelfInte)
7670             RaiseIfFailed("MakeCutList", self.BoolOp)
7671             self._autoPublish(anObj, theName, "cut")
7672             return anObj
7673
7674         # end of l3_boolean
7675         ## @}
7676
7677         ## @addtogroup l3_basic_op
7678         ## @{
7679
7680         ## Perform partition operation.
7681         #  @param ListShapes Shapes to be intersected.
7682         #  @param ListTools Shapes to intersect theShapes.
7683         #  @param Limit Type of resulting shapes (see ShapeType()).\n
7684         #         If this parameter is set to -1 ("Auto"), most appropriate shape limit
7685         #         type will be detected automatically.
7686         #  @param KeepNonlimitShapes if this parameter == 0, then only shapes of
7687         #                             target type (equal to Limit) are kept in the result,
7688         #                             else standalone shapes of lower dimension
7689         #                             are kept also (if they exist).
7690         #
7691         #  @param theName Object name; when specified, this parameter is used
7692         #         for result publication in the study. Otherwise, if automatic
7693         #         publication is switched on, default value is used for result name.
7694         #
7695         #  @note Each compound from ListShapes and ListTools will be exploded
7696         #        in order to avoid possible intersection between shapes from this compound.
7697         #
7698         #  After implementation new version of PartitionAlgo (October 2006)
7699         #  other parameters are ignored by current functionality. They are kept
7700         #  in this function only for support old versions.
7701         #      @param ListKeepInside Shapes, outside which the results will be deleted.
7702         #         Each shape from theKeepInside must belong to theShapes also.
7703         #      @param ListRemoveInside Shapes, inside which the results will be deleted.
7704         #         Each shape from theRemoveInside must belong to theShapes also.
7705         #      @param RemoveWebs If TRUE, perform Glue 3D algorithm.
7706         #      @param ListMaterials Material indices for each shape. Make sence,
7707         #         only if theRemoveWebs is TRUE.
7708         #
7709         #  @return New GEOM.GEOM_Object, containing the result shapes.
7710         #
7711         #  @ref tui_partition "Example"
7712         @ManageTransactions("BoolOp")
7713         def MakePartition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
7714                           Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
7715                           KeepNonlimitShapes=0, theName=None):
7716             """
7717             Perform partition operation.
7718
7719             Parameters:
7720                 ListShapes Shapes to be intersected.
7721                 ListTools Shapes to intersect theShapes.
7722                 Limit Type of resulting shapes (see geompy.ShapeType)
7723                       If this parameter is set to -1 ("Auto"), most appropriate shape limit
7724                       type will be detected automatically.
7725                 KeepNonlimitShapes if this parameter == 0, then only shapes of
7726                                     target type (equal to Limit) are kept in the result,
7727                                     else standalone shapes of lower dimension
7728                                     are kept also (if they exist).
7729
7730                 theName Object name; when specified, this parameter is used
7731                         for result publication in the study. Otherwise, if automatic
7732                         publication is switched on, default value is used for result name.
7733             Note:
7734                     Each compound from ListShapes and ListTools will be exploded
7735                     in order to avoid possible intersection between shapes from
7736                     this compound.
7737
7738             After implementation new version of PartitionAlgo (October 2006) other
7739             parameters are ignored by current functionality. They are kept in this
7740             function only for support old versions.
7741
7742             Ignored parameters:
7743                 ListKeepInside Shapes, outside which the results will be deleted.
7744                                Each shape from theKeepInside must belong to theShapes also.
7745                 ListRemoveInside Shapes, inside which the results will be deleted.
7746                                  Each shape from theRemoveInside must belong to theShapes also.
7747                 RemoveWebs If TRUE, perform Glue 3D algorithm.
7748                 ListMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
7749
7750             Returns:
7751                 New GEOM.GEOM_Object, containing the result shapes.
7752             """
7753             # Example: see GEOM_TestAll.py
7754             if Limit == self.ShapeType["AUTO"]:
7755                 # automatic detection of the most appropriate shape limit type
7756                 lim = GEOM.SHAPE
7757                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
7758                 Limit = EnumToLong(lim)
7759                 pass
7760             anObj = self.BoolOp.MakePartition(ListShapes, ListTools,
7761                                               ListKeepInside, ListRemoveInside,
7762                                               Limit, RemoveWebs, ListMaterials,
7763                                               KeepNonlimitShapes);
7764             RaiseIfFailed("MakePartition", self.BoolOp)
7765             self._autoPublish(anObj, theName, "partition")
7766             return anObj
7767
7768         ## Perform partition operation.
7769         #  This method may be useful if it is needed to make a partition for
7770         #  compound contains nonintersected shapes. Performance will be better
7771         #  since intersection between shapes from compound is not performed.
7772         #
7773         #  Description of all parameters as in previous method MakePartition().
7774         #  One additional parameter is provided:
7775         #  @param checkSelfInte The flag that tells if the arguments should
7776         #         be checked for self-intersection prior to the operation.
7777         #
7778         #  @note This algorithm doesn't find all types of self-intersections.
7779         #        It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7780         #        vertex/face and edge/face intersections. Face/face
7781         #        intersections detection is switched off as it is a
7782         #        time-consuming operation that gives an impact on performance.
7783         #        To find all self-intersections please use
7784         #        CheckSelfIntersections() method.
7785         #
7786         #  @note Passed compounds (via ListShapes or via ListTools)
7787         #           have to consist of nonintersecting shapes.
7788         #
7789         #  @return New GEOM.GEOM_Object, containing the result shapes.
7790         #
7791         #  @ref swig_todo "Example"
7792         @ManageTransactions("BoolOp")
7793         def MakePartitionNonSelfIntersectedShape(self, ListShapes, ListTools=[],
7794                                                  ListKeepInside=[], ListRemoveInside=[],
7795                                                  Limit=ShapeType["AUTO"], RemoveWebs=0,
7796                                                  ListMaterials=[], KeepNonlimitShapes=0,
7797                                                  checkSelfInte=False, theName=None):
7798             """
7799             Perform partition operation.
7800             This method may be useful if it is needed to make a partition for
7801             compound contains nonintersected shapes. Performance will be better
7802             since intersection between shapes from compound is not performed.
7803
7804             Parameters:
7805                 Description of all parameters as in method geompy.MakePartition.
7806                 One additional parameter is provided:
7807                 checkSelfInte The flag that tells if the arguments should
7808                               be checked for self-intersection prior to
7809                               the operation.
7810
7811             Note:
7812                     This algorithm doesn't find all types of self-intersections.
7813                     It is tuned to detect vertex/vertex, vertex/edge, edge/edge,
7814                     vertex/face and edge/face intersections. Face/face
7815                     intersections detection is switched off as it is a
7816                     time-consuming operation that gives an impact on performance.
7817                     To find all self-intersections please use
7818                     CheckSelfIntersections() method.
7819
7820             NOTE:
7821                 Passed compounds (via ListShapes or via ListTools)
7822                 have to consist of nonintersecting shapes.
7823
7824             Returns:
7825                 New GEOM.GEOM_Object, containing the result shapes.
7826             """
7827             if Limit == self.ShapeType["AUTO"]:
7828                 # automatic detection of the most appropriate shape limit type
7829                 lim = GEOM.SHAPE
7830                 for s in ListShapes: lim = min( lim, s.GetMaxShapeType() )
7831                 Limit = EnumToLong(lim)
7832                 pass
7833             anObj = self.BoolOp.MakePartitionNonSelfIntersectedShape(ListShapes, ListTools,
7834                                                                      ListKeepInside, ListRemoveInside,
7835                                                                      Limit, RemoveWebs, ListMaterials,
7836                                                                      KeepNonlimitShapes, checkSelfInte);
7837             RaiseIfFailed("MakePartitionNonSelfIntersectedShape", self.BoolOp)
7838             self._autoPublish(anObj, theName, "partition")
7839             return anObj
7840
7841         ## See method MakePartition() for more information.
7842         #
7843         #  @ref tui_partition "Example 1"
7844         #  \n @ref swig_Partition "Example 2"
7845         def Partition(self, ListShapes, ListTools=[], ListKeepInside=[], ListRemoveInside=[],
7846                       Limit=ShapeType["AUTO"], RemoveWebs=0, ListMaterials=[],
7847                       KeepNonlimitShapes=0, theName=None):
7848             """
7849             See method geompy.MakePartition for more information.
7850             """
7851             # Example: see GEOM_TestOthers.py
7852             # note: auto-publishing is done in self.MakePartition()
7853             anObj = self.MakePartition(ListShapes, ListTools,
7854                                        ListKeepInside, ListRemoveInside,
7855                                        Limit, RemoveWebs, ListMaterials,
7856                                        KeepNonlimitShapes, theName);
7857             return anObj
7858
7859         ## Perform partition of the Shape with the Plane
7860         #  @param theShape Shape to be intersected.
7861         #  @param thePlane Tool shape, to intersect theShape.
7862         #  @param theName Object name; when specified, this parameter is used
7863         #         for result publication in the study. Otherwise, if automatic
7864         #         publication is switched on, default value is used for result name.
7865         #
7866         #  @return New GEOM.GEOM_Object, containing the result shape.
7867         #
7868         #  @ref tui_partition "Example"
7869         @ManageTransactions("BoolOp")
7870         def MakeHalfPartition(self, theShape, thePlane, theName=None):
7871             """
7872             Perform partition of the Shape with the Plane
7873
7874             Parameters:
7875                 theShape Shape to be intersected.
7876                 thePlane Tool shape, to intersect theShape.
7877                 theName Object name; when specified, this parameter is used
7878                         for result publication in the study. Otherwise, if automatic
7879                         publication is switched on, default value is used for result name.
7880
7881             Returns:
7882                 New GEOM.GEOM_Object, containing the result shape.
7883             """
7884             # Example: see GEOM_TestAll.py
7885             anObj = self.BoolOp.MakeHalfPartition(theShape, thePlane)
7886             RaiseIfFailed("MakeHalfPartition", self.BoolOp)
7887             self._autoPublish(anObj, theName, "partition")
7888             return anObj
7889
7890         # end of l3_basic_op
7891         ## @}
7892
7893         ## @addtogroup l3_transform
7894         ## @{
7895
7896         ## Translate the given object along the vector, specified
7897         #  by its end points.
7898         #  @param theObject The object to be translated.
7899         #  @param thePoint1 Start point of translation vector.
7900         #  @param thePoint2 End point of translation vector.
7901         #  @param theCopy Flag used to translate object itself or create a copy.
7902         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
7903         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
7904         @ManageTransactions("TrsfOp")
7905         def TranslateTwoPoints(self, theObject, thePoint1, thePoint2, theCopy=False):
7906             """
7907             Translate the given object along the vector, specified by its end points.
7908
7909             Parameters:
7910                 theObject The object to be translated.
7911                 thePoint1 Start point of translation vector.
7912                 thePoint2 End point of translation vector.
7913                 theCopy Flag used to translate object itself or create a copy.
7914
7915             Returns:
7916                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
7917                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
7918             """
7919             if theCopy:
7920                 anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
7921             else:
7922                 anObj = self.TrsfOp.TranslateTwoPoints(theObject, thePoint1, thePoint2)
7923             RaiseIfFailed("TranslateTwoPoints", self.TrsfOp)
7924             return anObj
7925
7926         ## Translate the given object along the vector, specified
7927         #  by its end points, creating its copy before the translation.
7928         #  @param theObject The object to be translated.
7929         #  @param thePoint1 Start point of translation vector.
7930         #  @param thePoint2 End point of translation vector.
7931         #  @param theName Object name; when specified, this parameter is used
7932         #         for result publication in the study. Otherwise, if automatic
7933         #         publication is switched on, default value is used for result name.
7934         #
7935         #  @return New GEOM.GEOM_Object, containing the translated object.
7936         #
7937         #  @ref tui_translation "Example 1"
7938         #  \n @ref swig_MakeTranslationTwoPoints "Example 2"
7939         @ManageTransactions("TrsfOp")
7940         def MakeTranslationTwoPoints(self, theObject, thePoint1, thePoint2, theName=None):
7941             """
7942             Translate the given object along the vector, specified
7943             by its end points, creating its copy before the translation.
7944
7945             Parameters:
7946                 theObject The object to be translated.
7947                 thePoint1 Start point of translation vector.
7948                 thePoint2 End point of translation vector.
7949                 theName Object name; when specified, this parameter is used
7950                         for result publication in the study. Otherwise, if automatic
7951                         publication is switched on, default value is used for result name.
7952
7953             Returns:
7954                 New GEOM.GEOM_Object, containing the translated object.
7955             """
7956             # Example: see GEOM_TestAll.py
7957             anObj = self.TrsfOp.TranslateTwoPointsCopy(theObject, thePoint1, thePoint2)
7958             RaiseIfFailed("TranslateTwoPointsCopy", self.TrsfOp)
7959             self._autoPublish(anObj, theName, "translated")
7960             return anObj
7961
7962         ## Translate the given object along the vector, specified by its components.
7963         #  @param theObject The object to be translated.
7964         #  @param theDX,theDY,theDZ Components of translation vector.
7965         #  @param theCopy Flag used to translate object itself or create a copy.
7966         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
7967         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
7968         #
7969         #  @ref tui_translation "Example"
7970         @ManageTransactions("TrsfOp")
7971         def TranslateDXDYDZ(self, theObject, theDX, theDY, theDZ, theCopy=False):
7972             """
7973             Translate the given object along the vector, specified by its components.
7974
7975             Parameters:
7976                 theObject The object to be translated.
7977                 theDX,theDY,theDZ Components of translation vector.
7978                 theCopy Flag used to translate object itself or create a copy.
7979
7980             Returns:
7981                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
7982                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
7983             """
7984             # Example: see GEOM_TestAll.py
7985             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
7986             if theCopy:
7987                 anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
7988             else:
7989                 anObj = self.TrsfOp.TranslateDXDYDZ(theObject, theDX, theDY, theDZ)
7990             anObj.SetParameters(Parameters)
7991             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
7992             return anObj
7993
7994         ## Translate the given object along the vector, specified
7995         #  by its components, creating its copy before the translation.
7996         #  @param theObject The object to be translated.
7997         #  @param theDX,theDY,theDZ Components of translation vector.
7998         #  @param theName Object name; when specified, this parameter is used
7999         #         for result publication in the study. Otherwise, if automatic
8000         #         publication is switched on, default value is used for result name.
8001         #
8002         #  @return New GEOM.GEOM_Object, containing the translated object.
8003         #
8004         #  @ref tui_translation "Example"
8005         @ManageTransactions("TrsfOp")
8006         def MakeTranslation(self,theObject, theDX, theDY, theDZ, theName=None):
8007             """
8008             Translate the given object along the vector, specified
8009             by its components, creating its copy before the translation.
8010
8011             Parameters:
8012                 theObject The object to be translated.
8013                 theDX,theDY,theDZ Components of translation vector.
8014                 theName Object name; when specified, this parameter is used
8015                         for result publication in the study. Otherwise, if automatic
8016                         publication is switched on, default value is used for result name.
8017
8018             Returns:
8019                 New GEOM.GEOM_Object, containing the translated object.
8020             """
8021             # Example: see GEOM_TestAll.py
8022             theDX, theDY, theDZ, Parameters = ParseParameters(theDX, theDY, theDZ)
8023             anObj = self.TrsfOp.TranslateDXDYDZCopy(theObject, theDX, theDY, theDZ)
8024             anObj.SetParameters(Parameters)
8025             RaiseIfFailed("TranslateDXDYDZ", self.TrsfOp)
8026             self._autoPublish(anObj, theName, "translated")
8027             return anObj
8028
8029         ## Translate the given object along the given vector.
8030         #  @param theObject The object to be translated.
8031         #  @param theVector The translation vector.
8032         #  @param theCopy Flag used to translate object itself or create a copy.
8033         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8034         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8035         @ManageTransactions("TrsfOp")
8036         def TranslateVector(self, theObject, theVector, theCopy=False):
8037             """
8038             Translate the given object along the given vector.
8039
8040             Parameters:
8041                 theObject The object to be translated.
8042                 theVector The translation vector.
8043                 theCopy Flag used to translate object itself or create a copy.
8044
8045             Returns:
8046                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8047                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8048             """
8049             if theCopy:
8050                 anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
8051             else:
8052                 anObj = self.TrsfOp.TranslateVector(theObject, theVector)
8053             RaiseIfFailed("TranslateVector", self.TrsfOp)
8054             return anObj
8055
8056         ## Translate the given object along the given vector,
8057         #  creating its copy before the translation.
8058         #  @param theObject The object to be translated.
8059         #  @param theVector The translation vector.
8060         #  @param theName Object name; when specified, this parameter is used
8061         #         for result publication in the study. Otherwise, if automatic
8062         #         publication is switched on, default value is used for result name.
8063         #
8064         #  @return New GEOM.GEOM_Object, containing the translated object.
8065         #
8066         #  @ref tui_translation "Example"
8067         @ManageTransactions("TrsfOp")
8068         def MakeTranslationVector(self, theObject, theVector, theName=None):
8069             """
8070             Translate the given object along the given vector,
8071             creating its copy before the translation.
8072
8073             Parameters:
8074                 theObject The object to be translated.
8075                 theVector The translation vector.
8076                 theName Object name; when specified, this parameter is used
8077                         for result publication in the study. Otherwise, if automatic
8078                         publication is switched on, default value is used for result name.
8079
8080             Returns:
8081                 New GEOM.GEOM_Object, containing the translated object.
8082             """
8083             # Example: see GEOM_TestAll.py
8084             anObj = self.TrsfOp.TranslateVectorCopy(theObject, theVector)
8085             RaiseIfFailed("TranslateVectorCopy", self.TrsfOp)
8086             self._autoPublish(anObj, theName, "translated")
8087             return anObj
8088
8089         ## Translate the given object along the given vector on given distance.
8090         #  @param theObject The object to be translated.
8091         #  @param theVector The translation vector.
8092         #  @param theDistance The translation distance.
8093         #  @param theCopy Flag used to translate object itself or create a copy.
8094         #  @return Translated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8095         #  new GEOM.GEOM_Object, containing the translated object if @a theCopy flag is @c True.
8096         #
8097         #  @ref tui_translation "Example"
8098         @ManageTransactions("TrsfOp")
8099         def TranslateVectorDistance(self, theObject, theVector, theDistance, theCopy=False):
8100             """
8101             Translate the given object along the given vector on given distance.
8102
8103             Parameters:
8104                 theObject The object to be translated.
8105                 theVector The translation vector.
8106                 theDistance The translation distance.
8107                 theCopy Flag used to translate object itself or create a copy.
8108
8109             Returns:
8110                 Translated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8111                 new GEOM.GEOM_Object, containing the translated object if theCopy flag is True.
8112             """
8113             # Example: see GEOM_TestAll.py
8114             theDistance,Parameters = ParseParameters(theDistance)
8115             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, theCopy)
8116             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
8117             anObj.SetParameters(Parameters)
8118             return anObj
8119
8120         ## Translate the given object along the given vector on given distance,
8121         #  creating its copy before the translation.
8122         #  @param theObject The object to be translated.
8123         #  @param theVector The translation vector.
8124         #  @param theDistance The translation distance.
8125         #  @param theName Object name; when specified, this parameter is used
8126         #         for result publication in the study. Otherwise, if automatic
8127         #         publication is switched on, default value is used for result name.
8128         #
8129         #  @return New GEOM.GEOM_Object, containing the translated object.
8130         #
8131         #  @ref tui_translation "Example"
8132         @ManageTransactions("TrsfOp")
8133         def MakeTranslationVectorDistance(self, theObject, theVector, theDistance, theName=None):
8134             """
8135             Translate the given object along the given vector on given distance,
8136             creating its copy before the translation.
8137
8138             Parameters:
8139                 theObject The object to be translated.
8140                 theVector The translation vector.
8141                 theDistance The translation distance.
8142                 theName Object name; when specified, this parameter is used
8143                         for result publication in the study. Otherwise, if automatic
8144                         publication is switched on, default value is used for result name.
8145
8146             Returns:
8147                 New GEOM.GEOM_Object, containing the translated object.
8148             """
8149             # Example: see GEOM_TestAll.py
8150             theDistance,Parameters = ParseParameters(theDistance)
8151             anObj = self.TrsfOp.TranslateVectorDistance(theObject, theVector, theDistance, 1)
8152             RaiseIfFailed("TranslateVectorDistance", self.TrsfOp)
8153             anObj.SetParameters(Parameters)
8154             self._autoPublish(anObj, theName, "translated")
8155             return anObj
8156
8157         ## Rotate the given object around the given axis on the given angle.
8158         #  @param theObject The object to be rotated.
8159         #  @param theAxis Rotation axis.
8160         #  @param theAngle Rotation angle in radians.
8161         #  @param theCopy Flag used to rotate object itself or create a copy.
8162         #
8163         #  @return Rotated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8164         #  new GEOM.GEOM_Object, containing the rotated object if @a theCopy flag is @c True.
8165         #
8166         #  @ref tui_rotation "Example"
8167         @ManageTransactions("TrsfOp")
8168         def Rotate(self, theObject, theAxis, theAngle, theCopy=False):
8169             """
8170             Rotate the given object around the given axis on the given angle.
8171
8172             Parameters:
8173                 theObject The object to be rotated.
8174                 theAxis Rotation axis.
8175                 theAngle Rotation angle in radians.
8176                 theCopy Flag used to rotate object itself or create a copy.
8177
8178             Returns:
8179                 Rotated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8180                 new GEOM.GEOM_Object, containing the rotated object if theCopy flag is True.
8181             """
8182             # Example: see GEOM_TestAll.py
8183             flag = False
8184             if isinstance(theAngle,str):
8185                 flag = True
8186             theAngle, Parameters = ParseParameters(theAngle)
8187             if flag:
8188                 theAngle = theAngle*math.pi/180.0
8189             if theCopy:
8190                 anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
8191             else:
8192                 anObj = self.TrsfOp.Rotate(theObject, theAxis, theAngle)
8193             RaiseIfFailed("Rotate", self.TrsfOp)
8194             anObj.SetParameters(Parameters)
8195             return anObj
8196
8197         ## Rotate the given object around the given axis
8198         #  on the given angle, creating its copy before the rotation.
8199         #  @param theObject The object to be rotated.
8200         #  @param theAxis Rotation axis.
8201         #  @param theAngle Rotation angle in radians.
8202         #  @param theName Object name; when specified, this parameter is used
8203         #         for result publication in the study. Otherwise, if automatic
8204         #         publication is switched on, default value is used for result name.
8205         #
8206         #  @return New GEOM.GEOM_Object, containing the rotated object.
8207         #
8208         #  @ref tui_rotation "Example"
8209         @ManageTransactions("TrsfOp")
8210         def MakeRotation(self, theObject, theAxis, theAngle, theName=None):
8211             """
8212             Rotate the given object around the given axis
8213             on the given angle, creating its copy before the rotatation.
8214
8215             Parameters:
8216                 theObject The object to be rotated.
8217                 theAxis Rotation axis.
8218                 theAngle Rotation angle in radians.
8219                 theName Object name; when specified, this parameter is used
8220                         for result publication in the study. Otherwise, if automatic
8221                         publication is switched on, default value is used for result name.
8222
8223             Returns:
8224                 New GEOM.GEOM_Object, containing the rotated object.
8225             """
8226             # Example: see GEOM_TestAll.py
8227             flag = False
8228             if isinstance(theAngle,str):
8229                 flag = True
8230             theAngle, Parameters = ParseParameters(theAngle)
8231             if flag:
8232                 theAngle = theAngle*math.pi/180.0
8233             anObj = self.TrsfOp.RotateCopy(theObject, theAxis, theAngle)
8234             RaiseIfFailed("RotateCopy", self.TrsfOp)
8235             anObj.SetParameters(Parameters)
8236             self._autoPublish(anObj, theName, "rotated")
8237             return anObj
8238
8239         ## Rotate given object around vector perpendicular to plane
8240         #  containing three points.
8241         #  @param theObject The object to be rotated.
8242         #  @param theCentPoint central point the axis is the vector perpendicular to the plane
8243         #  containing the three points.
8244         #  @param thePoint1,thePoint2 points in a perpendicular plane of the axis.
8245         #  @param theCopy Flag used to rotate object itself or create a copy.
8246         #  @return Rotated @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8247         #  new GEOM.GEOM_Object, containing the rotated object if @a theCopy flag is @c True.
8248         @ManageTransactions("TrsfOp")
8249         def RotateThreePoints(self, theObject, theCentPoint, thePoint1, thePoint2, theCopy=False):
8250             """
8251             Rotate given object around vector perpendicular to plane
8252             containing three points.
8253
8254             Parameters:
8255                 theObject The object to be rotated.
8256                 theCentPoint central point  the axis is the vector perpendicular to the plane
8257                              containing the three points.
8258                 thePoint1,thePoint2 points in a perpendicular plane of the axis.
8259                 theCopy Flag used to rotate object itself or create a copy.
8260
8261             Returns:
8262                 Rotated theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8263                 new GEOM.GEOM_Object, containing the rotated object if theCopy flag is True.
8264             """
8265             if theCopy:
8266                 anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
8267             else:
8268                 anObj = self.TrsfOp.RotateThreePoints(theObject, theCentPoint, thePoint1, thePoint2)
8269             RaiseIfFailed("RotateThreePoints", self.TrsfOp)
8270             return anObj
8271
8272         ## Rotate given object around vector perpendicular to plane
8273         #  containing three points, creating its copy before the rotatation.
8274         #  @param theObject The object to be rotated.
8275         #  @param theCentPoint central point the axis is the vector perpendicular to the plane
8276         #  containing the three points.
8277         #  @param thePoint1,thePoint2 in a perpendicular plane of the axis.
8278         #  @param theName Object name; when specified, this parameter is used
8279         #         for result publication in the study. Otherwise, if automatic
8280         #         publication is switched on, default value is used for result name.
8281         #
8282         #  @return New GEOM.GEOM_Object, containing the rotated object.
8283         #
8284         #  @ref tui_rotation "Example"
8285         @ManageTransactions("TrsfOp")
8286         def MakeRotationThreePoints(self, theObject, theCentPoint, thePoint1, thePoint2, theName=None):
8287             """
8288             Rotate given object around vector perpendicular to plane
8289             containing three points, creating its copy before the rotatation.
8290
8291             Parameters:
8292                 theObject The object to be rotated.
8293                 theCentPoint central point  the axis is the vector perpendicular to the plane
8294                              containing the three points.
8295                 thePoint1,thePoint2  in a perpendicular plane of the axis.
8296                 theName Object name; when specified, this parameter is used
8297                         for result publication in the study. Otherwise, if automatic
8298                         publication is switched on, default value is used for result name.
8299
8300             Returns:
8301                 New GEOM.GEOM_Object, containing the rotated object.
8302             """
8303             # Example: see GEOM_TestAll.py
8304             anObj = self.TrsfOp.RotateThreePointsCopy(theObject, theCentPoint, thePoint1, thePoint2)
8305             RaiseIfFailed("RotateThreePointsCopy", self.TrsfOp)
8306             self._autoPublish(anObj, theName, "rotated")
8307             return anObj
8308
8309         ## Scale the given object by the specified factor.
8310         #  @param theObject The object to be scaled.
8311         #  @param thePoint Center point for scaling.
8312         #                  Passing None for it means scaling relatively the origin of global CS.
8313         #  @param theFactor Scaling factor value.
8314         #  @param theCopy Flag used to scale object itself or create a copy.
8315         #  @return Scaled @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8316         #  new GEOM.GEOM_Object, containing the scaled object if @a theCopy flag is @c True.
8317         @ManageTransactions("TrsfOp")
8318         def Scale(self, theObject, thePoint, theFactor, theCopy=False):
8319             """
8320             Scale the given object by the specified factor.
8321
8322             Parameters:
8323                 theObject The object to be scaled.
8324                 thePoint Center point for scaling.
8325                          Passing None for it means scaling relatively the origin of global CS.
8326                 theFactor Scaling factor value.
8327                 theCopy Flag used to scale object itself or create a copy.
8328
8329             Returns:
8330                 Scaled theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8331                 new GEOM.GEOM_Object, containing the scaled object if theCopy flag is True.
8332             """
8333             # Example: see GEOM_TestAll.py
8334             theFactor, Parameters = ParseParameters(theFactor)
8335             if theCopy:
8336                 anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
8337             else:
8338                 anObj = self.TrsfOp.ScaleShape(theObject, thePoint, theFactor)
8339             RaiseIfFailed("Scale", self.TrsfOp)
8340             anObj.SetParameters(Parameters)
8341             return anObj
8342
8343         ## Scale the given object by the factor, creating its copy before the scaling.
8344         #  @param theObject The object to be scaled.
8345         #  @param thePoint Center point for scaling.
8346         #                  Passing None for it means scaling relatively the origin of global CS.
8347         #  @param theFactor Scaling factor value.
8348         #  @param theName Object name; when specified, this parameter is used
8349         #         for result publication in the study. Otherwise, if automatic
8350         #         publication is switched on, default value is used for result name.
8351         #
8352         #  @return New GEOM.GEOM_Object, containing the scaled shape.
8353         #
8354         #  @ref tui_scale "Example"
8355         @ManageTransactions("TrsfOp")
8356         def MakeScaleTransform(self, theObject, thePoint, theFactor, theName=None):
8357             """
8358             Scale the given object by the factor, creating its copy before the scaling.
8359
8360             Parameters:
8361                 theObject The object to be scaled.
8362                 thePoint Center point for scaling.
8363                          Passing None for it means scaling relatively the origin of global CS.
8364                 theFactor Scaling factor value.
8365                 theName Object name; when specified, this parameter is used
8366                         for result publication in the study. Otherwise, if automatic
8367                         publication is switched on, default value is used for result name.
8368
8369             Returns:
8370                 New GEOM.GEOM_Object, containing the scaled shape.
8371             """
8372             # Example: see GEOM_TestAll.py
8373             theFactor, Parameters = ParseParameters(theFactor)
8374             anObj = self.TrsfOp.ScaleShapeCopy(theObject, thePoint, theFactor)
8375             RaiseIfFailed("ScaleShapeCopy", self.TrsfOp)
8376             anObj.SetParameters(Parameters)
8377             self._autoPublish(anObj, theName, "scaled")
8378             return anObj
8379
8380         ## Scale the given object by different factors along coordinate axes.
8381         #  @param theObject The object to be scaled.
8382         #  @param thePoint Center point for scaling.
8383         #                  Passing None for it means scaling relatively the origin of global CS.
8384         #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8385         #  @param theCopy Flag used to scale object itself or create a copy.
8386         #  @return Scaled @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8387         #  new GEOM.GEOM_Object, containing the scaled object if @a theCopy flag is @c True.
8388         @ManageTransactions("TrsfOp")
8389         def ScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ, theCopy=False):
8390             """
8391             Scale the given object by different factors along coordinate axes.
8392
8393             Parameters:
8394                 theObject The object to be scaled.
8395                 thePoint Center point for scaling.
8396                             Passing None for it means scaling relatively the origin of global CS.
8397                 theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8398                 theCopy Flag used to scale object itself or create a copy.
8399
8400             Returns:
8401                 Scaled theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8402                 new GEOM.GEOM_Object, containing the scaled object if theCopy flag is True.
8403             """
8404             # Example: see GEOM_TestAll.py
8405             theFactorX, theFactorY, theFactorZ, Parameters = ParseParameters(theFactorX, theFactorY, theFactorZ)
8406             if theCopy:
8407                 anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
8408                                                             theFactorX, theFactorY, theFactorZ)
8409             else:
8410                 anObj = self.TrsfOp.ScaleShapeAlongAxes(theObject, thePoint,
8411                                                         theFactorX, theFactorY, theFactorZ)
8412             RaiseIfFailed("ScaleAlongAxes", self.TrsfOp)
8413             anObj.SetParameters(Parameters)
8414             return anObj
8415
8416         ## Scale the given object by different factors along coordinate axes,
8417         #  creating its copy before the scaling.
8418         #  @param theObject The object to be scaled.
8419         #  @param thePoint Center point for scaling.
8420         #                  Passing None for it means scaling relatively the origin of global CS.
8421         #  @param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8422         #  @param theName Object name; when specified, this parameter is used
8423         #         for result publication in the study. Otherwise, if automatic
8424         #         publication is switched on, default value is used for result name.
8425         #
8426         #  @return New GEOM.GEOM_Object, containing the scaled shape.
8427         #
8428         #  @ref swig_scale "Example"
8429         @ManageTransactions("TrsfOp")
8430         def MakeScaleAlongAxes(self, theObject, thePoint, theFactorX, theFactorY, theFactorZ, theName=None):
8431             """
8432             Scale the given object by different factors along coordinate axes,
8433             creating its copy before the scaling.
8434
8435             Parameters:
8436                 theObject The object to be scaled.
8437                 thePoint Center point for scaling.
8438                             Passing None for it means scaling relatively the origin of global CS.
8439                 theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
8440                 theName Object name; when specified, this parameter is used
8441                         for result publication in the study. Otherwise, if automatic
8442                         publication is switched on, default value is used for result name.
8443
8444             Returns:
8445                 New GEOM.GEOM_Object, containing the scaled shape.
8446             """
8447             # Example: see GEOM_TestAll.py
8448             theFactorX, theFactorY, theFactorZ, Parameters = ParseParameters(theFactorX, theFactorY, theFactorZ)
8449             anObj = self.TrsfOp.ScaleShapeAlongAxesCopy(theObject, thePoint,
8450                                                         theFactorX, theFactorY, theFactorZ)
8451             RaiseIfFailed("MakeScaleAlongAxes", self.TrsfOp)
8452             anObj.SetParameters(Parameters)
8453             self._autoPublish(anObj, theName, "scaled")
8454             return anObj
8455
8456         ## Mirror an object relatively the given plane.
8457         #  @param theObject The object to be mirrored.
8458         #  @param thePlane Plane of symmetry.
8459         #  @param theCopy Flag used to mirror object itself or create a copy.
8460         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8461         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8462         @ManageTransactions("TrsfOp")
8463         def MirrorByPlane(self, theObject, thePlane, theCopy=False):
8464             """
8465             Mirror an object relatively the given plane.
8466
8467             Parameters:
8468                 theObject The object to be mirrored.
8469                 thePlane Plane of symmetry.
8470                 theCopy Flag used to mirror object itself or create a copy.
8471
8472             Returns:
8473                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8474                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8475             """
8476             if theCopy:
8477                 anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
8478             else:
8479                 anObj = self.TrsfOp.MirrorPlane(theObject, thePlane)
8480             RaiseIfFailed("MirrorByPlane", self.TrsfOp)
8481             return anObj
8482
8483         ## Create an object, symmetrical
8484         #  to the given one relatively the given plane.
8485         #  @param theObject The object to be mirrored.
8486         #  @param thePlane Plane of symmetry.
8487         #  @param theName Object name; when specified, this parameter is used
8488         #         for result publication in the study. Otherwise, if automatic
8489         #         publication is switched on, default value is used for result name.
8490         #
8491         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8492         #
8493         #  @ref tui_mirror "Example"
8494         @ManageTransactions("TrsfOp")
8495         def MakeMirrorByPlane(self, theObject, thePlane, theName=None):
8496             """
8497             Create an object, symmetrical to the given one relatively the given plane.
8498
8499             Parameters:
8500                 theObject The object to be mirrored.
8501                 thePlane Plane of symmetry.
8502                 theName Object name; when specified, this parameter is used
8503                         for result publication in the study. Otherwise, if automatic
8504                         publication is switched on, default value is used for result name.
8505
8506             Returns:
8507                 New GEOM.GEOM_Object, containing the mirrored shape.
8508             """
8509             # Example: see GEOM_TestAll.py
8510             anObj = self.TrsfOp.MirrorPlaneCopy(theObject, thePlane)
8511             RaiseIfFailed("MirrorPlaneCopy", self.TrsfOp)
8512             self._autoPublish(anObj, theName, "mirrored")
8513             return anObj
8514
8515         ## Mirror an object relatively the given axis.
8516         #  @param theObject The object to be mirrored.
8517         #  @param theAxis Axis of symmetry.
8518         #  @param theCopy Flag used to mirror object itself or create a copy.
8519         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8520         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8521         @ManageTransactions("TrsfOp")
8522         def MirrorByAxis(self, theObject, theAxis, theCopy=False):
8523             """
8524             Mirror an object relatively the given axis.
8525
8526             Parameters:
8527                 theObject The object to be mirrored.
8528                 theAxis Axis of symmetry.
8529                 theCopy Flag used to mirror object itself or create a copy.
8530
8531             Returns:
8532                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8533                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8534             """
8535             if theCopy:
8536                 anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
8537             else:
8538                 anObj = self.TrsfOp.MirrorAxis(theObject, theAxis)
8539             RaiseIfFailed("MirrorByAxis", self.TrsfOp)
8540             return anObj
8541
8542         ## Create an object, symmetrical
8543         #  to the given one relatively the given axis.
8544         #  @param theObject The object to be mirrored.
8545         #  @param theAxis Axis of symmetry.
8546         #  @param theName Object name; when specified, this parameter is used
8547         #         for result publication in the study. Otherwise, if automatic
8548         #         publication is switched on, default value is used for result name.
8549         #
8550         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8551         #
8552         #  @ref tui_mirror "Example"
8553         @ManageTransactions("TrsfOp")
8554         def MakeMirrorByAxis(self, theObject, theAxis, theName=None):
8555             """
8556             Create an object, symmetrical to the given one relatively the given axis.
8557
8558             Parameters:
8559                 theObject The object to be mirrored.
8560                 theAxis Axis of symmetry.
8561                 theName Object name; when specified, this parameter is used
8562                         for result publication in the study. Otherwise, if automatic
8563                         publication is switched on, default value is used for result name.
8564
8565             Returns:
8566                 New GEOM.GEOM_Object, containing the mirrored shape.
8567             """
8568             # Example: see GEOM_TestAll.py
8569             anObj = self.TrsfOp.MirrorAxisCopy(theObject, theAxis)
8570             RaiseIfFailed("MirrorAxisCopy", self.TrsfOp)
8571             self._autoPublish(anObj, theName, "mirrored")
8572             return anObj
8573
8574         ## Mirror an object relatively the given point.
8575         #  @param theObject The object to be mirrored.
8576         #  @param thePoint Point of symmetry.
8577         #  @param theCopy Flag used to mirror object itself or create a copy.
8578         #  @return Mirrored @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8579         #  new GEOM.GEOM_Object, containing the mirrored object if @a theCopy flag is @c True.
8580         @ManageTransactions("TrsfOp")
8581         def MirrorByPoint(self, theObject, thePoint, theCopy=False):
8582             """
8583             Mirror an object relatively the given point.
8584
8585             Parameters:
8586                 theObject The object to be mirrored.
8587                 thePoint Point of symmetry.
8588                 theCopy Flag used to mirror object itself or create a copy.
8589
8590             Returns:
8591                 Mirrored theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8592                 new GEOM.GEOM_Object, containing the mirrored object if theCopy flag is True.
8593             """
8594             # Example: see GEOM_TestAll.py
8595             if theCopy:
8596                 anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
8597             else:
8598                 anObj = self.TrsfOp.MirrorPoint(theObject, thePoint)
8599             RaiseIfFailed("MirrorByPoint", self.TrsfOp)
8600             return anObj
8601
8602         ## Create an object, symmetrical
8603         #  to the given one relatively the given point.
8604         #  @param theObject The object to be mirrored.
8605         #  @param thePoint Point of symmetry.
8606         #  @param theName Object name; when specified, this parameter is used
8607         #         for result publication in the study. Otherwise, if automatic
8608         #         publication is switched on, default value is used for result name.
8609         #
8610         #  @return New GEOM.GEOM_Object, containing the mirrored shape.
8611         #
8612         #  @ref tui_mirror "Example"
8613         @ManageTransactions("TrsfOp")
8614         def MakeMirrorByPoint(self, theObject, thePoint, theName=None):
8615             """
8616             Create an object, symmetrical
8617             to the given one relatively the given point.
8618
8619             Parameters:
8620                 theObject The object to be mirrored.
8621                 thePoint Point of symmetry.
8622                 theName Object name; when specified, this parameter is used
8623                         for result publication in the study. Otherwise, if automatic
8624                         publication is switched on, default value is used for result name.
8625
8626             Returns:
8627                 New GEOM.GEOM_Object, containing the mirrored shape.
8628             """
8629             # Example: see GEOM_TestAll.py
8630             anObj = self.TrsfOp.MirrorPointCopy(theObject, thePoint)
8631             RaiseIfFailed("MirrorPointCopy", self.TrsfOp)
8632             self._autoPublish(anObj, theName, "mirrored")
8633             return anObj
8634
8635         ## Modify the location of the given object.
8636         #  @param theObject The object to be displaced.
8637         #  @param theStartLCS Coordinate system to perform displacement from it.\n
8638         #                     If \a theStartLCS is NULL, displacement
8639         #                     will be performed from global CS.\n
8640         #                     If \a theObject itself is used as \a theStartLCS,
8641         #                     its location will be changed to \a theEndLCS.
8642         #  @param theEndLCS Coordinate system to perform displacement to it.
8643         #  @param theCopy Flag used to displace object itself or create a copy.
8644         #  @return Displaced @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8645         #  new GEOM.GEOM_Object, containing the displaced object if @a theCopy flag is @c True.
8646         @ManageTransactions("TrsfOp")
8647         def Position(self, theObject, theStartLCS, theEndLCS, theCopy=False):
8648             """
8649             Modify the Location of the given object by LCS, creating its copy before the setting.
8650
8651             Parameters:
8652                 theObject The object to be displaced.
8653                 theStartLCS Coordinate system to perform displacement from it.
8654                             If theStartLCS is NULL, displacement
8655                             will be performed from global CS.
8656                             If theObject itself is used as theStartLCS,
8657                             its location will be changed to theEndLCS.
8658                 theEndLCS Coordinate system to perform displacement to it.
8659                 theCopy Flag used to displace object itself or create a copy.
8660
8661             Returns:
8662                 Displaced theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8663                 new GEOM.GEOM_Object, containing the displaced object if theCopy flag is True.
8664             """
8665             # Example: see GEOM_TestAll.py
8666             if theCopy:
8667                 anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
8668             else:
8669                 anObj = self.TrsfOp.PositionShape(theObject, theStartLCS, theEndLCS)
8670             RaiseIfFailed("Displace", self.TrsfOp)
8671             return anObj
8672
8673         ## Modify the Location of the given object by LCS,
8674         #  creating its copy before the setting.
8675         #  @param theObject The object to be displaced.
8676         #  @param theStartLCS Coordinate system to perform displacement from it.\n
8677         #                     If \a theStartLCS is NULL, displacement
8678         #                     will be performed from global CS.\n
8679         #                     If \a theObject itself is used as \a theStartLCS,
8680         #                     its location will be changed to \a theEndLCS.
8681         #  @param theEndLCS Coordinate system to perform displacement to it.
8682         #  @param theName Object name; when specified, this parameter is used
8683         #         for result publication in the study. Otherwise, if automatic
8684         #         publication is switched on, default value is used for result name.
8685         #
8686         #  @return New GEOM.GEOM_Object, containing the displaced shape.
8687         #
8688         #  @ref tui_modify_location "Example"
8689         @ManageTransactions("TrsfOp")
8690         def MakePosition(self, theObject, theStartLCS, theEndLCS, theName=None):
8691             """
8692             Modify the Location of the given object by LCS, creating its copy before the setting.
8693
8694             Parameters:
8695                 theObject The object to be displaced.
8696                 theStartLCS Coordinate system to perform displacement from it.
8697                             If theStartLCS is NULL, displacement
8698                             will be performed from global CS.
8699                             If theObject itself is used as theStartLCS,
8700                             its location will be changed to theEndLCS.
8701                 theEndLCS Coordinate system to perform displacement to it.
8702                 theName Object name; when specified, this parameter is used
8703                         for result publication in the study. Otherwise, if automatic
8704                         publication is switched on, default value is used for result name.
8705
8706             Returns:
8707                 New GEOM.GEOM_Object, containing the displaced shape.
8708
8709             Example of usage:
8710                 # create local coordinate systems
8711                 cs1 = geompy.MakeMarker( 0, 0, 0, 1,0,0, 0,1,0)
8712                 cs2 = geompy.MakeMarker(30,40,40, 1,0,0, 0,1,0)
8713                 # modify the location of the given object
8714                 position = geompy.MakePosition(cylinder, cs1, cs2)
8715             """
8716             # Example: see GEOM_TestAll.py
8717             anObj = self.TrsfOp.PositionShapeCopy(theObject, theStartLCS, theEndLCS)
8718             RaiseIfFailed("PositionShapeCopy", self.TrsfOp)
8719             self._autoPublish(anObj, theName, "displaced")
8720             return anObj
8721
8722         ## Modify the Location of the given object by Path.
8723         #  @param  theObject The object to be displaced.
8724         #  @param  thePath Wire or Edge along that the object will be translated.
8725         #  @param  theDistance progress of Path (0 = start location, 1 = end of path location).
8726         #  @param  theCopy is to create a copy objects if true.
8727         #  @param  theReverse  0 - for usual direction, 1 - to reverse path direction.
8728         #  @return Displaced @a theObject (GEOM.GEOM_Object) if @a theCopy is @c False or
8729         #          new GEOM.GEOM_Object, containing the displaced shape if @a theCopy is @c True.
8730         #
8731         #  @ref tui_modify_location "Example"
8732         @ManageTransactions("TrsfOp")
8733         def PositionAlongPath(self,theObject, thePath, theDistance, theCopy, theReverse):
8734             """
8735             Modify the Location of the given object by Path.
8736
8737             Parameters:
8738                  theObject The object to be displaced.
8739                  thePath Wire or Edge along that the object will be translated.
8740                  theDistance progress of Path (0 = start location, 1 = end of path location).
8741                  theCopy is to create a copy objects if true.
8742                  theReverse  0 - for usual direction, 1 - to reverse path direction.
8743
8744             Returns:
8745                  Displaced theObject (GEOM.GEOM_Object) if theCopy is False or
8746                  new GEOM.GEOM_Object, containing the displaced shape if theCopy is True.
8747
8748             Example of usage:
8749                 position = geompy.PositionAlongPath(cylinder, circle, 0.75, 1, 1)
8750             """
8751             # Example: see GEOM_TestAll.py
8752             anObj = self.TrsfOp.PositionAlongPath(theObject, thePath, theDistance, theCopy, theReverse)
8753             RaiseIfFailed("PositionAlongPath", self.TrsfOp)
8754             return anObj
8755
8756         ## Modify the Location of the given object by Path, creating its copy before the operation.
8757         #  @param theObject The object to be displaced.
8758         #  @param thePath Wire or Edge along that the object will be translated.
8759         #  @param theDistance progress of Path (0 = start location, 1 = end of path location).
8760         #  @param theReverse  0 - for usual direction, 1 - to reverse path direction.
8761         #  @param theName Object name; when specified, this parameter is used
8762         #         for result publication in the study. Otherwise, if automatic
8763         #         publication is switched on, default value is used for result name.
8764         #
8765         #  @return New GEOM.GEOM_Object, containing the displaced shape.
8766         @ManageTransactions("TrsfOp")
8767         def MakePositionAlongPath(self, theObject, thePath, theDistance, theReverse, theName=None):
8768             """
8769             Modify the Location of the given object by Path, creating its copy before the operation.
8770
8771             Parameters:
8772                  theObject The object to be displaced.
8773                  thePath Wire or Edge along that the object will be translated.
8774                  theDistance progress of Path (0 = start location, 1 = end of path location).
8775                  theReverse  0 - for usual direction, 1 - to reverse path direction.
8776                  theName Object name; when specified, this parameter is used
8777                          for result publication in the study. Otherwise, if automatic
8778                          publication is switched on, default value is used for result name.
8779
8780             Returns:
8781                 New GEOM.GEOM_Object, containing the displaced shape.
8782             """
8783             # Example: see GEOM_TestAll.py
8784             anObj = self.TrsfOp.PositionAlongPath(theObject, thePath, theDistance, 1, theReverse)
8785             RaiseIfFailed("PositionAlongPath", self.TrsfOp)
8786             self._autoPublish(anObj, theName, "displaced")
8787             return anObj
8788
8789         ## Offset given shape.
8790         #  @param theObject The base object for the offset.
8791         #  @param theOffset Offset value.
8792         #  @param theCopy Flag used to offset object itself or create a copy.
8793         #  @return Modified @a theObject (GEOM.GEOM_Object) if @a theCopy flag is @c False (default) or
8794         #  new GEOM.GEOM_Object, containing the result of offset operation if @a theCopy flag is @c True.
8795         @ManageTransactions("TrsfOp")
8796         def Offset(self, theObject, theOffset, theCopy=False):
8797             """
8798             Offset given shape.
8799
8800             Parameters:
8801                 theObject The base object for the offset.
8802                 theOffset Offset value.
8803                 theCopy Flag used to offset object itself or create a copy.
8804
8805             Returns:
8806                 Modified theObject (GEOM.GEOM_Object) if theCopy flag is False (default) or
8807                 new GEOM.GEOM_Object, containing the result of offset operation if theCopy flag is True.
8808             """
8809             theOffset, Parameters = ParseParameters(theOffset)
8810             if theCopy:
8811                 anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
8812             else:
8813                 anObj = self.TrsfOp.OffsetShape(theObject, theOffset)
8814             RaiseIfFailed("Offset", self.TrsfOp)
8815             anObj.SetParameters(Parameters)
8816             return anObj
8817
8818         ## Create new object as offset of the given one.
8819         #  @param theObject The base object for the offset.
8820         #  @param theOffset Offset value.
8821         #  @param theName Object name; when specified, this parameter is used
8822         #         for result publication in the study. Otherwise, if automatic
8823         #         publication is switched on, default value is used for result name.
8824         #
8825         #  @return New GEOM.GEOM_Object, containing the offset object.
8826         #
8827         #  @ref tui_offset "Example"
8828         @ManageTransactions("TrsfOp")
8829         def MakeOffset(self, theObject, theOffset, theName=None):
8830             """
8831             Create new object as offset of the given one.
8832
8833             Parameters:
8834                 theObject The base object for the offset.
8835                 theOffset Offset value.
8836                 theName Object name; when specified, this parameter is used
8837                         for result publication in the study. Otherwise, if automatic
8838                         publication is switched on, default value is used for result name.
8839
8840             Returns:
8841                 New GEOM.GEOM_Object, containing the offset object.
8842
8843             Example of usage:
8844                  box = geompy.MakeBox(20, 20, 20, 200, 200, 200)
8845                  # create a new object as offset of the given object
8846                  offset = geompy.MakeOffset(box, 70.)
8847             """
8848             # Example: see GEOM_TestAll.py
8849             theOffset, Parameters = ParseParameters(theOffset)
8850             anObj = self.TrsfOp.OffsetShapeCopy(theObject, theOffset)
8851             RaiseIfFailed("OffsetShapeCopy", self.TrsfOp)
8852             anObj.SetParameters(Parameters)
8853             self._autoPublish(anObj, theName, "offset")
8854             return anObj
8855
8856         ## Create new object as projection of the given one on another.
8857         #  @param theSource The source object for the projection. It can be a point, edge or wire.
8858         #         Edge and wire are acceptable if @a theTarget is a face.
8859         #  @param theTarget The target object. It can be planar or cylindrical face, edge or wire.
8860         #  @param theName Object name; when specified, this parameter is used
8861         #         for result publication in the study. Otherwise, if automatic
8862         #         publication is switched on, default value is used for result name.
8863         #
8864         #  @return New GEOM.GEOM_Object, containing the projection.
8865         #
8866         #  @ref tui_projection "Example"
8867         @ManageTransactions("TrsfOp")
8868         def MakeProjection(self, theSource, theTarget, theName=None):
8869             """
8870             Create new object as projection of the given one on another.
8871
8872             Parameters:
8873                 theSource The source object for the projection. It can be a point, edge or wire.
8874                           Edge and wire are acceptable if theTarget is a face.
8875                 theTarget The target object. It can be planar or cylindrical face, edge or wire.
8876                 theName Object name; when specified, this parameter is used
8877                         for result publication in the study. Otherwise, if automatic
8878                         publication is switched on, default value is used for result name.
8879
8880             Returns:
8881                 New GEOM.GEOM_Object, containing the projection.
8882             """
8883             # Example: see GEOM_TestAll.py
8884             anObj = self.TrsfOp.ProjectShapeCopy(theSource, theTarget)
8885             RaiseIfFailed("ProjectShapeCopy", self.TrsfOp)
8886             self._autoPublish(anObj, theName, "projection")
8887             return anObj
8888
8889         ## Create a projection projection of the given point on a wire or an edge.
8890         #  If there are no solutions or there are 2 or more solutions It throws an
8891         #  exception.
8892         #  @param thePoint the point to be projected.
8893         #  @param theWire the wire. The edge is accepted as well.
8894         #  @param theName Object name; when specified, this parameter is used
8895         #         for result publication in the study. Otherwise, if automatic
8896         #         publication is switched on, default value is used for result name.
8897         #
8898         #  @return [\a u, \a PointOnEdge, \a EdgeInWireIndex]
8899         #  \n \a u: The parameter of projection point on edge.
8900         #  \n \a PointOnEdge: The projection point.
8901         #  \n \a EdgeInWireIndex: The index of an edge in a wire.
8902         #
8903         #  @ref tui_projection "Example"
8904         @ManageTransactions("TrsfOp")
8905         def MakeProjectionOnWire(self, thePoint, theWire, theName=None):
8906             """
8907             Create a projection projection of the given point on a wire or an edge.
8908             If there are no solutions or there are 2 or more solutions It throws an
8909             exception.
8910
8911             Parameters:
8912                 thePoint the point to be projected.
8913                 theWire the wire. The edge is accepted as well.
8914                 theName Object name; when specified, this parameter is used
8915                         for result publication in the study. Otherwise, if automatic
8916                         publication is switched on, default value is used for result name.
8917
8918             Returns:
8919                 [u, PointOnEdge, EdgeInWireIndex]
8920                  u: The parameter of projection point on edge.
8921                  PointOnEdge: The projection point.
8922                  EdgeInWireIndex: The index of an edge in a wire.
8923             """
8924             # Example: see GEOM_TestAll.py
8925             anObj = self.TrsfOp.ProjectPointOnWire(thePoint, theWire)
8926             RaiseIfFailed("ProjectPointOnWire", self.TrsfOp)
8927             self._autoPublish(anObj[1], theName, "projection")
8928             return anObj
8929
8930         # -----------------------------------------------------------------------------
8931         # Patterns
8932         # -----------------------------------------------------------------------------
8933
8934         ## Translate the given object along the given vector a given number times
8935         #  @param theObject The object to be translated.
8936         #  @param theVector Direction of the translation. DX if None.
8937         #  @param theStep Distance to translate on.
8938         #  @param theNbTimes Quantity of translations to be done.
8939         #  @param theName Object name; when specified, this parameter is used
8940         #         for result publication in the study. Otherwise, if automatic
8941         #         publication is switched on, default value is used for result name.
8942         #
8943         #  @return New GEOM.GEOM_Object, containing compound of all
8944         #          the shapes, obtained after each translation.
8945         #
8946         #  @ref tui_multi_translation "Example"
8947         @ManageTransactions("TrsfOp")
8948         def MakeMultiTranslation1D(self, theObject, theVector, theStep, theNbTimes, theName=None):
8949             """
8950             Translate the given object along the given vector a given number times
8951
8952             Parameters:
8953                 theObject The object to be translated.
8954                 theVector Direction of the translation. DX if None.
8955                 theStep Distance to translate on.
8956                 theNbTimes Quantity of translations to be done.
8957                 theName Object name; when specified, this parameter is used
8958                         for result publication in the study. Otherwise, if automatic
8959                         publication is switched on, default value is used for result name.
8960
8961             Returns:
8962                 New GEOM.GEOM_Object, containing compound of all
8963                 the shapes, obtained after each translation.
8964
8965             Example of usage:
8966                 r1d = geompy.MakeMultiTranslation1D(prism, vect, 20, 4)
8967             """
8968             # Example: see GEOM_TestAll.py
8969             theStep, theNbTimes, Parameters = ParseParameters(theStep, theNbTimes)
8970             anObj = self.TrsfOp.MultiTranslate1D(theObject, theVector, theStep, theNbTimes)
8971             RaiseIfFailed("MultiTranslate1D", self.TrsfOp)
8972             anObj.SetParameters(Parameters)
8973             self._autoPublish(anObj, theName, "multitranslation")
8974             return anObj
8975
8976         ## Conseqently apply two specified translations to theObject specified number of times.
8977         #  @param theObject The object to be translated.
8978         #  @param theVector1 Direction of the first translation. DX if None.
8979         #  @param theStep1 Step of the first translation.
8980         #  @param theNbTimes1 Quantity of translations to be done along theVector1.
8981         #  @param theVector2 Direction of the second translation. DY if None.
8982         #  @param theStep2 Step of the second translation.
8983         #  @param theNbTimes2 Quantity of translations to be done along theVector2.
8984         #  @param theName Object name; when specified, this parameter is used
8985         #         for result publication in the study. Otherwise, if automatic
8986         #         publication is switched on, default value is used for result name.
8987         #
8988         #  @return New GEOM.GEOM_Object, containing compound of all
8989         #          the shapes, obtained after each translation.
8990         #
8991         #  @ref tui_multi_translation "Example"
8992         @ManageTransactions("TrsfOp")
8993         def MakeMultiTranslation2D(self, theObject, theVector1, theStep1, theNbTimes1,
8994                                    theVector2, theStep2, theNbTimes2, theName=None):
8995             """
8996             Conseqently apply two specified translations to theObject specified number of times.
8997
8998             Parameters:
8999                 theObject The object to be translated.
9000                 theVector1 Direction of the first translation. DX if None.
9001                 theStep1 Step of the first translation.
9002                 theNbTimes1 Quantity of translations to be done along theVector1.
9003                 theVector2 Direction of the second translation. DY if None.
9004                 theStep2 Step of the second translation.
9005                 theNbTimes2 Quantity of translations to be done along theVector2.
9006                 theName Object name; when specified, this parameter is used
9007                         for result publication in the study. Otherwise, if automatic
9008                         publication is switched on, default value is used for result name.
9009
9010             Returns:
9011                 New GEOM.GEOM_Object, containing compound of all
9012                 the shapes, obtained after each translation.
9013
9014             Example of usage:
9015                 tr2d = geompy.MakeMultiTranslation2D(prism, vect1, 20, 4, vect2, 80, 3)
9016             """
9017             # Example: see GEOM_TestAll.py
9018             theStep1,theNbTimes1,theStep2,theNbTimes2, Parameters = ParseParameters(theStep1,theNbTimes1,theStep2,theNbTimes2)
9019             anObj = self.TrsfOp.MultiTranslate2D(theObject, theVector1, theStep1, theNbTimes1,
9020                                                  theVector2, theStep2, theNbTimes2)
9021             RaiseIfFailed("MultiTranslate2D", self.TrsfOp)
9022             anObj.SetParameters(Parameters)
9023             self._autoPublish(anObj, theName, "multitranslation")
9024             return anObj
9025
9026         ## Rotate the given object around the given axis a given number times.
9027         #  Rotation angle will be 2*PI/theNbTimes.
9028         #  @param theObject The object to be rotated.
9029         #  @param theAxis The rotation axis. DZ if None.
9030         #  @param theNbTimes Quantity of rotations to be done.
9031         #  @param theName Object name; when specified, this parameter is used
9032         #         for result publication in the study. Otherwise, if automatic
9033         #         publication is switched on, default value is used for result name.
9034         #
9035         #  @return New GEOM.GEOM_Object, containing compound of all the
9036         #          shapes, obtained after each rotation.
9037         #
9038         #  @ref tui_multi_rotation "Example"
9039         @ManageTransactions("TrsfOp")
9040         def MultiRotate1DNbTimes (self, theObject, theAxis, theNbTimes, theName=None):
9041             """
9042             Rotate the given object around the given axis a given number times.
9043             Rotation angle will be 2*PI/theNbTimes.
9044
9045             Parameters:
9046                 theObject The object to be rotated.
9047                 theAxis The rotation axis. DZ if None.
9048                 theNbTimes Quantity of rotations to be done.
9049                 theName Object name; when specified, this parameter is used
9050                         for result publication in the study. Otherwise, if automatic
9051                         publication is switched on, default value is used for result name.
9052
9053             Returns:
9054                 New GEOM.GEOM_Object, containing compound of all the
9055                 shapes, obtained after each rotation.
9056
9057             Example of usage:
9058                 rot1d = geompy.MultiRotate1DNbTimes(prism, vect, 4)
9059             """
9060             # Example: see GEOM_TestAll.py
9061             theNbTimes, Parameters = ParseParameters(theNbTimes)
9062             anObj = self.TrsfOp.MultiRotate1D(theObject, theAxis, theNbTimes)
9063             RaiseIfFailed("MultiRotate1DNbTimes", self.TrsfOp)
9064             anObj.SetParameters(Parameters)
9065             self._autoPublish(anObj, theName, "multirotation")
9066             return anObj
9067
9068         ## Rotate the given object around the given axis
9069         #  a given number times on the given angle.
9070         #  @param theObject The object to be rotated.
9071         #  @param theAxis The rotation axis. DZ if None.
9072         #  @param theAngleStep Rotation angle in radians.
9073         #  @param theNbTimes Quantity of rotations to be done.
9074         #  @param theName Object name; when specified, this parameter is used
9075         #         for result publication in the study. Otherwise, if automatic
9076         #         publication is switched on, default value is used for result name.
9077         #
9078         #  @return New GEOM.GEOM_Object, containing compound of all the
9079         #          shapes, obtained after each rotation.
9080         #
9081         #  @ref tui_multi_rotation "Example"
9082         @ManageTransactions("TrsfOp")
9083         def MultiRotate1DByStep(self, theObject, theAxis, theAngleStep, theNbTimes, theName=None):
9084             """
9085             Rotate the given object around the given axis
9086             a given number times on the given angle.
9087
9088             Parameters:
9089                 theObject The object to be rotated.
9090                 theAxis The rotation axis. DZ if None.
9091                 theAngleStep Rotation angle in radians.
9092                 theNbTimes Quantity of rotations to be done.
9093                 theName Object name; when specified, this parameter is used
9094                         for result publication in the study. Otherwise, if automatic
9095                         publication is switched on, default value is used for result name.
9096
9097             Returns:
9098                 New GEOM.GEOM_Object, containing compound of all the
9099                 shapes, obtained after each rotation.
9100
9101             Example of usage:
9102                 rot1d = geompy.MultiRotate1DByStep(prism, vect, math.pi/4, 4)
9103             """
9104             # Example: see GEOM_TestAll.py
9105             theAngleStep, theNbTimes, Parameters = ParseParameters(theAngleStep, theNbTimes)
9106             anObj = self.TrsfOp.MultiRotate1DByStep(theObject, theAxis, theAngleStep, theNbTimes)
9107             RaiseIfFailed("MultiRotate1DByStep", self.TrsfOp)
9108             anObj.SetParameters(Parameters)
9109             self._autoPublish(anObj, theName, "multirotation")
9110             return anObj
9111
9112         ## Rotate the given object around the given axis a given
9113         #  number times and multi-translate each rotation result.
9114         #  Rotation angle will be 2*PI/theNbTimes1.
9115         #  Translation direction passes through center of gravity
9116         #  of rotated shape and its projection on the rotation axis.
9117         #  @param theObject The object to be rotated.
9118         #  @param theAxis Rotation axis. DZ if None.
9119         #  @param theNbTimes1 Quantity of rotations to be done.
9120         #  @param theRadialStep Translation distance.
9121         #  @param theNbTimes2 Quantity of translations to be done.
9122         #  @param theName Object name; when specified, this parameter is used
9123         #         for result publication in the study. Otherwise, if automatic
9124         #         publication is switched on, default value is used for result name.
9125         #
9126         #  @return New GEOM.GEOM_Object, containing compound of all the
9127         #          shapes, obtained after each transformation.
9128         #
9129         #  @ref tui_multi_rotation "Example"
9130         @ManageTransactions("TrsfOp")
9131         def MultiRotate2DNbTimes(self, theObject, theAxis, theNbTimes1, theRadialStep, theNbTimes2, theName=None):
9132             """
9133             Rotate the given object around the
9134             given axis on the given angle a given number
9135             times and multi-translate each rotation result.
9136             Translation direction passes through center of gravity
9137             of rotated shape and its projection on the rotation axis.
9138
9139             Parameters:
9140                 theObject The object to be rotated.
9141                 theAxis Rotation axis. DZ if None.
9142                 theNbTimes1 Quantity of rotations to be done.
9143                 theRadialStep Translation distance.
9144                 theNbTimes2 Quantity of translations to be done.
9145                 theName Object name; when specified, this parameter is used
9146                         for result publication in the study. Otherwise, if automatic
9147                         publication is switched on, default value is used for result name.
9148
9149             Returns:
9150                 New GEOM.GEOM_Object, containing compound of all the
9151                 shapes, obtained after each transformation.
9152
9153             Example of usage:
9154                 rot2d = geompy.MultiRotate2D(prism, vect, 60, 4, 50, 5)
9155             """
9156             # Example: see GEOM_TestAll.py
9157             theNbTimes1, theRadialStep, theNbTimes2, Parameters = ParseParameters(theNbTimes1, theRadialStep, theNbTimes2)
9158             anObj = self.TrsfOp.MultiRotate2DNbTimes(theObject, theAxis, theNbTimes1, theRadialStep, theNbTimes2)
9159             RaiseIfFailed("MultiRotate2DNbTimes", self.TrsfOp)
9160             anObj.SetParameters(Parameters)
9161             self._autoPublish(anObj, theName, "multirotation")
9162             return anObj
9163
9164         ## Rotate the given object around the
9165         #  given axis on the given angle a given number
9166         #  times and multi-translate each rotation result.
9167         #  Translation direction passes through center of gravity
9168         #  of rotated shape and its projection on the rotation axis.
9169         #  @param theObject The object to be rotated.
9170         #  @param theAxis Rotation axis. DZ if None.
9171         #  @param theAngleStep Rotation angle in radians.
9172         #  @param theNbTimes1 Quantity of rotations to be done.
9173         #  @param theRadialStep Translation distance.
9174         #  @param theNbTimes2 Quantity of translations to be done.
9175         #  @param theName Object name; when specified, this parameter is used
9176         #         for result publication in the study. Otherwise, if automatic
9177         #         publication is switched on, default value is used for result name.
9178         #
9179         #  @return New GEOM.GEOM_Object, containing compound of all the
9180         #          shapes, obtained after each transformation.
9181         #
9182         #  @ref tui_multi_rotation "Example"
9183         @ManageTransactions("TrsfOp")
9184         def MultiRotate2DByStep (self, theObject, theAxis, theAngleStep, theNbTimes1, theRadialStep, theNbTimes2, theName=None):
9185             """
9186             Rotate the given object around the
9187             given axis on the given angle a given number
9188             times and multi-translate each rotation result.
9189             Translation direction passes through center of gravity
9190             of rotated shape and its projection on the rotation axis.
9191
9192             Parameters:
9193                 theObject The object to be rotated.
9194                 theAxis Rotation axis. DZ if None.
9195                 theAngleStep Rotation angle in radians.
9196                 theNbTimes1 Quantity of rotations to be done.
9197                 theRadialStep Translation distance.
9198                 theNbTimes2 Quantity of translations to be done.
9199                 theName Object name; when specified, this parameter is used
9200                         for result publication in the study. Otherwise, if automatic
9201                         publication is switched on, default value is used for result name.
9202
9203             Returns:
9204                 New GEOM.GEOM_Object, containing compound of all the
9205                 shapes, obtained after each transformation.
9206
9207             Example of usage:
9208                 rot2d = geompy.MultiRotate2D(prism, vect, math.pi/3, 4, 50, 5)
9209             """
9210             # Example: see GEOM_TestAll.py
9211             theAngleStep, theNbTimes1, theRadialStep, theNbTimes2, Parameters = ParseParameters(theAngleStep, theNbTimes1, theRadialStep, theNbTimes2)
9212             anObj = self.TrsfOp.MultiRotate2DByStep(theObject, theAxis, theAngleStep, theNbTimes1, theRadialStep, theNbTimes2)
9213             RaiseIfFailed("MultiRotate2DByStep", self.TrsfOp)
9214             anObj.SetParameters(Parameters)
9215             self._autoPublish(anObj, theName, "multirotation")
9216             return anObj
9217
9218         ## The same, as MultiRotate1DNbTimes(), but axis is given by direction and point
9219         #
9220         #  @ref swig_MakeMultiRotation "Example"
9221         def MakeMultiRotation1DNbTimes(self, aShape, aDir, aPoint, aNbTimes, theName=None):
9222             """
9223             The same, as geompy.MultiRotate1DNbTimes, but axis is given by direction and point
9224
9225             Example of usage:
9226                 pz = geompy.MakeVertex(0, 0, 100)
9227                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9228                 MultiRot1D = geompy.MakeMultiRotation1DNbTimes(prism, vy, pz, 6)
9229             """
9230             # Example: see GEOM_TestOthers.py
9231             aVec = self.MakeLine(aPoint,aDir)
9232             # note: auto-publishing is done in self.MultiRotate1D()
9233             anObj = self.MultiRotate1DNbTimes(aShape, aVec, aNbTimes, theName)
9234             return anObj
9235
9236         ## The same, as MultiRotate1DByStep(), but axis is given by direction and point
9237         #
9238         #  @ref swig_MakeMultiRotation "Example"
9239         def MakeMultiRotation1DByStep(self, aShape, aDir, aPoint, anAngle, aNbTimes, theName=None):
9240             """
9241             The same, as geompy.MultiRotate1D, but axis is given by direction and point
9242
9243             Example of usage:
9244                 pz = geompy.MakeVertex(0, 0, 100)
9245                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9246                 MultiRot1D = geompy.MakeMultiRotation1DByStep(prism, vy, pz, math.pi/3, 6)
9247             """
9248             # Example: see GEOM_TestOthers.py
9249             aVec = self.MakeLine(aPoint,aDir)
9250             # note: auto-publishing is done in self.MultiRotate1D()
9251             anObj = self.MultiRotate1DByStep(aShape, aVec, anAngle, aNbTimes, theName)
9252             return anObj
9253
9254         ## The same, as MultiRotate2DNbTimes(), but axis is given by direction and point
9255         #
9256         #  @ref swig_MakeMultiRotation "Example"
9257         def MakeMultiRotation2DNbTimes(self, aShape, aDir, aPoint, nbtimes1, aStep, nbtimes2, theName=None):
9258             """
9259             The same, as MultiRotate2DNbTimes(), but axis is given by direction and point
9260
9261             Example of usage:
9262                 pz = geompy.MakeVertex(0, 0, 100)
9263                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9264                 MultiRot2D = geompy.MakeMultiRotation2DNbTimes(f12, vy, pz, 6, 30, 3)
9265             """
9266             # Example: see GEOM_TestOthers.py
9267             aVec = self.MakeLine(aPoint,aDir)
9268             # note: auto-publishing is done in self.MultiRotate2DNbTimes()
9269             anObj = self.MultiRotate2DNbTimes(aShape, aVec, nbtimes1, aStep, nbtimes2, theName)
9270             return anObj
9271
9272         ## The same, as MultiRotate2DByStep(), but axis is given by direction and point
9273         #
9274         #  @ref swig_MakeMultiRotation "Example"
9275         def MakeMultiRotation2DByStep(self, aShape, aDir, aPoint, anAngle, nbtimes1, aStep, nbtimes2, theName=None):
9276             """
9277             The same, as MultiRotate2DByStep(), but axis is given by direction and point
9278
9279             Example of usage:
9280                 pz = geompy.MakeVertex(0, 0, 100)
9281                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9282                 MultiRot2D = geompy.MakeMultiRotation2DByStep(f12, vy, pz, math.pi/4, 6, 30, 3)
9283             """
9284             # Example: see GEOM_TestOthers.py
9285             aVec = self.MakeLine(aPoint,aDir)
9286             # note: auto-publishing is done in self.MultiRotate2D()
9287             anObj = self.MultiRotate2DByStep(aShape, aVec, anAngle, nbtimes1, aStep, nbtimes2, theName)
9288             return anObj
9289
9290         # end of l3_transform
9291         ## @}
9292
9293         ## @addtogroup l3_transform_d
9294         ## @{
9295
9296         ## Deprecated method. Use MultiRotate1DNbTimes instead.
9297         def MultiRotate1D(self, theObject, theAxis, theNbTimes, theName=None):
9298             """
9299             Deprecated method. Use MultiRotate1DNbTimes instead.
9300             """
9301             print "The method MultiRotate1D is DEPRECATED. Use MultiRotate1DNbTimes instead."
9302             return self.MultiRotate1DNbTimes(theObject, theAxis, theNbTimes, theName)
9303
9304         ## The same, as MultiRotate2DByStep(), but theAngle is in degrees.
9305         #  This method is DEPRECATED. Use MultiRotate2DByStep() instead.
9306         @ManageTransactions("TrsfOp")
9307         def MultiRotate2D(self, theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2, theName=None):
9308             """
9309             The same, as MultiRotate2DByStep(), but theAngle is in degrees.
9310             This method is DEPRECATED. Use MultiRotate2DByStep() instead.
9311
9312             Example of usage:
9313                 rot2d = geompy.MultiRotate2D(prism, vect, 60, 4, 50, 5)
9314             """
9315             print "The method MultiRotate2D is DEPRECATED. Use MultiRotate2DByStep instead."
9316             theAngle, theNbTimes1, theStep, theNbTimes2, Parameters = ParseParameters(theAngle, theNbTimes1, theStep, theNbTimes2)
9317             anObj = self.TrsfOp.MultiRotate2D(theObject, theAxis, theAngle, theNbTimes1, theStep, theNbTimes2)
9318             RaiseIfFailed("MultiRotate2D", self.TrsfOp)
9319             anObj.SetParameters(Parameters)
9320             self._autoPublish(anObj, theName, "multirotation")
9321             return anObj
9322
9323         ## The same, as MultiRotate1D(), but axis is given by direction and point
9324         #  This method is DEPRECATED. Use MakeMultiRotation1DNbTimes instead.
9325         def MakeMultiRotation1D(self, aShape, aDir, aPoint, aNbTimes, theName=None):
9326             """
9327             The same, as geompy.MultiRotate1D, but axis is given by direction and point.
9328             This method is DEPRECATED. Use MakeMultiRotation1DNbTimes instead.
9329
9330             Example of usage:
9331                 pz = geompy.MakeVertex(0, 0, 100)
9332                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9333                 MultiRot1D = geompy.MakeMultiRotation1D(prism, vy, pz, 6)
9334             """
9335             print "The method MakeMultiRotation1D is DEPRECATED. Use MakeMultiRotation1DNbTimes instead."
9336             aVec = self.MakeLine(aPoint,aDir)
9337             # note: auto-publishing is done in self.MultiRotate1D()
9338             anObj = self.MultiRotate1D(aShape, aVec, aNbTimes, theName)
9339             return anObj
9340
9341         ## The same, as MultiRotate2D(), but axis is given by direction and point
9342         #  This method is DEPRECATED. Use MakeMultiRotation2DByStep instead.
9343         def MakeMultiRotation2D(self, aShape, aDir, aPoint, anAngle, nbtimes1, aStep, nbtimes2, theName=None):
9344             """
9345             The same, as MultiRotate2D(), but axis is given by direction and point
9346             This method is DEPRECATED. Use MakeMultiRotation2DByStep instead.
9347
9348             Example of usage:
9349                 pz = geompy.MakeVertex(0, 0, 100)
9350                 vy = geompy.MakeVectorDXDYDZ(0, 100, 0)
9351                 MultiRot2D = geompy.MakeMultiRotation2D(f12, vy, pz, 45, 6, 30, 3)
9352             """
9353             print "The method MakeMultiRotation2D is DEPRECATED. Use MakeMultiRotation2DByStep instead."
9354             aVec = self.MakeLine(aPoint,aDir)
9355             # note: auto-publishing is done in self.MultiRotate2D()
9356             anObj = self.MultiRotate2D(aShape, aVec, anAngle, nbtimes1, aStep, nbtimes2, theName)
9357             return anObj
9358
9359         # end of l3_transform_d
9360         ## @}
9361
9362         ## @addtogroup l3_local
9363         ## @{
9364
9365         ## Perform a fillet on all edges of the given shape.
9366         #  @param theShape Shape, to perform fillet on.
9367         #  @param theR Fillet radius.
9368         #  @param theName Object name; when specified, this parameter is used
9369         #         for result publication in the study. Otherwise, if automatic
9370         #         publication is switched on, default value is used for result name.
9371         #
9372         #  @return New GEOM.GEOM_Object, containing the result shape.
9373         #
9374         #  @ref tui_fillet "Example 1"
9375         #  \n @ref swig_MakeFilletAll "Example 2"
9376         @ManageTransactions("LocalOp")
9377         def MakeFilletAll(self, theShape, theR, theName=None):
9378             """
9379             Perform a fillet on all edges of the given shape.
9380
9381             Parameters:
9382                 theShape Shape, to perform fillet on.
9383                 theR Fillet radius.
9384                 theName Object name; when specified, this parameter is used
9385                         for result publication in the study. Otherwise, if automatic
9386                         publication is switched on, default value is used for result name.
9387
9388             Returns:
9389                 New GEOM.GEOM_Object, containing the result shape.
9390
9391             Example of usage:
9392                filletall = geompy.MakeFilletAll(prism, 10.)
9393             """
9394             # Example: see GEOM_TestOthers.py
9395             theR,Parameters = ParseParameters(theR)
9396             anObj = self.LocalOp.MakeFilletAll(theShape, theR)
9397             RaiseIfFailed("MakeFilletAll", self.LocalOp)
9398             anObj.SetParameters(Parameters)
9399             self._autoPublish(anObj, theName, "fillet")
9400             return anObj
9401
9402         ## Perform a fillet on the specified edges/faces of the given shape
9403         #  @param theShape Shape, to perform fillet on.
9404         #  @param theR Fillet radius.
9405         #  @param theShapeType Type of shapes in <VAR>theListShapes</VAR> (see ShapeType())
9406         #  @param theListShapes Global indices of edges/faces to perform fillet on.
9407         #  @param theName Object name; when specified, this parameter is used
9408         #         for result publication in the study. Otherwise, if automatic
9409         #         publication is switched on, default value is used for result name.
9410         #
9411         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9412         #
9413         #  @return New GEOM.GEOM_Object, containing the result shape.
9414         #
9415         #  @ref tui_fillet "Example"
9416         @ManageTransactions("LocalOp")
9417         def MakeFillet(self, theShape, theR, theShapeType, theListShapes, theName=None):
9418             """
9419             Perform a fillet on the specified edges/faces of the given shape
9420
9421             Parameters:
9422                 theShape Shape, to perform fillet on.
9423                 theR Fillet radius.
9424                 theShapeType Type of shapes in theListShapes (see geompy.ShapeTypes)
9425                 theListShapes Global indices of edges/faces to perform fillet on.
9426                 theName Object name; when specified, this parameter is used
9427                         for result publication in the study. Otherwise, if automatic
9428                         publication is switched on, default value is used for result name.
9429
9430             Note:
9431                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9432
9433             Returns:
9434                 New GEOM.GEOM_Object, containing the result shape.
9435
9436             Example of usage:
9437                 # get the list of IDs (IDList) for the fillet
9438                 prism_edges = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["EDGE"])
9439                 IDlist_e = []
9440                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[0]))
9441                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[1]))
9442                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[2]))
9443                 # make a fillet on the specified edges of the given shape
9444                 fillet = geompy.MakeFillet(prism, 10., geompy.ShapeType["EDGE"], IDlist_e)
9445             """
9446             # Example: see GEOM_TestAll.py
9447             theR,Parameters = ParseParameters(theR)
9448             anObj = None
9449             if theShapeType == self.ShapeType["EDGE"]:
9450                 anObj = self.LocalOp.MakeFilletEdges(theShape, theR, theListShapes)
9451                 RaiseIfFailed("MakeFilletEdges", self.LocalOp)
9452             else:
9453                 anObj = self.LocalOp.MakeFilletFaces(theShape, theR, theListShapes)
9454                 RaiseIfFailed("MakeFilletFaces", self.LocalOp)
9455             anObj.SetParameters(Parameters)
9456             self._autoPublish(anObj, theName, "fillet")
9457             return anObj
9458
9459         ## The same that MakeFillet() but with two Fillet Radius R1 and R2
9460         @ManageTransactions("LocalOp")
9461         def MakeFilletR1R2(self, theShape, theR1, theR2, theShapeType, theListShapes, theName=None):
9462             """
9463             The same that geompy.MakeFillet but with two Fillet Radius R1 and R2
9464
9465             Example of usage:
9466                 # get the list of IDs (IDList) for the fillet
9467                 prism_edges = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["EDGE"])
9468                 IDlist_e = []
9469                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[0]))
9470                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[1]))
9471                 IDlist_e.append(geompy.GetSubShapeID(prism, prism_edges[2]))
9472                 # make a fillet on the specified edges of the given shape
9473                 fillet = geompy.MakeFillet(prism, 10., 15., geompy.ShapeType["EDGE"], IDlist_e)
9474             """
9475             theR1,theR2,Parameters = ParseParameters(theR1,theR2)
9476             anObj = None
9477             if theShapeType == self.ShapeType["EDGE"]:
9478                 anObj = self.LocalOp.MakeFilletEdgesR1R2(theShape, theR1, theR2, theListShapes)
9479                 RaiseIfFailed("MakeFilletEdgesR1R2", self.LocalOp)
9480             else:
9481                 anObj = self.LocalOp.MakeFilletFacesR1R2(theShape, theR1, theR2, theListShapes)
9482                 RaiseIfFailed("MakeFilletFacesR1R2", self.LocalOp)
9483             anObj.SetParameters(Parameters)
9484             self._autoPublish(anObj, theName, "fillet")
9485             return anObj
9486
9487         ## Perform a fillet on the specified edges of the given shape
9488         #  @param theShape  Wire Shape to perform fillet on.
9489         #  @param theR  Fillet radius.
9490         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
9491         #    \note Global index of sub-shape can be obtained, using method GetSubShapeID()
9492         #    \note The list of vertices could be empty,
9493         #          in this case fillet will done done at all vertices in wire
9494         #  @param doIgnoreSecantVertices If FALSE, fillet radius is always limited
9495         #         by the length of the edges, nearest to the fillet vertex.
9496         #         But sometimes the next edge is C1 continuous with the one, nearest to
9497         #         the fillet point, and such two (or more) edges can be united to allow
9498         #         bigger radius. Set this flag to TRUE to allow collinear edges union,
9499         #         thus ignoring the secant vertex (vertices).
9500         #  @param theName Object name; when specified, this parameter is used
9501         #         for result publication in the study. Otherwise, if automatic
9502         #         publication is switched on, default value is used for result name.
9503         #
9504         #  @return New GEOM.GEOM_Object, containing the result shape.
9505         #
9506         #  @ref tui_fillet2d "Example"
9507         @ManageTransactions("LocalOp")
9508         def MakeFillet1D(self, theShape, theR, theListOfVertexes, doIgnoreSecantVertices = True, theName=None):
9509             """
9510             Perform a fillet on the specified edges of the given shape
9511
9512             Parameters:
9513                 theShape  Wire Shape to perform fillet on.
9514                 theR  Fillet radius.
9515                 theListOfVertexes Global indices of vertexes to perform fillet on.
9516                 doIgnoreSecantVertices If FALSE, fillet radius is always limited
9517                     by the length of the edges, nearest to the fillet vertex.
9518                     But sometimes the next edge is C1 continuous with the one, nearest to
9519                     the fillet point, and such two (or more) edges can be united to allow
9520                     bigger radius. Set this flag to TRUE to allow collinear edges union,
9521                     thus ignoring the secant vertex (vertices).
9522                 theName Object name; when specified, this parameter is used
9523                         for result publication in the study. Otherwise, if automatic
9524                         publication is switched on, default value is used for result name.
9525             Note:
9526                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9527
9528                 The list of vertices could be empty,in this case fillet will done done at all vertices in wire
9529
9530             Returns:
9531                 New GEOM.GEOM_Object, containing the result shape.
9532
9533             Example of usage:
9534                 # create wire
9535                 Wire_1 = geompy.MakeWire([Edge_12, Edge_7, Edge_11, Edge_6, Edge_1,Edge_4])
9536                 # make fillet at given wire vertices with giver radius
9537                 Fillet_1D_1 = geompy.MakeFillet1D(Wire_1, 55, [3, 4, 6, 8, 10])
9538             """
9539             # Example: see GEOM_TestAll.py
9540             theR,doIgnoreSecantVertices,Parameters = ParseParameters(theR,doIgnoreSecantVertices)
9541             anObj = self.LocalOp.MakeFillet1D(theShape, theR, theListOfVertexes, doIgnoreSecantVertices)
9542             RaiseIfFailed("MakeFillet1D", self.LocalOp)
9543             anObj.SetParameters(Parameters)
9544             self._autoPublish(anObj, theName, "fillet")
9545             return anObj
9546
9547         ## Perform a fillet at the specified vertices of the given face/shell.
9548         #  @param theShape Face or Shell shape to perform fillet on.
9549         #  @param theR Fillet radius.
9550         #  @param theListOfVertexes Global indices of vertexes to perform fillet on.
9551         #  @param theName Object name; when specified, this parameter is used
9552         #         for result publication in the study. Otherwise, if automatic
9553         #         publication is switched on, default value is used for result name.
9554         #
9555         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9556         #
9557         #  @return New GEOM.GEOM_Object, containing the result shape.
9558         #
9559         #  @ref tui_fillet2d "Example"
9560         @ManageTransactions("LocalOp")
9561         def MakeFillet2D(self, theShape, theR, theListOfVertexes, theName=None):
9562             """
9563             Perform a fillet at the specified vertices of the given face/shell.
9564
9565             Parameters:
9566                 theShape  Face or Shell shape to perform fillet on.
9567                 theR  Fillet radius.
9568                 theListOfVertexes Global indices of vertexes to perform fillet on.
9569                 theName Object name; when specified, this parameter is used
9570                         for result publication in the study. Otherwise, if automatic
9571                         publication is switched on, default value is used for result name.
9572             Note:
9573                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9574
9575             Returns:
9576                 New GEOM.GEOM_Object, containing the result shape.
9577
9578             Example of usage:
9579                 face = geompy.MakeFaceHW(100, 100, 1)
9580                 fillet2d = geompy.MakeFillet2D(face, 30, [7, 9])
9581             """
9582             # Example: see GEOM_TestAll.py
9583             theR,Parameters = ParseParameters(theR)
9584             anObj = self.LocalOp.MakeFillet2D(theShape, theR, theListOfVertexes)
9585             RaiseIfFailed("MakeFillet2D", self.LocalOp)
9586             anObj.SetParameters(Parameters)
9587             self._autoPublish(anObj, theName, "fillet")
9588             return anObj
9589
9590         ## Perform a symmetric chamfer on all edges of the given shape.
9591         #  @param theShape Shape, to perform chamfer on.
9592         #  @param theD Chamfer size along each face.
9593         #  @param theName Object name; when specified, this parameter is used
9594         #         for result publication in the study. Otherwise, if automatic
9595         #         publication is switched on, default value is used for result name.
9596         #
9597         #  @return New GEOM.GEOM_Object, containing the result shape.
9598         #
9599         #  @ref tui_chamfer "Example 1"
9600         #  \n @ref swig_MakeChamferAll "Example 2"
9601         @ManageTransactions("LocalOp")
9602         def MakeChamferAll(self, theShape, theD, theName=None):
9603             """
9604             Perform a symmetric chamfer on all edges of the given shape.
9605
9606             Parameters:
9607                 theShape Shape, to perform chamfer on.
9608                 theD Chamfer size along each face.
9609                 theName Object name; when specified, this parameter is used
9610                         for result publication in the study. Otherwise, if automatic
9611                         publication is switched on, default value is used for result name.
9612
9613             Returns:
9614                 New GEOM.GEOM_Object, containing the result shape.
9615
9616             Example of usage:
9617                 chamfer_all = geompy.MakeChamferAll(prism, 10.)
9618             """
9619             # Example: see GEOM_TestOthers.py
9620             theD,Parameters = ParseParameters(theD)
9621             anObj = self.LocalOp.MakeChamferAll(theShape, theD)
9622             RaiseIfFailed("MakeChamferAll", self.LocalOp)
9623             anObj.SetParameters(Parameters)
9624             self._autoPublish(anObj, theName, "chamfer")
9625             return anObj
9626
9627         ## Perform a chamfer on edges, common to the specified faces,
9628         #  with distance D1 on the Face1
9629         #  @param theShape Shape, to perform chamfer on.
9630         #  @param theD1 Chamfer size along \a theFace1.
9631         #  @param theD2 Chamfer size along \a theFace2.
9632         #  @param theFace1,theFace2 Global indices of two faces of \a theShape.
9633         #  @param theName Object name; when specified, this parameter is used
9634         #         for result publication in the study. Otherwise, if automatic
9635         #         publication is switched on, default value is used for result name.
9636         #
9637         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9638         #
9639         #  @return New GEOM.GEOM_Object, containing the result shape.
9640         #
9641         #  @ref tui_chamfer "Example"
9642         @ManageTransactions("LocalOp")
9643         def MakeChamferEdge(self, theShape, theD1, theD2, theFace1, theFace2, theName=None):
9644             """
9645             Perform a chamfer on edges, common to the specified faces,
9646             with distance D1 on the Face1
9647
9648             Parameters:
9649                 theShape Shape, to perform chamfer on.
9650                 theD1 Chamfer size along theFace1.
9651                 theD2 Chamfer size along theFace2.
9652                 theFace1,theFace2 Global indices of two faces of theShape.
9653                 theName Object name; when specified, this parameter is used
9654                         for result publication in the study. Otherwise, if automatic
9655                         publication is switched on, default value is used for result name.
9656
9657             Note:
9658                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9659
9660             Returns:
9661                 New GEOM.GEOM_Object, containing the result shape.
9662
9663             Example of usage:
9664                 prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
9665                 f_ind_1 = geompy.GetSubShapeID(prism, prism_faces[0])
9666                 f_ind_2 = geompy.GetSubShapeID(prism, prism_faces[1])
9667                 chamfer_e = geompy.MakeChamferEdge(prism, 10., 10., f_ind_1, f_ind_2)
9668             """
9669             # Example: see GEOM_TestAll.py
9670             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
9671             anObj = self.LocalOp.MakeChamferEdge(theShape, theD1, theD2, theFace1, theFace2)
9672             RaiseIfFailed("MakeChamferEdge", self.LocalOp)
9673             anObj.SetParameters(Parameters)
9674             self._autoPublish(anObj, theName, "chamfer")
9675             return anObj
9676
9677         ## Perform a chamfer on edges
9678         #  @param theShape Shape, to perform chamfer on.
9679         #  @param theD Chamfer length
9680         #  @param theAngle Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9681         #  @param theFace1,theFace2 Global indices of two faces of \a theShape.
9682         #  @param theName Object name; when specified, this parameter is used
9683         #         for result publication in the study. Otherwise, if automatic
9684         #         publication is switched on, default value is used for result name.
9685         #
9686         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9687         #
9688         #  @return New GEOM.GEOM_Object, containing the result shape.
9689         @ManageTransactions("LocalOp")
9690         def MakeChamferEdgeAD(self, theShape, theD, theAngle, theFace1, theFace2, theName=None):
9691             """
9692             Perform a chamfer on edges
9693
9694             Parameters:
9695                 theShape Shape, to perform chamfer on.
9696                 theD1 Chamfer size along theFace1.
9697                 theAngle Angle of chamfer (angle in radians or a name of variable which defines angle in degrees).
9698                 theFace1,theFace2 Global indices of two faces of theShape.
9699                 theName Object name; when specified, this parameter is used
9700                         for result publication in the study. Otherwise, if automatic
9701                         publication is switched on, default value is used for result name.
9702
9703             Note:
9704                 Global index of sub-shape can be obtained, using method geompy.GetSubShapeID
9705
9706             Returns:
9707                 New GEOM.GEOM_Object, containing the result shape.
9708
9709             Example of usage:
9710                 prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
9711                 f_ind_1 = geompy.GetSubShapeID(prism, prism_faces[0])
9712                 f_ind_2 = geompy.GetSubShapeID(prism, prism_faces[1])
9713                 ang = 30
9714                 chamfer_e = geompy.MakeChamferEdge(prism, 10., ang, f_ind_1, f_ind_2)
9715             """
9716             flag = False
9717             if isinstance(theAngle,str):
9718                 flag = True
9719             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
9720             if flag:
9721                 theAngle = theAngle*math.pi/180.0
9722             anObj = self.LocalOp.MakeChamferEdgeAD(theShape, theD, theAngle, theFace1, theFace2)
9723             RaiseIfFailed("MakeChamferEdgeAD", self.LocalOp)
9724             anObj.SetParameters(Parameters)
9725             self._autoPublish(anObj, theName, "chamfer")
9726             return anObj
9727
9728         ## Perform a chamfer on all edges of the specified faces,
9729         #  with distance D1 on the first specified face (if several for one edge)
9730         #  @param theShape Shape, to perform chamfer on.
9731         #  @param theD1 Chamfer size along face from \a theFaces. If both faces,
9732         #               connected to the edge, are in \a theFaces, \a theD1
9733         #               will be get along face, which is nearer to \a theFaces beginning.
9734         #  @param theD2 Chamfer size along another of two faces, connected to the edge.
9735         #  @param theFaces Sequence of global indices of faces of \a theShape.
9736         #  @param theName Object name; when specified, this parameter is used
9737         #         for result publication in the study. Otherwise, if automatic
9738         #         publication is switched on, default value is used for result name.
9739         #
9740         #  @note Global index of sub-shape can be obtained, using method GetSubShapeID().
9741         #
9742         #  @return New GEOM.GEOM_Object, containing the result shape.
9743         #
9744         #  @ref tui_chamfer "Example"
9745         @ManageTransactions("LocalOp")
9746         def MakeChamferFaces(self, theShape, theD1, theD2, theFaces, theName=None):
9747             """
9748             Perform a chamfer on all edges of the specified faces,
9749             with distance D1 on the first specified face (if several for one edge)
9750
9751             Parameters:
9752                 theShape Shape, to perform chamfer on.
9753                 theD1 Chamfer size along face from  theFaces. If both faces,
9754                       connected to the edge, are in theFaces, theD1
9755                       will be get along face, which is nearer to theFaces beginning.
9756                 theD2 Chamfer size along another of two faces, connected to the edge.
9757                 theFaces Sequence of global indices of faces of theShape.
9758                 theName Object name; when specified, this parameter is used
9759                         for result publication in the study. Otherwise, if automatic
9760                         publication is switched on, default value is used for result name.
9761
9762             Note: Global index of sub-shape can be obtained, using method geompy.GetSubShapeID().
9763
9764             Returns:
9765                 New GEOM.GEOM_Object, containing the result shape.
9766             """
9767             # Example: see GEOM_TestAll.py
9768             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
9769             anObj = self.LocalOp.MakeChamferFaces(theShape, theD1, theD2, theFaces)
9770             RaiseIfFailed("MakeChamferFaces", self.LocalOp)
9771             anObj.SetParameters(Parameters)
9772             self._autoPublish(anObj, theName, "chamfer")
9773             return anObj
9774
9775         ## The Same that MakeChamferFaces() but with params theD is chamfer lenght and
9776         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9777         #
9778         #  @ref swig_FilletChamfer "Example"
9779         @ManageTransactions("LocalOp")
9780         def MakeChamferFacesAD(self, theShape, theD, theAngle, theFaces, theName=None):
9781             """
9782             The Same that geompy.MakeChamferFaces but with params theD is chamfer lenght and
9783             theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9784             """
9785             flag = False
9786             if isinstance(theAngle,str):
9787                 flag = True
9788             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
9789             if flag:
9790                 theAngle = theAngle*math.pi/180.0
9791             anObj = self.LocalOp.MakeChamferFacesAD(theShape, theD, theAngle, theFaces)
9792             RaiseIfFailed("MakeChamferFacesAD", self.LocalOp)
9793             anObj.SetParameters(Parameters)
9794             self._autoPublish(anObj, theName, "chamfer")
9795             return anObj
9796
9797         ## Perform a chamfer on edges,
9798         #  with distance D1 on the first specified face (if several for one edge)
9799         #  @param theShape Shape, to perform chamfer on.
9800         #  @param theD1,theD2 Chamfer size
9801         #  @param theEdges Sequence of edges of \a theShape.
9802         #  @param theName Object name; when specified, this parameter is used
9803         #         for result publication in the study. Otherwise, if automatic
9804         #         publication is switched on, default value is used for result name.
9805         #
9806         #  @return New GEOM.GEOM_Object, containing the result shape.
9807         #
9808         #  @ref swig_FilletChamfer "Example"
9809         @ManageTransactions("LocalOp")
9810         def MakeChamferEdges(self, theShape, theD1, theD2, theEdges, theName=None):
9811             """
9812             Perform a chamfer on edges,
9813             with distance D1 on the first specified face (if several for one edge)
9814
9815             Parameters:
9816                 theShape Shape, to perform chamfer on.
9817                 theD1,theD2 Chamfer size
9818                 theEdges Sequence of edges of theShape.
9819                 theName Object name; when specified, this parameter is used
9820                         for result publication in the study. Otherwise, if automatic
9821                         publication is switched on, default value is used for result name.
9822
9823             Returns:
9824                 New GEOM.GEOM_Object, containing the result shape.
9825             """
9826             theD1,theD2,Parameters = ParseParameters(theD1,theD2)
9827             anObj = self.LocalOp.MakeChamferEdges(theShape, theD1, theD2, theEdges)
9828             RaiseIfFailed("MakeChamferEdges", self.LocalOp)
9829             anObj.SetParameters(Parameters)
9830             self._autoPublish(anObj, theName, "chamfer")
9831             return anObj
9832
9833         ## The Same that MakeChamferEdges() but with params theD is chamfer lenght and
9834         #  theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9835         @ManageTransactions("LocalOp")
9836         def MakeChamferEdgesAD(self, theShape, theD, theAngle, theEdges, theName=None):
9837             """
9838             The Same that geompy.MakeChamferEdges but with params theD is chamfer lenght and
9839             theAngle is Angle of chamfer (angle in radians or a name of variable which defines angle in degrees)
9840             """
9841             flag = False
9842             if isinstance(theAngle,str):
9843                 flag = True
9844             theD,theAngle,Parameters = ParseParameters(theD,theAngle)
9845             if flag:
9846                 theAngle = theAngle*math.pi/180.0
9847             anObj = self.LocalOp.MakeChamferEdgesAD(theShape, theD, theAngle, theEdges)
9848             RaiseIfFailed("MakeChamferEdgesAD", self.LocalOp)
9849             anObj.SetParameters(Parameters)
9850             self._autoPublish(anObj, theName, "chamfer")
9851             return anObj
9852
9853         ## @sa MakeChamferEdge(), MakeChamferFaces()
9854         #
9855         #  @ref swig_MakeChamfer "Example"
9856         def MakeChamfer(self, aShape, d1, d2, aShapeType, ListShape, theName=None):
9857             """
9858             See geompy.MakeChamferEdge() and geompy.MakeChamferFaces() functions for more information.
9859             """
9860             # Example: see GEOM_TestOthers.py
9861             anObj = None
9862             # note: auto-publishing is done in self.MakeChamferEdge() or self.MakeChamferFaces()
9863             if aShapeType == self.ShapeType["EDGE"]:
9864                 anObj = self.MakeChamferEdge(aShape,d1,d2,ListShape[0],ListShape[1],theName)
9865             else:
9866                 anObj = self.MakeChamferFaces(aShape,d1,d2,ListShape,theName)
9867             return anObj
9868
9869         ## Remove material from a solid by extrusion of the base shape on the given distance.
9870         #  @param theInit Shape to remove material from. It must be a solid or
9871         #  a compound made of a single solid.
9872         #  @param theBase Closed edge or wire defining the base shape to be extruded.
9873         #  @param theH Prism dimension along the normal to theBase
9874         #  @param theAngle Draft angle in degrees.
9875         #  @param theName Object name; when specified, this parameter is used
9876         #         for result publication in the study. Otherwise, if automatic
9877         #         publication is switched on, default value is used for result name.
9878         #
9879         #  @return New GEOM.GEOM_Object, containing the initial shape with removed material
9880         #
9881         #  @ref tui_creation_prism "Example"
9882         @ManageTransactions("PrimOp")
9883         def MakeExtrudedCut(self, theInit, theBase, theH, theAngle, theName=None):
9884             """
9885             Add material to a solid by extrusion of the base shape on the given distance.
9886
9887             Parameters:
9888                 theInit Shape to remove material from. It must be a solid or a compound made of a single solid.
9889                 theBase Closed edge or wire defining the base shape to be extruded.
9890                 theH Prism dimension along the normal  to theBase
9891                 theAngle Draft angle in degrees.
9892                 theName Object name; when specified, this parameter is used
9893                         for result publication in the study. Otherwise, if automatic
9894                         publication is switched on, default value is used for result name.
9895
9896             Returns:
9897                 New GEOM.GEOM_Object,  containing the initial shape with removed material.
9898             """
9899             # Example: see GEOM_TestAll.py
9900             #theH,Parameters = ParseParameters(theH)
9901             anObj = self.PrimOp.MakeDraftPrism(theInit, theBase, theH, theAngle, False)
9902             RaiseIfFailed("MakeExtrudedBoss", self.PrimOp)
9903             #anObj.SetParameters(Parameters)
9904             self._autoPublish(anObj, theName, "extrudedCut")
9905             return anObj
9906
9907         ## Add material to a solid by extrusion of the base shape on the given distance.
9908         #  @param theInit Shape to add material to. It must be a solid or
9909         #  a compound made of a single solid.
9910         #  @param theBase Closed edge or wire defining the base shape to be extruded.
9911         #  @param theH Prism dimension along the normal to theBase
9912         #  @param theAngle Draft angle in degrees.
9913         #  @param theName Object name; when specified, this parameter is used
9914         #         for result publication in the study. Otherwise, if automatic
9915         #         publication is switched on, default value is used for result name.
9916         #
9917         #  @return New GEOM.GEOM_Object, containing the initial shape with added material
9918         #
9919         #  @ref tui_creation_prism "Example"
9920         @ManageTransactions("PrimOp")
9921         def MakeExtrudedBoss(self, theInit, theBase, theH, theAngle, theName=None):
9922             """
9923             Add material to a solid by extrusion of the base shape on the given distance.
9924
9925             Parameters:
9926                 theInit Shape to add material to. It must be a solid or a compound made of a single solid.
9927                 theBase Closed edge or wire defining the base shape to be extruded.
9928                 theH Prism dimension along the normal  to theBase
9929                 theAngle Draft angle in degrees.
9930                 theName Object name; when specified, this parameter is used
9931                         for result publication in the study. Otherwise, if automatic
9932                         publication is switched on, default value is used for result name.
9933
9934             Returns:
9935                 New GEOM.GEOM_Object,  containing the initial shape with added material.
9936             """
9937             # Example: see GEOM_TestAll.py
9938             #theH,Parameters = ParseParameters(theH)
9939             anObj = self.PrimOp.MakeDraftPrism(theInit, theBase, theH, theAngle, True)
9940             RaiseIfFailed("MakeExtrudedBoss", self.PrimOp)
9941             #anObj.SetParameters(Parameters)
9942             self._autoPublish(anObj, theName, "extrudedBoss")
9943             return anObj
9944
9945         # end of l3_local
9946         ## @}
9947
9948         ## @addtogroup l3_basic_op
9949         ## @{
9950
9951         ## Perform an Archimde operation on the given shape with given parameters.
9952         #  The object presenting the resulting face is returned.
9953         #  @param theShape Shape to be put in water.
9954         #  @param theWeight Weight of the shape.
9955         #  @param theWaterDensity Density of the water.
9956         #  @param theMeshDeflection Deflection of the mesh, using to compute the section.
9957         #  @param theName Object name; when specified, this parameter is used
9958         #         for result publication in the study. Otherwise, if automatic
9959         #         publication is switched on, default value is used for result name.
9960         #
9961         #  @return New GEOM.GEOM_Object, containing a section of \a theShape
9962         #          by a plane, corresponding to water level.
9963         #
9964         #  @ref tui_archimede "Example"
9965         @ManageTransactions("LocalOp")
9966         def Archimede(self, theShape, theWeight, theWaterDensity, theMeshDeflection, theName=None):
9967             """
9968             Perform an Archimde operation on the given shape with given parameters.
9969             The object presenting the resulting face is returned.
9970
9971             Parameters:
9972                 theShape Shape to be put in water.
9973                 theWeight Weight of the shape.
9974                 theWaterDensity Density of the water.
9975                 theMeshDeflection Deflection of the mesh, using to compute the section.
9976                 theName Object name; when specified, this parameter is used
9977                         for result publication in the study. Otherwise, if automatic
9978                         publication is switched on, default value is used for result name.
9979
9980             Returns:
9981                 New GEOM.GEOM_Object, containing a section of theShape
9982                 by a plane, corresponding to water level.
9983             """
9984             # Example: see GEOM_TestAll.py
9985             theWeight,theWaterDensity,theMeshDeflection,Parameters = ParseParameters(
9986               theWeight,theWaterDensity,theMeshDeflection)
9987             anObj = self.LocalOp.MakeArchimede(theShape, theWeight, theWaterDensity, theMeshDeflection)
9988             RaiseIfFailed("MakeArchimede", self.LocalOp)
9989             anObj.SetParameters(Parameters)
9990             self._autoPublish(anObj, theName, "archimede")
9991             return anObj
9992
9993         # end of l3_basic_op
9994         ## @}
9995
9996         ## @addtogroup l2_measure
9997         ## @{
9998
9999         ## Get point coordinates
10000         #  @return [x, y, z]
10001         #
10002         #  @ref tui_measurement_tools_page "Example"
10003         @ManageTransactions("MeasuOp")
10004         def PointCoordinates(self,Point):
10005             """
10006             Get point coordinates
10007
10008             Returns:
10009                 [x, y, z]
10010             """
10011             # Example: see GEOM_TestMeasures.py
10012             aTuple = self.MeasuOp.PointCoordinates(Point)
10013             RaiseIfFailed("PointCoordinates", self.MeasuOp)
10014             return aTuple
10015
10016         ## Get vector coordinates
10017         #  @return [x, y, z]
10018         #
10019         #  @ref tui_measurement_tools_page "Example"
10020         def VectorCoordinates(self,Vector):
10021             """
10022             Get vector coordinates
10023
10024             Returns:
10025                 [x, y, z]
10026             """
10027
10028             p1=self.GetFirstVertex(Vector)
10029             p2=self.GetLastVertex(Vector)
10030
10031             X1=self.PointCoordinates(p1)
10032             X2=self.PointCoordinates(p2)
10033
10034             return (X2[0]-X1[0],X2[1]-X1[1],X2[2]-X1[2])
10035
10036
10037         ## Compute cross product
10038         #  @return vector w=u^v
10039         #
10040         #  @ref tui_measurement_tools_page "Example"
10041         def CrossProduct(self, Vector1, Vector2):
10042             """
10043             Compute cross product
10044
10045             Returns: vector w=u^v
10046             """
10047             u=self.VectorCoordinates(Vector1)
10048             v=self.VectorCoordinates(Vector2)
10049             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])
10050
10051             return w
10052
10053         ## Compute cross product
10054         #  @return dot product  p=u.v
10055         #
10056         #  @ref tui_measurement_tools_page "Example"
10057         def DotProduct(self, Vector1, Vector2):
10058             """
10059             Compute cross product
10060
10061             Returns: dot product  p=u.v
10062             """
10063             u=self.VectorCoordinates(Vector1)
10064             v=self.VectorCoordinates(Vector2)
10065             p=u[0]*v[0]+u[1]*v[1]+u[2]*v[2]
10066
10067             return p
10068
10069
10070         ## Get summarized length of all wires,
10071         #  area of surface and volume of the given shape.
10072         #  @param theShape Shape to define properties of.
10073         #  @return [theLength, theSurfArea, theVolume]\n
10074         #  theLength:   Summarized length of all wires of the given shape.\n
10075         #  theSurfArea: Area of surface of the given shape.\n
10076         #  theVolume:   Volume of the given shape.
10077         #
10078         #  @ref tui_measurement_tools_page "Example"
10079         @ManageTransactions("MeasuOp")
10080         def BasicProperties(self,theShape):
10081             """
10082             Get summarized length of all wires,
10083             area of surface and volume of the given shape.
10084
10085             Parameters:
10086                 theShape Shape to define properties of.
10087
10088             Returns:
10089                 [theLength, theSurfArea, theVolume]
10090                  theLength:   Summarized length of all wires of the given shape.
10091                  theSurfArea: Area of surface of the given shape.
10092                  theVolume:   Volume of the given shape.
10093             """
10094             # Example: see GEOM_TestMeasures.py
10095             aTuple = self.MeasuOp.GetBasicProperties(theShape)
10096             RaiseIfFailed("GetBasicProperties", self.MeasuOp)
10097             return aTuple
10098
10099         ## Get parameters of bounding box of the given shape
10100         #  @param theShape Shape to obtain bounding box of.
10101         #  @param precise TRUE for precise computation; FALSE for fast one.
10102         #  @return [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
10103         #  Xmin,Xmax: Limits of shape along OX axis.
10104         #  Ymin,Ymax: Limits of shape along OY axis.
10105         #  Zmin,Zmax: Limits of shape along OZ axis.
10106         #
10107         #  @ref tui_measurement_tools_page "Example"
10108         @ManageTransactions("MeasuOp")
10109         def BoundingBox (self, theShape, precise=False):
10110             """
10111             Get parameters of bounding box of the given shape
10112
10113             Parameters:
10114                 theShape Shape to obtain bounding box of.
10115                 precise TRUE for precise computation; FALSE for fast one.
10116
10117             Returns:
10118                 [Xmin,Xmax, Ymin,Ymax, Zmin,Zmax]
10119                  Xmin,Xmax: Limits of shape along OX axis.
10120                  Ymin,Ymax: Limits of shape along OY axis.
10121                  Zmin,Zmax: Limits of shape along OZ axis.
10122             """
10123             # Example: see GEOM_TestMeasures.py
10124             aTuple = self.MeasuOp.GetBoundingBox(theShape, precise)
10125             RaiseIfFailed("GetBoundingBox", self.MeasuOp)
10126             return aTuple
10127
10128         ## Get bounding box of the given shape
10129         #  @param theShape Shape to obtain bounding box of.
10130         #  @param precise TRUE for precise computation; FALSE for fast one.
10131         #  @param theName Object name; when specified, this parameter is used
10132         #         for result publication in the study. Otherwise, if automatic
10133         #         publication is switched on, default value is used for result name.
10134         #
10135         #  @return New GEOM.GEOM_Object, containing the created box.
10136         #
10137         #  @ref tui_measurement_tools_page "Example"
10138         @ManageTransactions("MeasuOp")
10139         def MakeBoundingBox (self, theShape, precise=False, theName=None):
10140             """
10141             Get bounding box of the given shape
10142
10143             Parameters:
10144                 theShape Shape to obtain bounding box of.
10145                 precise TRUE for precise computation; FALSE for fast one.
10146                 theName Object name; when specified, this parameter is used
10147                         for result publication in the study. Otherwise, if automatic
10148                         publication is switched on, default value is used for result name.
10149
10150             Returns:
10151                 New GEOM.GEOM_Object, containing the created box.
10152             """
10153             # Example: see GEOM_TestMeasures.py
10154             anObj = self.MeasuOp.MakeBoundingBox(theShape, precise)
10155             RaiseIfFailed("MakeBoundingBox", self.MeasuOp)
10156             self._autoPublish(anObj, theName, "bndbox")
10157             return anObj
10158
10159         ## Get inertia matrix and moments of inertia of theShape.
10160         #  @param theShape Shape to calculate inertia of.
10161         #  @return [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
10162         #  I(1-3)(1-3): Components of the inertia matrix of the given shape.
10163         #  Ix,Iy,Iz:    Moments of inertia of the given shape.
10164         #
10165         #  @ref tui_measurement_tools_page "Example"
10166         @ManageTransactions("MeasuOp")
10167         def Inertia(self,theShape):
10168             """
10169             Get inertia matrix and moments of inertia of theShape.
10170
10171             Parameters:
10172                 theShape Shape to calculate inertia of.
10173
10174             Returns:
10175                 [I11,I12,I13, I21,I22,I23, I31,I32,I33, Ix,Iy,Iz]
10176                  I(1-3)(1-3): Components of the inertia matrix of the given shape.
10177                  Ix,Iy,Iz:    Moments of inertia of the given shape.
10178             """
10179             # Example: see GEOM_TestMeasures.py
10180             aTuple = self.MeasuOp.GetInertia(theShape)
10181             RaiseIfFailed("GetInertia", self.MeasuOp)
10182             return aTuple
10183
10184         ## Get if coords are included in the shape (ST_IN or ST_ON)
10185         #  @param theShape Shape
10186         #  @param coords list of points coordinates [x1, y1, z1, x2, y2, z2, ...]
10187         #  @param tolerance to be used (default is 1.0e-7)
10188         #  @return list_of_boolean = [res1, res2, ...]
10189         @ManageTransactions("MeasuOp")
10190         def AreCoordsInside(self, theShape, coords, tolerance=1.e-7):
10191             """
10192             Get if coords are included in the shape (ST_IN or ST_ON)
10193
10194             Parameters:
10195                 theShape Shape
10196                 coords list of points coordinates [x1, y1, z1, x2, y2, z2, ...]
10197                 tolerance to be used (default is 1.0e-7)
10198
10199             Returns:
10200                 list_of_boolean = [res1, res2, ...]
10201             """
10202             return self.MeasuOp.AreCoordsInside(theShape, coords, tolerance)
10203
10204         ## Get minimal distance between the given shapes.
10205         #  @param theShape1,theShape2 Shapes to find minimal distance between.
10206         #  @return Value of the minimal distance between the given shapes.
10207         #
10208         #  @ref tui_measurement_tools_page "Example"
10209         @ManageTransactions("MeasuOp")
10210         def MinDistance(self, theShape1, theShape2):
10211             """
10212             Get minimal distance between the given shapes.
10213
10214             Parameters:
10215                 theShape1,theShape2 Shapes to find minimal distance between.
10216
10217             Returns:
10218                 Value of the minimal distance between the given shapes.
10219             """
10220             # Example: see GEOM_TestMeasures.py
10221             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
10222             RaiseIfFailed("GetMinDistance", self.MeasuOp)
10223             return aTuple[0]
10224
10225         ## Get minimal distance between the given shapes.
10226         #  @param theShape1,theShape2 Shapes to find minimal distance between.
10227         #  @return Value of the minimal distance between the given shapes, in form of list
10228         #          [Distance, DX, DY, DZ].
10229         #
10230         #  @ref swig_all_measure "Example"
10231         @ManageTransactions("MeasuOp")
10232         def MinDistanceComponents(self, theShape1, theShape2):
10233             """
10234             Get minimal distance between the given shapes.
10235
10236             Parameters:
10237                 theShape1,theShape2 Shapes to find minimal distance between.
10238
10239             Returns:
10240                 Value of the minimal distance between the given shapes, in form of list
10241                 [Distance, DX, DY, DZ]
10242             """
10243             # Example: see GEOM_TestMeasures.py
10244             aTuple = self.MeasuOp.GetMinDistance(theShape1, theShape2)
10245             RaiseIfFailed("GetMinDistance", self.MeasuOp)
10246             aRes = [aTuple[0], aTuple[4] - aTuple[1], aTuple[5] - aTuple[2], aTuple[6] - aTuple[3]]
10247             return aRes
10248
10249         ## Get closest points of the given shapes.
10250         #  @param theShape1,theShape2 Shapes to find closest points of.
10251         #  @return The number of found solutions (-1 in case of infinite number of
10252         #          solutions) and a list of (X, Y, Z) coordinates for all couples of points.
10253         #
10254         #  @ref tui_measurement_tools_page "Example"
10255         @ManageTransactions("MeasuOp")
10256         def ClosestPoints (self, theShape1, theShape2):
10257             """
10258             Get closest points of the given shapes.
10259
10260             Parameters:
10261                 theShape1,theShape2 Shapes to find closest points of.
10262
10263             Returns:
10264                 The number of found solutions (-1 in case of infinite number of
10265                 solutions) and a list of (X, Y, Z) coordinates for all couples of points.
10266             """
10267             # Example: see GEOM_TestMeasures.py
10268             aTuple = self.MeasuOp.ClosestPoints(theShape1, theShape2)
10269             RaiseIfFailed("ClosestPoints", self.MeasuOp)
10270             return aTuple
10271
10272         ## Get angle between the given shapes in degrees.
10273         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
10274         #  @note If both arguments are vectors, the angle is computed in accordance
10275         #        with their orientations, otherwise the minimum angle is computed.
10276         #  @return Value of the angle between the given shapes in degrees.
10277         #
10278         #  @ref tui_measurement_tools_page "Example"
10279         @ManageTransactions("MeasuOp")
10280         def GetAngle(self, theShape1, theShape2):
10281             """
10282             Get angle between the given shapes in degrees.
10283
10284             Parameters:
10285                 theShape1,theShape2 Lines or linear edges to find angle between.
10286
10287             Note:
10288                 If both arguments are vectors, the angle is computed in accordance
10289                 with their orientations, otherwise the minimum angle is computed.
10290
10291             Returns:
10292                 Value of the angle between the given shapes in degrees.
10293             """
10294             # Example: see GEOM_TestMeasures.py
10295             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)
10296             RaiseIfFailed("GetAngle", self.MeasuOp)
10297             return anAngle
10298
10299         ## Get angle between the given shapes in radians.
10300         #  @param theShape1,theShape2 Lines or linear edges to find angle between.
10301         #  @note If both arguments are vectors, the angle is computed in accordance
10302         #        with their orientations, otherwise the minimum angle is computed.
10303         #  @return Value of the angle between the given shapes in radians.
10304         #
10305         #  @ref tui_measurement_tools_page "Example"
10306         @ManageTransactions("MeasuOp")
10307         def GetAngleRadians(self, theShape1, theShape2):
10308             """
10309             Get angle between the given shapes in radians.
10310
10311             Parameters:
10312                 theShape1,theShape2 Lines or linear edges to find angle between.
10313
10314
10315             Note:
10316                 If both arguments are vectors, the angle is computed in accordance
10317                 with their orientations, otherwise the minimum angle is computed.
10318
10319             Returns:
10320                 Value of the angle between the given shapes in radians.
10321             """
10322             # Example: see GEOM_TestMeasures.py
10323             anAngle = self.MeasuOp.GetAngle(theShape1, theShape2)*math.pi/180.
10324             RaiseIfFailed("GetAngle", self.MeasuOp)
10325             return anAngle
10326
10327         ## Get angle between the given vectors in degrees.
10328         #  @param theShape1,theShape2 Vectors to find angle between.
10329         #  @param theFlag If True, the normal vector is defined by the two vectors cross,
10330         #                 if False, the opposite vector to the normal vector is used.
10331         #  @return Value of the angle between the given vectors in degrees.
10332         #
10333         #  @ref tui_measurement_tools_page "Example"
10334         @ManageTransactions("MeasuOp")
10335         def GetAngleVectors(self, theShape1, theShape2, theFlag = True):
10336             """
10337             Get angle between the given vectors in degrees.
10338
10339             Parameters:
10340                 theShape1,theShape2 Vectors to find angle between.
10341                 theFlag If True, the normal vector is defined by the two vectors cross,
10342                         if False, the opposite vector to the normal vector is used.
10343
10344             Returns:
10345                 Value of the angle between the given vectors in degrees.
10346             """
10347             anAngle = self.MeasuOp.GetAngleBtwVectors(theShape1, theShape2)
10348             if not theFlag:
10349                 anAngle = 360. - anAngle
10350             RaiseIfFailed("GetAngleVectors", self.MeasuOp)
10351             return anAngle
10352
10353         ## The same as GetAngleVectors, but the result is in radians.
10354         def GetAngleRadiansVectors(self, theShape1, theShape2, theFlag = True):
10355             """
10356             Get angle between the given vectors in radians.
10357
10358             Parameters:
10359                 theShape1,theShape2 Vectors to find angle between.
10360                 theFlag If True, the normal vector is defined by the two vectors cross,
10361                         if False, the opposite vector to the normal vector is used.
10362
10363             Returns:
10364                 Value of the angle between the given vectors in radians.
10365             """
10366             anAngle = self.GetAngleVectors(theShape1, theShape2, theFlag)*math.pi/180.
10367             return anAngle
10368
10369         ## @name Curve Curvature Measurement
10370         #  Methods for receiving radius of curvature of curves
10371         #  in the given point
10372         ## @{
10373
10374         ## Measure curvature of a curve at a point, set by parameter.
10375         #  @param theCurve a curve.
10376         #  @param theParam parameter.
10377         #  @return radius of curvature of \a theCurve.
10378         #
10379         #  @ref swig_todo "Example"
10380         @ManageTransactions("MeasuOp")
10381         def CurveCurvatureByParam(self, theCurve, theParam):
10382             """
10383             Measure curvature of a curve at a point, set by parameter.
10384
10385             Parameters:
10386                 theCurve a curve.
10387                 theParam parameter.
10388
10389             Returns:
10390                 radius of curvature of theCurve.
10391             """
10392             # Example: see GEOM_TestMeasures.py
10393             aCurv = self.MeasuOp.CurveCurvatureByParam(theCurve,theParam)
10394             RaiseIfFailed("CurveCurvatureByParam", self.MeasuOp)
10395             return aCurv
10396
10397         ## Measure curvature of a curve at a point.
10398         #  @param theCurve a curve.
10399         #  @param thePoint given point.
10400         #  @return radius of curvature of \a theCurve.
10401         #
10402         #  @ref swig_todo "Example"
10403         @ManageTransactions("MeasuOp")
10404         def CurveCurvatureByPoint(self, theCurve, thePoint):
10405             """
10406             Measure curvature of a curve at a point.
10407
10408             Parameters:
10409                 theCurve a curve.
10410                 thePoint given point.
10411
10412             Returns:
10413                 radius of curvature of theCurve.
10414             """
10415             aCurv = self.MeasuOp.CurveCurvatureByPoint(theCurve,thePoint)
10416             RaiseIfFailed("CurveCurvatureByPoint", self.MeasuOp)
10417             return aCurv
10418         ## @}
10419
10420         ## @name Surface Curvature Measurement
10421         #  Methods for receiving max and min radius of curvature of surfaces
10422         #  in the given point
10423         ## @{
10424
10425         ## Measure max radius of curvature of surface.
10426         #  @param theSurf the given surface.
10427         #  @param theUParam Value of U-parameter on the referenced surface.
10428         #  @param theVParam Value of V-parameter on the referenced surface.
10429         #  @return max radius of curvature of theSurf.
10430         #
10431         ## @ref swig_todo "Example"
10432         @ManageTransactions("MeasuOp")
10433         def MaxSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
10434             """
10435             Measure max radius of curvature of surface.
10436
10437             Parameters:
10438                 theSurf the given surface.
10439                 theUParam Value of U-parameter on the referenced surface.
10440                 theVParam Value of V-parameter on the referenced surface.
10441
10442             Returns:
10443                 max radius of curvature of theSurf.
10444             """
10445             # Example: see GEOM_TestMeasures.py
10446             aSurf = self.MeasuOp.MaxSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
10447             RaiseIfFailed("MaxSurfaceCurvatureByParam", self.MeasuOp)
10448             return aSurf
10449
10450         ## Measure max radius of curvature of surface in the given point
10451         #  @param theSurf the given surface.
10452         #  @param thePoint given point.
10453         #  @return max radius of curvature of theSurf.
10454         #
10455         ## @ref swig_todo "Example"
10456         @ManageTransactions("MeasuOp")
10457         def MaxSurfaceCurvatureByPoint(self, theSurf, thePoint):
10458             """
10459             Measure max radius of curvature of surface in the given point.
10460
10461             Parameters:
10462                 theSurf the given surface.
10463                 thePoint given point.
10464
10465             Returns:
10466                 max radius of curvature of theSurf.
10467             """
10468             aSurf = self.MeasuOp.MaxSurfaceCurvatureByPoint(theSurf,thePoint)
10469             RaiseIfFailed("MaxSurfaceCurvatureByPoint", self.MeasuOp)
10470             return aSurf
10471
10472         ## Measure min radius of curvature of surface.
10473         #  @param theSurf the given surface.
10474         #  @param theUParam Value of U-parameter on the referenced surface.
10475         #  @param theVParam Value of V-parameter on the referenced surface.
10476         #  @return min radius of curvature of theSurf.
10477         #
10478         ## @ref swig_todo "Example"
10479         @ManageTransactions("MeasuOp")
10480         def MinSurfaceCurvatureByParam(self, theSurf, theUParam, theVParam):
10481             """
10482             Measure min radius of curvature of surface.
10483
10484             Parameters:
10485                 theSurf the given surface.
10486                 theUParam Value of U-parameter on the referenced surface.
10487                 theVParam Value of V-parameter on the referenced surface.
10488
10489             Returns:
10490                 Min radius of curvature of theSurf.
10491             """
10492             aSurf = self.MeasuOp.MinSurfaceCurvatureByParam(theSurf,theUParam,theVParam)
10493             RaiseIfFailed("MinSurfaceCurvatureByParam", self.MeasuOp)
10494             return aSurf
10495
10496         ## Measure min radius of curvature of surface in the given point
10497         #  @param theSurf the given surface.
10498         #  @param thePoint given point.
10499         #  @return min radius of curvature of theSurf.
10500         #
10501         ## @ref swig_todo "Example"
10502         @ManageTransactions("MeasuOp")
10503         def MinSurfaceCurvatureByPoint(self, theSurf, thePoint):
10504             """
10505             Measure min radius of curvature of surface in the given point.
10506
10507             Parameters:
10508                 theSurf the given surface.
10509                 thePoint given point.
10510
10511             Returns:
10512                 Min radius of curvature of theSurf.
10513             """
10514             aSurf = self.MeasuOp.MinSurfaceCurvatureByPoint(theSurf,thePoint)
10515             RaiseIfFailed("MinSurfaceCurvatureByPoint", self.MeasuOp)
10516             return aSurf
10517         ## @}
10518
10519         ## Get min and max tolerances of sub-shapes of theShape
10520         #  @param theShape Shape, to get tolerances of.
10521         #  @return [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]\n
10522         #  FaceMin,FaceMax: Min and max tolerances of the faces.\n
10523         #  EdgeMin,EdgeMax: Min and max tolerances of the edges.\n
10524         #  VertMin,VertMax: Min and max tolerances of the vertices.
10525         #
10526         #  @ref tui_measurement_tools_page "Example"
10527         @ManageTransactions("MeasuOp")
10528         def Tolerance(self,theShape):
10529             """
10530             Get min and max tolerances of sub-shapes of theShape
10531
10532             Parameters:
10533                 theShape Shape, to get tolerances of.
10534
10535             Returns:
10536                 [FaceMin,FaceMax, EdgeMin,EdgeMax, VertMin,VertMax]
10537                  FaceMin,FaceMax: Min and max tolerances of the faces.
10538                  EdgeMin,EdgeMax: Min and max tolerances of the edges.
10539                  VertMin,VertMax: Min and max tolerances of the vertices.
10540             """
10541             # Example: see GEOM_TestMeasures.py
10542             aTuple = self.MeasuOp.GetTolerance(theShape)
10543             RaiseIfFailed("GetTolerance", self.MeasuOp)
10544             return aTuple
10545
10546         ## Obtain description of the given shape (number of sub-shapes of each type)
10547         #  @param theShape Shape to be described.
10548         #  @return Description of the given shape.
10549         #
10550         #  @ref tui_measurement_tools_page "Example"
10551         @ManageTransactions("MeasuOp")
10552         def WhatIs(self,theShape):
10553             """
10554             Obtain description of the given shape (number of sub-shapes of each type)
10555
10556             Parameters:
10557                 theShape Shape to be described.
10558
10559             Returns:
10560                 Description of the given shape.
10561             """
10562             # Example: see GEOM_TestMeasures.py
10563             aDescr = self.MeasuOp.WhatIs(theShape)
10564             RaiseIfFailed("WhatIs", self.MeasuOp)
10565             return aDescr
10566
10567         ## Obtain quantity of shapes of the given type in \a theShape.
10568         #  If \a theShape is of type \a theType, it is also counted.
10569         #  @param theShape Shape to be described.
10570         #  @param theType the given ShapeType().
10571         #  @return Quantity of shapes of type \a theType in \a theShape.
10572         #
10573         #  @ref tui_measurement_tools_page "Example"
10574         def NbShapes (self, theShape, theType):
10575             """
10576             Obtain quantity of shapes of the given type in theShape.
10577             If theShape is of type theType, it is also counted.
10578
10579             Parameters:
10580                 theShape Shape to be described.
10581                 theType the given geompy.ShapeType
10582
10583             Returns:
10584                 Quantity of shapes of type theType in theShape.
10585             """
10586             # Example: see GEOM_TestMeasures.py
10587             listSh = self.SubShapeAllIDs(theShape, theType)
10588             Nb = len(listSh)
10589             return Nb
10590
10591         ## Obtain quantity of shapes of each type in \a theShape.
10592         #  The \a theShape is also counted.
10593         #  @param theShape Shape to be described.
10594         #  @return Dictionary of ShapeType() with bound quantities of shapes.
10595         #
10596         #  @ref tui_measurement_tools_page "Example"
10597         def ShapeInfo (self, theShape):
10598             """
10599             Obtain quantity of shapes of each type in theShape.
10600             The theShape is also counted.
10601
10602             Parameters:
10603                 theShape Shape to be described.
10604
10605             Returns:
10606                 Dictionary of geompy.ShapeType with bound quantities of shapes.
10607             """
10608             # Example: see GEOM_TestMeasures.py
10609             aDict = {}
10610             for typeSh in self.ShapeType:
10611                 if typeSh in ( "AUTO", "SHAPE" ): continue
10612                 listSh = self.SubShapeAllIDs(theShape, self.ShapeType[typeSh])
10613                 Nb = len(listSh)
10614                 aDict[typeSh] = Nb
10615                 pass
10616             return aDict
10617
10618         def GetCreationInformation(self, theShape):
10619             info = theShape.GetCreationInformation()
10620             # operationName
10621             opName = info.operationName
10622             if not opName: opName = "no info available"
10623             res = "Operation: " + opName
10624             # parameters
10625             for parVal in info.params:
10626                 res += " \n %s = %s" % ( parVal.name, parVal.value )
10627             return res
10628
10629         ## Get a point, situated at the centre of mass of theShape.
10630         #  @param theShape Shape to define centre of mass of.
10631         #  @param theName Object name; when specified, this parameter is used
10632         #         for result publication in the study. Otherwise, if automatic
10633         #         publication is switched on, default value is used for result name.
10634         #
10635         #  @return New GEOM.GEOM_Object, containing the created point.
10636         #
10637         #  @ref tui_measurement_tools_page "Example"
10638         @ManageTransactions("MeasuOp")
10639         def MakeCDG(self, theShape, theName=None):
10640             """
10641             Get a point, situated at the centre of mass of theShape.
10642
10643             Parameters:
10644                 theShape Shape to define centre of mass of.
10645                 theName Object name; when specified, this parameter is used
10646                         for result publication in the study. Otherwise, if automatic
10647                         publication is switched on, default value is used for result name.
10648
10649             Returns:
10650                 New GEOM.GEOM_Object, containing the created point.
10651             """
10652             # Example: see GEOM_TestMeasures.py
10653             anObj = self.MeasuOp.GetCentreOfMass(theShape)
10654             RaiseIfFailed("GetCentreOfMass", self.MeasuOp)
10655             self._autoPublish(anObj, theName, "centerOfMass")
10656             return anObj
10657
10658         ## Get a vertex sub-shape by index depended with orientation.
10659         #  @param theShape Shape to find sub-shape.
10660         #  @param theIndex Index to find vertex by this index (starting from zero)
10661         #  @param theName Object name; when specified, this parameter is used
10662         #         for result publication in the study. Otherwise, if automatic
10663         #         publication is switched on, default value is used for result name.
10664         #
10665         #  @return New GEOM.GEOM_Object, containing the created vertex.
10666         #
10667         #  @ref tui_measurement_tools_page "Example"
10668         @ManageTransactions("MeasuOp")
10669         def GetVertexByIndex(self, theShape, theIndex, theName=None):
10670             """
10671             Get a vertex sub-shape by index depended with orientation.
10672
10673             Parameters:
10674                 theShape Shape to find sub-shape.
10675                 theIndex Index to find vertex by this index (starting from zero)
10676                 theName Object name; when specified, this parameter is used
10677                         for result publication in the study. Otherwise, if automatic
10678                         publication is switched on, default value is used for result name.
10679
10680             Returns:
10681                 New GEOM.GEOM_Object, containing the created vertex.
10682             """
10683             # Example: see GEOM_TestMeasures.py
10684             anObj = self.MeasuOp.GetVertexByIndex(theShape, theIndex)
10685             RaiseIfFailed("GetVertexByIndex", self.MeasuOp)
10686             self._autoPublish(anObj, theName, "vertex")
10687             return anObj
10688
10689         ## Get the first vertex of wire/edge depended orientation.
10690         #  @param theShape Shape to find first vertex.
10691         #  @param theName Object name; when specified, this parameter is used
10692         #         for result publication in the study. Otherwise, if automatic
10693         #         publication is switched on, default value is used for result name.
10694         #
10695         #  @return New GEOM.GEOM_Object, containing the created vertex.
10696         #
10697         #  @ref tui_measurement_tools_page "Example"
10698         def GetFirstVertex(self, theShape, theName=None):
10699             """
10700             Get the first vertex of wire/edge depended orientation.
10701
10702             Parameters:
10703                 theShape Shape to find first vertex.
10704                 theName Object name; when specified, this parameter is used
10705                         for result publication in the study. Otherwise, if automatic
10706                         publication is switched on, default value is used for result name.
10707
10708             Returns:
10709                 New GEOM.GEOM_Object, containing the created vertex.
10710             """
10711             # Example: see GEOM_TestMeasures.py
10712             # note: auto-publishing is done in self.GetVertexByIndex()
10713             return self.GetVertexByIndex(theShape, 0, theName)
10714
10715         ## Get the last vertex of wire/edge depended orientation.
10716         #  @param theShape Shape to find last vertex.
10717         #  @param theName Object name; when specified, this parameter is used
10718         #         for result publication in the study. Otherwise, if automatic
10719         #         publication is switched on, default value is used for result name.
10720         #
10721         #  @return New GEOM.GEOM_Object, containing the created vertex.
10722         #
10723         #  @ref tui_measurement_tools_page "Example"
10724         def GetLastVertex(self, theShape, theName=None):
10725             """
10726             Get the last vertex of wire/edge depended orientation.
10727
10728             Parameters:
10729                 theShape Shape to find last vertex.
10730                 theName Object name; when specified, this parameter is used
10731                         for result publication in the study. Otherwise, if automatic
10732                         publication is switched on, default value is used for result name.
10733
10734             Returns:
10735                 New GEOM.GEOM_Object, containing the created vertex.
10736             """
10737             # Example: see GEOM_TestMeasures.py
10738             nb_vert =  self.NumberOfSubShapes(theShape, self.ShapeType["VERTEX"])
10739             # note: auto-publishing is done in self.GetVertexByIndex()
10740             return self.GetVertexByIndex(theShape, (nb_vert-1), theName)
10741
10742         ## Get a normale to the given face. If the point is not given,
10743         #  the normale is calculated at the center of mass.
10744         #  @param theFace Face to define normale of.
10745         #  @param theOptionalPoint Point to compute the normale at.
10746         #  @param theName Object name; when specified, this parameter is used
10747         #         for result publication in the study. Otherwise, if automatic
10748         #         publication is switched on, default value is used for result name.
10749         #
10750         #  @return New GEOM.GEOM_Object, containing the created vector.
10751         #
10752         #  @ref swig_todo "Example"
10753         @ManageTransactions("MeasuOp")
10754         def GetNormal(self, theFace, theOptionalPoint = None, theName=None):
10755             """
10756             Get a normale to the given face. If the point is not given,
10757             the normale is calculated at the center of mass.
10758
10759             Parameters:
10760                 theFace Face to define normale of.
10761                 theOptionalPoint Point to compute the normale at.
10762                 theName Object name; when specified, this parameter is used
10763                         for result publication in the study. Otherwise, if automatic
10764                         publication is switched on, default value is used for result name.
10765
10766             Returns:
10767                 New GEOM.GEOM_Object, containing the created vector.
10768             """
10769             # Example: see GEOM_TestMeasures.py
10770             anObj = self.MeasuOp.GetNormal(theFace, theOptionalPoint)
10771             RaiseIfFailed("GetNormal", self.MeasuOp)
10772             self._autoPublish(anObj, theName, "normal")
10773             return anObj
10774
10775         ## Print shape errors obtained from CheckShape.
10776         #  @param theShape Shape that was checked.
10777         #  @param theShapeErrors the shape errors obtained by CheckShape.
10778         #  @param theReturnStatus If 0 the description of problem is printed.
10779         #                         If 1 the description of problem is returned.
10780         #  @return If theReturnStatus is equal to 1 the description is returned.
10781         #          Otherwise doesn't return anything.
10782         #
10783         #  @ref tui_measurement_tools_page "Example"
10784         @ManageTransactions("MeasuOp")
10785         def PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0):
10786             """
10787             Print shape errors obtained from CheckShape.
10788
10789             Parameters:
10790                 theShape Shape that was checked.
10791                 theShapeErrors the shape errors obtained by CheckShape.
10792                 theReturnStatus If 0 the description of problem is printed.
10793                                 If 1 the description of problem is returned.
10794
10795             Returns:
10796                 If theReturnStatus is equal to 1 the description is returned.
10797                   Otherwise doesn't return anything.
10798             """
10799             # Example: see GEOM_TestMeasures.py
10800             Descr = self.MeasuOp.PrintShapeErrors(theShape, theShapeErrors)
10801             if theReturnStatus == 1:
10802                 return Descr
10803             print Descr
10804             pass
10805
10806         ## Check a topology of the given shape.
10807         #  @param theShape Shape to check validity of.
10808         #  @param theIsCheckGeom If FALSE, only the shape's topology will be checked, \n
10809         #                        if TRUE, the shape's geometry will be checked also.
10810         #  @param theReturnStatus If 0 and if theShape is invalid, a description
10811         #                         of problem is printed.
10812         #                         If 1 isValid flag and the description of
10813         #                         problem is returned.
10814         #                         If 2 isValid flag and the list of error data
10815         #                         is returned.
10816         #  @return TRUE, if the shape "seems to be valid".
10817         #          If theShape is invalid, prints a description of problem.
10818         #          If theReturnStatus is equal to 1 the description is returned
10819         #          along with IsValid flag.
10820         #          If theReturnStatus is equal to 2 the list of error data is
10821         #          returned along with IsValid flag.
10822         #
10823         #  @ref tui_measurement_tools_page "Example"
10824         @ManageTransactions("MeasuOp")
10825         def CheckShape(self,theShape, theIsCheckGeom = 0, theReturnStatus = 0):
10826             """
10827             Check a topology of the given shape.
10828
10829             Parameters:
10830                 theShape Shape to check validity of.
10831                 theIsCheckGeom If FALSE, only the shape's topology will be checked,
10832                                if TRUE, the shape's geometry will be checked also.
10833                 theReturnStatus If 0 and if theShape is invalid, a description
10834                                 of problem is printed.
10835                                 If 1 IsValid flag and the description of
10836                                 problem is returned.
10837                                 If 2 IsValid flag and the list of error data
10838                                 is returned.
10839
10840             Returns:
10841                 TRUE, if the shape "seems to be valid".
10842                 If theShape is invalid, prints a description of problem.
10843                 If theReturnStatus is equal to 1 the description is returned
10844                 along with IsValid flag.
10845                 If theReturnStatus is equal to 2 the list of error data is
10846                 returned along with IsValid flag.
10847             """
10848             # Example: see GEOM_TestMeasures.py
10849             if theIsCheckGeom:
10850                 (IsValid, ShapeErrors) = self.MeasuOp.CheckShapeWithGeometry(theShape)
10851                 RaiseIfFailed("CheckShapeWithGeometry", self.MeasuOp)
10852             else:
10853                 (IsValid, ShapeErrors) = self.MeasuOp.CheckShape(theShape)
10854                 RaiseIfFailed("CheckShape", self.MeasuOp)
10855             if IsValid == 0:
10856                 if theReturnStatus == 0:
10857                     Descr = self.MeasuOp.PrintShapeErrors(theShape, ShapeErrors)
10858                     print Descr
10859             if theReturnStatus == 1:
10860               Descr = self.MeasuOp.PrintShapeErrors(theShape, ShapeErrors)
10861               return (IsValid, Descr)
10862             elif theReturnStatus == 2:
10863               return (IsValid, ShapeErrors)
10864             return IsValid
10865
10866         ## Detect self-intersections in the given shape.
10867         #  @param theShape Shape to check.
10868         #  @param theCheckLevel is the level of self-intersection check.
10869         #         Possible input values are:
10870         #         - GEOM.SI_V_V(0) - only V/V interferences
10871         #         - GEOM.SI_V_E(1) - V/V and V/E interferences
10872         #         - GEOM.SI_E_E(2) - V/V, V/E and E/E interferences
10873         #         - GEOM.SI_V_F(3) - V/V, V/E, E/E and V/F interferences
10874         #         - GEOM.SI_E_F(4) - V/V, V/E, E/E, V/F and E/F interferences
10875         #         - GEOM.SI_ALL(5) - all interferences.
10876         #  @return TRUE, if the shape contains no self-intersections.
10877         #
10878         #  @ref tui_measurement_tools_page "Example"
10879         @ManageTransactions("MeasuOp")
10880         def CheckSelfIntersections(self, theShape, theCheckLevel = GEOM.SI_ALL):
10881             """
10882             Detect self-intersections in the given shape.
10883
10884             Parameters:
10885                 theShape Shape to check.
10886                 theCheckLevel is the level of self-intersection check.
10887                   Possible input values are:
10888                    - GEOM.SI_V_V(0) - only V/V interferences
10889                    - GEOM.SI_V_E(1) - V/V and V/E interferences
10890                    - GEOM.SI_E_E(2) - V/V, V/E and E/E interferences
10891                    - GEOM.SI_V_F(3) - V/V, V/E, E/E and V/F interferences
10892                    - GEOM.SI_E_F(4) - V/V, V/E, E/E, V/F and E/F interferences
10893                    - GEOM.SI_ALL(5) - all interferences.
10894  
10895             Returns:
10896                 TRUE, if the shape contains no self-intersections.
10897             """
10898             # Example: see GEOM_TestMeasures.py
10899             (IsValid, Pairs) = self.MeasuOp.CheckSelfIntersections(theShape, EnumToLong(theCheckLevel))
10900             RaiseIfFailed("CheckSelfIntersections", self.MeasuOp)
10901             return IsValid
10902
10903         ## Get position (LCS) of theShape.
10904         #
10905         #  Origin of the LCS is situated at the shape's center of mass.
10906         #  Axes of the LCS are obtained from shape's location or,
10907         #  if the shape is a planar face, from position of its plane.
10908         #
10909         #  @param theShape Shape to calculate position of.
10910         #  @return [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
10911         #          Ox,Oy,Oz: Coordinates of shape's LCS origin.
10912         #          Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
10913         #          Xx,Xy,Xz: Coordinates of shape's LCS X direction.
10914         #
10915         #  @ref swig_todo "Example"
10916         @ManageTransactions("MeasuOp")
10917         def GetPosition(self,theShape):
10918             """
10919             Get position (LCS) of theShape.
10920             Origin of the LCS is situated at the shape's center of mass.
10921             Axes of the LCS are obtained from shape's location or,
10922             if the shape is a planar face, from position of its plane.
10923
10924             Parameters:
10925                 theShape Shape to calculate position of.
10926
10927             Returns:
10928                 [Ox,Oy,Oz, Zx,Zy,Zz, Xx,Xy,Xz].
10929                  Ox,Oy,Oz: Coordinates of shape's LCS origin.
10930                  Zx,Zy,Zz: Coordinates of shape's LCS normal(main) direction.
10931                  Xx,Xy,Xz: Coordinates of shape's LCS X direction.
10932             """
10933             # Example: see GEOM_TestMeasures.py
10934             aTuple = self.MeasuOp.GetPosition(theShape)
10935             RaiseIfFailed("GetPosition", self.MeasuOp)
10936             return aTuple
10937
10938         ## Get kind of theShape.
10939         #
10940         #  @param theShape Shape to get a kind of.
10941         #  @return Returns a kind of shape in terms of <VAR>GEOM.GEOM_IKindOfShape.shape_kind</VAR> enumeration
10942         #          and a list of parameters, describing the shape.
10943         #  @note  Concrete meaning of each value, returned via \a theIntegers
10944         #         or \a theDoubles list depends on the kind() of the shape.
10945         #
10946         #  @ref swig_todo "Example"
10947         @ManageTransactions("MeasuOp")
10948         def KindOfShape(self,theShape):
10949             """
10950             Get kind of theShape.
10951
10952             Parameters:
10953                 theShape Shape to get a kind of.
10954
10955             Returns:
10956                 a kind of shape in terms of GEOM_IKindOfShape.shape_kind enumeration
10957                     and a list of parameters, describing the shape.
10958             Note:
10959                 Concrete meaning of each value, returned via theIntegers
10960                 or theDoubles list depends on the geompy.kind of the shape
10961             """
10962             # Example: see GEOM_TestMeasures.py
10963             aRoughTuple = self.MeasuOp.KindOfShape(theShape)
10964             RaiseIfFailed("KindOfShape", self.MeasuOp)
10965
10966             aKind  = aRoughTuple[0]
10967             anInts = aRoughTuple[1]
10968             aDbls  = aRoughTuple[2]
10969
10970             # Now there is no exception from this rule:
10971             aKindTuple = [aKind] + aDbls + anInts
10972
10973             # If they are we will regroup parameters for such kind of shape.
10974             # For example:
10975             #if aKind == kind.SOME_KIND:
10976             #    #  SOME_KIND     int int double int double double
10977             #    aKindTuple = [aKind, anInts[0], anInts[1], aDbls[0], anInts[2], aDbls[1], aDbls[2]]
10978
10979             return aKindTuple
10980
10981         ## Returns the string that describes if the shell is good for solid.
10982         #  This is a support method for MakeSolid.
10983         #
10984         #  @param theShell the shell to be checked.
10985         #  @return Returns a string that describes the shell validity for
10986         #          solid construction.
10987         @ManageTransactions("MeasuOp")
10988         def _IsGoodForSolid(self, theShell):
10989             """
10990             Returns the string that describes if the shell is good for solid.
10991             This is a support method for MakeSolid.
10992
10993             Parameter:
10994                 theShell the shell to be checked.
10995
10996             Returns:
10997                 Returns a string that describes the shell validity for
10998                 solid construction.
10999             """
11000             aDescr = self.MeasuOp.IsGoodForSolid(theShell)
11001             return aDescr
11002
11003         # end of l2_measure
11004         ## @}
11005
11006         ## @addtogroup l2_import_export
11007         ## @{
11008
11009         ## Import a shape from the BREP, IGES, STEP or other file
11010         #  (depends on given format) with given name.
11011         #
11012         #  Note: this function is deprecated, it is kept for backward compatibility only
11013         #  Use Import<FormatName> instead, where <FormatName> is a name of desirable format to import.
11014         #
11015         #  @param theFileName The file, containing the shape.
11016         #  @param theFormatName Specify format for the file reading.
11017         #         Available formats can be obtained with InsertOp.ImportTranslators() method.
11018         #         If format 'IGES_SCALE' is used instead of 'IGES' or
11019         #            format 'STEP_SCALE' is used instead of 'STEP',
11020         #            length unit will be set to 'meter' and result model will be scaled.
11021         #  @param theName Object name; when specified, this parameter is used
11022         #         for result publication in the study. Otherwise, if automatic
11023         #         publication is switched on, default value is used for result name.
11024         #
11025         #  @return New GEOM.GEOM_Object, containing the imported shape.
11026         #          If material names are imported it returns the list of
11027         #          objects. The first one is the imported object followed by
11028         #          material groups.
11029         #  @note Auto publishing is allowed for the shape itself. Imported
11030         #        material groups are not automatically published.
11031         #
11032         #  @ref swig_Import_Export "Example"
11033         @ManageTransactions("InsertOp")
11034         def ImportFile(self, theFileName, theFormatName, theName=None):
11035             """
11036             Import a shape from the BREP, IGES, STEP or other file
11037             (depends on given format) with given name.
11038
11039             Note: this function is deprecated, it is kept for backward compatibility only
11040             Use Import<FormatName> instead, where <FormatName> is a name of desirable format to import.
11041
11042             Parameters: 
11043                 theFileName The file, containing the shape.
11044                 theFormatName Specify format for the file reading.
11045                     Available formats can be obtained with geompy.InsertOp.ImportTranslators() method.
11046                     If format 'IGES_SCALE' is used instead of 'IGES' or
11047                        format 'STEP_SCALE' is used instead of 'STEP',
11048                        length unit will be set to 'meter' and result model will be scaled.
11049                 theName Object name; when specified, this parameter is used
11050                         for result publication in the study. Otherwise, if automatic
11051                         publication is switched on, default value is used for result name.
11052
11053             Returns:
11054                 New GEOM.GEOM_Object, containing the imported shape.
11055                 If material names are imported it returns the list of
11056                 objects. The first one is the imported object followed by
11057                 material groups.
11058             Note:
11059                 Auto publishing is allowed for the shape itself. Imported
11060                 material groups are not automatically published.
11061             """
11062             # Example: see GEOM_TestOthers.py
11063             print """
11064             WARNING: Function ImportFile is deprecated, use Import<FormatName> instead,
11065             where <FormatName> is a name of desirable format for importing.
11066             """
11067             aListObj = self.InsertOp.ImportFile(theFileName, theFormatName)
11068             RaiseIfFailed("ImportFile", self.InsertOp)
11069             aNbObj = len(aListObj)
11070             if aNbObj > 0:
11071                 self._autoPublish(aListObj[0], theName, "imported")
11072             if aNbObj == 1:
11073                 return aListObj[0]
11074             return aListObj
11075
11076         ## Deprecated analog of ImportFile()
11077         def Import(self, theFileName, theFormatName, theName=None):
11078             """
11079             Deprecated analog of geompy.ImportFile, kept for backward compatibility only.
11080             """
11081             # note: auto-publishing is done in self.ImportFile()
11082             return self.ImportFile(theFileName, theFormatName, theName)
11083
11084         ## Read a shape from the binary stream, containing its bounding representation (BRep).
11085         #  @note This method will not be dumped to the python script by DumpStudy functionality.
11086         #  @note GEOM.GEOM_Object.GetShapeStream() method can be used to obtain the shape's BRep stream.
11087         #  @param theStream The BRep binary stream.
11088         #  @param theName Object name; when specified, this parameter is used
11089         #         for result publication in the study. Otherwise, if automatic
11090         #         publication is switched on, default value is used for result name.
11091         #
11092         #  @return New GEOM_Object, containing the shape, read from theStream.
11093         #
11094         #  @ref swig_Import_Export "Example"
11095         @ManageTransactions("InsertOp")
11096         def RestoreShape (self, theStream, theName=None):
11097             """
11098             Read a shape from the binary stream, containing its bounding representation (BRep).
11099
11100             Note:
11101                 shape.GetShapeStream() method can be used to obtain the shape's BRep stream.
11102
11103             Parameters:
11104                 theStream The BRep binary stream.
11105                 theName Object name; when specified, this parameter is used
11106                         for result publication in the study. Otherwise, if automatic
11107                         publication is switched on, default value is used for result name.
11108
11109             Returns:
11110                 New GEOM_Object, containing the shape, read from theStream.
11111             """
11112             # Example: see GEOM_TestOthers.py
11113             anObj = self.InsertOp.RestoreShape(theStream)
11114             RaiseIfFailed("RestoreShape", self.InsertOp)
11115             self._autoPublish(anObj, theName, "restored")
11116             return anObj
11117
11118         ## Export the given shape into a file with given name.
11119         #
11120         #  Note: this function is deprecated, it is kept for backward compatibility only
11121         #  Use Export<FormatName> instead, where <FormatName> is a name of desirable format to export.
11122         #
11123         #  @param theObject Shape to be stored in the file.
11124         #  @param theFileName Name of the file to store the given shape in.
11125         #  @param theFormatName Specify format for the shape storage.
11126         #         Available formats can be obtained with
11127         #         geompy.InsertOp.ExportTranslators()[0] method.
11128         #
11129         #  @ref swig_Import_Export "Example"
11130         @ManageTransactions("InsertOp")
11131         def Export(self, theObject, theFileName, theFormatName):
11132             """
11133             Export the given shape into a file with given name.
11134
11135             Note: this function is deprecated, it is kept for backward compatibility only
11136             Use Export<FormatName> instead, where <FormatName> is a name of desirable format to export.
11137             
11138             Parameters: 
11139                 theObject Shape to be stored in the file.
11140                 theFileName Name of the file to store the given shape in.
11141                 theFormatName Specify format for the shape storage.
11142                               Available formats can be obtained with
11143                               geompy.InsertOp.ExportTranslators()[0] method.
11144             """
11145             # Example: see GEOM_TestOthers.py
11146             print """
11147             WARNING: Function Export is deprecated, use Export<FormatName> instead,
11148             where <FormatName> is a name of desirable format for exporting.
11149             """
11150             self.InsertOp.Export(theObject, theFileName, theFormatName)
11151             if self.InsertOp.IsDone() == 0:
11152                 raise RuntimeError,  "Export : " + self.InsertOp.GetErrorCode()
11153                 pass
11154             pass
11155
11156         # end of l2_import_export
11157         ## @}
11158
11159         ## @addtogroup l3_blocks
11160         ## @{
11161
11162         ## Create a quadrangle face from four edges. Order of Edges is not
11163         #  important. It is  not necessary that edges share the same vertex.
11164         #  @param E1,E2,E3,E4 Edges for the face bound.
11165         #  @param theName Object name; when specified, this parameter is used
11166         #         for result publication in the study. Otherwise, if automatic
11167         #         publication is switched on, default value is used for result name.
11168         #
11169         #  @return New GEOM.GEOM_Object, containing the created face.
11170         #
11171         #  @ref tui_building_by_blocks_page "Example"
11172         @ManageTransactions("BlocksOp")
11173         def MakeQuad(self, E1, E2, E3, E4, theName=None):
11174             """
11175             Create a quadrangle face from four edges. Order of Edges is not
11176             important. It is  not necessary that edges share the same vertex.
11177
11178             Parameters:
11179                 E1,E2,E3,E4 Edges for the face bound.
11180                 theName Object name; when specified, this parameter is used
11181                         for result publication in the study. Otherwise, if automatic
11182                         publication is switched on, default value is used for result name.
11183
11184             Returns:
11185                 New GEOM.GEOM_Object, containing the created face.
11186
11187             Example of usage:
11188                 qface1 = geompy.MakeQuad(edge1, edge2, edge3, edge4)
11189             """
11190             # Example: see GEOM_Spanner.py
11191             anObj = self.BlocksOp.MakeQuad(E1, E2, E3, E4)
11192             RaiseIfFailed("MakeQuad", self.BlocksOp)
11193             self._autoPublish(anObj, theName, "quad")
11194             return anObj
11195
11196         ## Create a quadrangle face on two edges.
11197         #  The missing edges will be built by creating the shortest ones.
11198         #  @param E1,E2 Two opposite edges for the face.
11199         #  @param theName Object name; when specified, this parameter is used
11200         #         for result publication in the study. Otherwise, if automatic
11201         #         publication is switched on, default value is used for result name.
11202         #
11203         #  @return New GEOM.GEOM_Object, containing the created face.
11204         #
11205         #  @ref tui_building_by_blocks_page "Example"
11206         @ManageTransactions("BlocksOp")
11207         def MakeQuad2Edges(self, E1, E2, theName=None):
11208             """
11209             Create a quadrangle face on two edges.
11210             The missing edges will be built by creating the shortest ones.
11211
11212             Parameters:
11213                 E1,E2 Two opposite edges for the face.
11214                 theName Object name; when specified, this parameter is used
11215                         for result publication in the study. Otherwise, if automatic
11216                         publication is switched on, default value is used for result name.
11217
11218             Returns:
11219                 New GEOM.GEOM_Object, containing the created face.
11220
11221             Example of usage:
11222                 # create vertices
11223                 p1 = geompy.MakeVertex(  0.,   0.,   0.)
11224                 p2 = geompy.MakeVertex(150.,  30.,   0.)
11225                 p3 = geompy.MakeVertex(  0., 120.,  50.)
11226                 p4 = geompy.MakeVertex(  0.,  40.,  70.)
11227                 # create edges
11228                 edge1 = geompy.MakeEdge(p1, p2)
11229                 edge2 = geompy.MakeEdge(p3, p4)
11230                 # create a quadrangle face from two edges
11231                 qface2 = geompy.MakeQuad2Edges(edge1, edge2)
11232             """
11233             # Example: see GEOM_Spanner.py
11234             anObj = self.BlocksOp.MakeQuad2Edges(E1, E2)
11235             RaiseIfFailed("MakeQuad2Edges", self.BlocksOp)
11236             self._autoPublish(anObj, theName, "quad")
11237             return anObj
11238
11239         ## Create a quadrangle face with specified corners.
11240         #  The missing edges will be built by creating the shortest ones.
11241         #  @param V1,V2,V3,V4 Corner vertices for the face.
11242         #  @param theName Object name; when specified, this parameter is used
11243         #         for result publication in the study. Otherwise, if automatic
11244         #         publication is switched on, default value is used for result name.
11245         #
11246         #  @return New GEOM.GEOM_Object, containing the created face.
11247         #
11248         #  @ref tui_building_by_blocks_page "Example 1"
11249         #  \n @ref swig_MakeQuad4Vertices "Example 2"
11250         @ManageTransactions("BlocksOp")
11251         def MakeQuad4Vertices(self, V1, V2, V3, V4, theName=None):
11252             """
11253             Create a quadrangle face with specified corners.
11254             The missing edges will be built by creating the shortest ones.
11255
11256             Parameters:
11257                 V1,V2,V3,V4 Corner vertices for the face.
11258                 theName Object name; when specified, this parameter is used
11259                         for result publication in the study. Otherwise, if automatic
11260                         publication is switched on, default value is used for result name.
11261
11262             Returns:
11263                 New GEOM.GEOM_Object, containing the created face.
11264
11265             Example of usage:
11266                 # create vertices
11267                 p1 = geompy.MakeVertex(  0.,   0.,   0.)
11268                 p2 = geompy.MakeVertex(150.,  30.,   0.)
11269                 p3 = geompy.MakeVertex(  0., 120.,  50.)
11270                 p4 = geompy.MakeVertex(  0.,  40.,  70.)
11271                 # create a quadrangle from four points in its corners
11272                 qface3 = geompy.MakeQuad4Vertices(p1, p2, p3, p4)
11273             """
11274             # Example: see GEOM_Spanner.py
11275             anObj = self.BlocksOp.MakeQuad4Vertices(V1, V2, V3, V4)
11276             RaiseIfFailed("MakeQuad4Vertices", self.BlocksOp)
11277             self._autoPublish(anObj, theName, "quad")
11278             return anObj
11279
11280         ## Create a hexahedral solid, bounded by the six given faces. Order of
11281         #  faces is not important. It is  not necessary that Faces share the same edge.
11282         #  @param F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
11283         #  @param theName Object name; when specified, this parameter is used
11284         #         for result publication in the study. Otherwise, if automatic
11285         #         publication is switched on, default value is used for result name.
11286         #
11287         #  @return New GEOM.GEOM_Object, containing the created solid.
11288         #
11289         #  @ref tui_building_by_blocks_page "Example 1"
11290         #  \n @ref swig_MakeHexa "Example 2"
11291         @ManageTransactions("BlocksOp")
11292         def MakeHexa(self, F1, F2, F3, F4, F5, F6, theName=None):
11293             """
11294             Create a hexahedral solid, bounded by the six given faces. Order of
11295             faces is not important. It is  not necessary that Faces share the same edge.
11296
11297             Parameters:
11298                 F1,F2,F3,F4,F5,F6 Faces for the hexahedral solid.
11299                 theName Object name; when specified, this parameter is used
11300                         for result publication in the study. Otherwise, if automatic
11301                         publication is switched on, default value is used for result name.
11302
11303             Returns:
11304                 New GEOM.GEOM_Object, containing the created solid.
11305
11306             Example of usage:
11307                 solid = geompy.MakeHexa(qface1, qface2, qface3, qface4, qface5, qface6)
11308             """
11309             # Example: see GEOM_Spanner.py
11310             anObj = self.BlocksOp.MakeHexa(F1, F2, F3, F4, F5, F6)
11311             RaiseIfFailed("MakeHexa", self.BlocksOp)
11312             self._autoPublish(anObj, theName, "hexa")
11313             return anObj
11314
11315         ## Create a hexahedral solid between two given faces.
11316         #  The missing faces will be built by creating the smallest ones.
11317         #  @param F1,F2 Two opposite faces for the hexahedral solid.
11318         #  @param theName Object name; when specified, this parameter is used
11319         #         for result publication in the study. Otherwise, if automatic
11320         #         publication is switched on, default value is used for result name.
11321         #
11322         #  @return New GEOM.GEOM_Object, containing the created solid.
11323         #
11324         #  @ref tui_building_by_blocks_page "Example 1"
11325         #  \n @ref swig_MakeHexa2Faces "Example 2"
11326         @ManageTransactions("BlocksOp")
11327         def MakeHexa2Faces(self, F1, F2, theName=None):
11328             """
11329             Create a hexahedral solid between two given faces.
11330             The missing faces will be built by creating the smallest ones.
11331
11332             Parameters:
11333                 F1,F2 Two opposite faces for the hexahedral solid.
11334                 theName Object name; when specified, this parameter is used
11335                         for result publication in the study. Otherwise, if automatic
11336                         publication is switched on, default value is used for result name.
11337
11338             Returns:
11339                 New GEOM.GEOM_Object, containing the created solid.
11340
11341             Example of usage:
11342                 solid1 = geompy.MakeHexa2Faces(qface1, qface2)
11343             """
11344             # Example: see GEOM_Spanner.py
11345             anObj = self.BlocksOp.MakeHexa2Faces(F1, F2)
11346             RaiseIfFailed("MakeHexa2Faces", self.BlocksOp)
11347             self._autoPublish(anObj, theName, "hexa")
11348             return anObj
11349
11350         # end of l3_blocks
11351         ## @}
11352
11353         ## @addtogroup l3_blocks_op
11354         ## @{
11355
11356         ## Get a vertex, found in the given shape by its coordinates.
11357         #  @param theShape Block or a compound of blocks.
11358         #  @param theX,theY,theZ Coordinates of the sought vertex.
11359         #  @param theEpsilon Maximum allowed distance between the resulting
11360         #                    vertex and point with the given coordinates.
11361         #  @param theName Object name; when specified, this parameter is used
11362         #         for result publication in the study. Otherwise, if automatic
11363         #         publication is switched on, default value is used for result name.
11364         #
11365         #  @return New GEOM.GEOM_Object, containing the found vertex.
11366         #
11367         #  @ref swig_GetPoint "Example"
11368         @ManageTransactions("BlocksOp")
11369         def GetPoint(self, theShape, theX, theY, theZ, theEpsilon, theName=None):
11370             """
11371             Get a vertex, found in the given shape by its coordinates.
11372
11373             Parameters:
11374                 theShape Block or a compound of blocks.
11375                 theX,theY,theZ Coordinates of the sought vertex.
11376                 theEpsilon Maximum allowed distance between the resulting
11377                            vertex and point with the given coordinates.
11378                 theName Object name; when specified, this parameter is used
11379                         for result publication in the study. Otherwise, if automatic
11380                         publication is switched on, default value is used for result name.
11381
11382             Returns:
11383                 New GEOM.GEOM_Object, containing the found vertex.
11384
11385             Example of usage:
11386                 pnt = geompy.GetPoint(shape, -50,  50,  50, 0.01)
11387             """
11388             # Example: see GEOM_TestOthers.py
11389             anObj = self.BlocksOp.GetPoint(theShape, theX, theY, theZ, theEpsilon)
11390             RaiseIfFailed("GetPoint", self.BlocksOp)
11391             self._autoPublish(anObj, theName, "vertex")
11392             return anObj
11393
11394         ## Find a vertex of the given shape, which has minimal distance to the given point.
11395         #  @param theShape Any shape.
11396         #  @param thePoint Point, close to the desired vertex.
11397         #  @param theName Object name; when specified, this parameter is used
11398         #         for result publication in the study. Otherwise, if automatic
11399         #         publication is switched on, default value is used for result name.
11400         #
11401         #  @return New GEOM.GEOM_Object, containing the found vertex.
11402         #
11403         #  @ref swig_GetVertexNearPoint "Example"
11404         @ManageTransactions("BlocksOp")
11405         def GetVertexNearPoint(self, theShape, thePoint, theName=None):
11406             """
11407             Find a vertex of the given shape, which has minimal distance to the given point.
11408
11409             Parameters:
11410                 theShape Any shape.
11411                 thePoint Point, close to the desired vertex.
11412                 theName Object name; when specified, this parameter is used
11413                         for result publication in the study. Otherwise, if automatic
11414                         publication is switched on, default value is used for result name.
11415
11416             Returns:
11417                 New GEOM.GEOM_Object, containing the found vertex.
11418
11419             Example of usage:
11420                 pmidle = geompy.MakeVertex(50, 0, 50)
11421                 edge1 = geompy.GetEdgeNearPoint(blocksComp, pmidle)
11422             """
11423             # Example: see GEOM_TestOthers.py
11424             anObj = self.BlocksOp.GetVertexNearPoint(theShape, thePoint)
11425             RaiseIfFailed("GetVertexNearPoint", self.BlocksOp)
11426             self._autoPublish(anObj, theName, "vertex")
11427             return anObj
11428
11429         ## Get an edge, found in the given shape by two given vertices.
11430         #  @param theShape Block or a compound of blocks.
11431         #  @param thePoint1,thePoint2 Points, close to the ends of the desired edge.
11432         #  @param theName Object name; when specified, this parameter is used
11433         #         for result publication in the study. Otherwise, if automatic
11434         #         publication is switched on, default value is used for result name.
11435         #
11436         #  @return New GEOM.GEOM_Object, containing the found edge.
11437         #
11438         #  @ref swig_GetEdge "Example"
11439         @ManageTransactions("BlocksOp")
11440         def GetEdge(self, theShape, thePoint1, thePoint2, theName=None):
11441             """
11442             Get an edge, found in the given shape by two given vertices.
11443
11444             Parameters:
11445                 theShape Block or a compound of blocks.
11446                 thePoint1,thePoint2 Points, close to the ends of the desired edge.
11447                 theName Object name; when specified, this parameter is used
11448                         for result publication in the study. Otherwise, if automatic
11449                         publication is switched on, default value is used for result name.
11450
11451             Returns:
11452                 New GEOM.GEOM_Object, containing the found edge.
11453             """
11454             # Example: see GEOM_Spanner.py
11455             anObj = self.BlocksOp.GetEdge(theShape, thePoint1, thePoint2)
11456             RaiseIfFailed("GetEdge", self.BlocksOp)
11457             self._autoPublish(anObj, theName, "edge")
11458             return anObj
11459
11460         ## Find an edge of the given shape, which has minimal distance to the given point.
11461         #  @param theShape Block or a compound of blocks.
11462         #  @param thePoint Point, close to the desired edge.
11463         #  @param theName Object name; when specified, this parameter is used
11464         #         for result publication in the study. Otherwise, if automatic
11465         #         publication is switched on, default value is used for result name.
11466         #
11467         #  @return New GEOM.GEOM_Object, containing the found edge.
11468         #
11469         #  @ref swig_GetEdgeNearPoint "Example"
11470         @ManageTransactions("BlocksOp")
11471         def GetEdgeNearPoint(self, theShape, thePoint, theName=None):
11472             """
11473             Find an edge of the given shape, which has minimal distance to the given point.
11474
11475             Parameters:
11476                 theShape Block or a compound of blocks.
11477                 thePoint Point, close to the desired edge.
11478                 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             Returns:
11483                 New GEOM.GEOM_Object, containing the found edge.
11484             """
11485             # Example: see GEOM_TestOthers.py
11486             anObj = self.BlocksOp.GetEdgeNearPoint(theShape, thePoint)
11487             RaiseIfFailed("GetEdgeNearPoint", self.BlocksOp)
11488             self._autoPublish(anObj, theName, "edge")
11489             return anObj
11490
11491         ## Returns a face, found in the given shape by four given corner vertices.
11492         #  @param theShape Block or a compound of blocks.
11493         #  @param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
11494         #  @param theName Object name; when specified, this parameter is used
11495         #         for result publication in the study. Otherwise, if automatic
11496         #         publication is switched on, default value is used for result name.
11497         #
11498         #  @return New GEOM.GEOM_Object, containing the found face.
11499         #
11500         #  @ref swig_todo "Example"
11501         @ManageTransactions("BlocksOp")
11502         def GetFaceByPoints(self, theShape, thePoint1, thePoint2, thePoint3, thePoint4, theName=None):
11503             """
11504             Returns a face, found in the given shape by four given corner vertices.
11505
11506             Parameters:
11507                 theShape Block or a compound of blocks.
11508                 thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
11509                 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             Returns:
11514                 New GEOM.GEOM_Object, containing the found face.
11515             """
11516             # Example: see GEOM_Spanner.py
11517             anObj = self.BlocksOp.GetFaceByPoints(theShape, thePoint1, thePoint2, thePoint3, thePoint4)
11518             RaiseIfFailed("GetFaceByPoints", self.BlocksOp)
11519             self._autoPublish(anObj, theName, "face")
11520             return anObj
11521
11522         ## Get a face of block, found in the given shape by two given edges.
11523         #  @param theShape Block or a compound of blocks.
11524         #  @param theEdge1,theEdge2 Edges, close to the edges of the desired face.
11525         #  @param theName Object name; when specified, this parameter is used
11526         #         for result publication in the study. Otherwise, if automatic
11527         #         publication is switched on, default value is used for result name.
11528         #
11529         #  @return New GEOM.GEOM_Object, containing the found face.
11530         #
11531         #  @ref swig_todo "Example"
11532         @ManageTransactions("BlocksOp")
11533         def GetFaceByEdges(self, theShape, theEdge1, theEdge2, theName=None):
11534             """
11535             Get a face of block, found in the given shape by two given edges.
11536
11537             Parameters:
11538                 theShape Block or a compound of blocks.
11539                 theEdge1,theEdge2 Edges, close to the edges of the desired face.
11540                 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             Returns:
11545                 New GEOM.GEOM_Object, containing the found face.
11546             """
11547             # Example: see GEOM_Spanner.py
11548             anObj = self.BlocksOp.GetFaceByEdges(theShape, theEdge1, theEdge2)
11549             RaiseIfFailed("GetFaceByEdges", self.BlocksOp)
11550             self._autoPublish(anObj, theName, "face")
11551             return anObj
11552
11553         ## Find a face, opposite to the given one in the given block.
11554         #  @param theBlock Must be a hexahedral solid.
11555         #  @param theFace Face of \a theBlock, opposite to the desired face.
11556         #  @param theName Object name; when specified, this parameter is used
11557         #         for result publication in the study. Otherwise, if automatic
11558         #         publication is switched on, default value is used for result name.
11559         #
11560         #  @return New GEOM.GEOM_Object, containing the found face.
11561         #
11562         #  @ref swig_GetOppositeFace "Example"
11563         @ManageTransactions("BlocksOp")
11564         def GetOppositeFace(self, theBlock, theFace, theName=None):
11565             """
11566             Find a face, opposite to the given one in the given block.
11567
11568             Parameters:
11569                 theBlock Must be a hexahedral solid.
11570                 theFace Face of theBlock, opposite to the desired face.
11571                 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             Returns:
11576                 New GEOM.GEOM_Object, containing the found face.
11577             """
11578             # Example: see GEOM_Spanner.py
11579             anObj = self.BlocksOp.GetOppositeFace(theBlock, theFace)
11580             RaiseIfFailed("GetOppositeFace", self.BlocksOp)
11581             self._autoPublish(anObj, theName, "face")
11582             return anObj
11583
11584         ## Find a face of the given shape, which has minimal distance to the given point.
11585         #  @param theShape Block or a compound of blocks.
11586         #  @param thePoint Point, close to the desired face.
11587         #  @param theName Object name; when specified, this parameter is used
11588         #         for result publication in the study. Otherwise, if automatic
11589         #         publication is switched on, default value is used for result name.
11590         #
11591         #  @return New GEOM.GEOM_Object, containing the found face.
11592         #
11593         #  @ref swig_GetFaceNearPoint "Example"
11594         @ManageTransactions("BlocksOp")
11595         def GetFaceNearPoint(self, theShape, thePoint, theName=None):
11596             """
11597             Find a face of the given shape, which has minimal distance to the given point.
11598
11599             Parameters:
11600                 theShape Block or a compound of blocks.
11601                 thePoint Point, close to the desired face.
11602                 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             Returns:
11607                 New GEOM.GEOM_Object, containing the found face.
11608             """
11609             # Example: see GEOM_Spanner.py
11610             anObj = self.BlocksOp.GetFaceNearPoint(theShape, thePoint)
11611             RaiseIfFailed("GetFaceNearPoint", self.BlocksOp)
11612             self._autoPublish(anObj, theName, "face")
11613             return anObj
11614
11615         ## Find a face of block, whose outside normale has minimal angle with the given vector.
11616         #  @param theBlock Block or a compound of blocks.
11617         #  @param theVector Vector, close to the normale of the desired face.
11618         #  @param theName Object name; when specified, this parameter is used
11619         #         for result publication in the study. Otherwise, if automatic
11620         #         publication is switched on, default value is used for result name.
11621         #
11622         #  @return New GEOM.GEOM_Object, containing the found face.
11623         #
11624         #  @ref swig_todo "Example"
11625         @ManageTransactions("BlocksOp")
11626         def GetFaceByNormale(self, theBlock, theVector, theName=None):
11627             """
11628             Find a face of block, whose outside normale has minimal angle with the given vector.
11629
11630             Parameters:
11631                 theBlock Block or a compound of blocks.
11632                 theVector Vector, close to the normale of the desired face.
11633                 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             Returns:
11638                 New GEOM.GEOM_Object, containing the found face.
11639             """
11640             # Example: see GEOM_Spanner.py
11641             anObj = self.BlocksOp.GetFaceByNormale(theBlock, theVector)
11642             RaiseIfFailed("GetFaceByNormale", self.BlocksOp)
11643             self._autoPublish(anObj, theName, "face")
11644             return anObj
11645
11646         ## Find all sub-shapes of type \a theShapeType of the given shape,
11647         #  which have minimal distance to the given point.
11648         #  @param theShape Any shape.
11649         #  @param thePoint Point, close to the desired shape.
11650         #  @param theShapeType Defines what kind of sub-shapes is searched GEOM::shape_type
11651         #  @param theTolerance The tolerance for distances comparison. All shapes
11652         #                      with distances to the given point in interval
11653         #                      [minimal_distance, minimal_distance + theTolerance] will be gathered.
11654         #  @param theName Object name; when specified, this parameter is used
11655         #         for result publication in the study. Otherwise, if automatic
11656         #         publication is switched on, default value is used for result name.
11657         #
11658         #  @return New GEOM_Object, containing a group of all found shapes.
11659         #
11660         #  @ref swig_GetShapesNearPoint "Example"
11661         @ManageTransactions("BlocksOp")
11662         def GetShapesNearPoint(self, theShape, thePoint, theShapeType, theTolerance = 1e-07, theName=None):
11663             """
11664             Find all sub-shapes of type theShapeType of the given shape,
11665             which have minimal distance to the given point.
11666
11667             Parameters:
11668                 theShape Any shape.
11669                 thePoint Point, close to the desired shape.
11670                 theShapeType Defines what kind of sub-shapes is searched (see GEOM::shape_type)
11671                 theTolerance The tolerance for distances comparison. All shapes
11672                                 with distances to the given point in interval
11673                                 [minimal_distance, minimal_distance + theTolerance] will be gathered.
11674                 theName Object name; when specified, this parameter is used
11675                         for result publication in the study. Otherwise, if automatic
11676                         publication is switched on, default value is used for result name.
11677
11678             Returns:
11679                 New GEOM_Object, containing a group of all found shapes.
11680             """
11681             # Example: see GEOM_TestOthers.py
11682             anObj = self.BlocksOp.GetShapesNearPoint(theShape, thePoint, theShapeType, theTolerance)
11683             RaiseIfFailed("GetShapesNearPoint", self.BlocksOp)
11684             self._autoPublish(anObj, theName, "group")
11685             return anObj
11686
11687         # end of l3_blocks_op
11688         ## @}
11689
11690         ## @addtogroup l4_blocks_measure
11691         ## @{
11692
11693         ## Check, if the compound of blocks is given.
11694         #  To be considered as a compound of blocks, the
11695         #  given shape must satisfy the following conditions:
11696         #  - Each element of the compound should be a Block (6 faces and 12 edges).
11697         #  - A connection between two Blocks should be an entire quadrangle face or an entire edge.
11698         #  - The compound should be connexe.
11699         #  - The glue between two quadrangle faces should be applied.
11700         #  @param theCompound The compound to check.
11701         #  @return TRUE, if the given shape is a compound of blocks.
11702         #  If theCompound is not valid, prints all discovered errors.
11703         #
11704         #  @ref tui_measurement_tools_page "Example 1"
11705         #  \n @ref swig_CheckCompoundOfBlocks "Example 2"
11706         @ManageTransactions("BlocksOp")
11707         def CheckCompoundOfBlocks(self,theCompound):
11708             """
11709             Check, if the compound of blocks is given.
11710             To be considered as a compound of blocks, the
11711             given shape must satisfy the following conditions:
11712             - Each element of the compound should be a Block (6 faces and 12 edges).
11713             - A connection between two Blocks should be an entire quadrangle face or an entire edge.
11714             - The compound should be connexe.
11715             - The glue between two quadrangle faces should be applied.
11716
11717             Parameters:
11718                 theCompound The compound to check.
11719
11720             Returns:
11721                 TRUE, if the given shape is a compound of blocks.
11722                 If theCompound is not valid, prints all discovered errors.
11723             """
11724             # Example: see GEOM_Spanner.py
11725             (IsValid, BCErrors) = self.BlocksOp.CheckCompoundOfBlocks(theCompound)
11726             RaiseIfFailed("CheckCompoundOfBlocks", self.BlocksOp)
11727             if IsValid == 0:
11728                 Descr = self.BlocksOp.PrintBCErrors(theCompound, BCErrors)
11729                 print Descr
11730             return IsValid
11731
11732         ## Retrieve all non blocks solids and faces from \a theShape.
11733         #  @param theShape The shape to explore.
11734         #  @param theName Object name; when specified, this parameter is used
11735         #         for result publication in the study. Otherwise, if automatic
11736         #         publication is switched on, default value is used for result name.
11737         #
11738         #  @return A tuple of two GEOM_Objects. The first object is a group of all
11739         #          non block solids (= not 6 faces, or with 6 faces, but with the
11740         #          presence of non-quadrangular faces). The second object is a
11741         #          group of all non quadrangular faces.
11742         #
11743         #  @ref tui_measurement_tools_page "Example 1"
11744         #  \n @ref swig_GetNonBlocks "Example 2"
11745         @ManageTransactions("BlocksOp")
11746         def GetNonBlocks (self, theShape, theName=None):
11747             """
11748             Retrieve all non blocks solids and faces from theShape.
11749
11750             Parameters:
11751                 theShape The shape to explore.
11752                 theName Object name; when specified, this parameter is used
11753                         for result publication in the study. Otherwise, if automatic
11754                         publication is switched on, default value is used for result name.
11755
11756             Returns:
11757                 A tuple of two GEOM_Objects. The first object is a group of all
11758                 non block solids (= not 6 faces, or with 6 faces, but with the
11759                 presence of non-quadrangular faces). The second object is a
11760                 group of all non quadrangular faces.
11761
11762             Usage:
11763                 (res_sols, res_faces) = geompy.GetNonBlocks(myShape1)
11764             """
11765             # Example: see GEOM_Spanner.py
11766             aTuple = self.BlocksOp.GetNonBlocks(theShape)
11767             RaiseIfFailed("GetNonBlocks", self.BlocksOp)
11768             self._autoPublish(aTuple, theName, ("groupNonHexas", "groupNonQuads"))
11769             return aTuple
11770
11771         ## Remove all seam and degenerated edges from \a theShape.
11772         #  Unite faces and edges, sharing one surface. It means that
11773         #  this faces must have references to one C++ surface object (handle).
11774         #  @param theShape The compound or single solid to remove irregular edges from.
11775         #  @param doUnionFaces If True, then unite faces. If False (the default value),
11776         #         do not unite faces.
11777         #  @param theName Object name; when specified, this parameter is used
11778         #         for result publication in the study. Otherwise, if automatic
11779         #         publication is switched on, default value is used for result name.
11780         #
11781         #  @return Improved shape.
11782         #
11783         #  @ref swig_RemoveExtraEdges "Example"
11784         @ManageTransactions("BlocksOp")
11785         def RemoveExtraEdges(self, theShape, doUnionFaces=False, theName=None):
11786             """
11787             Remove all seam and degenerated edges from theShape.
11788             Unite faces and edges, sharing one surface. It means that
11789             this faces must have references to one C++ surface object (handle).
11790
11791             Parameters:
11792                 theShape The compound or single solid to remove irregular edges from.
11793                 doUnionFaces If True, then unite faces. If False (the default value),
11794                              do not unite faces.
11795                 theName Object name; when specified, this parameter is used
11796                         for result publication in the study. Otherwise, if automatic
11797                         publication is switched on, default value is used for result name.
11798
11799             Returns:
11800                 Improved shape.
11801             """
11802             # Example: see GEOM_TestOthers.py
11803             nbFacesOptimum = -1 # -1 means do not unite faces
11804             if doUnionFaces is True: nbFacesOptimum = 0 # 0 means unite faces
11805             anObj = self.BlocksOp.RemoveExtraEdges(theShape, nbFacesOptimum)
11806             RaiseIfFailed("RemoveExtraEdges", self.BlocksOp)
11807             self._autoPublish(anObj, theName, "removeExtraEdges")
11808             return anObj
11809
11810         ## Performs union faces of \a theShape
11811         #  Unite faces sharing one surface. It means that
11812         #  these faces must have references to one C++ surface object (handle).
11813         #  @param theShape The compound or single solid that contains faces
11814         #         to perform union.
11815         #  @param theName Object name; when specified, this parameter is used
11816         #         for result publication in the study. Otherwise, if automatic
11817         #         publication is switched on, default value is used for result name.
11818         #
11819         #  @return Improved shape.
11820         #
11821         #  @ref swig_UnionFaces "Example"
11822         @ManageTransactions("BlocksOp")
11823         def UnionFaces(self, theShape, theName=None):
11824             """
11825             Performs union faces of theShape.
11826             Unite faces sharing one surface. It means that
11827             these faces must have references to one C++ surface object (handle).
11828
11829             Parameters:
11830                 theShape The compound or single solid that contains faces
11831                          to perform union.
11832                 theName Object name; when specified, this parameter is used
11833                         for result publication in the study. Otherwise, if automatic
11834                         publication is switched on, default value is used for result name.
11835
11836             Returns:
11837                 Improved shape.
11838             """
11839             # Example: see GEOM_TestOthers.py
11840             anObj = self.BlocksOp.UnionFaces(theShape)
11841             RaiseIfFailed("UnionFaces", self.BlocksOp)
11842             self._autoPublish(anObj, theName, "unionFaces")
11843             return anObj
11844
11845         ## Check, if the given shape is a blocks compound.
11846         #  Fix all detected errors.
11847         #    \note Single block can be also fixed by this method.
11848         #  @param theShape The compound to check and improve.
11849         #  @param theName Object name; when specified, this parameter is used
11850         #         for result publication in the study. Otherwise, if automatic
11851         #         publication is switched on, default value is used for result name.
11852         #
11853         #  @return Improved compound.
11854         #
11855         #  @ref swig_CheckAndImprove "Example"
11856         @ManageTransactions("BlocksOp")
11857         def CheckAndImprove(self, theShape, theName=None):
11858             """
11859             Check, if the given shape is a blocks compound.
11860             Fix all detected errors.
11861
11862             Note:
11863                 Single block can be also fixed by this method.
11864
11865             Parameters:
11866                 theShape The compound to check and improve.
11867                 theName Object name; when specified, this parameter is used
11868                         for result publication in the study. Otherwise, if automatic
11869                         publication is switched on, default value is used for result name.
11870
11871             Returns:
11872                 Improved compound.
11873             """
11874             # Example: see GEOM_TestOthers.py
11875             anObj = self.BlocksOp.CheckAndImprove(theShape)
11876             RaiseIfFailed("CheckAndImprove", self.BlocksOp)
11877             self._autoPublish(anObj, theName, "improved")
11878             return anObj
11879
11880         # end of l4_blocks_measure
11881         ## @}
11882
11883         ## @addtogroup l3_blocks_op
11884         ## @{
11885
11886         ## Get all the blocks, contained in the given compound.
11887         #  @param theCompound The compound to explode.
11888         #  @param theMinNbFaces If solid has lower number of faces, it is not a block.
11889         #  @param theMaxNbFaces If solid has higher number of faces, it is not a block.
11890         #  @param theName Object name; when specified, this parameter is used
11891         #         for result publication in the study. Otherwise, if automatic
11892         #         publication is switched on, default value is used for result name.
11893         #
11894         #  @note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
11895         #
11896         #  @return List of GEOM.GEOM_Object, containing the retrieved blocks.
11897         #
11898         #  @ref tui_explode_on_blocks "Example 1"
11899         #  \n @ref swig_MakeBlockExplode "Example 2"
11900         @ManageTransactions("BlocksOp")
11901         def MakeBlockExplode(self, theCompound, theMinNbFaces, theMaxNbFaces, theName=None):
11902             """
11903             Get all the blocks, contained in the given compound.
11904
11905             Parameters:
11906                 theCompound The compound to explode.
11907                 theMinNbFaces If solid has lower number of faces, it is not a block.
11908                 theMaxNbFaces If solid has higher number of faces, it is not a block.
11909                 theName Object name; when specified, this parameter is used
11910                         for result publication in the study. Otherwise, if automatic
11911                         publication is switched on, default value is used for result name.
11912
11913             Note:
11914                 If theMaxNbFaces = 0, the maximum number of faces is not restricted.
11915
11916             Returns:
11917                 List of GEOM.GEOM_Object, containing the retrieved blocks.
11918             """
11919             # Example: see GEOM_TestOthers.py
11920             theMinNbFaces,theMaxNbFaces,Parameters = ParseParameters(theMinNbFaces,theMaxNbFaces)
11921             aList = self.BlocksOp.ExplodeCompoundOfBlocks(theCompound, theMinNbFaces, theMaxNbFaces)
11922             RaiseIfFailed("ExplodeCompoundOfBlocks", self.BlocksOp)
11923             for anObj in aList:
11924                 anObj.SetParameters(Parameters)
11925                 pass
11926             self._autoPublish(aList, theName, "block")
11927             return aList
11928
11929         ## Find block, containing the given point inside its volume or on boundary.
11930         #  @param theCompound Compound, to find block in.
11931         #  @param thePoint Point, close to the desired block. If the point lays on
11932         #         boundary between some blocks, we return block with nearest center.
11933         #  @param theName Object name; when specified, this parameter is used
11934         #         for result publication in the study. Otherwise, if automatic
11935         #         publication is switched on, default value is used for result name.
11936         #
11937         #  @return New GEOM.GEOM_Object, containing the found block.
11938         #
11939         #  @ref swig_todo "Example"
11940         @ManageTransactions("BlocksOp")
11941         def GetBlockNearPoint(self, theCompound, thePoint, theName=None):
11942             """
11943             Find block, containing the given point inside its volume or on boundary.
11944
11945             Parameters:
11946                 theCompound Compound, to find block in.
11947                 thePoint Point, close to the desired block. If the point lays on
11948                          boundary between some blocks, we return block with nearest center.
11949                 theName Object name; when specified, this parameter is used
11950                         for result publication in the study. Otherwise, if automatic
11951                         publication is switched on, default value is used for result name.
11952
11953             Returns:
11954                 New GEOM.GEOM_Object, containing the found block.
11955             """
11956             # Example: see GEOM_Spanner.py
11957             anObj = self.BlocksOp.GetBlockNearPoint(theCompound, thePoint)
11958             RaiseIfFailed("GetBlockNearPoint", self.BlocksOp)
11959             self._autoPublish(anObj, theName, "block")
11960             return anObj
11961
11962         ## Find block, containing all the elements, passed as the parts, or maximum quantity of them.
11963         #  @param theCompound Compound, to find block in.
11964         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found block.
11965         #  @param theName Object name; when specified, this parameter is used
11966         #         for result publication in the study. Otherwise, if automatic
11967         #         publication is switched on, default value is used for result name.
11968         #
11969         #  @return New GEOM.GEOM_Object, containing the found block.
11970         #
11971         #  @ref swig_GetBlockByParts "Example"
11972         @ManageTransactions("BlocksOp")
11973         def GetBlockByParts(self, theCompound, theParts, theName=None):
11974             """
11975              Find block, containing all the elements, passed as the parts, or maximum quantity of them.
11976
11977              Parameters:
11978                 theCompound Compound, to find block in.
11979                 theParts List of faces and/or edges and/or vertices to be parts of the found block.
11980                 theName Object name; when specified, this parameter is used
11981                         for result publication in the study. Otherwise, if automatic
11982                         publication is switched on, default value is used for result name.
11983
11984             Returns:
11985                 New GEOM_Object, containing the found block.
11986             """
11987             # Example: see GEOM_TestOthers.py
11988             anObj = self.BlocksOp.GetBlockByParts(theCompound, theParts)
11989             RaiseIfFailed("GetBlockByParts", self.BlocksOp)
11990             self._autoPublish(anObj, theName, "block")
11991             return anObj
11992
11993         ## Return all blocks, containing all the elements, passed as the parts.
11994         #  @param theCompound Compound, to find blocks in.
11995         #  @param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
11996         #  @param theName Object name; when specified, this parameter is used
11997         #         for result publication in the study. Otherwise, if automatic
11998         #         publication is switched on, default value is used for result name.
11999         #
12000         #  @return List of GEOM.GEOM_Object, containing the found blocks.
12001         #
12002         #  @ref swig_todo "Example"
12003         @ManageTransactions("BlocksOp")
12004         def GetBlocksByParts(self, theCompound, theParts, theName=None):
12005             """
12006             Return all blocks, containing all the elements, passed as the parts.
12007
12008             Parameters:
12009                 theCompound Compound, to find blocks in.
12010                 theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
12011                 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             Returns:
12016                 List of GEOM.GEOM_Object, containing the found blocks.
12017             """
12018             # Example: see GEOM_Spanner.py
12019             aList = self.BlocksOp.GetBlocksByParts(theCompound, theParts)
12020             RaiseIfFailed("GetBlocksByParts", self.BlocksOp)
12021             self._autoPublish(aList, theName, "block")
12022             return aList
12023
12024         ## Multi-transformate block and glue the result.
12025         #  Transformation is defined so, as to superpose direction faces.
12026         #  @param Block Hexahedral solid to be multi-transformed.
12027         #  @param DirFace1 ID of First direction face.
12028         #  @param DirFace2 ID of Second direction face.
12029         #  @param NbTimes Quantity of transformations to be done.
12030         #  @param theName Object name; when specified, this parameter is used
12031         #         for result publication in the study. Otherwise, if automatic
12032         #         publication is switched on, default value is used for result name.
12033         #
12034         #  @note Unique ID of sub-shape can be obtained, using method GetSubShapeID().
12035         #
12036         #  @return New GEOM.GEOM_Object, containing the result shape.
12037         #
12038         #  @ref tui_multi_transformation "Example"
12039         @ManageTransactions("BlocksOp")
12040         def MakeMultiTransformation1D(self, Block, DirFace1, DirFace2, NbTimes, theName=None):
12041             """
12042             Multi-transformate block and glue the result.
12043             Transformation is defined so, as to superpose direction faces.
12044
12045             Parameters:
12046                 Block Hexahedral solid to be multi-transformed.
12047                 DirFace1 ID of First direction face.
12048                 DirFace2 ID of Second direction face.
12049                 NbTimes Quantity of transformations to be done.
12050                 theName Object name; when specified, this parameter is used
12051                         for result publication in the study. Otherwise, if automatic
12052                         publication is switched on, default value is used for result name.
12053
12054             Note:
12055                 Unique ID of sub-shape can be obtained, using method GetSubShapeID().
12056
12057             Returns:
12058                 New GEOM.GEOM_Object, containing the result shape.
12059             """
12060             # Example: see GEOM_Spanner.py
12061             DirFace1,DirFace2,NbTimes,Parameters = ParseParameters(DirFace1,DirFace2,NbTimes)
12062             anObj = self.BlocksOp.MakeMultiTransformation1D(Block, DirFace1, DirFace2, NbTimes)
12063             RaiseIfFailed("MakeMultiTransformation1D", self.BlocksOp)
12064             anObj.SetParameters(Parameters)
12065             self._autoPublish(anObj, theName, "transformed")
12066             return anObj
12067
12068         ## Multi-transformate block and glue the result.
12069         #  @param Block Hexahedral solid to be multi-transformed.
12070         #  @param DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
12071         #  @param DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
12072         #  @param NbTimesU,NbTimesV Quantity of transformations to be done.
12073         #  @param theName Object name; when specified, this parameter is used
12074         #         for result publication in the study. Otherwise, if automatic
12075         #         publication is switched on, default value is used for result name.
12076         #
12077         #  @return New GEOM.GEOM_Object, containing the result shape.
12078         #
12079         #  @ref tui_multi_transformation "Example"
12080         @ManageTransactions("BlocksOp")
12081         def MakeMultiTransformation2D(self, Block, DirFace1U, DirFace2U, NbTimesU,
12082                                       DirFace1V, DirFace2V, NbTimesV, theName=None):
12083             """
12084             Multi-transformate block and glue the result.
12085
12086             Parameters:
12087                 Block Hexahedral solid to be multi-transformed.
12088                 DirFace1U,DirFace2U IDs of Direction faces for the first transformation.
12089                 DirFace1V,DirFace2V IDs of Direction faces for the second transformation.
12090                 NbTimesU,NbTimesV Quantity of transformations to be done.
12091                 theName Object name; when specified, this parameter is used
12092                         for result publication in the study. Otherwise, if automatic
12093                         publication is switched on, default value is used for result name.
12094
12095             Returns:
12096                 New GEOM.GEOM_Object, containing the result shape.
12097             """
12098             # Example: see GEOM_Spanner.py
12099             DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV,Parameters = ParseParameters(
12100               DirFace1U,DirFace2U,NbTimesU,DirFace1V,DirFace2V,NbTimesV)
12101             anObj = self.BlocksOp.MakeMultiTransformation2D(Block, DirFace1U, DirFace2U, NbTimesU,
12102                                                             DirFace1V, DirFace2V, NbTimesV)
12103             RaiseIfFailed("MakeMultiTransformation2D", self.BlocksOp)
12104             anObj.SetParameters(Parameters)
12105             self._autoPublish(anObj, theName, "transformed")
12106             return anObj
12107
12108         ## Build all possible propagation groups.
12109         #  Propagation group is a set of all edges, opposite to one (main)
12110         #  edge of this group directly or through other opposite edges.
12111         #  Notion of Opposite Edge make sence only on quadrangle face.
12112         #  @param theShape Shape to build propagation groups on.
12113         #  @param theName Object name; when specified, this parameter is used
12114         #         for result publication in the study. Otherwise, if automatic
12115         #         publication is switched on, default value is used for result name.
12116         #
12117         #  @return List of GEOM.GEOM_Object, each of them is a propagation group.
12118         #
12119         #  @ref swig_Propagate "Example"
12120         @ManageTransactions("BlocksOp")
12121         def Propagate(self, theShape, theName=None):
12122             """
12123             Build all possible propagation groups.
12124             Propagation group is a set of all edges, opposite to one (main)
12125             edge of this group directly or through other opposite edges.
12126             Notion of Opposite Edge make sence only on quadrangle face.
12127
12128             Parameters:
12129                 theShape Shape to build propagation groups on.
12130                 theName Object name; when specified, this parameter is used
12131                         for result publication in the study. Otherwise, if automatic
12132                         publication is switched on, default value is used for result name.
12133
12134             Returns:
12135                 List of GEOM.GEOM_Object, each of them is a propagation group.
12136             """
12137             # Example: see GEOM_TestOthers.py
12138             listChains = self.BlocksOp.Propagate(theShape)
12139             RaiseIfFailed("Propagate", self.BlocksOp)
12140             self._autoPublish(listChains, theName, "propagate")
12141             return listChains
12142
12143         # end of l3_blocks_op
12144         ## @}
12145
12146         ## @addtogroup l3_groups
12147         ## @{
12148
12149         ## Creates a new group which will store sub-shapes of theMainShape
12150         #  @param theMainShape is a GEOM object on which the group is selected
12151         #  @param theShapeType defines a shape type of the group (see GEOM::shape_type)
12152         #  @param theName Object name; when specified, this parameter is used
12153         #         for result publication in the study. Otherwise, if automatic
12154         #         publication is switched on, default value is used for result name.
12155         #
12156         #  @return a newly created GEOM group (GEOM.GEOM_Object)
12157         #
12158         #  @ref tui_working_with_groups_page "Example 1"
12159         #  \n @ref swig_CreateGroup "Example 2"
12160         @ManageTransactions("GroupOp")
12161         def CreateGroup(self, theMainShape, theShapeType, theName=None):
12162             """
12163             Creates a new group which will store sub-shapes of theMainShape
12164
12165             Parameters:
12166                theMainShape is a GEOM object on which the group is selected
12167                theShapeType defines a shape type of the group:"COMPOUND", "COMPSOLID",
12168                             "SOLID", "SHELL", "FACE", "WIRE", "EDGE", "VERTEX", "SHAPE".
12169                 theName Object name; when specified, this parameter is used
12170                         for result publication in the study. Otherwise, if automatic
12171                         publication is switched on, default value is used for result name.
12172
12173             Returns:
12174                a newly created GEOM group
12175
12176             Example of usage:
12177                 group = geompy.CreateGroup(Box, geompy.ShapeType["FACE"])
12178
12179             """
12180             # Example: see GEOM_TestOthers.py
12181             anObj = self.GroupOp.CreateGroup(theMainShape, theShapeType)
12182             RaiseIfFailed("CreateGroup", self.GroupOp)
12183             self._autoPublish(anObj, theName, "group")
12184             return anObj
12185
12186         ## Adds a sub-object with ID theSubShapeId to the group
12187         #  @param theGroup is a GEOM group to which the new sub-shape is added
12188         #  @param theSubShapeID is a sub-shape ID in the main object.
12189         #  \note Use method GetSubShapeID() to get an unique ID of the sub-shape
12190         #
12191         #  @ref tui_working_with_groups_page "Example"
12192         @ManageTransactions("GroupOp")
12193         def AddObject(self,theGroup, theSubShapeID):
12194             """
12195             Adds a sub-object with ID theSubShapeId to the group
12196
12197             Parameters:
12198                 theGroup       is a GEOM group to which the new sub-shape is added
12199                 theSubShapeID  is a sub-shape ID in the main object.
12200
12201             Note:
12202                 Use method GetSubShapeID() to get an unique ID of the sub-shape
12203             """
12204             # Example: see GEOM_TestOthers.py
12205             self.GroupOp.AddObject(theGroup, theSubShapeID)
12206             if self.GroupOp.GetErrorCode() != "PAL_ELEMENT_ALREADY_PRESENT":
12207                 RaiseIfFailed("AddObject", self.GroupOp)
12208                 pass
12209             pass
12210
12211         ## Removes a sub-object with ID \a theSubShapeId from the group
12212         #  @param theGroup is a GEOM group from which the new sub-shape is removed
12213         #  @param theSubShapeID is a sub-shape ID in the main object.
12214         #  \note Use method GetSubShapeID() to get an unique ID of the sub-shape
12215         #
12216         #  @ref tui_working_with_groups_page "Example"
12217         @ManageTransactions("GroupOp")
12218         def RemoveObject(self,theGroup, theSubShapeID):
12219             """
12220             Removes a sub-object with ID theSubShapeId from the group
12221
12222             Parameters:
12223                 theGroup is a GEOM group from which the new sub-shape is removed
12224                 theSubShapeID is a sub-shape ID in the main object.
12225
12226             Note:
12227                 Use method GetSubShapeID() to get an unique ID of the sub-shape
12228             """
12229             # Example: see GEOM_TestOthers.py
12230             self.GroupOp.RemoveObject(theGroup, theSubShapeID)
12231             RaiseIfFailed("RemoveObject", self.GroupOp)
12232             pass
12233
12234         ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12235         #  @param theGroup is a GEOM group to which the new sub-shapes are added.
12236         #  @param theSubShapes is a list of sub-shapes to be added.
12237         #
12238         #  @ref tui_working_with_groups_page "Example"
12239         @ManageTransactions("GroupOp")
12240         def UnionList (self,theGroup, theSubShapes):
12241             """
12242             Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12243
12244             Parameters:
12245                 theGroup is a GEOM group to which the new sub-shapes are added.
12246                 theSubShapes is a list of sub-shapes to be added.
12247             """
12248             # Example: see GEOM_TestOthers.py
12249             self.GroupOp.UnionList(theGroup, theSubShapes)
12250             RaiseIfFailed("UnionList", self.GroupOp)
12251             pass
12252
12253         ## Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12254         #  @param theGroup is a GEOM group to which the new sub-shapes are added.
12255         #  @param theSubShapes is a list of indices of sub-shapes to be added.
12256         #
12257         #  @ref swig_UnionIDs "Example"
12258         @ManageTransactions("GroupOp")
12259         def UnionIDs(self,theGroup, theSubShapes):
12260             """
12261             Adds to the group all the given shapes. No errors, if some shapes are alredy included.
12262
12263             Parameters:
12264                 theGroup is a GEOM group to which the new sub-shapes are added.
12265                 theSubShapes is a list of indices of sub-shapes to be added.
12266             """
12267             # Example: see GEOM_TestOthers.py
12268             self.GroupOp.UnionIDs(theGroup, theSubShapes)
12269             RaiseIfFailed("UnionIDs", self.GroupOp)
12270             pass
12271
12272         ## Removes from the group all the given shapes. No errors, if some shapes are not included.
12273         #  @param theGroup is a GEOM group from which the sub-shapes are removed.
12274         #  @param theSubShapes is a list of sub-shapes to be removed.
12275         #
12276         #  @ref tui_working_with_groups_page "Example"
12277         @ManageTransactions("GroupOp")
12278         def DifferenceList (self,theGroup, theSubShapes):
12279             """
12280             Removes from the group all the given shapes. No errors, if some shapes are not included.
12281
12282             Parameters:
12283                 theGroup is a GEOM group from which the sub-shapes are removed.
12284                 theSubShapes is a list of sub-shapes to be removed.
12285             """
12286             # Example: see GEOM_TestOthers.py
12287             self.GroupOp.DifferenceList(theGroup, theSubShapes)
12288             RaiseIfFailed("DifferenceList", self.GroupOp)
12289             pass
12290
12291         ## Removes from the group all the given shapes. No errors, if some shapes are not included.
12292         #  @param theGroup is a GEOM group from which the sub-shapes are removed.
12293         #  @param theSubShapes is a list of indices of sub-shapes to be removed.
12294         #
12295         #  @ref swig_DifferenceIDs "Example"
12296         @ManageTransactions("GroupOp")
12297         def DifferenceIDs(self,theGroup, theSubShapes):
12298             """
12299             Removes from the group all the given shapes. No errors, if some shapes are not included.
12300
12301             Parameters:
12302                 theGroup is a GEOM group from which the sub-shapes are removed.
12303                 theSubShapes is a list of indices of sub-shapes to be removed.
12304             """
12305             # Example: see GEOM_TestOthers.py
12306             self.GroupOp.DifferenceIDs(theGroup, theSubShapes)
12307             RaiseIfFailed("DifferenceIDs", self.GroupOp)
12308             pass
12309
12310         ## Union of two groups.
12311         #  New group is created. It will contain all entities
12312         #  which are present in groups theGroup1 and theGroup2.
12313         #  @param theGroup1, theGroup2 are the initial GEOM groups
12314         #                              to create the united group from.
12315         #  @param theName Object name; when specified, this parameter is used
12316         #         for result publication in the study. Otherwise, if automatic
12317         #         publication is switched on, default value is used for result name.
12318         #
12319         #  @return a newly created GEOM group.
12320         #
12321         #  @ref tui_union_groups_anchor "Example"
12322         @ManageTransactions("GroupOp")
12323         def UnionGroups (self, theGroup1, theGroup2, theName=None):
12324             """
12325             Union of two groups.
12326             New group is created. It will contain all entities
12327             which are present in groups theGroup1 and theGroup2.
12328
12329             Parameters:
12330                 theGroup1, theGroup2 are the initial GEOM groups
12331                                      to create the united group from.
12332                 theName Object name; when specified, this parameter is used
12333                         for result publication in the study. Otherwise, if automatic
12334                         publication is switched on, default value is used for result name.
12335
12336             Returns:
12337                 a newly created GEOM group.
12338             """
12339             # Example: see GEOM_TestOthers.py
12340             aGroup = self.GroupOp.UnionGroups(theGroup1, theGroup2)
12341             RaiseIfFailed("UnionGroups", self.GroupOp)
12342             self._autoPublish(aGroup, theName, "group")
12343             return aGroup
12344
12345         ## Intersection of two groups.
12346         #  New group is created. It will contain only those entities
12347         #  which are present in both groups theGroup1 and theGroup2.
12348         #  @param theGroup1, theGroup2 are the initial GEOM groups to get common part of.
12349         #  @param theName Object name; when specified, this parameter is used
12350         #         for result publication in the study. Otherwise, if automatic
12351         #         publication is switched on, default value is used for result name.
12352         #
12353         #  @return a newly created GEOM group.
12354         #
12355         #  @ref tui_intersect_groups_anchor "Example"
12356         @ManageTransactions("GroupOp")
12357         def IntersectGroups (self, theGroup1, theGroup2, theName=None):
12358             """
12359             Intersection of two groups.
12360             New group is created. It will contain only those entities
12361             which are present in both groups theGroup1 and theGroup2.
12362
12363             Parameters:
12364                 theGroup1, theGroup2 are the initial GEOM groups to get common part of.
12365                 theName Object name; when specified, this parameter is used
12366                         for result publication in the study. Otherwise, if automatic
12367                         publication is switched on, default value is used for result name.
12368
12369             Returns:
12370                 a newly created GEOM group.
12371             """
12372             # Example: see GEOM_TestOthers.py
12373             aGroup = self.GroupOp.IntersectGroups(theGroup1, theGroup2)
12374             RaiseIfFailed("IntersectGroups", self.GroupOp)
12375             self._autoPublish(aGroup, theName, "group")
12376             return aGroup
12377
12378         ## Cut of two groups.
12379         #  New group is created. It will contain entities which are
12380         #  present in group theGroup1 but are not present in group theGroup2.
12381         #  @param theGroup1 is a GEOM group to include elements of.
12382         #  @param theGroup2 is a GEOM group to exclude elements of.
12383         #  @param theName Object name; when specified, this parameter is used
12384         #         for result publication in the study. Otherwise, if automatic
12385         #         publication is switched on, default value is used for result name.
12386         #
12387         #  @return a newly created GEOM group.
12388         #
12389         #  @ref tui_cut_groups_anchor "Example"
12390         @ManageTransactions("GroupOp")
12391         def CutGroups (self, theGroup1, theGroup2, theName=None):
12392             """
12393             Cut of two groups.
12394             New group is created. It will contain entities which are
12395             present in group theGroup1 but are not present in group theGroup2.
12396
12397             Parameters:
12398                 theGroup1 is a GEOM group to include elements of.
12399                 theGroup2 is a GEOM group to exclude elements of.
12400                 theName Object name; when specified, this parameter is used
12401                         for result publication in the study. Otherwise, if automatic
12402                         publication is switched on, default value is used for result name.
12403
12404             Returns:
12405                 a newly created GEOM group.
12406             """
12407             # Example: see GEOM_TestOthers.py
12408             aGroup = self.GroupOp.CutGroups(theGroup1, theGroup2)
12409             RaiseIfFailed("CutGroups", self.GroupOp)
12410             self._autoPublish(aGroup, theName, "group")
12411             return aGroup
12412
12413         ## Union of list of groups.
12414         #  New group is created. It will contain all entities that are
12415         #  present in groups listed in theGList.
12416         #  @param theGList is a list of GEOM groups to create the united group from.
12417         #  @param theName Object name; when specified, this parameter is used
12418         #         for result publication in the study. Otherwise, if automatic
12419         #         publication is switched on, default value is used for result name.
12420         #
12421         #  @return a newly created GEOM group.
12422         #
12423         #  @ref tui_union_groups_anchor "Example"
12424         @ManageTransactions("GroupOp")
12425         def UnionListOfGroups (self, theGList, theName=None):
12426             """
12427             Union of list of groups.
12428             New group is created. It will contain all entities that are
12429             present in groups listed in theGList.
12430
12431             Parameters:
12432                 theGList is a list of GEOM groups to create the united group from.
12433                 theName Object name; when specified, this parameter is used
12434                         for result publication in the study. Otherwise, if automatic
12435                         publication is switched on, default value is used for result name.
12436
12437             Returns:
12438                 a newly created GEOM group.
12439             """
12440             # Example: see GEOM_TestOthers.py
12441             aGroup = self.GroupOp.UnionListOfGroups(theGList)
12442             RaiseIfFailed("UnionListOfGroups", self.GroupOp)
12443             self._autoPublish(aGroup, theName, "group")
12444             return aGroup
12445
12446         ## Cut of lists of groups.
12447         #  New group is created. It will contain only entities
12448         #  which are present in groups listed in theGList.
12449         #  @param theGList is a list of GEOM groups to include elements of.
12450         #  @param theName Object name; when specified, this parameter is used
12451         #         for result publication in the study. Otherwise, if automatic
12452         #         publication is switched on, default value is used for result name.
12453         #
12454         #  @return a newly created GEOM group.
12455         #
12456         #  @ref tui_intersect_groups_anchor "Example"
12457         @ManageTransactions("GroupOp")
12458         def IntersectListOfGroups (self, theGList, theName=None):
12459             """
12460             Cut of lists of groups.
12461             New group is created. It will contain only entities
12462             which are present in groups listed in theGList.
12463
12464             Parameters:
12465                 theGList is a list of GEOM groups to include elements of.
12466                 theName Object name; when specified, this parameter is used
12467                         for result publication in the study. Otherwise, if automatic
12468                         publication is switched on, default value is used for result name.
12469
12470             Returns:
12471                 a newly created GEOM group.
12472             """
12473             # Example: see GEOM_TestOthers.py
12474             aGroup = self.GroupOp.IntersectListOfGroups(theGList)
12475             RaiseIfFailed("IntersectListOfGroups", self.GroupOp)
12476             self._autoPublish(aGroup, theName, "group")
12477             return aGroup
12478
12479         ## Cut of lists of groups.
12480         #  New group is created. It will contain only entities
12481         #  which are present in groups listed in theGList1 but
12482         #  are not present in groups from theGList2.
12483         #  @param theGList1 is a list of GEOM groups to include elements of.
12484         #  @param theGList2 is a list of GEOM groups to exclude elements of.
12485         #  @param theName Object name; when specified, this parameter is used
12486         #         for result publication in the study. Otherwise, if automatic
12487         #         publication is switched on, default value is used for result name.
12488         #
12489         #  @return a newly created GEOM group.
12490         #
12491         #  @ref tui_cut_groups_anchor "Example"
12492         @ManageTransactions("GroupOp")
12493         def CutListOfGroups (self, theGList1, theGList2, theName=None):
12494             """
12495             Cut of lists of groups.
12496             New group is created. It will contain only entities
12497             which are present in groups listed in theGList1 but
12498             are not present in groups from theGList2.
12499
12500             Parameters:
12501                 theGList1 is a list of GEOM groups to include elements of.
12502                 theGList2 is a list of GEOM groups to exclude elements of.
12503                 theName Object name; when specified, this parameter is used
12504                         for result publication in the study. Otherwise, if automatic
12505                         publication is switched on, default value is used for result name.
12506
12507             Returns:
12508                 a newly created GEOM group.
12509             """
12510             # Example: see GEOM_TestOthers.py
12511             aGroup = self.GroupOp.CutListOfGroups(theGList1, theGList2)
12512             RaiseIfFailed("CutListOfGroups", self.GroupOp)
12513             self._autoPublish(aGroup, theName, "group")
12514             return aGroup
12515
12516         ## Returns a list of sub-objects ID stored in the group
12517         #  @param theGroup is a GEOM group for which a list of IDs is requested
12518         #
12519         #  @ref swig_GetObjectIDs "Example"
12520         @ManageTransactions("GroupOp")
12521         def GetObjectIDs(self,theGroup):
12522             """
12523             Returns a list of sub-objects ID stored in the group
12524
12525             Parameters:
12526                 theGroup is a GEOM group for which a list of IDs is requested
12527             """
12528             # Example: see GEOM_TestOthers.py
12529             ListIDs = self.GroupOp.GetObjects(theGroup)
12530             RaiseIfFailed("GetObjects", self.GroupOp)
12531             return ListIDs
12532
12533         ## Returns a type of sub-objects stored in the group
12534         #  @param theGroup is a GEOM group which type is returned.
12535         #
12536         #  @ref swig_GetType "Example"
12537         @ManageTransactions("GroupOp")
12538         def GetType(self,theGroup):
12539             """
12540             Returns a type of sub-objects stored in the group
12541
12542             Parameters:
12543                 theGroup is a GEOM group which type is returned.
12544             """
12545             # Example: see GEOM_TestOthers.py
12546             aType = self.GroupOp.GetType(theGroup)
12547             RaiseIfFailed("GetType", self.GroupOp)
12548             return aType
12549
12550         ## Convert a type of geom object from id to string value
12551         #  @param theId is a GEOM obect type id.
12552         #  @return type of geom object (POINT, VECTOR, PLANE, LINE, TORUS, ... )
12553         #  @ref swig_GetType "Example"
12554         def ShapeIdToType(self, theId):
12555             """
12556             Convert a type of geom object from id to string value
12557
12558             Parameters:
12559                 theId is a GEOM obect type id.
12560
12561             Returns:
12562                 type of geom object (POINT, VECTOR, PLANE, LINE, TORUS, ... )
12563             """
12564             if theId == 0:
12565                 return "COPY"
12566             if theId == 1:
12567                 return "IMPORT"
12568             if theId == 2:
12569                 return "POINT"
12570             if theId == 3:
12571                 return "VECTOR"
12572             if theId == 4:
12573                 return "PLANE"
12574             if theId == 5:
12575                 return "LINE"
12576             if theId == 6:
12577                 return "TORUS"
12578             if theId == 7:
12579                 return "BOX"
12580             if theId == 8:
12581                 return "CYLINDER"
12582             if theId == 9:
12583                 return "CONE"
12584             if theId == 10:
12585                 return "SPHERE"
12586             if theId == 11:
12587                 return "PRISM"
12588             if theId == 12:
12589                 return "REVOLUTION"
12590             if theId == 13:
12591                 return "BOOLEAN"
12592             if theId == 14:
12593                 return "PARTITION"
12594             if theId == 15:
12595                 return "POLYLINE"
12596             if theId == 16:
12597                 return "CIRCLE"
12598             if theId == 17:
12599                 return "SPLINE"
12600             if theId == 18:
12601                 return "ELLIPSE"
12602             if theId == 19:
12603                 return "CIRC_ARC"
12604             if theId == 20:
12605                 return "FILLET"
12606             if theId == 21:
12607                 return "CHAMFER"
12608             if theId == 22:
12609                 return "EDGE"
12610             if theId == 23:
12611                 return "WIRE"
12612             if theId == 24:
12613                 return "FACE"
12614             if theId == 25:
12615                 return "SHELL"
12616             if theId == 26:
12617                 return "SOLID"
12618             if theId == 27:
12619                 return "COMPOUND"
12620             if theId == 28:
12621                 return "SUBSHAPE"
12622             if theId == 29:
12623                 return "PIPE"
12624             if theId == 30:
12625                 return "ARCHIMEDE"
12626             if theId == 31:
12627                 return "FILLING"
12628             if theId == 32:
12629                 return "EXPLODE"
12630             if theId == 33:
12631                 return "GLUED"
12632             if theId == 34:
12633                 return "SKETCHER"
12634             if theId == 35:
12635                 return "CDG"
12636             if theId == 36:
12637                 return "FREE_BOUNDS"
12638             if theId == 37:
12639                 return "GROUP"
12640             if theId == 38:
12641                 return "BLOCK"
12642             if theId == 39:
12643                 return "MARKER"
12644             if theId == 40:
12645                 return "THRUSECTIONS"
12646             if theId == 41:
12647                 return "COMPOUNDFILTER"
12648             if theId == 42:
12649                 return "SHAPES_ON_SHAPE"
12650             if theId == 43:
12651                 return "ELLIPSE_ARC"
12652             if theId == 44:
12653                 return "3DSKETCHER"
12654             if theId == 45:
12655                 return "FILLET_2D"
12656             if theId == 46:
12657                 return "FILLET_1D"
12658             if theId == 201:
12659                 return "PIPETSHAPE"
12660             return "Shape Id not exist."
12661
12662         ## Returns a main shape associated with the group
12663         #  @param theGroup is a GEOM group for which a main shape object is requested
12664         #  @return a GEOM object which is a main shape for theGroup
12665         #
12666         #  @ref swig_GetMainShape "Example"
12667         @ManageTransactions("GroupOp")
12668         def GetMainShape(self,theGroup):
12669             """
12670             Returns a main shape associated with the group
12671
12672             Parameters:
12673                 theGroup is a GEOM group for which a main shape object is requested
12674
12675             Returns:
12676                 a GEOM object which is a main shape for theGroup
12677
12678             Example of usage: BoxCopy = geompy.GetMainShape(CreateGroup)
12679             """
12680             # Example: see GEOM_TestOthers.py
12681             anObj = self.GroupOp.GetMainShape(theGroup)
12682             RaiseIfFailed("GetMainShape", self.GroupOp)
12683             return anObj
12684
12685         ## Create group of edges of theShape, whose length is in range [min_length, max_length].
12686         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
12687         #  @param theShape given shape (see GEOM.GEOM_Object)
12688         #  @param min_length minimum length of edges of theShape
12689         #  @param max_length maximum length of edges of theShape
12690         #  @param include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12691         #  @param include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12692         #  @param theName Object name; when specified, this parameter is used
12693         #         for result publication in the study. Otherwise, if automatic
12694         #         publication is switched on, default value is used for result name.
12695         #
12696         #  @return a newly created GEOM group of edges
12697         #
12698         #  @@ref swig_todo "Example"
12699         def GetEdgesByLength (self, theShape, min_length, max_length, include_min = 1, include_max = 1, theName=None):
12700             """
12701             Create group of edges of theShape, whose length is in range [min_length, max_length].
12702             If include_min/max == 0, edges with length == min/max_length will not be included in result.
12703
12704             Parameters:
12705                 theShape given shape
12706                 min_length minimum length of edges of theShape
12707                 max_length maximum length of edges of theShape
12708                 include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12709                 include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12710                 theName Object name; when specified, this parameter is used
12711                         for result publication in the study. Otherwise, if automatic
12712                         publication is switched on, default value is used for result name.
12713
12714              Returns:
12715                 a newly created GEOM group of edges.
12716             """
12717             edges = self.SubShapeAll(theShape, self.ShapeType["EDGE"])
12718             edges_in_range = []
12719             for edge in edges:
12720                 Props = self.BasicProperties(edge)
12721                 if min_length <= Props[0] and Props[0] <= max_length:
12722                     if (not include_min) and (min_length == Props[0]):
12723                         skip = 1
12724                     else:
12725                         if (not include_max) and (Props[0] == max_length):
12726                             skip = 1
12727                         else:
12728                             edges_in_range.append(edge)
12729
12730             if len(edges_in_range) <= 0:
12731                 print "No edges found by given criteria"
12732                 return None
12733
12734             # note: auto-publishing is done in self.CreateGroup()
12735             group_edges = self.CreateGroup(theShape, self.ShapeType["EDGE"], theName)
12736             self.UnionList(group_edges, edges_in_range)
12737
12738             return group_edges
12739
12740         ## Create group of edges of selected shape, whose length is in range [min_length, max_length].
12741         #  If include_min/max == 0, edges with length == min/max_length will not be included in result.
12742         #  @param min_length minimum length of edges of selected shape
12743         #  @param max_length maximum length of edges of selected shape
12744         #  @param include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12745         #  @param include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12746         #  @return a newly created GEOM group of edges
12747         #  @ref swig_todo "Example"
12748         def SelectEdges (self, min_length, max_length, include_min = 1, include_max = 1):
12749             """
12750             Create group of edges of selected shape, whose length is in range [min_length, max_length].
12751             If include_min/max == 0, edges with length == min/max_length will not be included in result.
12752
12753             Parameters:
12754                 min_length minimum length of edges of selected shape
12755                 max_length maximum length of edges of selected shape
12756                 include_max indicating if edges with length == max_length should be included in result, 1-yes, 0-no (default=1)
12757                 include_min indicating if edges with length == min_length should be included in result, 1-yes, 0-no (default=1)
12758
12759              Returns:
12760                 a newly created GEOM group of edges.
12761             """
12762             nb_selected = sg.SelectedCount()
12763             if nb_selected < 1:
12764                 print "Select a shape before calling this function, please."
12765                 return 0
12766             if nb_selected > 1:
12767                 print "Only one shape must be selected"
12768                 return 0
12769
12770             id_shape = sg.getSelected(0)
12771             shape = IDToObject( id_shape )
12772
12773             group_edges = self.GetEdgesByLength(shape, min_length, max_length, include_min, include_max)
12774
12775             left_str  = " < "
12776             right_str = " < "
12777             if include_min: left_str  = " <= "
12778             if include_max: right_str  = " <= "
12779
12780             self.addToStudyInFather(shape, group_edges, "Group of edges with " + `min_length`
12781                                     + left_str + "length" + right_str + `max_length`)
12782
12783             sg.updateObjBrowser(1)
12784
12785             return group_edges
12786
12787         # end of l3_groups
12788         ## @}
12789
12790         #@@ insert new functions before this line @@ do not remove this line @@#
12791
12792         ## Create a copy of the given object
12793         #
12794         #  @param theOriginal geometry object for copy
12795         #  @param theName Object name; when specified, this parameter is used
12796         #         for result publication in the study. Otherwise, if automatic
12797         #         publication is switched on, default value is used for result name.
12798         #
12799         #  @return New GEOM_Object, containing the copied shape.
12800         #
12801         #  @ingroup l1_geomBuilder_auxiliary
12802         #  @ref swig_MakeCopy "Example"
12803         @ManageTransactions("InsertOp")
12804         def MakeCopy(self, theOriginal, theName=None):
12805             """
12806             Create a copy of the given object
12807
12808             Parameters:
12809                 theOriginal geometry object for copy
12810                 theName Object name; when specified, this parameter is used
12811                         for result publication in the study. Otherwise, if automatic
12812                         publication is switched on, default value is used for result name.
12813
12814             Returns:
12815                 New GEOM_Object, containing the copied shape.
12816
12817             Example of usage: Copy = geompy.MakeCopy(Box)
12818             """
12819             # Example: see GEOM_TestAll.py
12820             anObj = self.InsertOp.MakeCopy(theOriginal)
12821             RaiseIfFailed("MakeCopy", self.InsertOp)
12822             self._autoPublish(anObj, theName, "copy")
12823             return anObj
12824
12825         ## Add Path to load python scripts from
12826         #  @param Path a path to load python scripts from
12827         #  @ingroup l1_geomBuilder_auxiliary
12828         def addPath(self,Path):
12829             """
12830             Add Path to load python scripts from
12831
12832             Parameters:
12833                 Path a path to load python scripts from
12834             """
12835             if (sys.path.count(Path) < 1):
12836                 sys.path.append(Path)
12837                 pass
12838             pass
12839
12840         ## Load marker texture from the file
12841         #  @param Path a path to the texture file
12842         #  @return unique texture identifier
12843         #  @ingroup l1_geomBuilder_auxiliary
12844         @ManageTransactions("InsertOp")
12845         def LoadTexture(self, Path):
12846             """
12847             Load marker texture from the file
12848
12849             Parameters:
12850                 Path a path to the texture file
12851
12852             Returns:
12853                 unique texture identifier
12854             """
12855             # Example: see GEOM_TestAll.py
12856             ID = self.InsertOp.LoadTexture(Path)
12857             RaiseIfFailed("LoadTexture", self.InsertOp)
12858             return ID
12859
12860         ## Get internal name of the object based on its study entry
12861         #  @note This method does not provide an unique identifier of the geometry object.
12862         #  @note This is internal function of GEOM component, though it can be used outside it for
12863         #  appropriate reason (e.g. for identification of geometry object).
12864         #  @param obj geometry object
12865         #  @return unique object identifier
12866         #  @ingroup l1_geomBuilder_auxiliary
12867         def getObjectID(self, obj):
12868             """
12869             Get internal name of the object based on its study entry.
12870             Note: this method does not provide an unique identifier of the geometry object.
12871             It is an internal function of GEOM component, though it can be used outside GEOM for
12872             appropriate reason (e.g. for identification of geometry object).
12873
12874             Parameters:
12875                 obj geometry object
12876
12877             Returns:
12878                 unique object identifier
12879             """
12880             ID = ""
12881             entry = salome.ObjectToID(obj)
12882             if entry is not None:
12883                 lst = entry.split(":")
12884                 if len(lst) > 0:
12885                     ID = lst[-1] # -1 means last item in the list
12886                     return "GEOM_" + ID
12887             return ID
12888
12889
12890
12891         ## Add marker texture. @a Width and @a Height parameters
12892         #  specify width and height of the texture in pixels.
12893         #  If @a RowData is @c True, @a Texture parameter should represent texture data
12894         #  packed into the byte array. If @a RowData is @c False (default), @a Texture
12895         #  parameter should be unpacked string, in which '1' symbols represent opaque
12896         #  pixels and '0' represent transparent pixels of the texture bitmap.
12897         #
12898         #  @param Width texture width in pixels
12899         #  @param Height texture height in pixels
12900         #  @param Texture texture data
12901         #  @param RowData if @c True, @a Texture data are packed in the byte stream
12902         #  @return unique texture identifier
12903         #  @ingroup l1_geomBuilder_auxiliary
12904         @ManageTransactions("InsertOp")
12905         def AddTexture(self, Width, Height, Texture, RowData=False):
12906             """
12907             Add marker texture. Width and Height parameters
12908             specify width and height of the texture in pixels.
12909             If RowData is True, Texture parameter should represent texture data
12910             packed into the byte array. If RowData is False (default), Texture
12911             parameter should be unpacked string, in which '1' symbols represent opaque
12912             pixels and '0' represent transparent pixels of the texture bitmap.
12913
12914             Parameters:
12915                 Width texture width in pixels
12916                 Height texture height in pixels
12917                 Texture texture data
12918                 RowData if True, Texture data are packed in the byte stream
12919
12920             Returns:
12921                 return unique texture identifier
12922             """
12923             if not RowData: Texture = PackData(Texture)
12924             ID = self.InsertOp.AddTexture(Width, Height, Texture)
12925             RaiseIfFailed("AddTexture", self.InsertOp)
12926             return ID
12927
12928         ## Creates a new folder object. It is a container for any GEOM objects.
12929         #  @param Name name of the container
12930         #  @param Father parent object. If None,
12931         #         folder under 'Geometry' root object will be created.
12932         #  @return a new created folder
12933         #  @ingroup l1_publish_data
12934         def NewFolder(self, Name, Father=None):
12935             """
12936             Create a new folder object. It is an auxiliary container for any GEOM objects.
12937
12938             Parameters:
12939                 Name name of the container
12940                 Father parent object. If None,
12941                 folder under 'Geometry' root object will be created.
12942
12943             Returns:
12944                 a new created folder
12945             """
12946             if not Father: Father = self.father
12947             return self.CreateFolder(Name, Father)
12948
12949         ## Move object to the specified folder
12950         #  @param Object object to move
12951         #  @param Folder target folder
12952         #  @ingroup l1_publish_data
12953         def PutToFolder(self, Object, Folder):
12954             """
12955             Move object to the specified folder
12956
12957             Parameters:
12958                 Object object to move
12959                 Folder target folder
12960             """
12961             self.MoveToFolder(Object, Folder)
12962             pass
12963
12964         ## Move list of objects to the specified folder
12965         #  @param ListOfSO list of objects to move
12966         #  @param Folder target folder
12967         #  @ingroup l1_publish_data
12968         def PutListToFolder(self, ListOfSO, Folder):
12969             """
12970             Move list of objects to the specified folder
12971
12972             Parameters:
12973                 ListOfSO list of objects to move
12974                 Folder target folder
12975             """
12976             self.MoveListToFolder(ListOfSO, Folder)
12977             pass
12978
12979         ## @addtogroup l2_field
12980         ## @{
12981
12982         ## Creates a field
12983         #  @param shape the shape the field lies on
12984         #  @param name the field name
12985         #  @param type type of field data: 0 - bool, 1 - int, 2 - double, 3 - string
12986         #  @param dimension dimension of the shape the field lies on
12987         #         0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
12988         #  @param componentNames names of components
12989         #  @return a created field
12990         @ManageTransactions("FieldOp")
12991         def CreateField(self, shape, name, type, dimension, componentNames):
12992             """
12993             Creates a field
12994
12995             Parameters:
12996                 shape the shape the field lies on
12997                 name  the field name
12998                 type  type of field data
12999                 dimension dimension of the shape the field lies on
13000                           0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13001                 componentNames names of components
13002
13003             Returns:
13004                 a created field
13005             """
13006             if isinstance( type, int ):
13007                 if type < 0 or type > 3:
13008                     raise RuntimeError, "CreateField : Error: data type must be within [0-3] range"
13009                 type = [GEOM.FDT_Bool,GEOM.FDT_Int,GEOM.FDT_Double,GEOM.FDT_String][type]
13010
13011             f = self.FieldOp.CreateField( shape, name, type, dimension, componentNames)
13012             RaiseIfFailed("CreateField", self.FieldOp)
13013             global geom
13014             geom._autoPublish( f, "", name)
13015             return f
13016
13017         ## Removes a field from the GEOM component
13018         #  @param field the field to remove
13019         def RemoveField(self, field):
13020             "Removes a field from the GEOM component"
13021             global geom
13022             if isinstance( field, GEOM._objref_GEOM_Field ):
13023                 geom.RemoveObject( field )
13024             elif isinstance( field, geomField ):
13025                 geom.RemoveObject( field.field )
13026             else:
13027                 raise RuntimeError, "RemoveField() : the object is not a field"
13028             return
13029
13030         ## Returns number of fields on a shape
13031         @ManageTransactions("FieldOp")
13032         def CountFields(self, shape):
13033             "Returns number of fields on a shape"
13034             nb = self.FieldOp.CountFields( shape )
13035             RaiseIfFailed("CountFields", self.FieldOp)
13036             return nb
13037
13038         ## Returns all fields on a shape
13039         @ManageTransactions("FieldOp")
13040         def GetFields(self, shape):
13041             "Returns all fields on a shape"
13042             ff = self.FieldOp.GetFields( shape )
13043             RaiseIfFailed("GetFields", self.FieldOp)
13044             return ff
13045
13046         ## Returns a field on a shape by its name
13047         @ManageTransactions("FieldOp")
13048         def GetField(self, shape, name):
13049             "Returns a field on a shape by its name"
13050             f = self.FieldOp.GetField( shape, name )
13051             RaiseIfFailed("GetField", self.FieldOp)
13052             return f
13053
13054         # end of l2_field
13055         ## @}
13056
13057
13058 import omniORB
13059 # Register the new proxy for GEOM_Gen
13060 omniORB.registerObjref(GEOM._objref_GEOM_Gen._NP_RepositoryId, geomBuilder)
13061
13062
13063 ## Field on Geometry
13064 #  @ingroup l2_field
13065 class geomField( GEOM._objref_GEOM_Field ):
13066
13067     def __init__(self):
13068         GEOM._objref_GEOM_Field.__init__(self)
13069         self.field = GEOM._objref_GEOM_Field
13070         return
13071
13072     ## Returns the shape the field lies on
13073     def getShape(self):
13074         "Returns the shape the field lies on"
13075         return self.field.GetShape(self)
13076
13077     ## Returns the field name
13078     def getName(self):
13079         "Returns the field name"
13080         return self.field.GetName(self)
13081
13082     ## Returns type of field data as integer [0-3]
13083     def getType(self):
13084         "Returns type of field data"
13085         return self.field.GetDataType(self)._v
13086
13087     ## Returns type of field data:
13088     #  one of GEOM.FDT_Bool, GEOM.FDT_Int, GEOM.FDT_Double, GEOM.FDT_String
13089     def getTypeEnum(self):
13090         "Returns type of field data"
13091         return self.field.GetDataType(self)
13092
13093     ## Returns dimension of the shape the field lies on:
13094     #  0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
13095     def getDimension(self):
13096         """Returns dimension of the shape the field lies on:
13097         0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape"""
13098         return self.field.GetDimension(self)
13099
13100     ## Returns names of components
13101     def getComponents(self):
13102         "Returns names of components"
13103         return self.field.GetComponents(self)
13104
13105     ## Adds a time step to the field
13106     #  @param step the time step number further used as the step identifier
13107     #  @param stamp the time step time
13108     #  @param values the values of the time step
13109     def addStep(self, step, stamp, values):
13110         "Adds a time step to the field"
13111         stp = self.field.AddStep( self, step, stamp )
13112         if not stp:
13113             raise RuntimeError, \
13114                   "Field.addStep() : Error: step %s already exists in this field"%step
13115         global geom
13116         geom._autoPublish( stp, "", "Step %s, %s"%(step,stamp))
13117         self.setValues( step, values )
13118         return stp
13119
13120     ## Remove a time step from the field
13121     def removeStep(self,step):
13122         "Remove a time step from the field"
13123         stepSO = None
13124         try:
13125             stepObj = self.field.GetStep( self, step )
13126             if stepObj:
13127                 stepSO = geom.myStudy.FindObjectID( stepObj.GetStudyEntry() )
13128         except:
13129             #import traceback
13130             #traceback.print_exc()
13131             pass
13132         self.field.RemoveStep( self, step )
13133         if stepSO:
13134             geom.myBuilder.RemoveObjectWithChildren( stepSO )
13135         return
13136
13137     ## Returns number of time steps in the field
13138     def countSteps(self):
13139         "Returns number of time steps in the field"
13140         return self.field.CountSteps(self)
13141
13142     ## Returns a list of time step IDs in the field
13143     def getSteps(self):
13144         "Returns a list of time step IDs in the field"
13145         return self.field.GetSteps(self)
13146
13147     ## Returns a time step by its ID
13148     def getStep(self,step):
13149         "Returns a time step by its ID"
13150         stp = self.field.GetStep(self, step)
13151         if not stp:
13152             raise RuntimeError, "Step %s is missing from this field"%step
13153         return stp
13154
13155     ## Returns the time of the field step
13156     def getStamp(self,step):
13157         "Returns the time of the field step"
13158         return self.getStep(step).GetStamp()
13159
13160     ## Changes the time of the field step
13161     def setStamp(self, step, stamp):
13162         "Changes the time of the field step"
13163         return self.getStep(step).SetStamp(stamp)
13164
13165     ## Returns values of the field step
13166     def getValues(self, step):
13167         "Returns values of the field step"
13168         return self.getStep(step).GetValues()
13169
13170     ## Changes values of the field step
13171     def setValues(self, step, values):
13172         "Changes values of the field step"
13173         stp = self.getStep(step)
13174         errBeg = "Field.setValues(values) : Error: "
13175         try:
13176             ok = stp.SetValues( values )
13177         except Exception, e:
13178             excStr = str(e)
13179             if excStr.find("WrongPythonType") > 0:
13180                 raise RuntimeError, errBeg +\
13181                       "wrong type of values, %s values are expected"%str(self.getTypeEnum())[4:]
13182             raise RuntimeError, errBeg + str(e)
13183         if not ok:
13184             nbOK = self.field.GetArraySize(self)
13185             nbKO = len(values)
13186             if nbOK != nbKO:
13187                 raise RuntimeError, errBeg + "len(values) must be %s but not %s"%(nbOK,nbKO)
13188             else:
13189                 raise RuntimeError, errBeg + "failed"
13190         return
13191
13192     pass # end of class geomField
13193
13194 # Register the new proxy for GEOM_Field
13195 omniORB.registerObjref(GEOM._objref_GEOM_Field._NP_RepositoryId, geomField)
13196
13197
13198 ## Create a new geomBuilder instance.The geomBuilder class provides the Python
13199 #  interface to GEOM operations.
13200 #
13201 #  Typical use is:
13202 #  \code
13203 #    import salome
13204 #    salome.salome_init()
13205 #    from salome.geom import geomBuilder
13206 #    geompy = geomBuilder.New(salome.myStudy)
13207 #  \endcode
13208 #  @param  study     SALOME study, generally obtained by salome.myStudy.
13209 #  @param  instance  CORBA proxy of GEOM Engine. If None, the default Engine is used.
13210 #  @return geomBuilder instance
13211 def New( study, instance=None):
13212     """
13213     Create a new geomBuilder instance.The geomBuilder class provides the Python
13214     interface to GEOM operations.
13215
13216     Typical use is:
13217         import salome
13218         salome.salome_init()
13219         from salome.geom import geomBuilder
13220         geompy = geomBuilder.New(salome.myStudy)
13221
13222     Parameters:
13223         study     SALOME study, generally obtained by salome.myStudy.
13224         instance  CORBA proxy of GEOM Engine. If None, the default Engine is used.
13225     Returns:
13226         geomBuilder instance
13227     """
13228     #print "New geomBuilder ", study, instance
13229     global engine
13230     global geom
13231     global doLcc
13232     engine = instance
13233     if engine is None:
13234       doLcc = True
13235     geom = geomBuilder()
13236     assert isinstance(geom,geomBuilder), "Geom engine class is %s but should be geomBuilder.geomBuilder. Import geomBuilder before creating the instance."%geom.__class__
13237     geom.init_geom(study)
13238     return geom
13239
13240
13241 # Register methods from the plug-ins in the geomBuilder class 
13242 plugins_var = os.environ.get( "GEOM_PluginsList" )
13243
13244 plugins = None
13245 if plugins_var is not None:
13246     plugins = plugins_var.split( ":" )
13247     plugins=filter(lambda x: len(x)>0, plugins)
13248 if plugins is not None:
13249     for pluginName in plugins:
13250         pluginBuilderName = pluginName + "Builder"
13251         try:
13252             exec( "from salome.%s.%s import *" % (pluginName, pluginBuilderName))
13253         except Exception, e:
13254             from salome_utils import verbose
13255             print "Exception while loading %s: %s" % ( pluginBuilderName, e )
13256             continue
13257         exec( "from salome.%s import %s" % (pluginName, pluginBuilderName))
13258         plugin = eval( pluginBuilderName )
13259         
13260         # add methods from plugin module to the geomBuilder class
13261         for k in dir( plugin ):
13262             if k[0] == '_': continue
13263             method = getattr( plugin, k )
13264             if type( method ).__name__ == 'function':
13265                 if not hasattr( geomBuilder, k ):
13266                     setattr( geomBuilder, k, method )
13267                 pass
13268             pass
13269         del pluginName
13270         pass
13271     pass