1 // Copyright (C) 2005 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // File : GEOM_Gen.idl
21 // Author : Sergey RUIN
26 #include "SALOME_Exception.idl"
27 #include "SALOME_Component.idl"
28 #include "SALOMEDS.idl"
29 #include "SALOMEDS_Attributes.idl"
31 #include "SALOME_GenericObj.idl"
36 * Topological types of shapes (like Open Cascade types)
38 enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
39 FACE, WIRE, EDGE, VERTEX, SHAPE };
43 * State of shape relatively geometrical surface like plane, sphere or cylinder.
44 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
48 /*! Shape is on surface */
52 * Shape is in the direction defined by the normal and not on surface.
53 * For plane it means above the plane,
54 * For sphere and cylinder it means outside of volume, bounded by the surface.
59 * Shape is in the direction defined by the normal and on surface.
65 * Complementary to ONOUT.
66 * For plane it means below the plane,
67 * For sphere and cylinder it means inside the volume, bounded by the surface
68 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
73 * Complementary to OUT.
80 * Kind of method to find inside one main shape some subshapes,
81 * corresponding to other given shape (its argument)
82 * Is used in functions GEOM_Gen.RestoreSubShapes<xxx>()
84 enum find_shape_method
86 /*! Use GetInPlace functionality. Suits all cases, except transformations */
89 /*! To be used only for transformation result, to find subshapes of argument.
90 * Only this method can be used after transformation.
94 /*! To find only shared subshapes, not modified by the operation */
97 /*! Use GetShapesOnShape method (can work only on solids) */
100 /*! Use GetInPlaceByHistory method (can work only after Partition) */
101 FSM_GetInPlaceByHistory
105 typedef sequence<string> string_array;
106 typedef sequence<short> short_array;
107 typedef sequence<long> ListOfLong;
108 typedef sequence<double> ListOfDouble;
110 interface GEOM_Object;
112 typedef sequence<GEOM_Object> ListOfGO;
115 * GEOM_Object: interface of geometric object
117 interface GEOM_Object : SALOME::GenericObj
121 * Get an entry of the object in GEOM component.
126 * Get ID of study, where the object is created.
131 * Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
136 * Get a <VAR>shape_type</VAR> of the object value.
138 shape_type GetShapeType();
141 * Set name of the object.
142 * \param theName is a name which will be associated with this object.
144 void SetName (in string theName);
147 * Get name of the object associated with this object.
152 * Set color of the object.
153 * \param theColor is a color of the object.
155 void SetColor(in SALOMEDS::Color theColor);
158 * Get color of the object.
160 SALOMEDS::Color GetColor();
163 * Toggle auto color mode on the object.
164 * \param theAtoColor is a flag which toggles auto color mode.
166 void SetAutoColor(in boolean theAutoColor);
169 * Get flag of object's auto color mode.
171 boolean GetAutoColor();
174 * Set a Study entry where this object was published.
176 void SetStudyEntry (in string theEntry);
179 * Get a Study entry where this object was published.
181 string GetStudyEntry();
184 * Get a list of all GEOM objects on which were the arguments
185 * when this object was constructed and modified.
186 * \note This method is supposed to be used by GUI only.
188 ListOfGO GetDependency();
191 * Get a list of GEOM objects on which the last function that created or modified the object depends.
192 * \note This method is supposed to be used by GUI only.
194 ListOfGO GetLastDependency();
197 * Get the TopoDS_Shape, for colocated case only.
199 long long getShape();
202 ######################################################################
203 * Internal methods (For sub shape identification)
204 ######################################################################
208 * Get geometric shape of the object as a byte stream
210 SALOMEDS::TMPFile GetShapeStream();
213 * Returns True if this object is not a sub shape of another object.
215 boolean IsMainShape();
218 * Get a list of ID's of sub shapes in the main shape.
219 * \note Internal method, suppopsed to be used only by GEOM_Client
221 ListOfLong GetSubShapeIndices();
224 * Get a main shape object to which this object is a sub shape
225 * \note Internal method, suppopsed to be used only by GEOM_Client
227 GEOM_Object GetMainShape();
230 * Return true if geom object representes a shape.
231 * For example, method return false for GEOM_MARKER
238 * GEOM_IOperations: basic methods of all geometric operations
240 interface GEOM_IOperations : SALOME::GenericObj
243 * To know, if the operation was successfully performed
248 * Set the operation error code
249 * \param theErrorID is a string describing the error occured
250 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
252 void SetErrorCode (in string theErrorID);
255 * Get the operation error code
257 string GetErrorCode();
260 * Get ID of study, where the operation is defined
265 * Opens a new transaction
267 void StartOperation();
270 * Closes the previously opened trasaction
272 void FinishOperation();
275 * Aborts the previously opened transaction
277 void AbortOperation();
281 * GEOM_IBasicOperations: interface for basic geometry creation
282 * (Point, Vector, Plane, Marker)
284 interface GEOM_IBasicOperations : GEOM_IOperations
287 * Create point by three coordinates.
288 * \param theX The X coordinate of the point.
289 * \param theY The Y coordinate of the point.
290 * \param theZ The Z coordinate of the point.
291 * \return New GEOM_Object, containing the created point.
293 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
296 * Create a point, distant from the referenced point
297 * on the given distances along the coordinate axes.
298 * \param theReference The referenced point.
299 * \param theX Displacement from the referenced point along OX axis.
300 * \param theY Displacement from the referenced point along OY axis.
301 * \param theZ Displacement from the referenced point along OZ axis.
302 * \return New GEOM_Object, containing the created point.
304 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
305 in double theX, in double theY, in double theZ);
308 * Create a point, corresponding to the given parameter on the given curve.
309 * \param theRefCurve The referenced curve.
310 * \param theParameter Value of parameter on the referenced curve.
311 * \return New GEOM_Object, containing the created point.
313 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
314 in double theParameter);
317 * Create a point, corresponding to the given parameters on the
319 * \param theRefSurf The referenced surface.
320 * \param theUParameter Value of U-parameter on the referenced surface.
321 * \param theVParameter Value of V-parameter on the referenced surface.
322 * \return New GEOM_Object, containing the created point.
324 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
325 in double theUParameter,
326 in double theVParameter);
329 * Create a point, on two lines intersection.
330 * \param theRefLine1, theRefLine2 The referenced lines.
331 * \return New GEOM_Object, containing the created point.
333 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
334 in GEOM_Object theRefLine2);
337 * Create a vector, corresponding to tangent to the given parameter on the given curve.
338 * \param theRefCurve The referenced curve.
339 * \param theParameter Value of parameter on the referenced curve.This value should be have value
340 * \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
341 * \last parameter of curve.
342 * \return New GEOM_Object, containing the created point.
344 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
345 in double theParameter);
348 * Create a vector with the given components.
349 * \param theDX X component of the vector.
350 * \param theDY Y component of the vector.
351 * \param theDZ Z component of the vector.
352 * \return New GEOM_Object, containing the created vector.
354 GEOM_Object MakeVectorDXDYDZ (in double theDX,
359 * Create a vector between two points.
360 * \param thePnt1 Start point for the vector.
361 * \param thePnt2 End point for the vector.
362 * \return New GEOM_Object, containing the created vector.
364 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
367 * Create a line, passing through the given point
368 * and parrallel to the given direction
369 * \param thePnt Point. The resulting line will pass through it.
370 * \param theDir Direction. The resulting line will be parallel to it.
371 * \return New GEOM_Object, containing the created line.
373 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
376 * Create a line, passing through the given points
377 * \param thePnt1 First of two points, defining the line.
378 * \param thePnt2 Second of two points, defining the line.
379 * \return New GEOM_Object, containing the created line.
381 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
384 * Create a line, given by two faces intersection.
385 * \param theFace1 First of two faces, defining the line.
386 * \param theFace2 Second of two faces, defining the line.
387 * \return New GEOM_Object, containing the created line.
389 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
392 * Create a plane, passing through the three given points
393 * \param thePnt1 First of three points, defining the plane.
394 * \param thePnt2 Second of three points, defining the plane.
395 * \param thePnt3 Fird of three points, defining the plane.
396 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
397 * \return New GEOM_Object, containing the created plane.
399 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
400 in GEOM_Object thePnt2,
401 in GEOM_Object thePnt3,
402 in double theTrimSize);
405 * Create a plane, passing through the given point
406 * and normal to the given vector.
407 * \param thePnt Point, the plane has to pass through.
408 * \param theVec Vector, defining the plane normal direction.
409 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
410 * \return New GEOM_Object, containing the created plane.
412 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
413 in GEOM_Object theVec,
414 in double theTrimSize);
417 * Create a plane, similar to the existing one, but with another size of representing face.
418 * \param theFace Referenced plane or LCS(Marker).
419 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
420 * \return New GEOM_Object, containing the created plane.
422 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
423 in double theTrimSize);
426 * Create a local coordinate system.
427 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
428 * \param theXDX,theXDY,theXDZ Three components of OX direction
429 * \param theYDX,theYDY,theYDZ Three components of OY direction
430 * \return New GEOM_Object, containing the created coordinate system.
432 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
433 in double theXDX, in double theXDY, in double theXDZ,
434 in double theYDX, in double theYDY, in double theYDZ);
437 * Create a tangent plane to specified face in the point with specified parameters.
438 * Values of parameters should be between 0. and 1.0
439 * \param theFace - face for which tangent plane shuold be built.
440 * \param theParameterU - value of parameter by U
441 * \param theParameterV - value of parameter Vthe
442 * \param theTrimSize - defines sizes of created face
443 * \return New GEOM_Object, containing the face built on tangent plane.
445 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
446 in double theParameterU,
447 in double theParameterV,
448 in double theTrimSize);
451 interface GEOM_ITransformOperations : GEOM_IOperations
454 * Translate the given object along the vector, specified by its end points.
455 * \param theObject The object to be translated.
456 * \param thePoint1 Start point of translation vector.
457 * \param thePoint2 End point of translation vector.
460 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
461 in GEOM_Object thePoint1,
462 in GEOM_Object thePoint2);
465 * Translate the given object along the vector, specified
466 * by its end points, creating its copy before the translation.
467 * \param theObject The object to be translated.
468 * \param thePoint1 Start point of translation vector.
469 * \param thePoint2 End point of translation vector.
470 * \return New GEOM_Object, containing the translated object.
472 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
473 in GEOM_Object thePoint1,
474 in GEOM_Object thePoint2);
477 * Translate the given object along the vector, specified by its components.
478 * \param theObject The object to be translated.
479 * \param theDX,theDY,theDZ Components of translation vector.
482 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
483 in double theDX, in double theDY, in double theDZ);
486 * Translate the given object along the vector, specified
487 * by its components, creating its copy before the translation.
488 * \param theObject The object to be translated.
489 * \param theDX,theDY,theDZ Components of translation vector.
490 * \return New GEOM_Object, containing the translated object.
492 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
493 in double theDX, in double theDY, in double theDZ);
497 * Translate the given object along the given vector.
498 * \param theObject The object to be translated.
499 * \param theVector Translation vector, giving both direction and distance.
502 GEOM_Object TranslateVector (in GEOM_Object theObject,
503 in GEOM_Object theVector);
506 * Translate the given object along the given vector,
507 * creating its copy before the translation.
508 * \param theObject The object to be translated.
509 * \param theVector Translation vector, giving both direction and distance.
510 * \return New GEOM_Object, containing the translated object.
512 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
513 in GEOM_Object theVector);
516 * Translate the given object along the given vector on given distance,
517 * creating its copy before the translation.
518 * \param theObject The object to be translated.
519 * \param theVector Translation vector, giving a direction.
520 * \param theDistance Translation distance, giving a distance.
521 * \param theCope Translation copy, creating its copy if true.
522 * \return New GEOM_Object, containing the translated object.
524 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
525 in GEOM_Object theVector,
526 in double theDistance,
530 * Translate the given object along the given vector a given number times
531 * \param theObject The object to be translated.
532 * \param theVector Direction of the translation.
533 * \param theStep Distance to translate on.
534 * \param theNbTimes Quantity of translations to be done.
535 * \return New GEOM_Object, containing compound of all
536 * the shapes, obtained after each translation.
538 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
539 in GEOM_Object theVector,
544 * Conseqently apply two specified translations to theObject specified number of times.
545 * \param theObject The object to be translated.
546 * \param theVector1 Direction of the first translation.
547 * \param theStep1 Step of the first translation.
548 * \param theNbTimes1 Quantity of translations to be done along theVector1.
549 * \param theVector2 Direction of the second translation.
550 * \param theStep2 Step of the second translation.
551 * \param theNbTimes2 Quantity of translations to be done along theVector2.
552 * \return New GEOM_Object, containing compound of all
553 * the shapes, obtained after each translation.
555 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
556 in GEOM_Object theVector1,
559 in GEOM_Object theVector2,
561 in long theNbTimes2);
564 * Rotate given object around vector perpendicular to plane containing three points.
565 * \param theObject The object to be rotated.
566 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
567 * containing the three points.
568 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
571 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
572 in GEOM_Object theCentPoint,
573 in GEOM_Object thePoint1,
574 in GEOM_Object thePoint2);
578 * Rotate given object around vector perpendicular to plane containing three points.
579 * Creating its copy before the rotatation.
580 * \param theObject The object to be rotated.
581 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
582 * containing the three points.
583 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
584 * \return New GEOM_Object, containing the rotated object.
586 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
587 in GEOM_Object theCentPoint,
588 in GEOM_Object thePoint1,
589 in GEOM_Object thePoint2);
592 * Rotate the given object around the given axis on the given angle.
593 * \param theObject The object to be rotated.
594 * \param theAxis Rotation axis.
595 * \param theAngle Rotation angle in radians.
598 GEOM_Object Rotate (in GEOM_Object theObject,
599 in GEOM_Object theAxis,
604 * Rotate the given object around the given axis
605 * on the given angle, creating its copy before the rotatation.
606 * \param theObject The object to be rotated.
607 * \param theAxis Rotation axis.
608 * \param theAngle Rotation angle in radians.
609 * \return New GEOM_Object, containing the rotated object.
611 GEOM_Object RotateCopy (in GEOM_Object theObject,
612 in GEOM_Object theAxis,
617 * Rotate the given object around the given axis a given number times.
618 * Rotation angle will be 2*PI/theNbTimes.
619 * \param theObject The object to be rotated.
620 * \param theAxis The rotation axis.
621 * \param theNbTimes Quantity of rotations to be done.
622 * \return New GEOM_Object, containing compound of all the
623 * shapes, obtained after each rotation.
625 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
626 in GEOM_Object theAxis,
630 * Rotate the given object around the
631 * given axis on the given angle a given number
632 * times and multi-translate each rotation result.
633 * Translation direction passes through center of gravity
634 * of rotated shape and its projection on the rotation axis.
635 * \param theObject The object to be rotated.
636 * \param theAxis Rotation axis.
637 * \param theAngle Rotation angle in graduces.
638 * \param theNbTimes1 Quantity of rotations to be done.
639 * \param theStep Translation distance.
640 * \param theNbTimes2 Quantity of translations to be done.
641 * \return New GEOM_Object, containing compound of all the
642 * shapes, obtained after each transformation.
644 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
645 in GEOM_Object theAxis,
649 in long theNbTimes2);
652 * Replace the given object by an object,
653 * symmetrical to it relatively the given plane.
654 * \param theObject The object to be mirrored.
655 * \param thePlane Plane of symmetry.
657 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
660 * Create an object, symmetrical
661 * to the given one relatively the given plane.
662 * \param theObject The object to be mirrored.
663 * \param thePlane Plane of symmetry.
664 * \return New GEOM_Object, containing the mirrored shape.
666 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
669 * Replace the given object by an object,
670 * symmetrical to it relatively the given axis.
671 * \param theObject The object to be mirrored.
672 * \param theAxis Axis of symmetry.
675 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
678 * Create an object, symmetrical
679 * to the given one relatively the given axis.
680 * \param theObject The object to be mirrored.
681 * \param theAxis Axis of symmetry.
682 * \return New GEOM_Object, containing the mirrored object.
684 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
687 * Replace the given object by an object, symmetrical to it relatively the given point.
688 * \param theObject The object to be mirrored.
689 * \param thePoint Point of symmetry.
692 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
695 * Create an object, symmetrical to the given one relatively the given point.
696 * \param theObject The object to be mirrored.
697 * \param thePoint Point of symmetry.
698 * \return New GEOM_Object, containing the mirrored object.
700 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
703 * Replace the given object by its offset.
704 * \param theObject The base object for the offset.
705 * \param theOffset Offset value.
708 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
711 * Create new object as offset of the given one.
712 * \param theObject The base object for the offset.
713 * \param theOffset Offset value.
714 * \return New GEOM_Object, containing the offset object.
716 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
719 * Scale the given object by the factor.
720 * \param theObject The object to be scaled.
721 * \param thePoint Center point for scaling.
722 * \param theFactor Scaling factor value.
725 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
726 in double theFactor);
729 * Scale the given object by the factor, creating its copy before the scaling.
730 * \param theObject The object to be scaled.
731 * \param thePoint Center point for scaling.
732 * \param theFactor Scaling factor value.
733 * \return New GEOM_Object, containing the scaled shape.
735 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
736 in double theFactor);
739 * Scale the given object by different factors along coordinate axes.
740 * \param theObject The object to be scaled.
741 * \param thePoint Center point for scaling.
742 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
745 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
746 in GEOM_Object thePoint,
747 in double theFactorX,
748 in double theFactorY,
749 in double theFactorZ);
752 * Scale the given object by different factors along coordinate axes,
753 * creating its copy before the scaling.
754 * \param theObject The object to be scaled.
755 * \param thePoint Center point for scaling.
756 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
757 * \return New GEOM_Object, containing the scaled shape.
759 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
760 in GEOM_Object thePoint,
761 in double theFactorX,
762 in double theFactorY,
763 in double theFactorZ);
766 * Modify the Location of the given object by LCS.
767 * \param theObject The object to be displaced.
768 * \param theStartLCS Coordinate system to perform displacement from it.
769 * If \a theStartLCS is NULL, displacement
770 * will be performed from global CS.
771 * If \a theObject itself is used as \a theStartLCS,
772 * its location will be changed to \a theEndLCS.
773 * \param theEndLCS Coordinate system to perform displacement to it.
776 GEOM_Object PositionShape (in GEOM_Object theObject,
777 in GEOM_Object theStartLCS,
778 in GEOM_Object theEndLCS);
781 * Modify the Location of the given object by LCS,
782 * creating its copy before the setting.
783 * \param theObject The object to be displaced.
784 * \param theStartLCS Coordinate system to perform displacement from it.
785 * If \a theStartLCS is NULL, displacement
786 * will be performed from global CS.
787 * If \a theObject itself is used as \a theStartLCS,
788 * its location will be changed to \a theEndLCS.
789 * \param theEndLCS Coordinate system to perform displacement to it.
790 * \return New GEOM_Object, containing the displaced shape.
792 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
793 in GEOM_Object theStartLCS,
794 in GEOM_Object theEndLCS);
798 * GEOM_I3DPrimOperations: Interface for 3D primitives creation
799 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
800 * Pipe (extrusion along contour), Revolution, Solid (from shell).
802 interface GEOM_I3DPrimOperations : GEOM_IOperations
805 * Create a box with specified dimensions along the coordinate axes
806 * and with edges, parallel to the coordinate axes.
807 * Center of the box will be at point (DX/2, DY/2, DZ/2).
808 * \param theDX Length of Box edges, parallel to OX axis.
809 * \param theDY Length of Box edges, parallel to OY axis.
810 * \param theDZ Length of Box edges, parallel to OZ axis.
811 * \return New GEOM_Object, containing the created box.
813 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
816 * Create a box with two specified opposite vertices,
817 * and with edges, parallel to the coordinate axes
818 * \param thePnt1 First of two opposite vertices.
819 * \param thePnt2 Second of two opposite vertices.
820 * \return New GEOM_Object, containing the created box.
822 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
825 * Create a cylinder with given radius and height at
826 * the origin of coordinate system. Axis of the cylinder
827 * will be collinear to the OZ axis of the coordinate system.
828 * \param theR Cylinder radius.
829 * \param theH Cylinder height.
830 * \return New GEOM_Object, containing the created cylinder.
832 GEOM_Object MakeCylinderRH (in double theR, in double theH);
835 * Create a cylinder with given base point, axis, radius and height.
836 * \param thePnt Central point of cylinder base.
837 * \param theAxis Cylinder axis.
838 * \param theR Cylinder radius.
839 * \param theH Cylinder height.
840 * \return New GEOM_Object, containing the created cylinder.
842 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
843 in GEOM_Object theAxis,
848 * Create a cone with given height and radiuses at
849 * the origin of coordinate system. Axis of the cone will
850 * be collinear to the OZ axis of the coordinate system.
851 * \param theR1 Radius of the first cone base.
852 * \param theR2 Radius of the second cone base.
853 * \note If both radiuses are non-zero, the cone will be truncated.
854 * \note If the radiuses are equal, a cylinder will be created instead.
855 * \param theH Cone height.
856 * \return New GEOM_Object, containing the created cone.
858 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
861 * Create a cone with given base point, axis, height and radiuses.
862 * \param thePnt Central point of the first cone base.
863 * \param theAxis Cone axis.
864 * \param theR1 Radius of the first cone base.
865 * \param theR2 Radius of the second cone base.
866 * \note If both radiuses are non-zero, the cone will be truncated.
867 * \note If the radiuses are equal, a cylinder will be created instead.
868 * \param theH Cone height.
869 * \return New GEOM_Object, containing the created cone.
871 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
872 in GEOM_Object theAxis,
878 * Create a torus with given radiuses at the origin of coordinate system.
879 * \param theRMajor Torus major radius.
880 * \param theRMinor Torus minor radius.
881 * \return New GEOM_Object, containing the created torus.
883 GEOM_Object MakeTorusRR (in double theRMajor,
884 in double theRMinor);
887 * Create a torus with given center, normal vector and radiuses.
888 * \param thePnt Torus central point.
889 * \param theVec Torus axis of symmetry.
890 * \param theRMajor Torus major radius.
891 * \param theRMinor Torus minor radius.
892 * \return New GEOM_Object, containing the created torus.
894 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
895 in GEOM_Object theVec,
897 in double theRMinor);
900 * Create a sphere with given radius at the origin of coordinate system.
901 * \param theR Sphere radius.
902 * \return New GEOM_Object, containing the created sphere.
904 GEOM_Object MakeSphereR (in double theR);
907 * Create a sphere with given center and radius.
908 * \param thePnt Sphere center.
909 * \param theR Sphere radius.
910 * \return New GEOM_Object, containing the created .
912 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
915 * Create a shape by extrusion of the base shape along the vector,
916 * i.e. all the space, transfixed by the base shape during its translation
917 * along the vector on the given distance.
918 * \param theBase Base shape to be extruded.
919 * \param theVec Direction of extrusion.
920 * \param theH Prism dimension along theVec.
921 * \return New GEOM_Object, containing the created prism.
923 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
924 in GEOM_Object theVec,
926 /* The Same Prism but in 2 directions (forward&backward) */
927 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
928 in GEOM_Object theVec,
932 * Create a shape by extrusion of the base shape along a vector, defined by two points.
933 * \param theBase Base shape to be extruded.
934 * \param thePoint1 First end of extrusion vector.
935 * \param thePoint2 Second end of extrusion vector.
936 * \return New GEOM_Object, containing the created prism.
938 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
939 in GEOM_Object thePoint1,
940 in GEOM_Object thePoint2);
941 /* The same prism but in two directions forward&backward */
942 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
943 in GEOM_Object thePoint1,
944 in GEOM_Object thePoint2);
947 * Create a shape by extrusion of the base shape along
948 * the path shape. The path shape can be a wire or an edge.
949 * \param theBase Base shape to be extruded.
950 * \param thePath Path shape to extrude the base shape along it.
951 * \return New GEOM_Object, containing the created pipe.
953 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
956 * Create a shape by revolution of the base shape around the axis
957 * on the given angle, i.e. all the space, transfixed by the base
958 * shape during its rotation around the axis on the given angle.
959 * \param theBase Base shape to be rotated.
960 * \param theAxis Rotation axis.
961 * \param theAngle Rotation angle in radians.
962 * \return New GEOM_Object, containing the created revolution.
964 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
965 in GEOM_Object theAxis,
967 /* The Same Revolution but in both ways forward&backward */
968 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
969 in GEOM_Object theAxis,
973 * Create a filling from the given compound of contours.
974 * \param theMinDeg a minimal degree of BSpline surface to create
975 * \param theMaxDeg a maximal degree of BSpline surface to create
976 * \param theTol2D a 2d tolerance to be reached
977 * \param theTol3D a 3d tolerance to be reached
978 * \param theNbIter a number of iteration of approximation algorithm
979 * \return New GEOM_Object, containing the created filling surface.
981 GEOM_Object MakeFilling (in GEOM_Object theShape,
982 in long theMinDeg, in long theMaxDeg,
983 in double theTol2D, in double theTol3D,
984 in long theNbIter, in boolean theApprox);
987 * Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
988 * \param theSeqSections - set of specified sections.
989 * \param theModeSolid - mode defining building solid or shell
990 * \param thePreci - precision 3D used for smoothing by default 1.e-6
991 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
992 * \return New GEOM_Object, containing the created shell or solid.
994 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
995 in boolean theModeSolid,
997 in boolean theRuled);
1000 * Create a shape by extrusion of the profile shape along
1001 * the path shape. The path shape can be a wire or an edge.
1002 * the several profiles can be specified in the several locations of path.
1003 * \param theSeqBases - list of Bases shape to be extruded.
1004 * \param theLocations - list of locations on the path corresponding
1005 * specified list of the Bases shapes. Number of locations
1006 * should be equal to number of bases or list of locations can be empty.
1007 * \param thePath - Path shape to extrude the base shape along it.
1008 * \param theWithContact - the mode defining that the section is translated to be in
1009 * contact with the spine.
1010 * \param - WithCorrection - defining that the section is rotated to be
1011 * orthogonal to the spine tangent in the correspondent point
1012 * \return New GEOM_Object, containing the created pipe.
1014 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1015 in ListOfGO theLocations,
1016 in GEOM_Object thePath,
1017 in boolean theWithContact ,
1018 in boolean theWithCorrection );
1021 * Create a shape by extrusion of the profile shape along
1022 * the path shape. The path shape can be a shell or a face.
1023 * the several profiles can be specified in the several locations of path.
1024 * \param theSeqBases - list of Bases shape to be extruded.
1025 * \param theSeqSubBases - list of corresponding subshapes of section shapes.
1026 * \param theLocations - list of locations on the path corresponding
1027 * specified list of the Bases shapes. Number of locations
1028 * should be equal to number of bases.
1029 * \param thePath - Path shape to extrude the base shape along it.
1030 * \param theWithContact - the mode defining that the section is translated to be in
1031 * contact with the spine.
1032 * \param - WithCorrection - defining that the section is rotated to be
1033 * orthogonal to the spine tangent in the correspondent point
1034 * \return New GEOM_Object, containing the created pipe.
1036 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1037 in ListOfGO theSeqSubBases,
1038 in ListOfGO theLocations,
1039 in GEOM_Object thePath,
1040 in boolean theWithContact ,
1041 in boolean theWithCorrection );
1044 * Create solids between given sections
1045 * \param theSeqBases - list of sections (shell or face).
1046 * \param theLocations - list of corresponding vertexes
1047 * \return New GEOM_Object, containing the created solids.
1049 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1050 in ListOfGO theLocations);
1053 * Create a shape by extrusion of the base shape along
1054 * the path shape with constant bi-normal direction along the given vector.
1055 * The path shape can be a wire or an edge.
1056 * \param theBase Base shape to be extruded.
1057 * \param thePath Path shape to extrude the base shape along it.
1058 * \param theVec Vector defines a constant binormal direction to keep the
1059 * same angle beetween the Direction and the sections
1060 * along the sweep surface.
1061 * \return New GEOM_Object, containing the created pipe.
1063 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1064 in GEOM_Object thePath,
1065 in GEOM_Object theVec);
1069 * GEOM_IShapesOperations: Interface for Shapes creation:
1070 * Edge from two points, Wire from edges, Face from wire,
1071 * Shell from faces, Solid from shells, Compound from shapes
1073 interface GEOM_IShapesOperations : GEOM_IOperations
1076 * Create a linear edge with specified ends.
1077 * \param thePnt1 Point for the first end of edge.
1078 * \param thePnt2 Point for the second end of edge.
1079 * \return New GEOM_Object, containing the created edge.
1081 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1084 * Create a wire from the set of edges and wires.
1085 * \param theEdgesAndWires List of edge and/or wires.
1086 * \return New GEOM_Object, containing the created wire.
1088 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires);
1091 * Create a face on the given wire.
1092 * \param theWire closed Wire or Edge to build the face on.
1093 * \param isPlanarWanted If TRUE, only planar face will be built.
1094 * If impossible, NULL object will be returned.
1095 * \return New GEOM_Object, containing the created face.
1097 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1100 * Create a face on the given wires set.
1101 * \param theWires List of closed wires or edges to build the face on.
1102 * \param isPlanarWanted If TRUE, only planar face will be built.
1103 * If impossible, NULL object will be returned.
1104 * \return New GEOM_Object, containing the created face.
1106 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1109 * Create a shell from the set of faces and shells.
1110 * \param theFacesAndShells List of faces and/or shells.
1111 * \return New GEOM_Object, containing the created shell.
1113 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1116 * Create a solid, bounded by the given shell.
1117 * \param theShell Bounding shell.
1118 * \return New GEOM_Object, containing the created solid.
1120 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1123 * Create a solid, bounded by the given shells.
1124 * \param theShells Bounding shells.
1125 * \return New GEOM_Object, containing the created solid.
1127 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1130 * Create a compound of the given shapes.
1131 * \param theShapes List of shapes to put in compound.
1132 * \return New GEOM_Object, containing the created compound.
1134 GEOM_Object MakeCompound (in ListOfGO theShapes);
1137 * Replace coincident faces in theShape by one face.
1138 * \param theShape Initial shape.
1139 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1140 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1141 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1143 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1146 * Find coincident faces in theShape for possible gluing.
1147 * \param theShape Initial shape.
1148 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1151 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1154 * Replace coincident faces in theShape by one face
1155 * in compliance with given list of faces
1156 * \param theShape Initial shape.
1157 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1158 * \param theFaces List of faces for gluing.
1159 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1160 * \return New GEOM_Object, containing a copy of theShape without some faces.
1162 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1163 in ListOfGO theFaces, in boolean doKeepNonSolids);
1166 * Explode a shape on subshapes of a given type.
1167 * \param theShape Shape to be exploded.
1168 * \param theShapeType Type of sub-shapes to be retrieved.
1169 * \param isSorted If this parameter is TRUE, sub-shapes will be
1170 * sorted by coordinates of their gravity centers.
1171 * \return List of sub-shapes of type theShapeType, contained in theShape.
1173 ListOfGO MakeExplode (in GEOM_Object theShape,
1174 in long theShapeType,
1175 in boolean isSorted);
1178 * Explode a shape on subshapes of a given type.
1179 * Does the same, as the above method, but returns IDs of sub-shapes,
1180 * not GEOM_Objects. It works faster.
1181 * \param theShape Shape to be exploded.
1182 * \param theShapeType Type of sub-shapes to be retrieved.
1183 * \param isSorted If this parameter is TRUE, sub-shapes will be
1184 * sorted by coordinates of their gravity centers.
1185 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1187 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1188 in long theShapeType,
1189 in boolean isSorted);
1192 * Get a sub shape defined by its unique ID inside \a theMainShape
1193 * \note The sub shape GEOM_Objects can has ONLY ONE function.
1194 * Don't try to apply modification operations on them.
1196 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1200 * Get global index of \a theSubShape in \a theMainShape.
1201 * \param theMainShape Main shape.
1202 * \param theSubShape Sub-shape of the main shape.
1203 * \return global index of \a theSubShape in \a theMainShape.
1205 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1208 * Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1209 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1210 * to generate automatic names for sub-shapes, when publishing them in a study.
1211 * \param theMainShape Main shape.
1212 * \param theSubShape Sub-shape of the main shape.
1213 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1215 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1218 * \brief Get name of type of \a theShape.
1220 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1221 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1222 * to generate automatic names for sub-shapes, when publishing them in a study.
1223 * \param theShape The shape to get a type of.
1224 * \return String, containing a type name of \a theShape.
1226 string GetShapeTypeString (in GEOM_Object theShape);
1229 * Count number of faces in the given shape.
1230 * \param theShape Shape to count faces in.
1231 * \return Number of faces in the given shape.
1233 long NumberOfFaces (in GEOM_Object theShape);
1236 * Count number of edges in the given shape.
1237 * \param theShape Shape to count edges in.
1238 * \return Number of edges in theShape.
1240 long NumberOfEdges (in GEOM_Object theShape);
1243 * Reverses an orientation the given shape.
1244 * \param theShape Shape to be reversed.
1245 * \return The reversed copy of theShape.
1247 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1250 * Retrieve all free faces from the given shape.
1251 * Free face is a face, which is not shared between two shells of the shape.
1252 * \param theShape Shape to find free faces in.
1253 * \return List of IDs of all free faces, contained in theShape.
1255 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1258 * Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1259 * \param theShape1 Shape to find sub-shapes in.
1260 * \param theShape2 Shape to find shared sub-shapes with.
1261 * \param theShapeType Type of sub-shapes to be retrieved.
1262 * \return List of sub-shapes of theShape1, shared with theShape2.
1264 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1265 in GEOM_Object theShape2,
1266 in long theShapeType);
1269 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1270 * the specified plane by the certain way, defined through \a theState parameter.
1271 * \param theShape Shape to find sub-shapes of.
1272 * \param theShapeType Type of sub-shapes to be retrieved.
1273 * \param theAx1 Vector (or line, or linear edge), specifying normal
1274 * direction and location of the plane to find shapes on.
1275 * \param theState The state of the subshapes to find.
1276 * \return List of all found sub-shapes.
1278 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1279 in long theShapeType,
1280 in GEOM_Object theAx1,
1281 in shape_state theState);
1283 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1284 * the specified plane by the certain way, defined through \a theState parameter.
1285 * \param theShape Shape to find sub-shapes of.
1286 * \param theShapeType Type of sub-shapes to be retrieved.
1287 * \param theAx1 Vector (or line, or linear edge), specifying normal
1288 * direction of the plane to find shapes on.
1289 * \param thePnt Point specifying location of the plane to find shapes on.
1290 * \param theState The state of the subshapes to find.
1291 * \return List of all found sub-shapes.
1293 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1294 in long theShapeType,
1295 in GEOM_Object theAx1,
1296 in GEOM_Object thePnt,
1297 in shape_state theState);
1302 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1303 * the specified cylinder by the certain way, defined through \a theState parameter.
1304 * \param theShape Shape to find sub-shapes of.
1305 * \param theShapeType Type of sub-shapes to be retrieved.
1306 * \param theAxis Vector (or line, or linear edge), specifying
1307 * axis of the cylinder to find shapes on.
1308 * \param theRadius Radius of the cylinder to find shapes on.
1309 * \param theState The state of the subshapes to find.
1310 * \return List of all found sub-shapes.
1312 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1313 in long theShapeType,
1314 in GEOM_Object theAxis,
1315 in double theRadius,
1316 in shape_state theState);
1319 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1320 * the specified sphere by the certain way, defined through \a theState parameter.
1321 * \param theShape Shape to find sub-shapes of.
1322 * \param theShapeType Type of sub-shapes to be retrieved.
1323 * \param theCenter Point, specifying center of the sphere to find shapes on.
1324 * \param theRadius Radius of the sphere to find shapes on.
1325 * \param theState The state of the subshapes to find.
1326 * \return List of all found sub-shapes.
1328 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1329 in long theShapeType,
1330 in GEOM_Object theCenter,
1331 in double theRadius,
1332 in shape_state theState);
1335 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1336 * the specified quadrangle by the certain way, defined through \a theState parameter.
1337 * \param theShape Shape to find sub-shapes of.
1338 * \param theShapeType Type of sub-shapes to be retrieved.
1339 * \param theTopLeftPoint Top left quadrangle corner
1340 * \param theTopRigthPoint Top right quadrangle corner
1341 * \param theBottomLeftPoint Bottom left quadrangle corner
1342 * \param theBottomRigthPoint Bottom right quadrangle corner
1343 * \param theState The state of the subshapes to find.
1344 * \return List of all found sub-shapes.
1346 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1347 in long theShapeType,
1348 in GEOM_Object theTopLeftPoint,
1349 in GEOM_Object theTopRigthPoint,
1350 in GEOM_Object theBottomLeftPoint,
1351 in GEOM_Object theBottomRigthPoint,
1352 in shape_state theState);
1355 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1356 * the specified plane by the certain way, defined through \a theState parameter.
1357 * \param theShape Shape to find sub-shapes of.
1358 * \param theShapeType Type of sub-shapes to be retrieved.
1359 * \param theAx1 Vector (or line, or linear edge), specifying normal
1360 * direction and location of the plane to find shapes on.
1361 * \param theState The state of the subshapes to find.
1362 * \return List of IDs of all found sub-shapes.
1364 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1365 in long theShapeType,
1366 in GEOM_Object theAx1,
1367 in shape_state theState);
1370 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1371 * the specified plane by the certain way, defined through \a theState parameter.
1372 * \param theShape Shape to find sub-shapes of.
1373 * \param theShapeType Type of sub-shapes to be retrieved.
1374 * \param theAx1 Vector (or line, or linear edge), specifying normal
1375 * direction of the plane to find shapes on.
1376 * \param thePnt Point specifying location of the plane to find shapes on.
1377 * \param theState The state of the subshapes to find.
1378 * \return List of IDs of all found sub-shapes.
1380 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1381 in long theShapeType,
1382 in GEOM_Object theAx1,
1383 in GEOM_Object thePnt,
1384 in shape_state theState);
1387 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1388 * the specified cylinder by the certain way, defined through \a theState parameter.
1389 * \param theShape Shape to find sub-shapes of.
1390 * \param theShapeType Type of sub-shapes to be retrieved.
1391 * \param theAxis Vector (or line, or linear edge), specifying
1392 * axis of the cylinder to find shapes on.
1393 * \param theRadius Radius of the cylinder to find shapes on.
1394 * \param theState The state of the subshapes to find.
1395 * \return List of IDs of all found sub-shapes.
1397 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1398 in long theShapeType,
1399 in GEOM_Object theAxis,
1400 in double theRadius,
1401 in shape_state theState);
1404 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1405 * the specified sphere by the certain way, defined through \a theState parameter.
1406 * \param theShape Shape to find sub-shapes of.
1407 * \param theShapeType Type of sub-shapes to be retrieved.
1408 * \param theCenter Point, specifying center of the sphere to find shapes on.
1409 * \param theRadius Radius of the sphere to find shapes on.
1410 * \param theState The state of the subshapes to find.
1411 * \return List of IDs of all found sub-shapes.
1413 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1414 in long theShapeType,
1415 in GEOM_Object theCenter,
1416 in double theRadius,
1417 in shape_state theState);
1420 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1421 * the specified quadrangle by the certain way, defined through \a theState parameter.
1422 * \param theShape Shape to find sub-shapes of.
1423 * \param theShapeType Type of sub-shapes to be retrieved.
1424 * \param theTopLeftPoint Top left quadrangle corner
1425 * \param theTopRigthPoint Top right quadrangle corner
1426 * \param theBottomLeftPoint Bottom left quadrangle corner
1427 * \param theBottomRigthPoint Bottom right quadrangle corner
1428 * \param theState The state of the subshapes to find.
1429 * \return List of IDs of all found sub-shapes.
1431 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1432 in long theShapeType,
1433 in GEOM_Object theTopLeftPoint,
1434 in GEOM_Object theTopRigthPoint,
1435 in GEOM_Object theBottomLeftPoint,
1436 in GEOM_Object theBottomRigthPoint,
1437 in shape_state theState);
1440 * \brief Find subshapes complying with given status
1441 * \param theBox - the box to check state of subshapes against
1442 * \param theShape - the shape to explore
1443 * \param theShapeType - type of subshape of theShape
1444 * \param theState - required state
1445 * \return List of IDs of all found sub-shapes.
1447 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1448 in GEOM_Object theShape,
1449 in long theShapeType,
1450 in shape_state theState);
1453 * \brief Find subshapes complying with given status
1454 * \param theBox - the box to check state of subshapes against
1455 * \param theShape - the shape to explore
1456 * \param theShapeType - type of subshape of theShape
1457 * \param theState - required state
1458 * \return List of all found sub-shapes.
1460 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1461 in GEOM_Object theShape,
1462 in long theShapeType,
1463 in shape_state theState);
1466 * \brief Find subshapes complying with given status
1467 * \param theCheckShape - the shape to check state of subshapes against
1468 * \param theShape - the shape to explore
1469 * \param theShapeType - type of subshape of theShape
1470 * \param theState - required state
1471 * \return List of IDs of all found sub-shapes.
1473 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
1474 in GEOM_Object theShape,
1475 in short theShapeType,
1476 in shape_state theState);
1479 * \brief Find subshapes complying with given status
1480 * \param theCheckShape - the shape to check state of subshapes against
1481 * \param theShape - the shape to explore
1482 * \param theShapeType - type of subshape of theShape
1483 * \param theState - required state
1484 * \return List of all found sub-shapes.
1486 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
1487 in GEOM_Object theShape,
1488 in short theShapeType,
1489 in shape_state theState);
1492 * \brief Find subshapes complying with given status
1493 * \param theCheckShape - the shape to check state of subshapes against
1494 * \param theShape - the shape to explore
1495 * \param theShapeType - type of subshape of theShape
1496 * \param theState - required state
1497 * \return compound includes all found sub-shapes.
1499 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
1500 in GEOM_Object theShape,
1501 in short theShapeType,
1502 in shape_state theState);
1505 * Get sub-shape(s) of \a theShapeWhere, which are
1506 * coincident with \a theShapeWhat or could be a part of it.
1507 * \param theShapeWhere Shape to find sub-shapes of.
1508 * \param theShapeWhat Shape, specifying what to find.
1509 * \return Group of all found sub-shapes or a single found sub-shape.
1511 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1512 in GEOM_Object theShapeWhat);
1515 * Get sub-shape(s) of \a theShapeWhere, which are
1516 * coincident with \a theShapeWhat or could be a part of it.
1518 * Implementation of this method is based on a saved history of an operation,
1519 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1520 * arguments (an argument shape or a sub-shape of an argument shape).
1521 * The operation could be the Partition or one of boolean operations,
1522 * performed on simple shapes (not on compounds).
1524 * \param theShapeWhere Shape to find sub-shapes of.
1525 * \param theShapeWhat Shape, specifying what to find.
1526 * \return Group of all found sub-shapes or a single found sub-shape.
1528 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
1529 in GEOM_Object theShapeWhat);
1532 * Get sub-shape of theShapeWhere, which are
1533 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1534 * \param theShapeWhere Shape to find sub-shapes of.
1535 * \param theShapeWhat Shape, specifying what to find.
1536 * \return found sub-shape.
1538 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1539 in GEOM_Object theShapeWhat);
1543 * GEOM_IBlocksOperations: Interface for Blocks construction
1544 * Face from points or edges, Block from faces,
1545 * Blocks multi-translation and multi-rotation
1547 interface GEOM_IBlocksOperations : GEOM_IOperations
1550 * Creation of blocks
1554 * Create a quadrangle face from four edges. Order of Edges is not
1555 * important. It is not necessary that edges share the same vertex.
1556 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1557 * \return New GEOM_Object, containing the created face.
1559 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1560 in GEOM_Object theEdge2,
1561 in GEOM_Object theEdge3,
1562 in GEOM_Object theEdge4);
1565 * Create a quadrangle face on two edges.
1566 * The missing edges will be built by creating the shortest ones.
1567 * \param theEdge1,theEdge2 Two opposite edges for the face.
1568 * \return New GEOM_Object, containing the created face.
1570 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1571 in GEOM_Object theEdge2);
1574 * Create a quadrangle face with specified corners.
1575 * The missing edges will be built by creating the shortest ones.
1576 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1577 * \return New GEOM_Object, containing the created face.
1579 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1580 in GEOM_Object thePnt2,
1581 in GEOM_Object thePnt3,
1582 in GEOM_Object thePnt4);
1585 * Create a hexahedral solid, bounded by the six given faces. Order of
1586 * faces is not important. It is not necessary that Faces share the same edge.
1587 * \param theFace1-theFace6 Faces for the hexahedral solid.
1588 * \return New GEOM_Object, containing the created solid.
1590 GEOM_Object MakeHexa (in GEOM_Object theFace1,
1591 in GEOM_Object theFace2,
1592 in GEOM_Object theFace3,
1593 in GEOM_Object theFace4,
1594 in GEOM_Object theFace5,
1595 in GEOM_Object theFace6);
1598 * Create a hexahedral solid between two given faces.
1599 * The missing faces will be built by creating the smallest ones.
1600 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1601 * \return New GEOM_Object, containing the created solid.
1603 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1604 in GEOM_Object theFace2);
1607 * Extract elements of blocks and blocks compounds
1611 * Get a vertex, found in the given shape by its coordinates.
1612 * \param theShape Block or a compound of blocks.
1613 * \param theX,theY,theZ Coordinates of the sought vertex.
1614 * \param theEpsilon Maximum allowed distance between the resulting
1615 * vertex and point with the given coordinates.
1616 * \return New GEOM_Object, containing the found vertex.
1618 GEOM_Object GetPoint (in GEOM_Object theShape,
1622 in double theEpsilon);
1625 * Get an edge, found in the given shape by two given vertices.
1626 * \param theShape Block or a compound of blocks.
1627 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1628 * \return New GEOM_Object, containing the found edge.
1630 GEOM_Object GetEdge (in GEOM_Object theShape,
1631 in GEOM_Object thePoint1,
1632 in GEOM_Object thePoint2);
1635 * Find an edge of the given shape, which has minimal distance to the given point.
1636 * \param theShape Block or a compound of blocks.
1637 * \param thePoint Point, close to the desired edge.
1638 * \return New GEOM_Object, containing the found edge.
1640 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1641 in GEOM_Object thePoint);
1644 * Returns a face, found in the given shape by four given corner vertices.
1645 * \param theShape Block or a compound of blocks.
1646 * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1647 * \return New GEOM_Object, containing the found face.
1649 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1650 in GEOM_Object thePoint1,
1651 in GEOM_Object thePoint2,
1652 in GEOM_Object thePoint3,
1653 in GEOM_Object thePoint4);
1656 * Get a face of block, found in the given shape by two given edges.
1657 * \param theShape Block or a compound of blocks.
1658 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
1659 * \return New GEOM_Object, containing the found face.
1661 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
1662 in GEOM_Object theEdge1,
1663 in GEOM_Object theEdge2);
1666 * Find a face, opposite to the given one in the given block.
1667 * \param theBlock Must be a hexahedral solid.
1668 * \param theFace Face of \a theBlock, opposite to the desired face.
1669 * \return New GEOM_Object, containing the found face.
1671 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
1672 in GEOM_Object theFace);
1675 * Find a face of the given shape, which has minimal distance to the given point.
1676 * \param theShape Block or a compound of blocks.
1677 * \param thePoint Point, close to the desired face.
1678 * \return New GEOM_Object, containing the found face.
1680 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
1681 in GEOM_Object thePoint);
1684 * Find a face of block, whose outside normale has minimal angle with the given vector.
1685 * \param theShape Block or a compound of blocks.
1686 * \param theVector Vector, close to the normale of the desired face.
1687 * \return New GEOM_Object, containing the found face.
1689 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
1690 in GEOM_Object theVector);
1693 * Extract blocks from blocks compounds
1697 * Check, if the compound contains only specified blocks.
1698 * \param theCompound The compound to check.
1699 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
1700 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1701 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1702 * \return TRUE, if the given compound contains only blocks.
1703 * \return theNbBlocks Number of specified blocks in theCompound.
1705 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
1706 in long theMinNbFaces,
1707 in long theMaxNbFaces,
1708 out long theNbBlocks);
1711 * Enumeration of Blocks Compound defects.
1715 /* Each element of the compound should be a Block */
1718 /* An element is a potential block, but has degenerated and/or seam edge(s). */
1721 /* A connection between two Blocks should be an entire face or an entire edge */
1724 /* The compound should be connexe */
1727 /* The glue between two quadrangle faces should be applied */
1732 * Description of Blocks Compound defect: type and incriminated sub-shapes.
1737 ListOfLong incriminated;
1741 * Sequence of all Blocks Compound defects.
1743 typedef sequence<BCError> BCErrors;
1746 * Check, if the compound of blocks is given.
1747 * To be considered as a compound of blocks, the
1748 * given shape must satisfy the following conditions:
1749 * - Each element of the compound should be a Block (6 faces and 12 edges).
1750 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
1751 * - The compound should be connexe.
1752 * - The glue between two quadrangle faces should be applied.
1753 * \note Single block is also accepted as a valid compound of blocks.
1754 * \param theCompound The compound to check.
1755 * \return TRUE, if the given shape is a compound of blocks.
1756 * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
1758 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
1759 out BCErrors theErrors);
1762 * Convert sequence of Blocks Compound errors, returned by
1763 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
1764 * \param theCompound The bad compound.
1765 * \param theErrors The sequence of \a theCompound errors.
1766 * \return String, describing all the errors in form, suitable for printing.
1768 string PrintBCErrors (in GEOM_Object theCompound,
1769 in BCErrors theErrors);
1772 * Remove all seam and degenerated edges from \a theShape.
1773 * Unite faces and edges, sharing one surface.
1774 * \param theShape The compound or single solid to remove irregular edges from.
1775 * \return Improved shape.
1777 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape);
1780 * Check, if the given shape is a blocks compound.
1781 * Fix all detected errors.
1782 * \note Single block can be also fixed by this method.
1783 * \param theCompound The compound to check and improve.
1784 * \return Improved compound.
1786 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
1789 * Get all the blocks, contained in the given compound.
1790 * \param theCompound The compound to explode.
1791 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
1792 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1793 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1794 * \return List of GEOM_Objects, containing the retrieved blocks.
1796 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
1797 in long theMinNbFaces,
1798 in long theMaxNbFaces);
1801 * Find block, containing the given point inside its volume or on boundary.
1802 * \param theCompound Compound, to find block in.
1803 * \param thePoint Point, close to the desired block. If the point lays on
1804 * boundary between some blocks, we return block with nearest center.
1805 * \return New GEOM_Object, containing the found block.
1807 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
1808 in GEOM_Object thePoint);
1811 * Find block, containing all the elements, passed as the parts, or maximum quantity of them.
1812 * \param theCompound Compound, to find block in.
1813 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
1814 * \return New GEOM_Object, containing the found block.
1816 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
1817 in ListOfGO theParts);
1820 * Return all blocks, containing all the elements, passed as the parts.
1821 * \param theCompound Compound, to find blocks in.
1822 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
1823 * \return List of GEOM_Objects, containing the found blocks.
1825 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
1826 in ListOfGO theParts);
1829 * Operations on blocks with gluing of result
1833 * Multi-transformate block and glue the result.
1834 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
1835 * \param theBlock Hexahedral solid to be multi-transformed.
1836 * \param theDirFace1 First direction face global index.
1837 * \param theDirFace2 Second direction face global index.
1838 * \param theNbTimes Quantity of transformations to be done.
1839 * \note Global index of sub-shape can be obtained, using method
1840 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
1841 * \return New GEOM_Object, containing the result shape.
1843 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
1844 in long theDirFace1,
1845 in long theDirFace2,
1846 in long theNbTimes);
1849 * Multi-transformate block and glue the result.
1850 * \param theBlock Hexahedral solid to be multi-transformed.
1851 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
1852 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
1853 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
1854 * \return New GEOM_Object, containing the result shape.
1856 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
1857 in long theDirFace1U,
1858 in long theDirFace2U,
1859 in long theNbTimesU,
1860 in long theDirFace1V,
1861 in long theDirFace2V,
1862 in long theNbTimesV);
1865 * Special operation - propagation
1869 * Build all possible propagation groups.
1870 * Propagation group is a set of all edges, opposite to one (main)
1871 * edge of this group directly or through other opposite edges.
1872 * Notion of Opposite Edge make sence only on quadrangle face.
1873 * \param theShape Shape to build propagation groups on.
1874 * \return List of GEOM_Objects, each of them is a propagation group.
1876 ListOfGO Propagate (in GEOM_Object theShape);
1880 * GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
1882 interface GEOM_IBooleanOperations : GEOM_IOperations
1885 * Perform one of boolean operations on two given shapes.
1886 * \param theShape1 First argument for boolean operation.
1887 * \param theShape2 Second argument for boolean operation.
1888 * \param theOperation Indicates the operation to be done:
1889 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1890 * \return New GEOM_Object, containing the result shape.
1892 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
1893 in GEOM_Object theShape2,
1894 in long theOperation);
1897 * Perform partition operation.
1898 * \param theShapes Shapes to be intersected.
1899 * \param theTools Shapes to intersect theShapes.
1900 * \note Each compound from ListShapes and ListTools will be exploded in order
1901 * to avoid possible intersection between shapes from this compound.
1902 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1903 # \param KeepNonlimitShapes: if this parameter == 0 - only shapes with
1904 # type <= Limit are kept in the result,
1905 # else - shapes with type > Limit are kept
1906 # also (if they exist)
1908 * After implementation new version of PartitionAlgo (October 2006)
1909 * other parameters are ignored by current functionality. They are kept
1910 * in this function only for supporting old versions.
1911 * Ignored parameters:
1912 * \param theKeepInside Shapes, outside which the results will be deleted.
1913 * Each shape from theKeepInside must belong to theShapes also.
1914 * \param theRemoveInside Shapes, inside which the results will be deleted.
1915 * Each shape from theRemoveInside must belong to theShapes also.
1916 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
1917 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
1919 * \return New GEOM_Object, containing the result shapes.
1921 GEOM_Object MakePartition (in ListOfGO theShapes,
1922 in ListOfGO theTools,
1923 in ListOfGO theKeepInside,
1924 in ListOfGO theRemoveInside,
1926 in boolean theRemoveWebs,
1927 in ListOfLong theMaterials,
1928 in short theKeepNonlimitShapes);
1931 * Perform partition operation.
1932 * This method may be usefull if it is needed to make a partition for
1933 * a compound containing nonintersected shapes. Performance will be better
1934 * since intersection between shapes from compound is not performed.
1936 * Description of all parameters as in previous method MakePartition()
1938 * \note Passed compounds (via ListShapes or via ListTools)
1939 * have to consist of nonintersecting shapes.
1941 * \return New GEOM_Object, containing the result shapes.
1943 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
1944 in ListOfGO theTools,
1945 in ListOfGO theKeepInside,
1946 in ListOfGO theRemoveInside,
1948 in boolean theRemoveWebs,
1949 in ListOfLong theMaterials,
1950 in short theKeepNonlimitShapes);
1953 * Perform partition of the Shape with the Plane
1954 * \param theShape Shape to be intersected.
1955 * \param thePlane Tool shape, to intersect theShape.
1956 * \return New GEOM_Object, containing the result shape.
1958 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
1959 in GEOM_Object thePlane);
1963 * GEOM_ICurvesOperations: Interface for curves creation.
1964 * Polyline, Circle, Spline (Bezier and Interpolation)
1966 interface GEOM_ICurvesOperations : GEOM_IOperations
1969 * Create a circle with given center, normal vector and radius.
1970 * \param thePnt Circle center.
1971 * \param theVec Vector, normal to the plane of the circle.
1972 * \param theR Circle radius.
1973 * \return New GEOM_Object, containing the created circle.
1975 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
1976 in GEOM_Object theVec,
1979 * Create a circle, passing through three given points
1980 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
1981 * \return New GEOM_Object, containing the created circle.
1983 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
1984 in GEOM_Object thePnt2,
1985 in GEOM_Object thePnt3);
1987 * Create a circle with given center, with a radius equals the distance from center to Point1
1988 * and on a plane defined by all of three points.
1989 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
1990 * \return New GEOM_Object, containing the created circle.
1992 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
1993 in GEOM_Object thePnt2,
1994 in GEOM_Object thePnt3);
1996 * Create an ellipse with given center, normal vector and radiuses.
1997 * \param thePnt Ellipse center.
1998 * \param theVec Vector, normal to the plane of the ellipse.
1999 * \param theRMajor Major ellipse radius.
2000 * \param theRMinor Minor ellipse radius.
2001 * \return New GEOM_Object, containing the created ellipse.
2003 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2004 in GEOM_Object theVec,
2005 in double theRMajor,
2006 in double theRMinor);
2009 * Create an arc of circle, passing through three given points.
2010 * \param thePnt1 Start point of the arc.
2011 * \param thePnt2 Middle point of the arc.
2012 * \param thePnt3 End point of the arc.
2013 * \return New GEOM_Object, containing the created arc.
2015 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2016 in GEOM_Object thePnt2,
2017 in GEOM_Object thePnt3);
2020 * Create an arc of circle of center C from one point to another
2021 * \param theCenter Center point of the arc.
2022 * \param thePnt1 Start point of the arc.
2023 * \param thePnt2 End point of the arc.
2024 * \param theSense Orientation of the arc
2025 * \return New GEOM_Object, containing the created arc.
2027 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2028 in GEOM_Object thePnt1,
2029 in GEOM_Object thePnt2,
2030 in boolean theSense);
2034 * Create a polyline on the set of points.
2035 * \param thePoints Sequence of points for the polyline.
2036 * \return New GEOM_Object, containing the created polyline.
2038 GEOM_Object MakePolyline (in ListOfGO thePoints);
2041 * Create bezier curve on the set of points.
2042 * \param thePoints Sequence of points for the bezier curve.
2043 * \return New GEOM_Object, containing the created bezier curve.
2045 GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
2048 * Create B-Spline curve on the set of points.
2049 * \param thePoints Sequence of points for the B-Spline curve.
2050 * \return New GEOM_Object, containing the created B-Spline curve.
2052 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints);
2055 * Create a sketcher (wire or face), following the textual description,
2056 * passed through \a theCommand argument. \n
2057 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2058 * Format of the description string have to be the following:
2060 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2063 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2065 * - "R angle" : Set the direction by angle
2066 * - "D dx dy" : Set the direction by DX & DY
2069 * - "TT x y" : Create segment by point at X & Y
2070 * - "T dx dy" : Create segment by point with DX & DY
2071 * - "L length" : Create segment by direction & Length
2072 * - "IX x" : Create segment by direction & Intersect. X
2073 * - "IY y" : Create segment by direction & Intersect. Y
2076 * - "C radius length" : Create arc by direction, radius and length(in degree)
2079 * - "WW" : Close Wire (to finish)
2080 * - "WF" : Close Wire and build face (to finish)
2082 * \param theCommand String, defining the sketcher in local
2083 * coordinates of the working plane.
2084 * \param theWorkingPlane Nine double values, defining origin,
2085 * OZ and OX directions of the working plane.
2086 * \return New GEOM_Object, containing the created wire.
2088 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2091 * Create a sketcher (wire or face), following the textual description,
2092 * passed through \a theCommand argument. \n
2093 * For format of the description string see the previous method.\n
2094 * \param theCommand String, defining the sketcher in local
2095 * coordinates of the working plane.
2096 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2097 * \return New GEOM_Object, containing the created wire.
2099 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2103 * GEOM_ILocalOperations: Interface for fillet and chamfer creation.
2105 interface GEOM_ILocalOperations : GEOM_IOperations
2108 * Perform a fillet on all edges of the given shape.
2109 * \param theShape Shape, to perform fillet on.
2110 * \param theR Fillet radius.
2111 * \return New GEOM_Object, containing the result shape.
2113 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2117 * Perform a fillet on the specified edges of the given shape
2118 * \param theShape Shape, to perform fillet on.
2119 * \param theR Fillet radius.
2120 * \param theEdges Global indices of edges to perform fillet on.
2121 * \note Global index of sub-shape can be obtained, using method
2122 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2123 * \return New GEOM_Object, containing the result shape.
2125 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2127 in ListOfLong theEdges);
2128 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2131 in ListOfLong theEdges);
2134 * Perform a fillet on all edges of the specified faces of the given shape.
2135 * \param theShape Shape, to perform fillet on.
2136 * \param theR Fillet radius.
2137 * \param theFaces Global indices of faces to perform fillet on.
2138 * \note Global index of sub-shape can be obtained, using method
2139 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2140 * \return New GEOM_Object, containing the result shape.
2142 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2144 in ListOfLong theFaces);
2145 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2148 in ListOfLong theFaces);
2151 * Perform a symmetric chamfer on all edges of the given shape.
2152 * \param theShape Shape, to perform chamfer on.
2153 * \param theD Chamfer size along each face.
2154 * \return New GEOM_Object, containing the result shape.
2156 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2160 * Perform a chamfer on edges, common to the specified faces.
2161 * with distance D1 on the Face1
2162 * \param theShape Shape, to perform chamfer on.
2163 * \param theD1 Chamfer size along \a theFace1.
2164 * \param theD2 Chamfer size along \a theFace2.
2165 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2166 * \note Global index of sub-shape can be obtained, using method
2167 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2168 * \return New GEOM_Object, containing the result shape.
2170 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2171 in double theD1, in double theD2,
2172 in long theFace1, in long theFace2);
2174 * The Same but with params theD = Chamfer Lenght
2175 * and theAngle = Chamfer Angle (Angle in radians)
2177 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2178 in double theD, in double theAngle,
2179 in long theFace1, in long theFace2);
2182 * Perform a chamfer on all edges of the specified faces.
2183 * with distance D1 on the first specified face (if several for one edge)
2184 * \param theShape Shape, to perform chamfer on.
2185 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2186 * connected to the edge, are in \a theFaces, \a theD1
2187 * will be get along face, which is nearer to \a theFaces beginning.
2188 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2189 * \param theFaces Sequence of global indices of faces of \a theShape.
2190 * \note Global index of sub-shape can be obtained, using method
2191 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2192 * \return New GEOM_Object, containing the result shape.
2194 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2195 in double theD1, in double theD2,
2196 in ListOfLong theFaces);
2198 * The Same but with params theD = Chamfer Lenght
2199 * and theAngle = Chamfer Angle (Angle in radians)
2201 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2202 in double theD, in double theAngle,
2203 in ListOfLong theFaces);
2206 * Perform a chamfer on edges,
2207 * with distance D1 on the first specified face (if several for one edge)
2208 * \param theShape Shape, to perform chamfer on.
2209 * \param theD1 theD2 Chamfer size
2210 * \param theEdges Sequence of edges of \a theShape.
2211 * \return New GEOM_Object, containing the result shape.
2213 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2214 in double theD1, in double theD2,
2215 in ListOfLong theEdges);
2217 * The Same but with params theD = Chamfer Lenght
2218 * and theAngle = Chamfer Angle (Angle in radians)
2220 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2221 in double theD, in double theAngle,
2222 in ListOfLong theEdges);
2225 * Perform an Archimde operation on the given shape with given parameters.
2226 * The object presenting the resulting face is returned
2227 * \param theShape Shape to be put in water.
2228 * \param theWeight Weight og the shape.
2229 * \param theWaterDensity Density of the water.
2230 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
2231 * \return New GEOM_Object, containing a section of \a theShape
2232 * by a plane, corresponding to water level.
2234 GEOM_Object MakeArchimede (in GEOM_Object theShape,
2235 in double theWeight,
2236 in double theWaterDensity,
2237 in double theMeshDeflection);
2240 * Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2241 * Present here only for compatibility.
2243 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2247 * GEOM_IHealingOperations: Interface for shape healing operations.
2248 * Shape Processing, SuppressFaces, etc.
2250 interface GEOM_IHealingOperations : GEOM_IOperations
2253 * Apply a sequence of Shape Healing operators to the given object.
2254 * \param theShapes Shape to be processed.
2255 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2256 * \param theParameters List of names of parameters
2257 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2258 * \param theValues List of values of parameters, in the same order
2259 * as parameters are listed in \a theParameters list.
2260 * \return New GEOM_Object, containing processed shape.
2262 GEOM_Object ProcessShape (in GEOM_Object theShapes,
2263 in string_array theOperators,
2264 in string_array theParameters,
2265 in string_array theValues);
2268 * Get default sequence of operators, their parameters and parameters' values
2269 * of Shape Process operation. In the current implementation the defaults are
2270 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2271 * \param theOperators Output. Default list of names of operators.
2272 * \param theParameters Output. Default list of names of parameters.
2273 * \param theValues Output. List of default values of parameters, in the same order
2274 * as parameters are listed in \a theParameters list.
2276 void GetShapeProcessParameters (out string_array theOperators,
2277 out string_array theParameters,
2278 out string_array theValues);
2280 * Get parameters and parameters' values for the given Shape Process operation.
2281 * In the current implementation the defaults are
2282 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2283 * \param theOperator Input. The operator's name.
2284 * \param theParameters Output. Default list of names of parameters.
2285 * \param theValues Output. List of default values of parameters, in the same order
2286 * as parameters are listed in \a theParameters list.
2288 void GetOperatorParameters (in string theOperator,
2289 out string_array theParameters,
2290 out string_array theValues);
2293 * Remove faces from the given object (shape).
2294 * \param theObject Shape to be processed.
2295 * \param theFaces Indices of faces to be removed, if EMPTY then the method
2296 * removes ALL faces of the given object.
2297 * \return New GEOM_Object, containing processed shape.
2299 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
2302 * Close an open wire.
2303 * \param theObject Shape to be processed.
2304 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2305 * if -1, then theObject itself is a wire.
2306 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
2307 * If FALS : closure by creation of an edge between ends.
2308 * \return New GEOM_Object, containing processed shape.
2310 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2311 in boolean isCommonVertex);
2314 * Remove internal wires and edges from the given object (face).
2315 * \param theObject Shape to be processed.
2316 * \param theWires Indices of wires to be removed, if EMPTY then the method
2317 * removes ALL internal wires of the given object.
2318 * \return New GEOM_Object, containing processed shape.
2320 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2323 * Remove internal closed contours (holes) from the given object.
2324 * \param theObject Shape to be processed.
2325 * \param theWires Indices of wires to be removed, if EMPTY then the method
2326 * removes ALL internal holes of the given object
2327 * \return New GEOM_Object, containing processed shape.
2329 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2332 * Sewing of the given object.
2333 * \param theObject Shape to be processed.
2334 * \param theTolerance Required tolerance value.
2335 * \return New GEOM_Object, containing processed shape.
2337 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2340 * Addition of a point to a given edge object.
2341 * \param theObject Shape to be processed.
2342 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
2343 * if -1, then theObject itself is the edge.
2344 * \param theValue Value of parameter on edge or length parameter,
2345 * depending on \a isByParameter.
2346 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2347 * if FALSE : \a theValue is treated as a length parameter [0..1]
2348 * \return New GEOM_Object, containing processed shape.
2350 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2351 in double theValue, in boolean isByParameter);
2354 * Get a list of wires (wrapped in GEOM_Object-s),
2355 * that constitute a free boundary of the given shape.
2356 * \param theObject Shape to get free boundary of.
2357 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2358 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
2359 * \return FALSE, if an error(s) occured during the method execution.
2361 boolean GetFreeBoundary (in GEOM_Object theObject,
2362 out ListOfGO theClosedWires,
2363 out ListOfGO theOpenWires);
2366 * Change orientation of the given object.
2367 * \param theObject Shape to be processed.
2368 * \return New GEOM_Object, containing processed shape.
2370 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2371 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2376 * GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2379 interface GEOM_IInsertOperations : GEOM_IOperations
2382 * Create a copy of the given object
2384 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2387 * Export the given shape into a file with given name.
2388 * \param theObject Shape to be stored in the file.
2389 * \param theFileName Name of the file to store the given shape in.
2390 * \param theFormatName Specify format for the shape storage.
2391 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2393 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2396 * Import a shape from the BRep or IGES or STEP file
2397 * (depends on given format) with given name.
2398 * \param theFileName The file, containing the shape.
2399 * \param theFormatName Specify format for the file reading.
2400 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2401 * \return New GEOM_Object, containing the imported shape.
2403 GEOM_Object Import (in string theFileName, in string theFormatName);
2406 * Get the supported import formats and corresponding patterns for File dialog.
2407 * \param theFormats Output. List of formats, available for import.
2408 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2409 * \return Returns available formats and patterns through the arguments.
2411 void ImportTranslators (out string_array theFormats,
2412 out string_array thePatterns);
2415 * Get the supported export formats and corresponding patterns for File dialog.
2416 * \param theFormats Output. List of formats, available for export.
2417 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2418 * \return Returns available formats and patterns through the arguments.
2420 void ExportTranslators (out string_array theFormats,
2421 out string_array thePatterns);
2425 * GEOM_IKindOfShape: namespace for shape_kind enumeration.
2427 interface GEOM_IKindOfShape
2437 SPHERE, // full sphere
2438 CYLINDER, // cylinder
2439 BOX, // box with faces, parallel to global coordinate planes
2440 ROTATED_BOX, // other box
2441 TORUS, // full torus
2443 POLYHEDRON, // solid, bounded by polygons
2444 SOLID, // other solid
2446 SPHERE2D, // spherical face (closed)
2447 CYLINDER2D, // cylindrical face with defined height
2448 TORUS2D, // toroidal face (closed)
2449 CONE2D, // conical face with defined height
2450 DISK_CIRCLE, // planar, bounded by circle
2451 DISK_ELLIPSE, // planar, bounded by ellipse
2452 POLYGON, // planar, bounded by segments
2453 PLANE, // infinite planar
2454 PLANAR, // other planar
2457 CIRCLE, // full circle
2458 ARC_CIRCLE, // arc of circle
2459 ELLIPSE, // full ellipse
2460 ARC_ELLIPSE, // arc of ellipse
2461 LINE, // infinite segment
2471 * GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
2472 * properties calculation (like Centre of Mass, Inertia, etc.).
2475 interface GEOM_IMeasureOperations : GEOM_IOperations
2478 * Get kind of theShape.
2479 * \param theShape Shape to get a kind of.
2480 * \param theIntegers Output. Integer and enumerated shape's parameters
2481 * (kind of surface, closed/unclosed, number of edges, etc.)
2482 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
2483 * \note Concrete meaning of each value, returned via \a theIntegers
2484 * or \a theDoubles list depends on the kind of the shape.
2485 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
2487 //short KindOfShape (in GEOM_Object theShape,
2488 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
2489 out ListOfLong theIntegers,
2490 out ListOfDouble theDoubles);
2493 * Get position (LCS) of theShape.
2494 * \param theShape Shape to calculate position of.
2495 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
2496 * Origin of the LCS is situated at the shape's center of mass.
2497 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
2498 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
2499 * Axes of the LCS are obtained from shape's location or,
2500 * if the shape is a planar face, from position of its plane.
2501 * \return Returns position of the shape through the last nine arguments.
2503 void GetPosition (in GEOM_Object theShape,
2504 out double Ox, out double Oy, out double Oz,
2505 out double Zx, out double Zy, out double Zz,
2506 out double Xx, out double Xy, out double Xz);
2509 * Get summarized length of all wires,
2510 * area of surface and volume of the given shape.
2511 * \param theShape Shape to define properties of.
2512 * \param theLength Output. Summarized length of all wires of the given shape.
2513 * \param theSurfArea Output. Area of surface of the given shape.
2514 * \param theVolume Output. Volume of the given shape.
2515 * \return Returns shape properties through the last three arguments.
2517 void GetBasicProperties (in GEOM_Object theShape,
2518 out double theLength,
2519 out double theSurfArea,
2520 out double theVolume);
2523 * Get a point, situated at the centre of mass of theShape.
2524 * \param theShape Shape to define centre of mass of.
2525 * \return New GEOM_Object, containing the created point.
2527 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
2530 * Get a vector, representing the normal of theFace.
2531 * If the face is not planar, theOptionalPoint is obligatory.
2532 * \param theFace Shape (face) to define the normal of.
2533 * \param theOptionalPoint Shape (point) to define the normal at.
2534 * Can be NULL in case of planar face.
2535 * \return New GEOM_Object, containing the created normal vector.
2537 GEOM_Object GetNormal (in GEOM_Object theFace,
2538 in GEOM_Object theOptionalPoint);
2541 * Get inertia matrix and moments of inertia of theShape.
2542 * \param theShape Shape to calculate inertia of.
2543 * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
2544 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
2545 * \return Returns inertia through the last twelve arguments.
2547 void GetInertia (in GEOM_Object theShape,
2548 out double I11, out double I12, out double I13,
2549 out double I21, out double I22, out double I23,
2550 out double I31, out double I32, out double I33,
2551 out double Ix , out double Iy , out double Iz);
2554 * Get parameters of bounding box of the given shape
2555 * \param theShape Shape to obtain bounding box of.
2556 * \param Xmin,Xmax Output. Limits of shape along OX axis.
2557 * \param Ymin,Ymax Output. Limits of shape along OY axis.
2558 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
2559 * \return Returns parameters of bounding box through the last six arguments.
2561 void GetBoundingBox (in GEOM_Object theShape,
2562 out double Xmin, out double Xmax,
2563 out double Ymin, out double Ymax,
2564 out double Zmin, out double Zmax);
2567 * Get min and max tolerances of sub-shapes of theShape
2568 * \param theShape Shape, to get tolerances of.
2569 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
2570 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
2571 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
2572 * \return Returns shape tolerances through the last six arguments.
2574 void GetTolerance (in GEOM_Object theShape,
2575 out double FaceMin, out double FaceMax,
2576 out double EdgeMin, out double EdgeMax,
2577 out double VertMin, out double VertMax);
2580 * Check a topology of the given shape.
2581 * \param theShape Shape to check validity of.
2582 * \param theDescription Output. Description of problems in the shape, if they are.
2583 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
2585 boolean CheckShape (in GEOM_Object theShape,
2586 out string theDescription);
2589 * Check a topology and a geometry of the given shape.
2590 * \param theShape Shape to check validity of.
2591 * \param theDescription Output. Description of problems in the shape, if they are.
2592 * \return TRUE, if the shape "seems to be valid".
2594 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
2595 out string theDescription);
2598 * Obtain description of the given shape
2599 * \param theShape Shape to be described.
2600 * \return Description of the given shape.
2602 string WhatIs (in GEOM_Object theShape);
2605 * Get minimal distance between the given shapes.
2606 * \param theShape1,theShape2 Shapes to find minimal distance between.
2607 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
2608 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
2609 * \return Value of the minimal distance between the given shapes.
2611 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
2612 out double X1, out double Y1, out double Z1,
2613 out double X2, out double Y2, out double Z2);
2616 * Get angle between the given lines or linear edges.
2617 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
2618 * \return Value of the angle between the given shapes.
2620 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
2623 * Get point coordinates
2625 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
2628 * Get radius of curvature of curve in the point determinated by param
2629 * \param theShape - curve.
2630 * \param theParam - parameter on curve
2631 * \return Value of curvature.
2633 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
2636 * Get radius of curvature of curve in the given point
2637 * \param theShape - curve.
2638 * \param thePoint - point
2639 * \return Value of curvature.
2641 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
2644 * Get max radius of curvature of surface in the point determinated by params
2645 * \param theShape - surface.
2646 * \param theUParam - U-parameter on surface
2647 * \param theVParam - V-parameter on surface
2648 * \return Value of curvature.
2650 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
2651 in double theVParam);
2654 * Get max radius of curvature of surface in the given point
2655 * \param theShape - surface.
2656 * \param thePoint - point
2657 * \return Value of curvature.
2659 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
2662 * Get min radius of curvature of surface in the point determinated by params
2663 * \param theShape - surface.
2664 * \param theUParam - U-parameter on surface
2665 * \param theVParam - V-parameter on surface
2666 * \return Value of curvature.
2668 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
2669 in double theVParam);
2672 * Get min radius of curvature of surface in the given point
2673 * \param theShape - surface.
2674 * \param thePoint - point
2675 * \return Value of curvature.
2677 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
2683 * GEOM_IGroupOperations: Interface for groups creation.
2685 interface GEOM_IGroupOperations : GEOM_IOperations
2688 * Creates a new group which will store sub shapes of theMainShape
2689 * \param theMainShape is a GEOM object on which the group is selected
2690 * \param theShapeType defines a shape type of the group
2691 * \return a newly created GEOM group
2693 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
2696 * Adds a sub object with ID theSubShapeId to the group
2697 * \param theGroup is a GEOM group to which the new sub shape is added
2698 * \param theSubShapeId is a sub shape ID in the main object.
2699 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
2701 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
2704 * Removes a sub object with ID \a theSubShapeId from the group
2705 * \param theGroup is a GEOM group from which the sub shape is removed.
2706 * \param theSubShapeId is a sub shape ID in the main object.
2707 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
2709 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
2712 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2713 * \param theGroup is a GEOM group to which the new sub shapes are added.
2714 * \param theSubShapes is a list of sub shapes to be added.
2716 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
2719 * Removes from the group all the given shapes. No errors, if some shapes are not included.
2720 * \param theGroup is a GEOM group from which the sub-shapes are removed.
2721 * \param theSubShapes is a list of sub-shapes to be removed.
2723 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
2726 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
2727 * \param theGroup is a GEOM group to which the new sub shapes are added.
2728 * \param theSubShapes is a list of IDs of sub shapes to be added.
2730 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2733 * Removes from the group all the given shapes. No errors, if some shapes are not included.
2734 * \param theGroup is a GEOM group from which the sub-shapes are removed.
2735 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
2737 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
2740 * Returns a type of sub objects stored in the group
2741 * \param theGroup is a GEOM group which type is returned.
2743 long GetType (in GEOM_Object theGroup);
2746 * Returns a main shape associated with the group
2747 * \param theGroup is a GEOM group for which a main shape object is requested
2748 * \return a GEOM object which is a main shape for theGroup
2750 GEOM_Object GetMainShape (in GEOM_Object theGroup);
2753 * Returns a list of sub objects ID stored in the group
2754 * \param theGroup is a GEOM group for which a list of IDs is requested
2756 ListOfLong GetObjects (in GEOM_Object theGroup);
2761 * GEOM_Gen: Interface to access other GEOM interfaces.
2762 * Also contains some methods to access and manage GEOM objects.
2764 interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
2767 * Undo/Redo Management
2770 void Undo (in long theStudyID);
2772 void Redo (in long theStudyID);
2775 * Publishing management
2776 * Adds in theStudy a object theObject under with a name theName,
2777 * if theFather is not NULL the object is placed under thFather's SObject.
2778 * Returns a SObject where theObject is placed
2780 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
2781 in GEOM_Object theObject,
2783 in GEOM_Object theFather);
2786 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
2787 * To be used from python scripts out of geompy.addToStudy (non-default usage)
2788 * \param theStudy the study, in which theObject is published already,
2789 * and in which the arguments will be published
2790 * \param theObject published GEOM object, arguments of which will be published
2791 * \param theArgs list of GEOM_Object, operation arguments to be published.
2792 * If this list is empty, all operation arguments will be published
2793 * \param theFindMethod method to search subshapes, corresponding to arguments and
2794 * their subshapes. Value from enumeration GEOM::find_shape_method.
2795 * \param theInheritFirstArg set properties of the first argument for \a theObject.
2796 * Do not publish subshapes in place of arguments, but only
2797 * in place of subshapes of the first argument,
2798 * because the whole shape corresponds to the first argument.
2799 * Mainly to be used after transformations, but it also can be
2800 * usefull after partition with one object shape, and some other
2801 * operations, where only the first argument has to be considered.
2802 * If theObject has only one argument shape, this flag is automatically
2803 * considered as True, not regarding really passed value.
2804 * \return True in case of success, False otherwise.
2806 boolean RestoreSubShapesO (in SALOMEDS::Study theStudy,
2807 in GEOM_Object theObject,
2808 in ListOfGO theArgs,
2809 in find_shape_method theFindMethod,
2810 in boolean theInheritFirstArg);
2813 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
2814 * To be used from GUI and from geompy.addToStudy.
2815 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
2816 * \param theSObject study object, referencing GEOM object, arguments of which will be published
2818 boolean RestoreSubShapesSO (in SALOMEDS::Study theStudy,
2819 in SALOMEDS::SObject theSObject,
2820 in ListOfGO theArgs,
2821 in find_shape_method theFindMethod,
2822 in boolean theInheritFirstArg);
2825 * Methods to access interfaces for objects creation and transformation
2827 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2828 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
2829 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2830 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2831 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2832 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2833 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2834 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2835 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2836 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2837 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2838 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
2841 * Objects Management
2845 * Removes the object from the GEOM component
2846 * \param theObject is a GEOM object to be removed
2848 void RemoveObject (in GEOM_Object theObject);
2851 * Returns an object defined by the study and its entry in the GEOM component
2852 * \param theStudyID is a SALOMEDS Study ID
2853 * \param theEntry is an entry of the requested GEOM object in the GEOM component
2854 * \note if the object has not previously been created a NULL GEOM object is returned
2856 GEOM_Object GetObject (in long theStudyID, in string theEntry);
2859 * Add a sub shape defined by indices in \a theIndices
2860 * (contains unique IDs of sub shapes inside theMainShape)
2861 * \note The sub shape GEOM_Objects can has ONLY ONE function.
2862 * Don't try to apply modification operations on them.
2863 * \note Internal method
2865 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
2868 * GEOM object's IOR Management
2872 * Returns a GEOM Object defined by its IOR
2873 * \param theIOR a string containg an IOR of the requested GEOM object
2875 GEOM_Object GetIORFromString (in string theIOR);
2878 * Returns a string which contains an IOR of the GEOM object
2879 * \param theObject is a GEOM object which IOR is requested
2881 string GetStringFromIOR (in GEOM_Object theObject);
2884 * Returns a name with which a GEOM object was dumped into python script
2885 * \param theStudyEntry is an entry of the GEOM object in the study
2887 string GetDumpName (in string theStudyEntry);
2890 * Returns all names with which a GEOM objects was dumped
2891 * into python script to avoid the same names in SMESH script
2893 string_array GetAllDumpNames();