1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : GEOM_Gen.idl
23 // Author : Sergey RUIN
28 #include "SALOME_Exception.idl"
29 #include "SALOME_Component.idl"
30 #include "SALOMEDS.idl"
31 #include "SALOMEDS_Attributes.idl"
33 #include "SALOME_GenericObj.idl"
38 * Topological types of shapes (like Open Cascade types)
40 enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
41 FACE, WIRE, EDGE, VERTEX, SHAPE };
46 enum marker_type { MT_NONE, MT_POINT, MT_PLUS, MT_STAR, MT_O, MT_X, MT_O_POINT, MT_O_PLUS,
47 MT_O_STAR, MT_O_X, MT_BALL, MT_RING1, MT_RING2, MT_RING3, MT_USER };
52 enum marker_size { MS_NONE, MS_10, MS_15, MS_20, MS_25, MS_30, MS_35,
53 MS_40, MS_45, MS_50, MS_55, MS_60, MS_65, MS_70 };
56 * State of shape relatively geometrical surface like plane, sphere or cylinder.
57 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
61 /*! Shape is on surface */
65 * Shape is in the direction defined by the normal and not on surface.
66 * For plane it means above the plane,
67 * For sphere and cylinder it means outside of volume, bounded by the surface.
72 * Shape is in the direction defined by the normal and on surface.
78 * Complementary to ONOUT.
79 * For plane it means below the plane,
80 * For sphere and cylinder it means inside the volume, bounded by the surface
81 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
86 * Complementary to OUT.
93 * Kind of method to find inside one main shape some subshapes,
94 * corresponding to other given shape (its argument)
95 * Is used in functions GEOM_Gen.RestoreSubShapes<xxx>()
97 enum find_shape_method
99 /*! Use GetInPlace functionality. Suits all cases, except transformations */
102 /*! To be used only for transformation result, to find subshapes of argument.
103 * Only this method can be used after transformation.
107 /*! To find only shared subshapes, not modified by the operation */
110 /*! Use GetShapesOnShape method (can work only on solids) */
111 FSM_GetShapesOnShape,
113 /*! Use GetInPlaceByHistory method (can work only after Partition) */
114 FSM_GetInPlaceByHistory
118 * Kind of method to perform filling operation
119 * Is used in functions GEOM_Gen.MakeFilling<xxx>()
121 enum filling_oper_method
123 /*! Default (standard behaviour) */
126 /*! Use edges orientation */
129 /*! Auto-correct edges orientation */
134 typedef sequence<string> string_array;
135 typedef sequence<short> short_array;
136 typedef sequence<long> ListOfLong;
137 typedef sequence<double> ListOfDouble;
139 interface GEOM_Object;
141 typedef sequence<GEOM_Object> ListOfGO;
144 * GEOM_Object: interface of geometric object
146 interface GEOM_Object : SALOME::GenericObj
150 * Get an entry of the object in GEOM component.
155 * Get ID of study, where the object is created.
160 * Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
165 * Get a <VAR>shape_type</VAR> of the object value.
167 shape_type GetShapeType();
170 * Get the topology type of the object value.
171 * In contrast to the shape type, this function returns type of the most
172 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
176 shape_type GetTopologyType();
179 * Get a minimal type of the top-level shapes contained in the object.
180 * This function is useful for the compounds only; for simple shapes it
181 * exactly the same value as GetShapeType().
182 * Note, that compounds are procesed recursively.
183 * \sa GetShapeType(), GetTopologyType()
185 shape_type GetMinShapeType();
188 * Set name of the object.
189 * \param theName is a name which will be associated with this object.
191 void SetName (in string theName);
194 * Get name of the object associated with this object.
199 * Set color of the object.
200 * \param theColor is a color of the object.
202 void SetColor(in SALOMEDS::Color theColor);
205 * Get color of the object.
207 SALOMEDS::Color GetColor();
210 * Toggle auto color mode on the object.
211 * \param theAtoColor is a flag which toggles auto color mode.
213 void SetAutoColor(in boolean theAutoColor);
216 * Get flag of object's auto color mode.
218 boolean GetAutoColor();
221 * Set standard point marker for the object
222 * \param theType standard marker type
223 * \param theSize marker relative size
225 void SetMarkerStd(in marker_type theType, in marker_size theSize );
228 * Set custom point marker for the object. The texture can be added
229 * by LoadTexture() or AddTexture() functions.
230 * \param theTextureId texture ID
232 void SetMarkerTexture(in long theTextureId);
235 * Get type of the point marker assigned to the object
236 * \return current marker type (MT_NONE if no marker is set)
238 marker_type GetMarkerType();
241 * Get size of the point marker assigned to the object
242 * \return current marker relative size (MS_NONE if no marker is set)
244 marker_size GetMarkerSize();
247 * Get texture idenifier of the point marker assigned to the object
248 * \return marker texture ID (0 if no marker set)
250 long GetMarkerTexture();
253 * Set a Study entry where this object was published.
255 void SetStudyEntry (in string theEntry);
258 * Get a Study entry where this object was published.
260 string GetStudyEntry();
263 * Get a list of all GEOM objects on which were the arguments
264 * when this object was constructed and modified.
265 * \note This method is supposed to be used by GUI only.
267 ListOfGO GetDependency();
270 * Get a list of GEOM objects on which the last function that created or modified the object depends.
271 * \note This method is supposed to be used by GUI only.
273 ListOfGO GetLastDependency();
276 * Get the TopoDS_Shape, for colocated case only.
278 long long getShape();
281 ######################################################################
282 * Internal methods (For sub shape identification)
283 ######################################################################
287 * Get geometric shape of the object as a byte stream
289 SALOMEDS::TMPFile GetShapeStream();
292 * Returns True if this object is not a sub shape of another object.
294 boolean IsMainShape();
297 * Get a list of ID's of sub shapes in the main shape.
298 * \note Internal method, suppopsed to be used only by GEOM_Client
300 ListOfLong GetSubShapeIndices();
303 * Get a main shape object to which this object is a sub shape
304 * \note Internal method, suppopsed to be used only by GEOM_Client
306 GEOM_Object GetMainShape();
309 * Return true if geom object representes a shape.
310 * For example, method return false for GEOM_MARKER
315 * Set list of parameters
316 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
317 * used for object creation
319 void SetParameters (in string theParameters);
322 * Return list of notebook variables used for object creation separated by ":" symbol
324 string GetParameters();
329 * GEOM_IOperations: basic methods of all geometric operations
331 interface GEOM_IOperations : SALOME::GenericObj
334 * To know, if the operation was successfully performed
339 * Set the operation error code
340 * \param theErrorID is a string describing the error occured
341 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
343 void SetErrorCode (in string theErrorID);
346 * Get the operation error code
348 string GetErrorCode();
351 * Get ID of study, where the operation is defined
356 * Opens a new transaction
358 void StartOperation();
361 * Closes the previously opened trasaction
363 void FinishOperation();
366 * Aborts the previously opened transaction
368 void AbortOperation();
372 * GEOM_IBasicOperations: interface for basic geometry creation
373 * (Point, Vector, Plane, Marker)
375 interface GEOM_IBasicOperations : GEOM_IOperations
378 * Create point by three coordinates.
379 * \param theX The X coordinate of the point.
380 * \param theY The Y coordinate of the point.
381 * \param theZ The Z coordinate of the point.
382 * \return New GEOM_Object, containing the created point.
384 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
387 * Create a point, distant from the referenced point
388 * on the given distances along the coordinate axes.
389 * \param theReference The referenced point.
390 * \param theX Displacement from the referenced point along OX axis.
391 * \param theY Displacement from the referenced point along OY axis.
392 * \param theZ Displacement from the referenced point along OZ axis.
393 * \return New GEOM_Object, containing the created point.
395 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
396 in double theX, in double theY, in double theZ);
399 * Create a point, corresponding to the given parameter on the given curve.
400 * \param theRefCurve The referenced curve.
401 * \param theParameter Value of parameter on the referenced curve.
402 * \return New GEOM_Object, containing the created point.
404 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
405 in double theParameter);
408 * Create a point on the given curve, projecting given point
409 * \param theRefCurve The referenced curve.
410 * \param theXParameter X co-ordinate of point to project on curve
411 * \param theYParameter Y co-ordinate of point to project on curve
412 * \param theZParameter Z co-ordinate of point to project on curve
413 * \return New GEOM_Object, containing the created point.
415 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
416 in double theXParameter,
417 in double theYarameter,
418 in double theZPameter);
421 * Create a point, corresponding to the given parameters on the
423 * \param theRefSurf The referenced surface.
424 * \param theUParameter Value of U-parameter on the referenced surface.
425 * \param theVParameter Value of V-parameter on the referenced surface.
426 * \return New GEOM_Object, containing the created point.
428 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
429 in double theUParameter,
430 in double theVParameter);
433 * Create a point on the given surface, projecting given point
434 * \param theRefSurf The referenced surface.
435 * \param theXParameter X co-ordinate of point to project on curve
436 * \param theYParameter Y co-ordinate of point to project on curve
437 * \param theZParameter Z co-ordinate of point to project on curve
438 * \return New GEOM_Object, containing the created point.
440 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
441 in double theXParameter,
442 in double theYarameter,
443 in double theZPameter);
447 * Create a point, on two lines intersection.
448 * \param theRefLine1, theRefLine2 The referenced lines.
449 * \return New GEOM_Object, containing the created point.
451 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
452 in GEOM_Object theRefLine2);
455 * Create a vector, corresponding to tangent to the given parameter on the given curve.
456 * \param theRefCurve The referenced curve.
457 * \param theParameter Value of parameter on the referenced curve.This value should be have value
458 * \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
459 * \last parameter of curve.
460 * \return New GEOM_Object, containing the created point.
462 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
463 in double theParameter);
466 * Create a vector with the given components.
467 * \param theDX X component of the vector.
468 * \param theDY Y component of the vector.
469 * \param theDZ Z component of the vector.
470 * \return New GEOM_Object, containing the created vector.
472 GEOM_Object MakeVectorDXDYDZ (in double theDX,
477 * Create a vector between two points.
478 * \param thePnt1 Start point for the vector.
479 * \param thePnt2 End point for the vector.
480 * \return New GEOM_Object, containing the created vector.
482 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
485 * Create a line, passing through the given point
486 * and parrallel to the given direction
487 * \param thePnt Point. The resulting line will pass through it.
488 * \param theDir Direction. The resulting line will be parallel to it.
489 * \return New GEOM_Object, containing the created line.
491 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
494 * Create a line, passing through the given points
495 * \param thePnt1 First of two points, defining the line.
496 * \param thePnt2 Second of two points, defining the line.
497 * \return New GEOM_Object, containing the created line.
499 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
502 * Create a line, given by two faces intersection.
503 * \param theFace1 First of two faces, defining the line.
504 * \param theFace2 Second of two faces, defining the line.
505 * \return New GEOM_Object, containing the created line.
507 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
510 * Create a plane, passing through the three given points
511 * \param thePnt1 First of three points, defining the plane.
512 * \param thePnt2 Second of three points, defining the plane.
513 * \param thePnt3 Fird of three points, defining the plane.
514 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
515 * \return New GEOM_Object, containing the created plane.
517 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
518 in GEOM_Object thePnt2,
519 in GEOM_Object thePnt3,
520 in double theTrimSize);
523 * Create a plane, passing through the given point
524 * and normal to the given vector.
525 * \param thePnt Point, the plane has to pass through.
526 * \param theVec Vector, defining the plane normal direction.
527 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
528 * \return New GEOM_Object, containing the created plane.
530 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
531 in GEOM_Object theVec,
532 in double theTrimSize);
535 * Create a plane, similar to the existing one, but with another size of representing face.
536 * \param theFace Referenced plane or LCS(Marker).
537 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
538 * \return New GEOM_Object, containing the created plane.
540 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
541 in double theTrimSize);
544 * Create a plane, by two vectors.
545 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
546 * \param theVec Vector2, defining the plane normal direction.
547 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
548 * \return New GEOM_Object, containing the created plane.
550 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
551 in GEOM_Object theVec2,
552 in double theTrimSize);
555 * Create a plane, defined by local coordinate system.
556 * \param theLCS Referenced LCS(Marker).
557 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
558 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
559 * \return New GEOM_Object, containing the created plane.
561 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
562 in double theTrimSize,
563 in double theOrientation);
566 * Create a local coordinate system.
567 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
568 * \param theXDX,theXDY,theXDZ Three components of OX direction
569 * \param theYDX,theYDY,theYDZ Three components of OY direction
570 * \return New GEOM_Object, containing the created coordinate system.
572 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
573 in double theXDX, in double theXDY, in double theXDZ,
574 in double theYDX, in double theYDY, in double theYDZ);
577 * Create a local coordinate system from shape.
578 * \param theShape The initial shape to detect the coordinate system.
579 * \return New GEOM_Object, containing the created coordinate system.
581 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
584 * Create a local coordinate system from point and two vectors (DX, DY).
585 * \param theOrigin Point of coordinate system origin.
586 * \param theXVec Vector of X direction.
587 * \param theYVec Vector of Y direction.
588 * \return New GEOM_Object, containing the created coordinate system.
590 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin, in GEOM_Object theXVec, in GEOM_Object theYVec);
593 * Create a tangent plane to specified face in the point with specified parameters.
594 * Values of parameters should be between 0. and 1.0
595 * \param theFace - face for which tangent plane shuold be built.
596 * \param theParameterU - value of parameter by U
597 * \param theParameterV - value of parameter Vthe
598 * \param theTrimSize - defines sizes of created face
599 * \return New GEOM_Object, containing the face built on tangent plane.
601 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
602 in double theParameterU,
603 in double theParameterV,
604 in double theTrimSize);
607 interface GEOM_ITransformOperations : GEOM_IOperations
610 * Translate the given object along the vector, specified by its end points.
611 * \param theObject The object to be translated.
612 * \param thePoint1 Start point of translation vector.
613 * \param thePoint2 End point of translation vector.
616 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
617 in GEOM_Object thePoint1,
618 in GEOM_Object thePoint2);
621 * Translate the given object along the vector, specified
622 * by its end points, creating its copy before the translation.
623 * \param theObject The object to be translated.
624 * \param thePoint1 Start point of translation vector.
625 * \param thePoint2 End point of translation vector.
626 * \return New GEOM_Object, containing the translated object.
628 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
629 in GEOM_Object thePoint1,
630 in GEOM_Object thePoint2);
633 * Translate the given object along the vector, specified by its components.
634 * \param theObject The object to be translated.
635 * \param theDX,theDY,theDZ Components of translation vector.
638 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
639 in double theDX, in double theDY, in double theDZ);
642 * Translate the given object along the vector, specified
643 * by its components, creating its copy before the translation.
644 * \param theObject The object to be translated.
645 * \param theDX,theDY,theDZ Components of translation vector.
646 * \return New GEOM_Object, containing the translated object.
648 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
649 in double theDX, in double theDY, in double theDZ);
653 * Translate the given object along the given vector.
654 * \param theObject The object to be translated.
655 * \param theVector Translation vector, giving both direction and distance.
658 GEOM_Object TranslateVector (in GEOM_Object theObject,
659 in GEOM_Object theVector);
662 * Translate the given object along the given vector,
663 * creating its copy before the translation.
664 * \param theObject The object to be translated.
665 * \param theVector Translation vector, giving both direction and distance.
666 * \return New GEOM_Object, containing the translated object.
668 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
669 in GEOM_Object theVector);
672 * Translate the given object along the given vector on given distance,
673 * creating its copy before the translation.
674 * \param theObject The object to be translated.
675 * \param theVector Translation vector, giving a direction.
676 * \param theDistance Translation distance, giving a distance.
677 * \param theCope Translation copy, creating its copy if true.
678 * \return New GEOM_Object, containing the translated object.
680 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
681 in GEOM_Object theVector,
682 in double theDistance,
686 * Translate the given object along the given vector a given number times
687 * \param theObject The object to be translated.
688 * \param theVector Direction of the translation.
689 * \param theStep Distance to translate on.
690 * \param theNbTimes Quantity of translations to be done.
691 * \return New GEOM_Object, containing compound of all
692 * the shapes, obtained after each translation.
694 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
695 in GEOM_Object theVector,
700 * Conseqently apply two specified translations to theObject specified number of times.
701 * \param theObject The object to be translated.
702 * \param theVector1 Direction of the first translation.
703 * \param theStep1 Step of the first translation.
704 * \param theNbTimes1 Quantity of translations to be done along theVector1.
705 * \param theVector2 Direction of the second translation.
706 * \param theStep2 Step of the second translation.
707 * \param theNbTimes2 Quantity of translations to be done along theVector2.
708 * \return New GEOM_Object, containing compound of all
709 * the shapes, obtained after each translation.
711 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
712 in GEOM_Object theVector1,
715 in GEOM_Object theVector2,
717 in long theNbTimes2);
720 * Rotate given object around vector perpendicular to plane containing three points.
721 * \param theObject The object to be rotated.
722 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
723 * containing the three points.
724 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
727 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
728 in GEOM_Object theCentPoint,
729 in GEOM_Object thePoint1,
730 in GEOM_Object thePoint2);
734 * Rotate given object around vector perpendicular to plane containing three points.
735 * Creating its copy before the rotatation.
736 * \param theObject The object to be rotated.
737 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
738 * containing the three points.
739 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
740 * \return New GEOM_Object, containing the rotated object.
742 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
743 in GEOM_Object theCentPoint,
744 in GEOM_Object thePoint1,
745 in GEOM_Object thePoint2);
748 * Rotate the given object around the given axis on the given angle.
749 * \param theObject The object to be rotated.
750 * \param theAxis Rotation axis.
751 * \param theAngle Rotation angle in radians.
754 GEOM_Object Rotate (in GEOM_Object theObject,
755 in GEOM_Object theAxis,
760 * Rotate the given object around the given axis
761 * on the given angle, creating its copy before the rotatation.
762 * \param theObject The object to be rotated.
763 * \param theAxis Rotation axis.
764 * \param theAngle Rotation angle in radians.
765 * \return New GEOM_Object, containing the rotated object.
767 GEOM_Object RotateCopy (in GEOM_Object theObject,
768 in GEOM_Object theAxis,
773 * Rotate the given object around the given axis a given number times.
774 * Rotation angle will be 2*PI/theNbTimes.
775 * \param theObject The object to be rotated.
776 * \param theAxis The rotation axis.
777 * \param theNbTimes Quantity of rotations to be done.
778 * \return New GEOM_Object, containing compound of all the
779 * shapes, obtained after each rotation.
781 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
782 in GEOM_Object theAxis,
786 * Rotate the given object around the
787 * given axis on the given angle a given number
788 * times and multi-translate each rotation result.
789 * Translation direction passes through center of gravity
790 * of rotated shape and its projection on the rotation axis.
791 * \param theObject The object to be rotated.
792 * \param theAxis Rotation axis.
793 * \param theAngle Rotation angle in graduces.
794 * \param theNbTimes1 Quantity of rotations to be done.
795 * \param theStep Translation distance.
796 * \param theNbTimes2 Quantity of translations to be done.
797 * \return New GEOM_Object, containing compound of all the
798 * shapes, obtained after each transformation.
800 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
801 in GEOM_Object theAxis,
805 in long theNbTimes2);
808 * Replace the given object by an object,
809 * symmetrical to it relatively the given plane.
810 * \param theObject The object to be mirrored.
811 * \param thePlane Plane of symmetry.
813 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
816 * Create an object, symmetrical
817 * to the given one relatively the given plane.
818 * \param theObject The object to be mirrored.
819 * \param thePlane Plane of symmetry.
820 * \return New GEOM_Object, containing the mirrored shape.
822 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
825 * Replace the given object by an object,
826 * symmetrical to it relatively the given axis.
827 * \param theObject The object to be mirrored.
828 * \param theAxis Axis of symmetry.
831 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
834 * Create an object, symmetrical
835 * to the given one relatively the given axis.
836 * \param theObject The object to be mirrored.
837 * \param theAxis Axis of symmetry.
838 * \return New GEOM_Object, containing the mirrored object.
840 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
843 * Replace the given object by an object, symmetrical to it relatively the given point.
844 * \param theObject The object to be mirrored.
845 * \param thePoint Point of symmetry.
848 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
851 * Create an object, symmetrical to the given one relatively the given point.
852 * \param theObject The object to be mirrored.
853 * \param thePoint Point of symmetry.
854 * \return New GEOM_Object, containing the mirrored object.
856 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
859 * Replace the given object by its offset.
860 * \param theObject The base object for the offset.
861 * \param theOffset Offset value.
864 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
867 * Create new object as offset of the given one.
868 * \param theObject The base object for the offset.
869 * \param theOffset Offset value.
870 * \return New GEOM_Object, containing the offset object.
872 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
875 * Scale the given object by the factor.
876 * \param theObject The object to be scaled.
877 * \param thePoint Center point for scaling.
878 * \param theFactor Scaling factor value.
881 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
882 in double theFactor);
885 * Scale the given object by the factor, creating its copy before the scaling.
886 * \param theObject The object to be scaled.
887 * \param thePoint Center point for scaling.
888 * \param theFactor Scaling factor value.
889 * \return New GEOM_Object, containing the scaled shape.
891 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
892 in double theFactor);
895 * Scale the given object by different factors along coordinate axes.
896 * \param theObject The object to be scaled.
897 * \param thePoint Center point for scaling.
898 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
901 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
902 in GEOM_Object thePoint,
903 in double theFactorX,
904 in double theFactorY,
905 in double theFactorZ);
908 * Scale the given object by different factors along coordinate axes,
909 * creating its copy before the scaling.
910 * \param theObject The object to be scaled.
911 * \param thePoint Center point for scaling.
912 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
913 * \return New GEOM_Object, containing the scaled shape.
915 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
916 in GEOM_Object thePoint,
917 in double theFactorX,
918 in double theFactorY,
919 in double theFactorZ);
922 * Modify the Location of the given object by LCS.
923 * \param theObject The object to be displaced.
924 * \param theStartLCS Coordinate system to perform displacement from it.
925 * If \a theStartLCS is NULL, displacement
926 * will be performed from global CS.
927 * If \a theObject itself is used as \a theStartLCS,
928 * its location will be changed to \a theEndLCS.
929 * \param theEndLCS Coordinate system to perform displacement to it.
932 GEOM_Object PositionShape (in GEOM_Object theObject,
933 in GEOM_Object theStartLCS,
934 in GEOM_Object theEndLCS);
937 * Modify the Location of the given object by LCS,
938 * creating its copy before the setting.
939 * \param theObject The object to be displaced.
940 * \param theStartLCS Coordinate system to perform displacement from it.
941 * If \a theStartLCS is NULL, displacement
942 * will be performed from global CS.
943 * If \a theObject itself is used as \a theStartLCS,
944 * its location will be changed to \a theEndLCS.
945 * \param theEndLCS Coordinate system to perform displacement to it.
946 * \return New GEOM_Object, containing the displaced shape.
948 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
949 in GEOM_Object theStartLCS,
950 in GEOM_Object theEndLCS);
953 * Modify the Location of the given object by Path,
954 * \param theObject The object to be displaced.
955 * \param thePath Wire or Edge along that the object will be translated.
956 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
957 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
958 * \param theCopy is a true or false parameter. true is to reverse direction, false is to move normal direction.
959 * \return New GEOM_Object, containing the displaced shape.
962 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
963 in GEOM_Object thePath,
964 in double theDistance,
966 in boolean theReverse);
969 * Recompute the shape from its arguments.
970 * \param theObject The object to be recomputed.
973 GEOM_Object RecomputeObject (in GEOM_Object theObject);
977 * GEOM_I3DPrimOperations: Interface for 3D primitives creation
978 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
979 * Pipe (extrusion along contour), Revolution, Solid (from shell).
981 interface GEOM_I3DPrimOperations : GEOM_IOperations
984 * Create a box with specified dimensions along the coordinate axes
985 * and with edges, parallel to the coordinate axes.
986 * Center of the box will be at point (DX/2, DY/2, DZ/2).
987 * \param theDX Length of Box edges, parallel to OX axis.
988 * \param theDY Length of Box edges, parallel to OY axis.
989 * \param theDZ Length of Box edges, parallel to OZ axis.
990 * \return New GEOM_Object, containing the created box.
992 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
995 * Create a box with two specified opposite vertices,
996 * and with edges, parallel to the coordinate axes
997 * \param thePnt1 First of two opposite vertices.
998 * \param thePnt2 Second of two opposite vertices.
999 * \return New GEOM_Object, containing the created box.
1001 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1004 * Create a face specified dimensions along OX-OY coordinate axes,
1005 * with edges parallel to the coordinate axes.
1006 * Center of the face will be at point (0, 0, 0).
1007 * \param theH Height of the Face.
1008 * \param theW Width of the Face.
1009 * \param theOrientation Orientation belong axis OXY OYZ OZX
1010 * \return New GEOM_Object, containing the created face.
1012 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1014 * Create a face by normale vector or edge and two specified sizes,
1015 * vertical (H) and horisontal (W).
1016 * \param theVec defines plane.
1017 * \param theH vertical size (height).
1018 * \param theW horisontal size (width).
1019 * \return New GEOM_Object, containing the created face.
1021 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1023 * Create a Disk (circular face) with given center, normal vector and radius.
1024 * \param thePnt disk center.
1025 * \param theVec Vector, normal to the plane of the disk.
1026 * \param theR Disk radius.
1027 * \return New GEOM_Object, containing the created disk.
1029 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1030 in GEOM_Object theVec,
1033 * Create a disk (circular face), passing through three given points
1034 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1035 * \return New GEOM_Object, containing the created disk.
1037 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1038 in GEOM_Object thePnt2,
1039 in GEOM_Object thePnt3);
1042 * Create a disk specified dimensions along OX-OY coordinate axes,
1043 * Center of the disk at point (0, 0, 0).
1044 * \param theR of the Disk.
1045 * \param theOrientation Orientation belong axis OXY OYZ OZX
1046 * \return New GEOM_Object, containing the created disk.
1048 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1051 * Create a cylinder with given radius and height at
1052 * the origin of coordinate system. Axis of the cylinder
1053 * will be collinear to the OZ axis of the coordinate system.
1054 * \param theR Cylinder radius.
1055 * \param theH Cylinder height.
1056 * \return New GEOM_Object, containing the created cylinder.
1058 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1061 * Create a cylinder with given base point, axis, radius and height.
1062 * \param thePnt Central point of cylinder base.
1063 * \param theAxis Cylinder axis.
1064 * \param theR Cylinder radius.
1065 * \param theH Cylinder height.
1066 * \return New GEOM_Object, containing the created cylinder.
1068 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1069 in GEOM_Object theAxis,
1074 * Create a cone with given height and radiuses at
1075 * the origin of coordinate system. Axis of the cone will
1076 * be collinear to the OZ axis of the coordinate system.
1077 * \param theR1 Radius of the first cone base.
1078 * \param theR2 Radius of the second cone base.
1079 * \note If both radiuses are non-zero, the cone will be truncated.
1080 * \note If the radiuses are equal, a cylinder will be created instead.
1081 * \param theH Cone height.
1082 * \return New GEOM_Object, containing the created cone.
1084 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1087 * Create a cone with given base point, axis, height and radiuses.
1088 * \param thePnt Central point of the first cone base.
1089 * \param theAxis Cone axis.
1090 * \param theR1 Radius of the first cone base.
1091 * \param theR2 Radius of the second cone base.
1092 * \note If both radiuses are non-zero, the cone will be truncated.
1093 * \note If the radiuses are equal, a cylinder will be created instead.
1094 * \param theH Cone height.
1095 * \return New GEOM_Object, containing the created cone.
1097 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1098 in GEOM_Object theAxis,
1104 * Create a torus with given radiuses at the origin of coordinate system.
1105 * \param theRMajor Torus major radius.
1106 * \param theRMinor Torus minor radius.
1107 * \return New GEOM_Object, containing the created torus.
1109 GEOM_Object MakeTorusRR (in double theRMajor,
1110 in double theRMinor);
1113 * Create a torus with given center, normal vector and radiuses.
1114 * \param thePnt Torus central point.
1115 * \param theVec Torus axis of symmetry.
1116 * \param theRMajor Torus major radius.
1117 * \param theRMinor Torus minor radius.
1118 * \return New GEOM_Object, containing the created torus.
1120 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1121 in GEOM_Object theVec,
1122 in double theRMajor,
1123 in double theRMinor);
1126 * Create a sphere with given radius at the origin of coordinate system.
1127 * \param theR Sphere radius.
1128 * \return New GEOM_Object, containing the created sphere.
1130 GEOM_Object MakeSphereR (in double theR);
1133 * Create a sphere with given center and radius.
1134 * \param thePnt Sphere center.
1135 * \param theR Sphere radius.
1136 * \return New GEOM_Object, containing the created .
1138 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1141 * Create a shape by extrusion of the base shape along the vector,
1142 * i.e. all the space, transfixed by the base shape during its translation
1143 * along the vector on the given distance.
1144 * \param theBase Base shape to be extruded.
1145 * \param theVec Direction of extrusion.
1146 * \param theH Prism dimension along theVec.
1147 * \return New GEOM_Object, containing the created prism.
1149 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1150 in GEOM_Object theVec,
1152 /* The Same Prism but in 2 directions (forward&backward) */
1153 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1154 in GEOM_Object theVec,
1158 * Create a shape by extrusion of the base shape along a vector, defined by two points.
1159 * \param theBase Base shape to be extruded.
1160 * \param thePoint1 First end of extrusion vector.
1161 * \param thePoint2 Second end of extrusion vector.
1162 * \return New GEOM_Object, containing the created prism.
1164 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1165 in GEOM_Object thePoint1,
1166 in GEOM_Object thePoint2);
1167 /* The same prism but in two directions forward&backward */
1168 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1169 in GEOM_Object thePoint1,
1170 in GEOM_Object thePoint2);
1173 * Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1174 * \param theBase Base shape to be extruded.
1175 * \param DX, DY, DZ end of extrusion vector.
1176 * \return New GEOM_Object, containing the created prism.
1178 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1179 in double theDX, in double theDY, in double theDZ);
1180 /* The same prism but in two directions forward&backward */
1181 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1182 in double theDX, in double theDY, in double theDZ);
1185 * Create a shape by extrusion of the base shape along
1186 * the path shape. The path shape can be a wire or an edge.
1187 * \param theBase Base shape to be extruded.
1188 * \param thePath Path shape to extrude the base shape along it.
1189 * \return New GEOM_Object, containing the created pipe.
1191 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1194 * Create a shape by revolution of the base shape around the axis
1195 * on the given angle, i.e. all the space, transfixed by the base
1196 * shape during its rotation around the axis on the given angle.
1197 * \param theBase Base shape to be rotated.
1198 * \param theAxis Rotation axis.
1199 * \param theAngle Rotation angle in radians.
1200 * \return New GEOM_Object, containing the created revolution.
1202 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1203 in GEOM_Object theAxis,
1204 in double theAngle);
1205 /* The Same Revolution but in both ways forward&backward */
1206 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1207 in GEOM_Object theAxis,
1208 in double theAngle);
1211 * Create a filling from the given compound of contours.
1212 * \param theMinDeg a minimal degree of BSpline surface to create
1213 * \param theMaxDeg a maximal degree of BSpline surface to create
1214 * \param theTol2D a 2d tolerance to be reached
1215 * \param theTol3D a 3d tolerance to be reached
1216 * \param theNbIter a number of iteration of approximation algorithm
1217 * \param theMethod Kind of method to perform filling operation.
1218 * \return New GEOM_Object, containing the created filling surface.
1220 GEOM_Object MakeFilling (in GEOM_Object theShape,
1221 in long theMinDeg, in long theMaxDeg,
1222 in double theTol2D, in double theTol3D,
1224 in filling_oper_method theMethod,
1225 in boolean theApprox);
1228 * Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1229 * \param theSeqSections - set of specified sections.
1230 * \param theModeSolid - mode defining building solid or shell
1231 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1232 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1233 * \return New GEOM_Object, containing the created shell or solid.
1235 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1236 in boolean theModeSolid,
1238 in boolean theRuled);
1241 * Create a shape by extrusion of the profile shape along
1242 * the path shape. The path shape can be a wire or an edge.
1243 * the several profiles can be specified in the several locations of path.
1244 * \param theSeqBases - list of Bases shape to be extruded.
1245 * \param theLocations - list of locations on the path corresponding
1246 * specified list of the Bases shapes. Number of locations
1247 * should be equal to number of bases or list of locations can be empty.
1248 * \param thePath - Path shape to extrude the base shape along it.
1249 * \param theWithContact - the mode defining that the section is translated to be in
1250 * contact with the spine.
1251 * \param - WithCorrection - defining that the section is rotated to be
1252 * orthogonal to the spine tangent in the correspondent point
1253 * \return New GEOM_Object, containing the created pipe.
1255 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1256 in ListOfGO theLocations,
1257 in GEOM_Object thePath,
1258 in boolean theWithContact ,
1259 in boolean theWithCorrection );
1262 * Create a shape by extrusion of the profile shape along
1263 * the path shape. The path shape can be a shell or a face.
1264 * the several profiles can be specified in the several locations of path.
1265 * \param theSeqBases - list of Bases shape to be extruded.
1266 * \param theSeqSubBases - list of corresponding subshapes of section shapes.
1267 * \param theLocations - list of locations on the path corresponding
1268 * specified list of the Bases shapes. Number of locations
1269 * should be equal to number of bases.
1270 * \param thePath - Path shape to extrude the base shape along it.
1271 * \param theWithContact - the mode defining that the section is translated to be in
1272 * contact with the spine.
1273 * \param - WithCorrection - defining that the section is rotated to be
1274 * orthogonal to the spine tangent in the correspondent point
1275 * \return New GEOM_Object, containing the created pipe.
1277 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1278 in ListOfGO theSeqSubBases,
1279 in ListOfGO theLocations,
1280 in GEOM_Object thePath,
1281 in boolean theWithContact ,
1282 in boolean theWithCorrection );
1285 * Create solids between given sections
1286 * \param theSeqBases - list of sections (shell or face).
1287 * \param theLocations - list of corresponding vertexes
1288 * \return New GEOM_Object, containing the created solids.
1290 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1291 in ListOfGO theLocations);
1294 * Create a shape by extrusion of the base shape along
1295 * the path shape with constant bi-normal direction along the given vector.
1296 * The path shape can be a wire or an edge.
1297 * \param theBase Base shape to be extruded.
1298 * \param thePath Path shape to extrude the base shape along it.
1299 * \param theVec Vector defines a constant binormal direction to keep the
1300 * same angle beetween the Direction and the sections
1301 * along the sweep surface.
1302 * \return New GEOM_Object, containing the created pipe.
1304 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1305 in GEOM_Object thePath,
1306 in GEOM_Object theVec);
1311 * GEOM_IShapesOperations: Interface for Shapes creation:
1312 * Edge from two points, Wire from edges, Face from wire,
1313 * Shell from faces, Solid from shells, Compound from shapes
1315 interface GEOM_IShapesOperations : GEOM_IOperations
1318 * Create a linear edge with specified ends.
1319 * \param thePnt1 Point for the first end of edge.
1320 * \param thePnt2 Point for the second end of edge.
1321 * \return New GEOM_Object, containing the created edge.
1323 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1326 * Create an edge from specified wire.
1327 * \param theWire source Wire.
1328 * \param theLinearTolerance linear tolerance value
1329 * \param theAngularTolerance angular tolerance value
1330 * \return New GEOM_Object, containing the created edge.
1332 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1333 in double theLinearTolerance,
1334 in double theAngularTolerance);
1337 * Create a wire from the set of edges and wires.
1338 * \param theEdgesAndWires List of edge and/or wires.
1339 * \param theTolerance Maximum distance between vertices, that will be merged.
1340 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1341 * \return New GEOM_Object, containing the created wire.
1343 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1344 in double theTolerance);
1347 * Create a face on the given wire.
1348 * \param theWire closed Wire or Edge to build the face on.
1349 * \param isPlanarWanted If TRUE, only planar face will be built.
1350 * If impossible, NULL object will be returned.
1351 * \return New GEOM_Object, containing the created face.
1353 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1356 * Create a face on the given wires set.
1357 * \param theWires List of closed wires or edges to build the face on.
1358 * \param isPlanarWanted If TRUE, only planar face will be built.
1359 * If impossible, NULL object will be returned.
1360 * \return New GEOM_Object, containing the created face.
1362 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1365 * Create a shell from the set of faces and shells.
1366 * \param theFacesAndShells List of faces and/or shells.
1367 * \return New GEOM_Object, containing the created shell.
1369 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1372 * Create a solid, bounded by the given shell.
1373 * \param theShell Bounding shell.
1374 * \return New GEOM_Object, containing the created solid.
1376 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1379 * Create a solid, bounded by the given shells.
1380 * \param theShells Bounding shells.
1381 * \return New GEOM_Object, containing the created solid.
1383 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1386 * Create a compound of the given shapes.
1387 * \param theShapes List of shapes to put in compound.
1388 * \return New GEOM_Object, containing the created compound.
1390 GEOM_Object MakeCompound (in ListOfGO theShapes);
1393 * Replace coincident faces in theShape by one face.
1394 * \param theShape Initial shape.
1395 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1396 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1397 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1399 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1402 * Find coincident faces in theShape for possible gluing.
1403 * \param theShape Initial shape.
1404 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1407 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1410 * Replace coincident faces in theShape by one face
1411 * in compliance with given list of faces
1412 * \param theShape Initial shape.
1413 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1414 * \param theFaces List of faces for gluing.
1415 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1416 * \return New GEOM_Object, containing a copy of theShape without some faces.
1418 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1419 in ListOfGO theFaces, in boolean doKeepNonSolids);
1422 * Get all sub-shapes and groups of \a theShape,
1423 * that were created already by any other methods.
1424 * \param theShape Any shape.
1425 * \param theGroupsOnly If this parameter is TRUE, only groups will be
1426 * returned, else all found sub-shapes and groups.
1427 * \return List of existing sub-objects of \a theShape.
1429 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
1430 in boolean theGroupsOnly);
1433 * Deprecated method. Use MakeAllSubShapes() instead.
1435 ListOfGO MakeExplode (in GEOM_Object theShape,
1436 in long theShapeType,
1437 in boolean isSorted);
1440 * Explode a shape on subshapes of a given type.
1441 * \param theShape Shape to be exploded.
1442 * \param theShapeType Type of sub-shapes to be retrieved.
1443 * \param isSorted If this parameter is TRUE, sub-shapes will be
1444 * sorted by coordinates of their gravity centers.
1445 * \return List of sub-shapes of type theShapeType, contained in theShape.
1447 ListOfGO MakeAllSubShapes (in GEOM_Object theShape,
1448 in long theShapeType,
1449 in boolean isSorted);
1452 * Deprecated method. Use GetAllSubShapesIDs() instead.
1454 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1455 in long theShapeType,
1456 in boolean isSorted);
1459 * Explode a shape on subshapes of a given type.
1460 * Does the same, as MakeAllSubShapes, but returns IDs of
1461 * sub-shapes, not GEOM_Objects. It works faster.
1462 * \param theShape Shape to be exploded.
1463 * \param theShapeType Type of sub-shapes to be retrieved.
1464 * \param isSorted If this parameter is TRUE, sub-shapes will be
1465 * sorted by coordinates of their gravity centers.
1466 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1468 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
1469 in long theShapeType,
1470 in boolean isSorted);
1473 * Get a sub shape defined by its unique ID inside \a theMainShape
1474 * \note The sub shape GEOM_Objects can has ONLY ONE function.
1475 * Don't try to apply modification operations on them.
1477 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1481 * Get global index of \a theSubShape in \a theMainShape.
1482 * \param theMainShape Main shape.
1483 * \param theSubShape Sub-shape of the main shape.
1484 * \return global index of \a theSubShape in \a theMainShape.
1486 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1489 * Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1490 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1491 * to generate automatic names for sub-shapes, when publishing them in a study.
1492 * \param theMainShape Main shape.
1493 * \param theSubShape Sub-shape of the main shape.
1494 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1496 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1499 * \brief Get name of type of \a theShape.
1501 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1502 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1503 * to generate automatic names for sub-shapes, when publishing them in a study.
1504 * \param theShape The shape to get a type of.
1505 * \return String, containing a type name of \a theShape.
1507 string GetShapeTypeString (in GEOM_Object theShape);
1510 * Count number of faces in the given shape.
1511 * \param theShape Shape to count faces in.
1512 * \return Number of faces in the given shape.
1514 long NumberOfFaces (in GEOM_Object theShape);
1517 * Count number of edges in the given shape.
1518 * \param theShape Shape to count edges in.
1519 * \return Number of edges in theShape.
1521 long NumberOfEdges (in GEOM_Object theShape);
1524 * Count number of subshapes of type \a theShapeType in the given shape.
1525 * \param theShape Shape to count subshapes in.
1526 * \param theShapeType The type of subshapes to count.
1527 * \return Number of subshapes of type \a theShapeType in \a theShape.
1529 long NumberOfSubShapes (in GEOM_Object theShape,
1530 in long theShapeType);
1533 * Reverses an orientation the given shape.
1534 * \param theShape Shape to be reversed.
1535 * \return The reversed copy of theShape.
1537 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1540 * Retrieve all free faces from the given shape.
1541 * Free face is a face, which is not shared between two shells of the shape.
1542 * \param theShape Shape to find free faces in.
1543 * \return List of IDs of all free faces, contained in theShape.
1545 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1548 * Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1549 * \param theShape1 Shape to find sub-shapes in.
1550 * \param theShape2 Shape to find shared sub-shapes with.
1551 * \param theShapeType Type of sub-shapes to be retrieved.
1552 * \return List of sub-shapes of theShape1, shared with theShape2.
1554 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1555 in GEOM_Object theShape2,
1556 in long theShapeType);
1559 * Get all sub-shapes, shared by all shapes in the list \a theShapes.
1560 * \param theShapes Shapes to find common sub-shapes of.
1561 * \param theShapeType Type of sub-shapes to be retrieved.
1562 * \return List of objects, that are sub-shapes of all given shapes.
1564 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
1565 in long theShapeType);
1568 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1569 * the specified plane by the certain way, defined through \a theState parameter.
1570 * \param theShape Shape to find sub-shapes of.
1571 * \param theShapeType Type of sub-shapes to be retrieved.
1572 * \param theAx1 Vector (or line, or linear edge), specifying normal
1573 * direction and location of the plane to find shapes on.
1574 * \param theState The state of the subshapes to find.
1575 * \return List of all found sub-shapes.
1577 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1578 in long theShapeType,
1579 in GEOM_Object theAx1,
1580 in shape_state theState);
1582 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1583 * the specified plane by the certain way, defined through \a theState parameter.
1584 * \param theShape Shape to find sub-shapes of.
1585 * \param theShapeType Type of sub-shapes to be retrieved.
1586 * \param theAx1 Vector (or line, or linear edge), specifying normal
1587 * direction of the plane to find shapes on.
1588 * \param thePnt Point specifying location of the plane to find shapes on.
1589 * \param theState The state of the subshapes to find.
1590 * \return List of all found sub-shapes.
1592 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1593 in long theShapeType,
1594 in GEOM_Object theAx1,
1595 in GEOM_Object thePnt,
1596 in shape_state theState);
1601 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1602 * the specified cylinder by the certain way, defined through \a theState parameter.
1603 * \param theShape Shape to find sub-shapes of.
1604 * \param theShapeType Type of sub-shapes to be retrieved.
1605 * \param theAxis Vector (or line, or linear edge), specifying
1606 * axis of the cylinder to find shapes on.
1607 * \param theRadius Radius of the cylinder to find shapes on.
1608 * \param theState The state of the subshapes to find.
1609 * \return List of all found sub-shapes.
1611 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1612 in long theShapeType,
1613 in GEOM_Object theAxis,
1614 in double theRadius,
1615 in shape_state theState);
1618 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1619 * the specified cylinder by the certain way, defined through \a theState parameter.
1620 * \param theShape Shape to find sub-shapes of.
1621 * \param theShapeType Type of sub-shapes to be retrieved.
1622 * \param theAxis Vector (or line, or linear edge), specifying
1623 * axis of the cylinder to find shapes on.
1624 * \param thePnt Point specifying location of the bottom of the cylinder.
1625 * \param theRadius Radius of the cylinder to find shapes on.
1626 * \param theState The state of the subshapes to find.
1627 * \return List of all found sub-shapes.
1629 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1630 in long theShapeType,
1631 in GEOM_Object theAxis,
1632 in GEOM_Object thePnt,
1633 in double theRadius,
1634 in shape_state theState);
1637 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1638 * the specified sphere by the certain way, defined through \a theState parameter.
1639 * \param theShape Shape to find sub-shapes of.
1640 * \param theShapeType Type of sub-shapes to be retrieved.
1641 * \param theCenter Point, specifying center of the sphere to find shapes on.
1642 * \param theRadius Radius of the sphere to find shapes on.
1643 * \param theState The state of the subshapes to find.
1644 * \return List of all found sub-shapes.
1646 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1647 in long theShapeType,
1648 in GEOM_Object theCenter,
1649 in double theRadius,
1650 in shape_state theState);
1653 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1654 * the specified quadrangle by the certain way, defined through \a theState parameter.
1655 * \param theShape Shape to find sub-shapes of.
1656 * \param theShapeType Type of sub-shapes to be retrieved.
1657 * \param theTopLeftPoint Top left quadrangle corner
1658 * \param theTopRigthPoint Top right quadrangle corner
1659 * \param theBottomLeftPoint Bottom left quadrangle corner
1660 * \param theBottomRigthPoint Bottom right quadrangle corner
1661 * \param theState The state of the subshapes to find.
1662 * \return List of all found sub-shapes.
1664 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1665 in long theShapeType,
1666 in GEOM_Object theTopLeftPoint,
1667 in GEOM_Object theTopRigthPoint,
1668 in GEOM_Object theBottomLeftPoint,
1669 in GEOM_Object theBottomRigthPoint,
1670 in shape_state theState);
1673 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1674 * the specified plane by the certain way, defined through \a theState parameter.
1675 * \param theShape Shape to find sub-shapes of.
1676 * \param theShapeType Type of sub-shapes to be retrieved.
1677 * \param theAx1 Vector (or line, or linear edge), specifying normal
1678 * direction and location of the plane to find shapes on.
1679 * \param theState The state of the subshapes to find.
1680 * \return List of IDs of all found sub-shapes.
1682 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1683 in long theShapeType,
1684 in GEOM_Object theAx1,
1685 in shape_state theState);
1688 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1689 * the specified plane by the certain way, defined through \a theState parameter.
1690 * \param theShape Shape to find sub-shapes of.
1691 * \param theShapeType Type of sub-shapes to be retrieved.
1692 * \param theAx1 Vector (or line, or linear edge), specifying normal
1693 * direction of the plane to find shapes on.
1694 * \param thePnt Point specifying location of the plane to find shapes on.
1695 * \param theState The state of the subshapes to find.
1696 * \return List of IDs of all found sub-shapes.
1698 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1699 in long theShapeType,
1700 in GEOM_Object theAx1,
1701 in GEOM_Object thePnt,
1702 in shape_state theState);
1705 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1706 * the specified cylinder by the certain way, defined through \a theState parameter.
1707 * \param theShape Shape to find sub-shapes of.
1708 * \param theShapeType Type of sub-shapes to be retrieved.
1709 * \param theAxis Vector (or line, or linear edge), specifying
1710 * axis of the cylinder to find shapes on.
1711 * \param theRadius Radius of the cylinder to find shapes on.
1712 * \param theState The state of the subshapes to find.
1713 * \return List of IDs of all found sub-shapes.
1715 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1716 in long theShapeType,
1717 in GEOM_Object theAxis,
1718 in double theRadius,
1719 in shape_state theState);
1722 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1723 * the specified cylinder by the certain way, defined through \a theState parameter.
1724 * \param theShape Shape to find sub-shapes of.
1725 * \param theShapeType Type of sub-shapes to be retrieved.
1726 * \param theAxis Vector (or line, or linear edge), specifying
1727 * axis of the cylinder to find shapes on.
1728 * \param thePnt Point specifying location of the bottom of the cylinder.
1729 * \param theRadius Radius of the cylinder to find shapes on.
1730 * \param theState The state of the subshapes to find.
1731 * \return List of IDs all found sub-shapes.
1733 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1734 in long theShapeType,
1735 in GEOM_Object theAxis,
1736 in GEOM_Object thePnt,
1737 in double theRadius,
1738 in shape_state theState);
1741 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1742 * the specified sphere by the certain way, defined through \a theState parameter.
1743 * \param theShape Shape to find sub-shapes of.
1744 * \param theShapeType Type of sub-shapes to be retrieved.
1745 * \param theCenter Point, specifying center of the sphere to find shapes on.
1746 * \param theRadius Radius of the sphere to find shapes on.
1747 * \param theState The state of the subshapes to find.
1748 * \return List of IDs of all found sub-shapes.
1750 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1751 in long theShapeType,
1752 in GEOM_Object theCenter,
1753 in double theRadius,
1754 in shape_state theState);
1757 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1758 * the specified quadrangle by the certain way, defined through \a theState parameter.
1759 * \param theShape Shape to find sub-shapes of.
1760 * \param theShapeType Type of sub-shapes to be retrieved.
1761 * \param theTopLeftPoint Top left quadrangle corner
1762 * \param theTopRigthPoint Top right quadrangle corner
1763 * \param theBottomLeftPoint Bottom left quadrangle corner
1764 * \param theBottomRigthPoint Bottom right quadrangle corner
1765 * \param theState The state of the subshapes to find.
1766 * \return List of IDs of all found sub-shapes.
1768 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1769 in long theShapeType,
1770 in GEOM_Object theTopLeftPoint,
1771 in GEOM_Object theTopRigthPoint,
1772 in GEOM_Object theBottomLeftPoint,
1773 in GEOM_Object theBottomRigthPoint,
1774 in shape_state theState);
1777 * \brief Find subshapes complying with given status
1778 * \param theBox - the box to check state of subshapes against
1779 * \param theShape - the shape to explore
1780 * \param theShapeType - type of subshape of theShape
1781 * \param theState - required state
1782 * \return List of IDs of all found sub-shapes.
1784 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1785 in GEOM_Object theShape,
1786 in long theShapeType,
1787 in shape_state theState);
1790 * \brief Find subshapes complying with given status
1791 * \param theBox - the box to check state of subshapes against
1792 * \param theShape - the shape to explore
1793 * \param theShapeType - type of subshape of theShape
1794 * \param theState - required state
1795 * \return List of all found sub-shapes.
1797 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1798 in GEOM_Object theShape,
1799 in long theShapeType,
1800 in shape_state theState);
1803 * \brief Find subshapes complying with given status
1804 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1805 * \param theShape - the shape to explore
1806 * \param theShapeType - type of subshape of theShape
1807 * \param theState - required state
1808 * \return List of IDs of all found sub-shapes.
1810 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
1811 in GEOM_Object theShape,
1812 in short theShapeType,
1813 in shape_state theState);
1816 * \brief Find subshapes complying with given status
1817 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1818 * \param theShape - the shape to explore
1819 * \param theShapeType - type of subshape of theShape
1820 * \param theState - required state
1821 * \return List of all found sub-shapes.
1823 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
1824 in GEOM_Object theShape,
1825 in short theShapeType,
1826 in shape_state theState);
1829 * \brief Find subshapes complying with given status
1830 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1831 * \param theShape - the shape to explore
1832 * \param theShapeType - type of subshape of theShape
1833 * \param theState - required state
1834 * \return compound includes all found sub-shapes.
1836 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
1837 in GEOM_Object theShape,
1838 in short theShapeType,
1839 in shape_state theState);
1842 * Get sub-shape(s) of \a theShapeWhere, which are
1843 * coincident with \a theShapeWhat or could be a part of it.
1844 * \param theShapeWhere Shape to find sub-shapes of.
1845 * \param theShapeWhat Shape, specifying what to find.
1846 * \return Group of all found sub-shapes or a single found sub-shape.
1848 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1849 in GEOM_Object theShapeWhat);
1852 * Get sub-shape(s) of \a theShapeWhere, which are
1853 * coincident with \a theShapeWhat or could be a part of it.
1855 * Implementation of this method is based on a saved history of an operation,
1856 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1857 * arguments (an argument shape or a sub-shape of an argument shape).
1858 * The operation could be the Partition or one of boolean operations,
1859 * performed on simple shapes (not on compounds).
1861 * \param theShapeWhere Shape to find sub-shapes of.
1862 * \param theShapeWhat Shape, specifying what to find.
1863 * \return Group of all found sub-shapes or a single found sub-shape.
1865 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
1866 in GEOM_Object theShapeWhat);
1869 * Get sub-shape of theShapeWhere, which are
1870 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1871 * \param theShapeWhere Shape to find sub-shapes of.
1872 * \param theShapeWhat Shape, specifying what to find.
1873 * \return found sub-shape.
1875 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1876 in GEOM_Object theShapeWhat);
1880 * GEOM_IBlocksOperations: Interface for Blocks construction
1881 * Face from points or edges, Block from faces,
1882 * Blocks multi-translation and multi-rotation
1884 interface GEOM_IBlocksOperations : GEOM_IOperations
1887 * Creation of blocks
1891 * Create a quadrangle face from four edges. Order of Edges is not
1892 * important. It is not necessary that edges share the same vertex.
1893 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1894 * \return New GEOM_Object, containing the created face.
1896 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1897 in GEOM_Object theEdge2,
1898 in GEOM_Object theEdge3,
1899 in GEOM_Object theEdge4);
1902 * Create a quadrangle face on two edges.
1903 * The missing edges will be built by creating the shortest ones.
1904 * \param theEdge1,theEdge2 Two opposite edges for the face.
1905 * \return New GEOM_Object, containing the created face.
1907 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1908 in GEOM_Object theEdge2);
1911 * Create a quadrangle face with specified corners.
1912 * The missing edges will be built by creating the shortest ones.
1913 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1914 * \return New GEOM_Object, containing the created face.
1916 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1917 in GEOM_Object thePnt2,
1918 in GEOM_Object thePnt3,
1919 in GEOM_Object thePnt4);
1922 * Create a hexahedral solid, bounded by the six given faces. Order of
1923 * faces is not important. It is not necessary that Faces share the same edge.
1924 * \param theFace1-theFace6 Faces for the hexahedral solid.
1925 * \return New GEOM_Object, containing the created solid.
1927 GEOM_Object MakeHexa (in GEOM_Object theFace1,
1928 in GEOM_Object theFace2,
1929 in GEOM_Object theFace3,
1930 in GEOM_Object theFace4,
1931 in GEOM_Object theFace5,
1932 in GEOM_Object theFace6);
1935 * Create a hexahedral solid between two given faces.
1936 * The missing faces will be built by creating the smallest ones.
1937 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1938 * \return New GEOM_Object, containing the created solid.
1940 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1941 in GEOM_Object theFace2);
1944 * Extract elements of blocks and blocks compounds
1948 * Get a vertex, found in the given shape by its coordinates.
1949 * \param theShape Block or a compound of blocks.
1950 * \param theX,theY,theZ Coordinates of the sought vertex.
1951 * \param theEpsilon Maximum allowed distance between the resulting
1952 * vertex and point with the given coordinates.
1953 * \return New GEOM_Object, containing the found vertex.
1955 GEOM_Object GetPoint (in GEOM_Object theShape,
1959 in double theEpsilon);
1962 * Find a vertex of the given shape, which has minimal distance to the given point.
1963 * \param theShape Any shape.
1964 * \param thePoint Point, close to the desired vertex.
1965 * \return New GEOM_Object, containing the found vertex.
1967 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
1968 in GEOM_Object thePoint);
1971 * Get an edge, found in the given shape by two given vertices.
1972 * \param theShape Block or a compound of blocks.
1973 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1974 * \return New GEOM_Object, containing the found edge.
1976 GEOM_Object GetEdge (in GEOM_Object theShape,
1977 in GEOM_Object thePoint1,
1978 in GEOM_Object thePoint2);
1981 * Find an edge of the given shape, which has minimal distance to the given point.
1982 * \param theShape Block or a compound of blocks.
1983 * \param thePoint Point, close to the desired edge.
1984 * \return New GEOM_Object, containing the found edge.
1986 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1987 in GEOM_Object thePoint);
1990 * Returns a face, found in the given shape by four given corner vertices.
1991 * \param theShape Block or a compound of blocks.
1992 * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1993 * \return New GEOM_Object, containing the found face.
1995 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1996 in GEOM_Object thePoint1,
1997 in GEOM_Object thePoint2,
1998 in GEOM_Object thePoint3,
1999 in GEOM_Object thePoint4);
2002 * Get a face of block, found in the given shape by two given edges.
2003 * \param theShape Block or a compound of blocks.
2004 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2005 * \return New GEOM_Object, containing the found face.
2007 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2008 in GEOM_Object theEdge1,
2009 in GEOM_Object theEdge2);
2012 * Find a face, opposite to the given one in the given block.
2013 * \param theBlock Must be a hexahedral solid.
2014 * \param theFace Face of \a theBlock, opposite to the desired face.
2015 * \return New GEOM_Object, containing the found face.
2017 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2018 in GEOM_Object theFace);
2021 * Find a face of the given shape, which has minimal distance to the given point.
2022 * \param theShape Block or a compound of blocks.
2023 * \param thePoint Point, close to the desired face.
2024 * \return New GEOM_Object, containing the found face.
2026 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2027 in GEOM_Object thePoint);
2030 * Find a face of block, whose outside normale has minimal angle with the given vector.
2031 * \param theShape Block or a compound of blocks.
2032 * \param theVector Vector, close to the normale of the desired face.
2033 * \return New GEOM_Object, containing the found face.
2035 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2036 in GEOM_Object theVector);
2039 * Find all subshapes of type \a theShapeType of the given shape,
2040 * which have minimal distance to the given point.
2041 * \param theShape Any shape.
2042 * \param thePoint Point, close to the desired shape.
2043 * \param theShapeType Defines what kind of subshapes is searched.
2044 * \param theTolerance The tolerance for distances comparison. All shapes
2045 * with distances to the given point in interval
2046 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2047 * \return New GEOM_Object, containing a group of all found shapes.
2049 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2050 in GEOM_Object thePoint,
2051 in long theShapeType,
2052 in double theTolerance);
2055 * Extract blocks from blocks compounds
2059 * Check, if the compound contains only specified blocks.
2060 * \param theCompound The compound to check.
2061 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2062 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2063 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2064 * \return TRUE, if the given compound contains only blocks.
2065 * \return theNbBlocks Number of specified blocks in theCompound.
2067 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2068 in long theMinNbFaces,
2069 in long theMaxNbFaces,
2070 out long theNbBlocks);
2073 * Enumeration of Blocks Compound defects.
2077 /* Each element of the compound should be a Block */
2080 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2083 /* A connection between two Blocks should be an entire face or an entire edge */
2086 /* The compound should be connexe */
2089 /* The glue between two quadrangle faces should be applied */
2094 * Description of Blocks Compound defect: type and incriminated sub-shapes.
2099 ListOfLong incriminated;
2103 * Sequence of all Blocks Compound defects.
2105 typedef sequence<BCError> BCErrors;
2108 * Check, if the compound of blocks is given.
2109 * To be considered as a compound of blocks, the
2110 * given shape must satisfy the following conditions:
2111 * - Each element of the compound should be a Block (6 faces and 12 edges).
2112 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2113 * - The compound should be connexe.
2114 * - The glue between two quadrangle faces should be applied.
2115 * \note Single block is also accepted as a valid compound of blocks.
2116 * \param theCompound The compound to check.
2117 * \return TRUE, if the given shape is a compound of blocks.
2118 * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
2120 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2121 out BCErrors theErrors);
2124 * Convert sequence of Blocks Compound errors, returned by
2125 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2126 * \param theCompound The bad compound.
2127 * \param theErrors The sequence of \a theCompound errors.
2128 * \return String, describing all the errors in form, suitable for printing.
2130 string PrintBCErrors (in GEOM_Object theCompound,
2131 in BCErrors theErrors);
2134 * Remove all seam and degenerated edges from \a theShape.
2135 * Unite faces and edges, sharing one surface.
2136 * \param theShape The compound or single solid to remove irregular edges from.
2137 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2138 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2139 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2140 * For blocks repairing recommended value is 6.
2141 * \return Improved shape.
2143 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2144 in long theOptimumNbFaces);
2147 * Check, if the given shape is a blocks compound.
2148 * Fix all detected errors.
2149 * \note Single block can be also fixed by this method.
2150 * \param theCompound The compound to check and improve.
2151 * \return Improved compound.
2153 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2156 * Get all the blocks, contained in the given compound.
2157 * \param theCompound The compound to explode.
2158 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2159 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2160 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2161 * \return List of GEOM_Objects, containing the retrieved blocks.
2163 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2164 in long theMinNbFaces,
2165 in long theMaxNbFaces);
2168 * Find block, containing the given point inside its volume or on boundary.
2169 * \param theCompound Compound, to find block in.
2170 * \param thePoint Point, close to the desired block. If the point lays on
2171 * boundary between some blocks, we return block with nearest center.
2172 * \return New GEOM_Object, containing the found block.
2174 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2175 in GEOM_Object thePoint);
2178 * Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2179 * \param theCompound Compound, to find block in.
2180 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2181 * \return New GEOM_Object, containing the found block.
2183 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2184 in ListOfGO theParts);
2187 * Return all blocks, containing all the elements, passed as the parts.
2188 * \param theCompound Compound, to find blocks in.
2189 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2190 * \return List of GEOM_Objects, containing the found blocks.
2192 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2193 in ListOfGO theParts);
2196 * Operations on blocks with gluing of result
2200 * Multi-transformate block and glue the result.
2201 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2202 * \param theBlock Hexahedral solid to be multi-transformed.
2203 * \param theDirFace1 First direction face global index.
2204 * \param theDirFace2 Second direction face global index.
2205 * \param theNbTimes Quantity of transformations to be done.
2206 * \note Global index of sub-shape can be obtained, using method
2207 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2208 * \return New GEOM_Object, containing the result shape.
2210 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2211 in long theDirFace1,
2212 in long theDirFace2,
2213 in long theNbTimes);
2216 * Multi-transformate block and glue the result.
2217 * \param theBlock Hexahedral solid to be multi-transformed.
2218 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2219 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2220 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2221 * \return New GEOM_Object, containing the result shape.
2223 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2224 in long theDirFace1U,
2225 in long theDirFace2U,
2226 in long theNbTimesU,
2227 in long theDirFace1V,
2228 in long theDirFace2V,
2229 in long theNbTimesV);
2232 * Special operation - propagation
2236 * Build all possible propagation groups.
2237 * Propagation group is a set of all edges, opposite to one (main)
2238 * edge of this group directly or through other opposite edges.
2239 * Notion of Opposite Edge make sence only on quadrangle face.
2240 * \param theShape Shape to build propagation groups on.
2241 * \return List of GEOM_Objects, each of them is a propagation group.
2243 ListOfGO Propagate (in GEOM_Object theShape);
2247 * GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
2249 interface GEOM_IBooleanOperations : GEOM_IOperations
2252 * Perform one of boolean operations on two given shapes.
2253 * \param theShape1 First argument for boolean operation.
2254 * \param theShape2 Second argument for boolean operation.
2255 * \param theOperation Indicates the operation to be done:
2256 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2257 * \return New GEOM_Object, containing the result shape.
2259 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2260 in GEOM_Object theShape2,
2261 in long theOperation);
2264 * Perform partition operation.
2265 * \param theShapes Shapes to be intersected.
2266 * \param theTools Shapes to intersect theShapes.
2267 * \note Each compound from ListShapes and ListTools will be exploded in order
2268 * to avoid possible intersection between shapes from this compound.
2269 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2270 * \param KeepNonlimitShapes: if this parameter == 0, then only shapes of
2271 * target type (equal to Limit) are kept in the result,
2272 * else standalone shapes of lower dimension
2273 * are kept also (if they exist).
2275 * After implementation new version of PartitionAlgo (October 2006)
2276 * other parameters are ignored by current functionality. They are kept
2277 * in this function only for supporting old versions.
2278 * Ignored parameters:
2279 * \param theKeepInside Shapes, outside which the results will be deleted.
2280 * Each shape from theKeepInside must belong to theShapes also.
2281 * \param theRemoveInside Shapes, inside which the results will be deleted.
2282 * Each shape from theRemoveInside must belong to theShapes also.
2283 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2284 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2286 * \return New GEOM_Object, containing the result shapes.
2288 GEOM_Object MakePartition (in ListOfGO theShapes,
2289 in ListOfGO theTools,
2290 in ListOfGO theKeepInside,
2291 in ListOfGO theRemoveInside,
2293 in boolean theRemoveWebs,
2294 in ListOfLong theMaterials,
2295 in short theKeepNonlimitShapes);
2298 * Perform partition operation.
2299 * This method may be usefull if it is needed to make a partition for
2300 * a compound containing nonintersected shapes. Performance will be better
2301 * since intersection between shapes from compound is not performed.
2303 * Description of all parameters as in previous method MakePartition()
2305 * \note Passed compounds (via ListShapes or via ListTools)
2306 * have to consist of nonintersecting shapes.
2308 * \return New GEOM_Object, containing the result shapes.
2310 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2311 in ListOfGO theTools,
2312 in ListOfGO theKeepInside,
2313 in ListOfGO theRemoveInside,
2315 in boolean theRemoveWebs,
2316 in ListOfLong theMaterials,
2317 in short theKeepNonlimitShapes);
2320 * Perform partition of the Shape with the Plane
2321 * \param theShape Shape to be intersected.
2322 * \param thePlane Tool shape, to intersect theShape.
2323 * \return New GEOM_Object, containing the result shape.
2325 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2326 in GEOM_Object thePlane);
2330 * GEOM_ICurvesOperations: Interface for curves creation.
2331 * Polyline, Circle, Spline (Bezier and Interpolation)
2333 interface GEOM_ICurvesOperations : GEOM_IOperations
2336 * Create a circle with given center, normal vector and radius.
2337 * \param thePnt Circle center.
2338 * \param theVec Vector, normal to the plane of the circle.
2339 * \param theR Circle radius.
2340 * \return New GEOM_Object, containing the created circle.
2342 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2343 in GEOM_Object theVec,
2346 * Create a circle, passing through three given points
2347 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2348 * \return New GEOM_Object, containing the created circle.
2350 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2351 in GEOM_Object thePnt2,
2352 in GEOM_Object thePnt3);
2354 * Create a circle with given center, with a radius equals the distance from center to Point1
2355 * and on a plane defined by all of three points.
2356 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2357 * \return New GEOM_Object, containing the created circle.
2359 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2360 in GEOM_Object thePnt2,
2361 in GEOM_Object thePnt3);
2363 * Create an ellipse with given center, normal vector and radiuses.
2364 * \param thePnt Ellipse center.
2365 * \param theVec Vector, normal to the plane of the ellipse.
2366 * \param theRMajor Major ellipse radius.
2367 * \param theRMinor Minor ellipse radius.
2368 * \return New GEOM_Object, containing the created ellipse.
2370 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2371 in GEOM_Object theVec,
2372 in double theRMajor,
2373 in double theRMinor);
2376 * Create an ellipse with given center, normal vector, main axis vector and radiuses.
2377 * \param thePnt Ellipse center.
2378 * \param theVec Vector, normal to the plane of the ellipse.
2379 * \param theRMajor Major ellipse radius.
2380 * \param theRMinor Minor ellipse radius.
2381 * \param theVecMaj Vector, direction of the ellipse's main axis.
2382 * \return New GEOM_Object, containing the created ellipse.
2384 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2385 in GEOM_Object theVec,
2386 in double theRMajor,
2387 in double theRMinor,
2388 in GEOM_Object theVecMaj);
2391 * Create an arc of circle, passing through three given points.
2392 * \param thePnt1 Start point of the arc.
2393 * \param thePnt2 Middle point of the arc.
2394 * \param thePnt3 End point of the arc.
2395 * \return New GEOM_Object, containing the created arc.
2397 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2398 in GEOM_Object thePnt2,
2399 in GEOM_Object thePnt3);
2402 * Create an arc of circle of center C from one point to another
2403 * \param theCenter Center point of the arc.
2404 * \param thePnt1 Start point of the arc.
2405 * \param thePnt2 End point of the arc.
2406 * \param theSense Orientation of the arc
2407 * \return New GEOM_Object, containing the created arc.
2409 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2410 in GEOM_Object thePnt1,
2411 in GEOM_Object thePnt2,
2412 in boolean theSense);
2415 * Create an arc of ellipse of center C and two points P1 P2.
2416 * \param theCenter Center point of the arc.
2417 * \param thePnt1 Major radius is distance from center to Pnt1.
2418 * \param thePnt2 define a plane and Minor radius as a shortest distance from Pnt2 to vector Center->Pnt1.
2419 * \return New GEOM_Object, containing the created arc.
2421 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2422 in GEOM_Object thePnt1,
2423 in GEOM_Object thePnt2);
2427 * Create a polyline on the set of points.
2428 * \param thePoints Sequence of points for the polyline.
2429 * \return New GEOM_Object, containing the created polyline.
2431 GEOM_Object MakePolyline (in ListOfGO thePoints);
2434 * Create bezier curve on the set of points.
2435 * \param thePoints Sequence of points for the bezier curve.
2436 * \return New GEOM_Object, containing the created bezier curve.
2438 GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
2441 * Create B-Spline curve on the set of points.
2442 * \param thePoints Sequence of points for the B-Spline curve.
2443 * \param theIsClosed If TRUE, build a closed curve.
2444 * \return New GEOM_Object, containing the created B-Spline curve.
2446 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2447 in boolean theIsClosed);
2450 * Create a sketcher (wire or face), following the textual description,
2451 * passed through \a theCommand argument. \n
2452 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2453 * Format of the description string have to be the following:
2455 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2458 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2460 * - "R angle" : Set the direction by angle
2461 * - "D dx dy" : Set the direction by DX & DY
2464 * - "TT x y" : Create segment by point at X & Y
2465 * - "T dx dy" : Create segment by point with DX & DY
2466 * - "L length" : Create segment by direction & Length
2467 * - "IX x" : Create segment by direction & Intersect. X
2468 * - "IY y" : Create segment by direction & Intersect. Y
2471 * - "C radius length" : Create arc by direction, radius and length(in degree)
2474 * - "WW" : Close Wire (to finish)
2475 * - "WF" : Close Wire and build face (to finish)
2477 * \param theCommand String, defining the sketcher in local
2478 * coordinates of the working plane.
2479 * \param theWorkingPlane Nine double values, defining origin,
2480 * OZ and OX directions of the working plane.
2481 * \return New GEOM_Object, containing the created wire.
2483 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2486 * Create a 3D sketcher, following the numerical description,
2487 * passed through points created by \a theCoordinates argument. \n
2488 * Format of the description string have to be the following:
2490 * "Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"
2493 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2496 * Create a sketcher (wire or face), following the textual description,
2497 * passed through \a theCommand argument. \n
2498 * For format of the description string see the previous method.\n
2499 * \param theCommand String, defining the sketcher in local
2500 * coordinates of the working plane.
2501 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2502 * \return New GEOM_Object, containing the created wire.
2504 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2508 * GEOM_ILocalOperations: Interface for fillet and chamfer creation.
2510 interface GEOM_ILocalOperations : GEOM_IOperations
2513 * Perform a fillet on all edges of the given shape.
2514 * \param theShape Shape, to perform fillet on.
2515 * \param theR Fillet radius.
2516 * \return New GEOM_Object, containing the result shape.
2518 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2522 * Perform a fillet on the specified edges of the given shape
2523 * \param theShape Shape, to perform fillet on.
2524 * \param theR Fillet radius.
2525 * \param theEdges Global indices of edges to perform fillet on.
2526 * \note Global index of sub-shape can be obtained, using method
2527 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2528 * \return New GEOM_Object, containing the result shape.
2530 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2532 in ListOfLong theEdges);
2533 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2536 in ListOfLong theEdges);
2539 * Perform a fillet on all edges of the specified faces of the given shape.
2540 * \param theShape Shape, to perform fillet on.
2541 * \param theR Fillet radius.
2542 * \param theFaces Global indices of faces to perform fillet on.
2543 * \note Global index of sub-shape can be obtained, using method
2544 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2545 * \return New GEOM_Object, containing the result shape.
2547 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2549 in ListOfLong theFaces);
2551 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2554 in ListOfLong theFaces);
2557 * Perform a fillet on face of the specified vertexes of the given shape.
2558 * \param theShape Shape, to perform fillet on.
2559 * \param theR Fillet radius.
2560 * \param theVertexes Global indices of vertexes to perform fillet on.
2561 * \note Global index of sub-shape can be obtained, using method
2562 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2563 * \return New GEOM_Object, containing the result shape.
2565 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2567 in ListOfLong theVertexes);
2570 * Perform a fillet on edges of the specified vertexes of the given wire.
2571 * \param theShape Shape, to perform fillet on.
2572 * \param theR Fillet radius.
2573 * \param theVertexes Global indices of vertexes to perform fillet on.
2574 * \note Global index of sub-shape can be obtained, using method
2575 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2576 * \note The list of vertices coudl be empty, in this case fillet fill be done
2577 * at all vertices in given wire
2578 * \return New GEOM_Object, containing the result shape.
2580 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2582 in ListOfLong theVertexes);
2585 * Perform a symmetric chamfer on all edges of the given shape.
2586 * \param theShape Shape, to perform chamfer on.
2587 * \param theD Chamfer size along each face.
2588 * \return New GEOM_Object, containing the result shape.
2590 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2594 * Perform a chamfer on edges, common to the specified faces.
2595 * with distance D1 on the Face1
2596 * \param theShape Shape, to perform chamfer on.
2597 * \param theD1 Chamfer size along \a theFace1.
2598 * \param theD2 Chamfer size along \a theFace2.
2599 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2600 * \note Global index of sub-shape can be obtained, using method
2601 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2602 * \return New GEOM_Object, containing the result shape.
2604 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2605 in double theD1, in double theD2,
2606 in long theFace1, in long theFace2);
2608 * The Same but with params theD = Chamfer Lenght
2609 * and theAngle = Chamfer Angle (Angle in radians)
2611 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2612 in double theD, in double theAngle,
2613 in long theFace1, in long theFace2);
2616 * Perform a chamfer on all edges of the specified faces.
2617 * with distance D1 on the first specified face (if several for one edge)
2618 * \param theShape Shape, to perform chamfer on.
2619 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2620 * connected to the edge, are in \a theFaces, \a theD1
2621 * will be get along face, which is nearer to \a theFaces beginning.
2622 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2623 * \param theFaces Sequence of global indices of faces of \a theShape.
2624 * \note Global index of sub-shape can be obtained, using method
2625 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2626 * \return New GEOM_Object, containing the result shape.
2628 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2629 in double theD1, in double theD2,
2630 in ListOfLong theFaces);
2632 * The Same but with params theD = Chamfer Lenght
2633 * and theAngle = Chamfer Angle (Angle in radians)
2635 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2636 in double theD, in double theAngle,
2637 in ListOfLong theFaces);
2640 * Perform a chamfer on edges,
2641 * with distance D1 on the first specified face (if several for one edge)
2642 * \param theShape Shape, to perform chamfer on.
2643 * \param theD1 theD2 Chamfer size
2644 * \param theEdges Sequence of edges of \a theShape.
2645 * \return New GEOM_Object, containing the result shape.
2647 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2648 in double theD1, in double theD2,
2649 in ListOfLong theEdges);
2651 * The Same but with params theD = Chamfer Lenght
2652 * and theAngle = Chamfer Angle (Angle in radians)
2654 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2655 in double theD, in double theAngle,
2656 in ListOfLong theEdges);
2659 * Perform an Archimde operation on the given shape with given parameters.
2660 * The object presenting the resulting face is returned
2661 * \param theShape Shape to be put in water.
2662 * \param theWeight Weight og the shape.
2663 * \param theWaterDensity Density of the water.
2664 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
2665 * \return New GEOM_Object, containing a section of \a theShape
2666 * by a plane, corresponding to water level.
2668 GEOM_Object MakeArchimede (in GEOM_Object theShape,
2669 in double theWeight,
2670 in double theWaterDensity,
2671 in double theMeshDeflection);
2674 * Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2675 * Present here only for compatibility.
2677 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2681 * GEOM_IHealingOperations: Interface for shape healing operations.
2682 * Shape Processing, SuppressFaces, etc.
2684 interface GEOM_IHealingOperations : GEOM_IOperations
2687 * Apply a sequence of Shape Healing operators to the given object.
2688 * \param theShapes Shape to be processed.
2689 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2690 * \param theParameters List of names of parameters
2691 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2692 * \param theValues List of values of parameters, in the same order
2693 * as parameters are listed in \a theParameters list.
2694 * \return New GEOM_Object, containing processed shape.
2696 GEOM_Object ProcessShape (in GEOM_Object theShapes,
2697 in string_array theOperators,
2698 in string_array theParameters,
2699 in string_array theValues);
2702 * Get default sequence of operators, their parameters and parameters' values
2703 * of Shape Process operation. In the current implementation the defaults are
2704 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2705 * \param theOperators Output. Default list of names of operators.
2706 * \param theParameters Output. Default list of names of parameters.
2707 * \param theValues Output. List of default values of parameters, in the same order
2708 * as parameters are listed in \a theParameters list.
2710 void GetShapeProcessParameters (out string_array theOperators,
2711 out string_array theParameters,
2712 out string_array theValues);
2714 * Get parameters and parameters' values for the given Shape Process operation.
2715 * In the current implementation the defaults are
2716 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2717 * \param theOperator Input. The operator's name.
2718 * \param theParameters Output. Default list of names of parameters.
2719 * \param theValues Output. List of default values of parameters, in the same order
2720 * as parameters are listed in \a theParameters list.
2722 void GetOperatorParameters (in string theOperator,
2723 out string_array theParameters,
2724 out string_array theValues);
2727 * Remove faces from the given object (shape).
2728 * \param theObject Shape to be processed.
2729 * \param theFaces Indices of faces to be removed, if EMPTY then the method
2730 * removes ALL faces of the given object.
2731 * \return New GEOM_Object, containing processed shape.
2733 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
2736 * Close an open wire.
2737 * \param theObject Shape to be processed.
2738 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2739 * if -1, then theObject itself is a wire.
2740 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
2741 * If FALS : closure by creation of an edge between ends.
2742 * \return New GEOM_Object, containing processed shape.
2744 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2745 in boolean isCommonVertex);
2748 * Remove internal wires and edges from the given object (face).
2749 * \param theObject Shape to be processed.
2750 * \param theWires Indices of wires to be removed, if EMPTY then the method
2751 * removes ALL internal wires of the given object.
2752 * \return New GEOM_Object, containing processed shape.
2754 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2757 * Remove internal closed contours (holes) from the given object.
2758 * \param theObject Shape to be processed.
2759 * \param theWires Indices of wires to be removed, if EMPTY then the method
2760 * removes ALL internal holes of the given object
2761 * \return New GEOM_Object, containing processed shape.
2763 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2766 * Sewing of the given object.
2767 * \param theObject Shape to be processed.
2768 * \param theTolerance Required tolerance value.
2769 * \return New GEOM_Object, containing processed shape.
2771 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2774 * Addition of a point to a given edge object.
2775 * \param theObject Shape to be processed.
2776 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
2777 * if -1, then theObject itself is the edge.
2778 * \param theValue Value of parameter on edge or length parameter,
2779 * depending on \a isByParameter.
2780 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2781 * if FALSE : \a theValue is treated as a length parameter [0..1]
2782 * \return New GEOM_Object, containing processed shape.
2784 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2785 in double theValue, in boolean isByParameter);
2788 * Get a list of wires (wrapped in GEOM_Object-s),
2789 * that constitute a free boundary of the given shape.
2790 * \param theObject Shape to get free boundary of.
2791 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2792 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
2793 * \return FALSE, if an error(s) occured during the method execution.
2795 boolean GetFreeBoundary (in GEOM_Object theObject,
2796 out ListOfGO theClosedWires,
2797 out ListOfGO theOpenWires);
2800 * Change orientation of the given object.
2801 * \param theObject Shape to be processed.
2802 * \return New GEOM_Object, containing processed shape.
2804 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2805 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2808 * Try to limit tolerance of the given object by value \a theTolerance.
2809 * \param theObject Shape to be processed.
2810 * \param theTolerance Required tolerance value.
2811 * \return New GEOM_Object, containing processed shape.
2813 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
2818 * GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2821 interface GEOM_IInsertOperations : GEOM_IOperations
2824 * Create a copy of the given object
2826 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2829 * Export the given shape into a file with given name.
2830 * \param theObject Shape to be stored in the file.
2831 * \param theFileName Name of the file to store the given shape in.
2832 * \param theFormatName Specify format for the shape storage.
2833 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2835 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2838 * Import a shape from the BRep or IGES or STEP file
2839 * (depends on given format) with given name.
2840 * \param theFileName The file, containing the shape.
2841 * \param theFormatName Specify format for the file reading.
2842 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2843 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
2844 * set to 'meter' and result model will be scaled.
2845 * \return New GEOM_Object, containing the imported shape.
2847 GEOM_Object Import (in string theFileName, in string theFormatName);
2850 * Get the supported import formats and corresponding patterns for File dialog.
2851 * \param theFormats Output. List of formats, available for import.
2852 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2853 * \return Returns available formats and patterns through the arguments.
2855 void ImportTranslators (out string_array theFormats,
2856 out string_array thePatterns);
2859 * Get the supported export formats and corresponding patterns for File dialog.
2860 * \param theFormats Output. List of formats, available for export.
2861 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2862 * \return Returns available formats and patterns through the arguments.
2864 void ExportTranslators (out string_array theFormats,
2865 out string_array thePatterns);
2868 * Load texture from file
2869 * \param theTextureFile texture file name
2870 * \return unique texture identifier
2872 long LoadTexture(in string theTextureFile);
2875 * Add texture to the study
2876 * \param theWidth texture width in pixels
2877 * \param theHeight texture height in pixels
2878 * \param theTexture texture byte array
2879 * \return unique texture identifier
2881 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
2884 * Get previously loaded texture data
2885 * \param theID texture identifier
2886 * \param theWidth texture width in pixels
2887 * \param theHeight texture height in pixels
2888 * \return texture byte array
2890 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
2893 * Get list of all avaiable texture IDs
2894 * \return list of all texture IDs avaiable for the current study
2896 ListOfLong GetAllTextures();
2900 * GEOM_IKindOfShape: namespace for shape_kind enumeration.
2902 interface GEOM_IKindOfShape
2912 SPHERE, // full sphere
2913 CYLINDER, // cylinder
2914 BOX, // box with faces, parallel to global coordinate planes
2915 ROTATED_BOX, // other box
2916 TORUS, // full torus
2918 POLYHEDRON, // solid, bounded by polygons
2919 SOLID, // other solid
2921 SPHERE2D, // spherical face (closed)
2922 CYLINDER2D, // cylindrical face with defined height
2923 TORUS2D, // toroidal face (closed)
2924 CONE2D, // conical face with defined height
2925 DISK_CIRCLE, // planar, bounded by circle
2926 DISK_ELLIPSE, // planar, bounded by ellipse
2927 POLYGON, // planar, bounded by segments
2928 PLANE, // infinite planar
2929 PLANAR, // other planar
2932 CIRCLE, // full circle
2933 ARC_CIRCLE, // arc of circle
2934 ELLIPSE, // full ellipse
2935 ARC_ELLIPSE, // arc of ellipse
2936 LINE, // infinite segment
2942 ADVANCED // all advanced shapes (temporary implementation)
2948 * GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
2949 * properties calculation (like Centre of Mass, Inertia, etc.).
2952 interface GEOM_IMeasureOperations : GEOM_IOperations
2955 * Get kind of theShape.
2956 * \param theShape Shape to get a kind of.
2957 * \param theIntegers Output. Integer and enumerated shape's parameters
2958 * (kind of surface, closed/unclosed, number of edges, etc.)
2959 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
2960 * \note Concrete meaning of each value, returned via \a theIntegers
2961 * or \a theDoubles list depends on the kind of the shape.
2962 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
2964 //short KindOfShape (in GEOM_Object theShape,
2965 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
2966 out ListOfLong theIntegers,
2967 out ListOfDouble theDoubles);
2970 * Get position (LCS) of theShape.
2971 * \param theShape Shape to calculate position of.
2972 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
2973 * Origin of the LCS is situated at the shape's center of mass.
2974 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
2975 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
2976 * Axes of the LCS are obtained from shape's location or,
2977 * if the shape is a planar face, from position of its plane.
2978 * \return Returns position of the shape through the last nine arguments.
2980 void GetPosition (in GEOM_Object theShape,
2981 out double Ox, out double Oy, out double Oz,
2982 out double Zx, out double Zy, out double Zz,
2983 out double Xx, out double Xy, out double Xz);
2986 * Get summarized length of all wires,
2987 * area of surface and volume of the given shape.
2988 * \param theShape Shape to define properties of.
2989 * \param theLength Output. Summarized length of all wires of the given shape.
2990 * \param theSurfArea Output. Area of surface of the given shape.
2991 * \param theVolume Output. Volume of the given shape.
2992 * \return Returns shape properties through the last three arguments.
2994 void GetBasicProperties (in GEOM_Object theShape,
2995 out double theLength,
2996 out double theSurfArea,
2997 out double theVolume);
3000 * Get a point, situated at the centre of mass of theShape.
3001 * \param theShape Shape to define centre of mass of.
3002 * \return New GEOM_Object, containing the created point.
3004 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
3007 * Get the vertex by index for 1D objects depends the edge/wire orientation
3008 * \param theShape Shape (wire or edge) to find the vertex on it
3009 * \param theIndex Index of vertex subshape
3010 * \return New GEOM_Object, vertex.
3012 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
3015 * Get a vector, representing the normal of theFace.
3016 * If the face is not planar, theOptionalPoint is obligatory.
3017 * \param theFace Shape (face) to define the normal of.
3018 * \param theOptionalPoint Shape (point) to define the normal at.
3019 * Can be NULL in case of planar face.
3020 * \return New GEOM_Object, containing the created normal vector.
3022 GEOM_Object GetNormal (in GEOM_Object theFace,
3023 in GEOM_Object theOptionalPoint);
3026 * Get inertia matrix and moments of inertia of theShape.
3027 * \param theShape Shape to calculate inertia of.
3028 * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
3029 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
3030 * \return Returns inertia through the last twelve arguments.
3032 void GetInertia (in GEOM_Object theShape,
3033 out double I11, out double I12, out double I13,
3034 out double I21, out double I22, out double I23,
3035 out double I31, out double I32, out double I33,
3036 out double Ix , out double Iy , out double Iz);
3039 * Get parameters of bounding box of the given shape
3040 * \param theShape Shape to obtain bounding box of.
3041 * \param Xmin,Xmax Output. Limits of shape along OX axis.
3042 * \param Ymin,Ymax Output. Limits of shape along OY axis.
3043 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
3044 * \return Returns parameters of bounding box through the last six arguments.
3046 void GetBoundingBox (in GEOM_Object theShape,
3047 out double Xmin, out double Xmax,
3048 out double Ymin, out double Ymax,
3049 out double Zmin, out double Zmax);
3052 * Get min and max tolerances of sub-shapes of theShape
3053 * \param theShape Shape, to get tolerances of.
3054 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3055 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
3056 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
3057 * \return Returns shape tolerances through the last six arguments.
3059 void GetTolerance (in GEOM_Object theShape,
3060 out double FaceMin, out double FaceMax,
3061 out double EdgeMin, out double EdgeMax,
3062 out double VertMin, out double VertMax);
3065 * Check a topology of the given shape.
3066 * \param theShape Shape to check validity of.
3067 * \param theDescription Output. Description of problems in the shape, if they are.
3068 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
3070 boolean CheckShape (in GEOM_Object theShape,
3071 out string theDescription);
3074 * Check a topology and a geometry of the given shape.
3075 * \param theShape Shape to check validity of.
3076 * \param theDescription Output. Description of problems in the shape, if they are.
3077 * \return TRUE, if the shape "seems to be valid".
3079 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
3080 out string theDescription);
3083 * Obtain description of the given shape
3084 * \param theShape Shape to be described.
3085 * \return Description of the given shape.
3087 string WhatIs (in GEOM_Object theShape);
3090 * Get minimal distance between the given shapes.
3091 * \param theShape1,theShape2 Shapes to find minimal distance between.
3092 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
3093 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
3094 * \return Value of the minimal distance between the given shapes.
3096 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
3097 out double X1, out double Y1, out double Z1,
3098 out double X2, out double Y2, out double Z2);
3101 * Get angle between the given lines or linear edges.
3102 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
3103 * \return Value of the angle between the given shapes.
3105 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
3108 * Get point coordinates
3110 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
3113 * Get radius of curvature of curve in the point determinated by param
3114 * \param theShape - curve.
3115 * \param theParam - parameter on curve
3116 * \return Value of curvature.
3118 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3121 * Get radius of curvature of curve in the given point
3122 * \param theShape - curve.
3123 * \param thePoint - point
3124 * \return Value of curvature.
3126 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3129 * Get max radius of curvature of surface in the point determinated by params
3130 * \param theShape - surface.
3131 * \param theUParam - U-parameter on surface
3132 * \param theVParam - V-parameter on surface
3133 * \return Value of curvature.
3135 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3136 in double theVParam);
3139 * Get max radius of curvature of surface in the given point
3140 * \param theShape - surface.
3141 * \param thePoint - point
3142 * \return Value of curvature.
3144 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3147 * Get min radius of curvature of surface in the point determinated by params
3148 * \param theShape - surface.
3149 * \param theUParam - U-parameter on surface
3150 * \param theVParam - V-parameter on surface
3151 * \return Value of curvature.
3153 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3154 in double theVParam);
3157 * Get min radius of curvature of surface in the given point
3158 * \param theShape - surface.
3159 * \param thePoint - point
3160 * \return Value of curvature.
3162 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3168 * GEOM_IGroupOperations: Interface for groups creation.
3170 interface GEOM_IGroupOperations : GEOM_IOperations
3173 * Creates a new group which will store sub shapes of theMainShape
3174 * \param theMainShape is a GEOM object on which the group is selected
3175 * \param theShapeType defines a shape type of the group
3176 * \return a newly created GEOM group
3178 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3181 * Adds a sub object with ID theSubShapeId to the group
3182 * \param theGroup is a GEOM group to which the new sub shape is added
3183 * \param theSubShapeId is a sub shape ID in the main object.
3184 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3186 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3189 * Removes a sub object with ID \a theSubShapeId from the group
3190 * \param theGroup is a GEOM group from which the sub shape is removed.
3191 * \param theSubShapeId is a sub shape ID in the main object.
3192 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3194 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3197 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3198 * \param theGroup is a GEOM group to which the new sub shapes are added.
3199 * \param theSubShapes is a list of sub shapes to be added.
3201 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3204 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3205 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3206 * \param theSubShapes is a list of sub-shapes to be removed.
3208 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3211 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3212 * \param theGroup is a GEOM group to which the new sub shapes are added.
3213 * \param theSubShapes is a list of IDs of sub shapes to be added.
3215 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3218 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3219 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3220 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3222 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3225 * Returns a type of sub objects stored in the group
3226 * \param theGroup is a GEOM group which type is returned.
3228 long GetType (in GEOM_Object theGroup);
3231 * Returns a main shape associated with the group
3232 * \param theGroup is a GEOM group for which a main shape object is requested
3233 * \return a GEOM object which is a main shape for theGroup
3235 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3238 * Returns a list of sub objects ID stored in the group
3239 * \param theGroup is a GEOM group for which a list of IDs is requested
3241 ListOfLong GetObjects (in GEOM_Object theGroup);
3246 * GEOM_IAdvancedOperations: Interface for advanced modeling functions.
3248 interface GEOM_IAdvancedOperations : GEOM_IOperations
3251 * Create a T-shape object with specified caracteristics for the main and
3252 * the incident pipes (radius, width, half-length).
3253 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3254 * \param theR1 Internal radius of main pipe
3255 * \param theW1 Width of main pipe
3256 * \param theL1 Half-length of main pipe
3257 * \param theR2 Internal radius of incident pipe (R2 < R1)
3258 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3259 * \param theL2 Half-length of incident pipe
3260 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3261 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3263 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
3264 in double theR2, in double theW2, in double theL2,
3265 in boolean theHexMesh);
3267 * Create a T-shape object with specified caracteristics for the main and
3268 * the incident pipes (radius, width, half-length).
3269 * The extremities of the main pipe are located on junctions points P1 and P2.
3270 * The extremity of the incident pipe is located on junction point P3.
3271 * \param theR1 Internal radius of main pipe
3272 * \param theW1 Width of main pipe
3273 * \param theL1 Half-length of main pipe
3274 * \param theR2 Internal radius of incident pipe (R2 < R1)
3275 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3276 * \param theL2 Half-length of incident pipe
3277 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3278 * \param theP1 1st junction point of main pipe
3279 * \param theP2 2nd junction point of main pipe
3280 * \param theP3 Junction point of incident pipe
3281 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3283 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
3284 in double theR2, in double theW2, in double theL2,
3285 in boolean theHexMesh,
3286 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3288 * Create a T-shape object with specified caracteristics for the main and
3289 * the incident pipes (radius, width, half-length). A chamfer is created
3290 * on the junction of the pipes.
3291 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3292 * \param theR1 Internal radius of main pipe
3293 * \param theW1 Width of main pipe
3294 * \param theL1 Half-length of main pipe
3295 * \param theR2 Internal radius of incident pipe (R2 < R1)
3296 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3297 * \param theL2 Half-length of incident pipe
3298 * \param theH Height of the chamfer.
3299 * \param theW Width of the chamfer.
3300 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3301 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3303 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
3304 in double theR2, in double theW2, in double theL2,
3305 in double theH, in double theW, in boolean theHexMesh);
3307 * Create a T-shape object with specified caracteristics for the main and
3308 * the incident pipes (radius, width, half-length). A chamfer is created
3309 * on the junction of the pipes.
3310 * The extremities of the main pipe are located on junctions points P1 and P2.
3311 * The extremity of the incident pipe is located on junction point P3.
3312 * \param theR1 Internal radius of main pipe
3313 * \param theW1 Width of main pipe
3314 * \param theL1 Half-length of main pipe
3315 * \param theR2 Internal radius of incident pipe (R2 < R1)
3316 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3317 * \param theL2 Half-length of incident pipe
3318 * \param theH Height of the chamfer.
3319 * \param theW Width of the chamfer.
3320 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3321 * \param theP1 1st junction point of main pipe
3322 * \param theP2 2nd junction point of main pipe
3323 * \param theP3 Junction point of incident pipe
3324 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3326 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
3327 in double theR2, in double theW2, in double theL2,
3328 in double theH, in double theW, in boolean theHexMesh,
3329 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3331 * Create a T-shape object with specified caracteristics for the main and
3332 * the incident pipes (radius, width, half-length). A fillet is created
3333 * on the junction of the pipes.
3334 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3335 * \param theR1 Internal radius of main pipe
3336 * \param theW1 Width of main pipe
3337 * \param theL1 Half-length of main pipe
3338 * \param theR2 Internal radius of incident pipe (R2 < R1)
3339 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3340 * \param theL2 Half-length of incident pipe
3341 * \param theRF Radius of curvature of fillet.
3342 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3343 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3345 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
3346 in double theR2, in double theW2, in double theL2,
3347 in double theRF, in boolean theHexMesh);
3349 * Create a T-shape object with specified caracteristics for the main and
3350 * the incident pipes (radius, width, half-length). A fillet is created
3351 * on the junction of the pipes.
3352 * The extremities of the main pipe are located on junctions points P1 and P2.
3353 * The extremity of the incident pipe is located on junction point P3.
3354 * \param theR1 Internal radius of main pipe
3355 * \param theW1 Width of main pipe
3356 * \param theL1 Half-length of main pipe
3357 * \param theR2 Internal radius of incident pipe (R2 < R1)
3358 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3359 * \param theL2 Half-length of incident pipe
3360 * \param theRF Radius of curvature of fillet.
3361 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3362 * \param theP1 1st junction point of main pipe
3363 * \param theP2 2nd junction point of main pipe
3364 * \param theP3 Junction point of incident pipe
3365 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3367 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
3368 in double theR2, in double theW2, in double theL2,
3369 in double theRF, in boolean theHexMesh,
3370 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3371 /*@@ insert new functions before this line @@ do not remove this line @@*/
3375 * GEOM_Gen: Interface to access other GEOM interfaces.
3376 * Also contains some methods to access and manage GEOM objects.
3378 interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
3381 * Undo/Redo Management
3384 void Undo (in long theStudyID);
3386 void Redo (in long theStudyID);
3389 * Publishing management
3390 * Adds in theStudy a object theObject under with a name theName,
3391 * if theFather is not NULL the object is placed under thFather's SObject.
3392 * Returns a SObject where theObject is placed
3394 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3395 in GEOM_Object theObject,
3397 in GEOM_Object theFather);
3400 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3401 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3402 * \param theStudy the study, in which theObject is published already,
3403 * and in which the arguments will be published
3404 * \param theObject published GEOM object, arguments of which will be published
3405 * \param theArgs list of GEOM_Object, operation arguments to be published.
3406 * If this list is empty, all operation arguments will be published
3407 * \param theFindMethod method to search subshapes, corresponding to arguments and
3408 * their subshapes. Value from enumeration GEOM::find_shape_method.
3409 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3410 * Do not publish subshapes in place of arguments, but only
3411 * in place of subshapes of the first argument,
3412 * because the whole shape corresponds to the first argument.
3413 * Mainly to be used after transformations, but it also can be
3414 * usefull after partition with one object shape, and some other
3415 * operations, where only the first argument has to be considered.
3416 * If theObject has only one argument shape, this flag is automatically
3417 * considered as True, not regarding really passed value.
3418 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3419 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3420 * \return list of published sub-shapes
3422 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
3423 in GEOM_Object theObject,
3424 in ListOfGO theArgs,
3425 in find_shape_method theFindMethod,
3426 in boolean theInheritFirstArg,
3427 in boolean theAddPrefix);
3430 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3431 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3432 * \param theStudy the study, in which theObject is published already,
3433 * and in which the arguments will be published
3434 * \param theObject published GEOM object, arguments of which will be published
3435 * \param theArgs list of GEOM_Object, operation arguments to be published.
3436 * If this list is empty, all operation arguments will be published
3437 * \param theFindMethod method to search subshapes, corresponding to arguments and
3438 * their subshapes. Value from enumeration GEOM::find_shape_method.
3439 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3440 * Do not publish subshapes in place of arguments, but only
3441 * in place of subshapes of the first argument,
3442 * because the whole shape corresponds to the first argument.
3443 * Mainly to be used after transformations, but it also can be
3444 * usefull after partition with one object shape, and some other
3445 * operations, where only the first argument has to be considered.
3446 * If theObject has only one argument shape, this flag is automatically
3447 * considered as True, not regarding really passed value.
3448 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3449 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3450 * \return list of published sub-shapes
3452 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
3453 in GEOM_Object theObject,
3454 in ListOfGO theArgs,
3455 in find_shape_method theFindMethod,
3456 in boolean theInheritFirstArg,
3457 in boolean theAddPrefix);
3460 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3461 * To be used from GUI and from geompy.addToStudy.
3462 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
3463 * \param theSObject study object, referencing GEOM object, arguments of which will be published
3465 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
3466 in SALOMEDS::SObject theSObject,
3467 in ListOfGO theArgs,
3468 in find_shape_method theFindMethod,
3469 in boolean theInheritFirstArg,
3470 in boolean theAddPrefix);
3473 * Methods to access interfaces for objects creation and transformation
3475 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3476 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
3477 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3478 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3479 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3480 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3481 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3482 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3483 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3484 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3485 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3486 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3487 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3490 * Objects Management
3494 * Removes the object from the GEOM component
3495 * \param theObject is a GEOM object to be removed
3497 void RemoveObject (in GEOM_Object theObject);
3500 * Returns an object defined by the study and its entry in the GEOM component
3501 * \param theStudyID is a SALOMEDS Study ID
3502 * \param theEntry is an entry of the requested GEOM object in the GEOM component
3503 * \note if the object has not previously been created a NULL GEOM object is returned
3505 GEOM_Object GetObject (in long theStudyID, in string theEntry);
3508 * Add a sub shape defined by indices in \a theIndices
3509 * (contains unique IDs of sub shapes inside theMainShape)
3510 * \note The sub shape GEOM_Objects can has ONLY ONE function.
3511 * Don't try to apply modification operations on them.
3512 * \note Internal method
3514 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
3517 * GEOM object's IOR Management
3521 * Returns a GEOM Object defined by its IOR
3522 * \param theIOR a string containg an IOR of the requested GEOM object
3524 GEOM_Object GetIORFromString (in string theIOR);
3527 * Returns a string which contains an IOR of the GEOM object
3528 * \param theObject is a GEOM object which IOR is requested
3530 string GetStringFromIOR (in GEOM_Object theObject);
3533 * Returns a name with which a GEOM object was dumped into python script
3534 * \param theStudyEntry is an entry of the GEOM object in the study
3536 string GetDumpName (in string theStudyEntry);
3539 * Returns all names with which a GEOM objects was dumped
3540 * into python script to avoid the same names in SMESH script
3542 string_array GetAllDumpNames();
3545 * Publishes the named subshapes of given object in the study.
3546 * \param theStudy The study in which the object is published
3547 * \param theObject The object which named subshapes are published
3549 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
3550 //in SObject theSObject,
3551 in Object theObject);