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,
116 /*! To be used only for multi-transformation result.
117 * Only this method can be used after multi-transformation.
123 * Kind of method to perform filling operation
124 * Is used in functions GEOM_Gen.MakeFilling<xxx>()
126 enum filling_oper_method
128 /*! Default (standard behaviour) */
131 /*! Use edges orientation */
134 /*! Auto-correct edges orientation */
139 typedef sequence<string> string_array;
140 typedef sequence<short> short_array;
141 typedef sequence<boolean> ListOfBool;
142 typedef sequence<long> ListOfLong;
143 typedef sequence<double> ListOfDouble;
145 interface GEOM_Object;
147 typedef sequence<GEOM_Object> ListOfGO;
150 * GEOM_Object: interface of geometric object
152 interface GEOM_Object : SALOME::GenericObj
156 * Get an entry of the object in GEOM component.
161 * Get ID of study, where the object is created.
166 * Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
171 * Get a <VAR>shape_type</VAR> of the object value.
173 shape_type GetShapeType();
176 * Get the topology type of the object value.
177 * In contrast to the shape type, this function returns type of the most
178 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
182 shape_type GetTopologyType();
185 * Get a minimal type of the top-level shapes contained in the object.
186 * This function is useful for the compounds only; for simple shapes it
187 * exactly the same value as GetShapeType().
188 * Note, that compounds are procesed recursively.
189 * \sa GetShapeType(), GetTopologyType(), GetMaxShapeType()
191 shape_type GetMinShapeType();
194 * Get a maximal type of the top-level shapes contained in the object.
195 * This function is useful for the compounds only; for simple shapes it
196 * exactly the same value as GetShapeType().
197 * Note, that compounds are procesed recursively.
198 * \sa GetShapeType(), GetTopologyType(), GetMinShapeType()
200 shape_type GetMaxShapeType();
203 * Set name of the object.
204 * \param theName is a name which will be associated with this object.
206 void SetName (in string theName);
209 * Get name of the object associated with this object.
214 * Set color of the object.
215 * \param theColor is a color of the object.
217 void SetColor(in SALOMEDS::Color theColor);
220 * Get color of the object.
222 SALOMEDS::Color GetColor();
225 * Toggle auto color mode on the object.
226 * \param theAtoColor is a flag which toggles auto color mode.
228 void SetAutoColor(in boolean theAutoColor);
231 * Get flag of object's auto color mode.
233 boolean GetAutoColor();
236 * Set standard point marker for the object
237 * \param theType standard marker type
238 * \param theSize marker relative size
240 void SetMarkerStd(in marker_type theType, in marker_size theSize );
243 * Set custom point marker for the object. The texture can be added
244 * by LoadTexture() or AddTexture() functions.
245 * \param theTextureId texture ID
247 void SetMarkerTexture(in long theTextureId);
250 * Get type of the point marker assigned to the object
251 * \return current marker type (MT_NONE if no marker is set)
253 marker_type GetMarkerType();
256 * Get size of the point marker assigned to the object
257 * \return current marker relative size (MS_NONE if no marker is set)
259 marker_size GetMarkerSize();
262 * Get texture idenifier of the point marker assigned to the object
263 * \return marker texture ID (0 if no marker set)
265 long GetMarkerTexture();
268 * Set a Study entry where this object was published.
270 void SetStudyEntry (in string theEntry);
273 * Get a Study entry where this object was published.
275 string GetStudyEntry();
278 * Get a list of all GEOM objects on which were the arguments
279 * when this object was constructed and modified.
280 * \note This method is supposed to be used by GUI only.
282 ListOfGO GetDependency();
285 * Get a list of GEOM objects on which the last function that created or modified the object depends.
286 * \note This method is supposed to be used by GUI only.
288 ListOfGO GetLastDependency();
291 * Get the TopoDS_Shape, for colocated case only.
293 long long getShape();
296 ######################################################################
297 * Internal methods (For sub shape identification)
298 ######################################################################
302 * Get geometric shape of the object as a byte stream
304 SALOMEDS::TMPFile GetShapeStream();
307 * Returns True if this object is not a sub shape of another object.
309 boolean IsMainShape();
312 * Get a list of ID's of sub shapes in the main shape.
313 * \note Internal method, suppopsed to be used only by GEOM_Client
315 ListOfLong GetSubShapeIndices();
318 * Get a main shape object to which this object is a sub shape
319 * \note Internal method, suppopsed to be used only by GEOM_Client
321 GEOM_Object GetMainShape();
324 * Return true if geom object representes a shape.
325 * For example, method return false for GEOM_MARKER
330 * Return true if passed object is identical to this object
331 * \param other object being compared with this one
333 boolean IsSame(in GEOM_Object other);
336 * Set list of parameters
337 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
338 * used for object creation
340 void SetParameters (in string theParameters);
343 * Return list of notebook variables used for object creation separated by ":" symbol
345 string GetParameters();
350 * GEOM_IOperations: basic methods of all geometric operations
352 interface GEOM_IOperations : SALOME::GenericObj
355 * To know, if the operation was successfully performed
360 * Set the operation error code
361 * \param theErrorID is a string describing the error occured
362 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
364 void SetErrorCode (in string theErrorID);
367 * Get the operation error code
369 string GetErrorCode();
372 * Get ID of study, where the operation is defined
377 * Opens a new transaction
379 void StartOperation();
382 * Closes the previously opened trasaction
384 void FinishOperation();
387 * Aborts the previously opened transaction
389 void AbortOperation();
393 * GEOM_IBasicOperations: interface for basic geometry creation
394 * (Point, Vector, Plane, Marker)
396 interface GEOM_IBasicOperations : GEOM_IOperations
399 * Create point by three coordinates.
400 * \param theX The X coordinate of the point.
401 * \param theY The Y coordinate of the point.
402 * \param theZ The Z coordinate of the point.
403 * \return New GEOM_Object, containing the created point.
405 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
408 * Create a point, distant from the referenced point
409 * on the given distances along the coordinate axes.
410 * \param theReference The referenced point.
411 * \param theX Displacement from the referenced point along OX axis.
412 * \param theY Displacement from the referenced point along OY axis.
413 * \param theZ Displacement from the referenced point along OZ axis.
414 * \return New GEOM_Object, containing the created point.
416 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
417 in double theX, in double theY, in double theZ);
420 * Create a point, corresponding to the given parameter on the given curve.
421 * \param theRefCurve The referenced curve.
422 * \param theParameter Value of parameter on the referenced curve.
423 * \return New GEOM_Object, containing the created point.
425 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
426 in double theParameter);
429 * Create a point, corresponding to the given length on the given curve.
430 * \param theRefCurve The referenced curve.
431 * \param theLength Length on the referenced curve.
432 * \param theReverse Direction for the calculation of the length (false = forward or true = reversed).
433 * \return New GEOM_Object, containing the created point.
435 GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve,
437 in boolean theReverse);
440 * Create a point on the given curve, projecting given point
441 * \param theRefCurve The referenced curve.
442 * \param theXParameter X co-ordinate of point to project on curve
443 * \param theYParameter Y co-ordinate of point to project on curve
444 * \param theZParameter Z co-ordinate of point to project on curve
445 * \return New GEOM_Object, containing the created point.
447 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
448 in double theXParameter,
449 in double theYarameter,
450 in double theZPameter);
453 * Create a point, corresponding to the given parameters on the
455 * \param theRefSurf The referenced surface.
456 * \param theUParameter Value of U-parameter on the referenced surface.
457 * \param theVParameter Value of V-parameter on the referenced surface.
458 * \return New GEOM_Object, containing the created point.
460 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
461 in double theUParameter,
462 in double theVParameter);
465 * Create a point on the given surface, projecting given point
466 * \param theRefSurf The referenced surface.
467 * \param theXParameter X co-ordinate of point to project on curve
468 * \param theYParameter Y co-ordinate of point to project on curve
469 * \param theZParameter Z co-ordinate of point to project on curve
470 * \return New GEOM_Object, containing the created point.
472 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
473 in double theXParameter,
474 in double theYarameter,
475 in double theZPameter);
479 * Create a point, on two lines intersection.
480 * \param theRefLine1, theRefLine2 The referenced lines.
481 * \return New GEOM_Object, containing the created point.
483 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
484 in GEOM_Object theRefLine2);
487 * Create a vector, corresponding to tangent to the given parameter on the given curve.
488 * \param theRefCurve The referenced curve.
489 * \param theParameter Value of parameter on the referenced curve.This value should be have value
490 * \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
491 * \last parameter of curve.
492 * \return New GEOM_Object, containing the created point.
494 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
495 in double theParameter);
498 * Create a vector with the given components.
499 * \param theDX X component of the vector.
500 * \param theDY Y component of the vector.
501 * \param theDZ Z component of the vector.
502 * \return New GEOM_Object, containing the created vector.
504 GEOM_Object MakeVectorDXDYDZ (in double theDX,
509 * Create a vector between two points.
510 * \param thePnt1 Start point for the vector.
511 * \param thePnt2 End point for the vector.
512 * \return New GEOM_Object, containing the created vector.
514 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
517 * Create a line, passing through the given point
518 * and parrallel to the given direction
519 * \param thePnt Point. The resulting line will pass through it.
520 * \param theDir Direction. The resulting line will be parallel to it.
521 * \return New GEOM_Object, containing the created line.
523 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
526 * Create a line, passing through the given points
527 * \param thePnt1 First of two points, defining the line.
528 * \param thePnt2 Second of two points, defining the line.
529 * \return New GEOM_Object, containing the created line.
531 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
534 * Create a line, given by two faces intersection.
535 * \param theFace1 First of two faces, defining the line.
536 * \param theFace2 Second of two faces, defining the line.
537 * \return New GEOM_Object, containing the created line.
539 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
542 * Create a plane, passing through the three given points
543 * \param thePnt1 First of three points, defining the plane.
544 * \param thePnt2 Second of three points, defining the plane.
545 * \param thePnt3 Fird of three points, defining the plane.
546 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
547 * \return New GEOM_Object, containing the created plane.
549 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
550 in GEOM_Object thePnt2,
551 in GEOM_Object thePnt3,
552 in double theTrimSize);
555 * Create a plane, passing through the given point
556 * and normal to the given vector.
557 * \param thePnt Point, the plane has to pass through.
558 * \param theVec Vector, defining the plane normal direction.
559 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
560 * \return New GEOM_Object, containing the created plane.
562 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
563 in GEOM_Object theVec,
564 in double theTrimSize);
567 * Create a plane, similar to the existing one, but with another size of representing face.
568 * \param theFace Referenced plane or LCS(Marker).
569 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
570 * \return New GEOM_Object, containing the created plane.
572 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
573 in double theTrimSize);
576 * Create a plane, by two vectors.
577 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
578 * \param theVec Vector2, defining the plane normal direction.
579 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
580 * \return New GEOM_Object, containing the created plane.
582 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
583 in GEOM_Object theVec2,
584 in double theTrimSize);
587 * Create a plane, defined by local coordinate system.
588 * \param theLCS Referenced LCS(Marker).
589 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
590 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
591 * \return New GEOM_Object, containing the created plane.
593 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
594 in double theTrimSize,
595 in double theOrientation);
598 * Create a local coordinate system.
599 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
600 * \param theXDX,theXDY,theXDZ Three components of OX direction
601 * \param theYDX,theYDY,theYDZ Three components of OY direction
602 * \return New GEOM_Object, containing the created coordinate system.
604 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
605 in double theXDX, in double theXDY, in double theXDZ,
606 in double theYDX, in double theYDY, in double theYDZ);
609 * Create a local coordinate system from shape.
610 * \param theShape The initial shape to detect the coordinate system.
611 * \return New GEOM_Object, containing the created coordinate system.
613 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
616 * Create a local coordinate system from point and two vectors (DX, DY).
617 * \param theOrigin Point of coordinate system origin.
618 * \param theXVec Vector of X direction.
619 * \param theYVec Vector of Y direction.
620 * \return New GEOM_Object, containing the created coordinate system.
622 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin,
623 in GEOM_Object theXVec, in GEOM_Object theYVec);
626 * Create a tangent plane to specified face in the point with specified parameters.
627 * Values of parameters should be between 0. and 1.0
628 * \param theFace - face for which tangent plane shuold be built.
629 * \param theParameterU - value of parameter by U
630 * \param theParameterV - value of parameter Vthe
631 * \param theTrimSize - defines sizes of created face
632 * \return New GEOM_Object, containing the face built on tangent plane.
634 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
635 in double theParameterU,
636 in double theParameterV,
637 in double theTrimSize);
640 interface GEOM_ITransformOperations : GEOM_IOperations
643 * Translate the given object along the vector, specified by its end points.
644 * \param theObject The object to be translated.
645 * \param thePoint1 Start point of translation vector.
646 * \param thePoint2 End point of translation vector.
649 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
650 in GEOM_Object thePoint1,
651 in GEOM_Object thePoint2);
654 * Translate the given object along the vector, specified
655 * by its end points, creating its copy before the translation.
656 * \param theObject The object to be translated.
657 * \param thePoint1 Start point of translation vector.
658 * \param thePoint2 End point of translation vector.
659 * \return New GEOM_Object, containing the translated object.
661 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
662 in GEOM_Object thePoint1,
663 in GEOM_Object thePoint2);
666 * Translate the given object along the vector, specified by its components.
667 * \param theObject The object to be translated.
668 * \param theDX,theDY,theDZ Components of translation vector.
671 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
672 in double theDX, in double theDY, in double theDZ);
675 * Translate the given object along the vector, specified
676 * by its components, creating its copy before the translation.
677 * \param theObject The object to be translated.
678 * \param theDX,theDY,theDZ Components of translation vector.
679 * \return New GEOM_Object, containing the translated object.
681 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
682 in double theDX, in double theDY, in double theDZ);
686 * Translate the given object along the given vector.
687 * \param theObject The object to be translated.
688 * \param theVector Translation vector, giving both direction and distance.
691 GEOM_Object TranslateVector (in GEOM_Object theObject,
692 in GEOM_Object theVector);
695 * Translate the given object along the given vector,
696 * creating its copy before the translation.
697 * \param theObject The object to be translated.
698 * \param theVector Translation vector, giving both direction and distance.
699 * \return New GEOM_Object, containing the translated object.
701 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
702 in GEOM_Object theVector);
705 * Translate the given object along the given vector on given distance,
706 * creating its copy before the translation.
707 * \param theObject The object to be translated.
708 * \param theVector Translation vector, giving a direction.
709 * \param theDistance Translation distance, giving a distance.
710 * \param theCope Translation copy, creating its copy if true.
711 * \return New GEOM_Object, containing the translated object.
713 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
714 in GEOM_Object theVector,
715 in double theDistance,
719 * Translate the given object along the given vector a given number times
720 * \param theObject The object to be translated.
721 * \param theVector Direction of the translation.
722 * \param theStep Distance to translate on.
723 * \param theNbTimes Quantity of translations to be done.
724 * \return New GEOM_Object, containing compound of all
725 * the shapes, obtained after each translation.
727 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
728 in GEOM_Object theVector,
733 * Conseqently apply two specified translations to theObject specified number of times.
734 * \param theObject The object to be translated.
735 * \param theVector1 Direction of the first translation.
736 * \param theStep1 Step of the first translation.
737 * \param theNbTimes1 Quantity of translations to be done along theVector1.
738 * \param theVector2 Direction of the second translation.
739 * \param theStep2 Step of the second translation.
740 * \param theNbTimes2 Quantity of translations to be done along theVector2.
741 * \return New GEOM_Object, containing compound of all
742 * the shapes, obtained after each translation.
744 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
745 in GEOM_Object theVector1,
748 in GEOM_Object theVector2,
750 in long theNbTimes2);
753 * Rotate given object around vector perpendicular to plane containing three points.
754 * \param theObject The object to be rotated.
755 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
756 * containing the three points.
757 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
760 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
761 in GEOM_Object theCentPoint,
762 in GEOM_Object thePoint1,
763 in GEOM_Object thePoint2);
767 * Rotate given object around vector perpendicular to plane containing three points.
768 * Creating its copy before the rotatation.
769 * \param theObject The object to be rotated.
770 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
771 * containing the three points.
772 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
773 * \return New GEOM_Object, containing the rotated object.
775 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
776 in GEOM_Object theCentPoint,
777 in GEOM_Object thePoint1,
778 in GEOM_Object thePoint2);
781 * Rotate the given object around the given axis on the given angle.
782 * \param theObject The object to be rotated.
783 * \param theAxis Rotation axis.
784 * \param theAngle Rotation angle in radians.
787 GEOM_Object Rotate (in GEOM_Object theObject,
788 in GEOM_Object theAxis,
793 * Rotate the given object around the given axis
794 * on the given angle, creating its copy before the rotatation.
795 * \param theObject The object to be rotated.
796 * \param theAxis Rotation axis.
797 * \param theAngle Rotation angle in radians.
798 * \return New GEOM_Object, containing the rotated object.
800 GEOM_Object RotateCopy (in GEOM_Object theObject,
801 in GEOM_Object theAxis,
806 * Rotate the given object around the given axis a given number times.
807 * Rotation angle will be 2*PI/theNbTimes.
808 * \param theObject The object to be rotated.
809 * \param theAxis The rotation axis.
810 * \param theNbTimes Quantity of rotations to be done.
811 * \return New GEOM_Object, containing compound of all the
812 * shapes, obtained after each rotation.
814 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
815 in GEOM_Object theAxis,
819 * Rotate the given object around the
820 * given axis on the given angle a given number
821 * times and multi-translate each rotation result.
822 * Translation direction passes through center of gravity
823 * of rotated shape and its projection on the rotation axis.
824 * \param theObject The object to be rotated.
825 * \param theAxis Rotation axis.
826 * \param theAngle Rotation angle in graduces.
827 * \param theNbTimes1 Quantity of rotations to be done.
828 * \param theStep Translation distance.
829 * \param theNbTimes2 Quantity of translations to be done.
830 * \return New GEOM_Object, containing compound of all the
831 * shapes, obtained after each transformation.
833 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
834 in GEOM_Object theAxis,
838 in long theNbTimes2);
841 * Replace the given object by an object,
842 * symmetrical to it relatively the given plane.
843 * \param theObject The object to be mirrored.
844 * \param thePlane Plane of symmetry.
846 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
849 * Create an object, symmetrical
850 * to the given one relatively the given plane.
851 * \param theObject The object to be mirrored.
852 * \param thePlane Plane of symmetry.
853 * \return New GEOM_Object, containing the mirrored shape.
855 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
858 * Replace the given object by an object,
859 * symmetrical to it relatively the given axis.
860 * \param theObject The object to be mirrored.
861 * \param theAxis Axis of symmetry.
864 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
867 * Create an object, symmetrical
868 * to the given one relatively the given axis.
869 * \param theObject The object to be mirrored.
870 * \param theAxis Axis of symmetry.
871 * \return New GEOM_Object, containing the mirrored object.
873 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
876 * Replace the given object by an object, symmetrical to it relatively the given point.
877 * \param theObject The object to be mirrored.
878 * \param thePoint Point of symmetry.
881 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
884 * Create an object, symmetrical to the given one relatively the given point.
885 * \param theObject The object to be mirrored.
886 * \param thePoint Point of symmetry.
887 * \return New GEOM_Object, containing the mirrored object.
889 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
892 * Replace the given object by its offset.
893 * \param theObject The base object for the offset.
894 * \param theOffset Offset value.
897 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
900 * Create new object as offset of the given one.
901 * \param theObject The base object for the offset.
902 * \param theOffset Offset value.
903 * \return New GEOM_Object, containing the offset object.
905 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
908 * Scale the given object by the factor.
909 * \param theObject The object to be scaled.
910 * \param thePoint Center point for scaling.
911 * \param theFactor Scaling factor value.
914 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
915 in double theFactor);
918 * Scale the given object by the factor, creating its copy before the scaling.
919 * \param theObject The object to be scaled.
920 * \param thePoint Center point for scaling.
921 * \param theFactor Scaling factor value.
922 * \return New GEOM_Object, containing the scaled shape.
924 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
925 in double theFactor);
928 * Scale the given object by different factors along coordinate axes.
929 * \param theObject The object to be scaled.
930 * \param thePoint Center point for scaling.
931 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
934 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
935 in GEOM_Object thePoint,
936 in double theFactorX,
937 in double theFactorY,
938 in double theFactorZ);
941 * Scale the given object by different factors along coordinate axes,
942 * creating its copy before the scaling.
943 * \param theObject The object to be scaled.
944 * \param thePoint Center point for scaling.
945 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
946 * \return New GEOM_Object, containing the scaled shape.
948 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
949 in GEOM_Object thePoint,
950 in double theFactorX,
951 in double theFactorY,
952 in double theFactorZ);
955 * Modify the Location of the given object by LCS.
956 * \param theObject The object to be displaced.
957 * \param theStartLCS Coordinate system to perform displacement from it.
958 * If \a theStartLCS is NULL, displacement
959 * will be performed from global CS.
960 * If \a theObject itself is used as \a theStartLCS,
961 * its location will be changed to \a theEndLCS.
962 * \param theEndLCS Coordinate system to perform displacement to it.
965 GEOM_Object PositionShape (in GEOM_Object theObject,
966 in GEOM_Object theStartLCS,
967 in GEOM_Object theEndLCS);
970 * Modify the Location of the given object by LCS,
971 * creating its copy before the setting.
972 * \param theObject The object to be displaced.
973 * \param theStartLCS Coordinate system to perform displacement from it.
974 * If \a theStartLCS is NULL, displacement
975 * will be performed from global CS.
976 * If \a theObject itself is used as \a theStartLCS,
977 * its location will be changed to \a theEndLCS.
978 * \param theEndLCS Coordinate system to perform displacement to it.
979 * \return New GEOM_Object, containing the displaced shape.
981 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
982 in GEOM_Object theStartLCS,
983 in GEOM_Object theEndLCS);
986 * Modify the Location of the given object by Path,
987 * \param theObject The object to be displaced.
988 * \param thePath Wire or Edge along that the object will be translated.
989 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
990 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
991 * \param theCopy is a true or false parameter. true is to reverse direction, false is to move normal direction.
992 * \return New GEOM_Object, containing the displaced shape.
994 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
995 in GEOM_Object thePath,
996 in double theDistance,
998 in boolean theReverse);
1001 * Transform the shape in the same way what was used for the sample shape creation.
1002 * \param theObject The object to be transformed.
1003 * \param theSample The object containing information about required transformation.
1004 * \note Implementation of this method is limited by multi-transformations now.
1005 * \note Internal method.
1006 * \return New GEOM_Object, containing the transformed shape.
1008 GEOM_Object TransformLikeOtherCopy (in GEOM_Object theObject,
1009 in GEOM_Object theSample);
1012 * Recompute the shape from its arguments.
1013 * \param theObject The object to be recomputed.
1014 * \return theObject.
1016 GEOM_Object RecomputeObject (in GEOM_Object theObject);
1020 * GEOM_I3DPrimOperations: Interface for 3D primitives creation
1021 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
1022 * Pipe (extrusion along contour), Revolution, Solid (from shell).
1024 interface GEOM_I3DPrimOperations : GEOM_IOperations
1027 * Create a box with specified dimensions along the coordinate axes
1028 * and with edges, parallel to the coordinate axes.
1029 * Center of the box will be at point (DX/2, DY/2, DZ/2).
1030 * \param theDX Length of Box edges, parallel to OX axis.
1031 * \param theDY Length of Box edges, parallel to OY axis.
1032 * \param theDZ Length of Box edges, parallel to OZ axis.
1033 * \return New GEOM_Object, containing the created box.
1035 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
1038 * Create a box with two specified opposite vertices,
1039 * and with edges, parallel to the coordinate axes
1040 * \param thePnt1 First of two opposite vertices.
1041 * \param thePnt2 Second of two opposite vertices.
1042 * \return New GEOM_Object, containing the created box.
1044 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1047 * Create a face specified dimensions along OX-OY coordinate axes,
1048 * with edges parallel to the coordinate axes.
1049 * Center of the face will be at point (0, 0, 0).
1050 * \param theH Height of the Face.
1051 * \param theW Width of the Face.
1052 * \param theOrientation Orientation belong axis OXY OYZ OZX
1053 * \return New GEOM_Object, containing the created face.
1055 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1057 * Create a face by normale vector or edge and two specified sizes,
1058 * vertical (H) and horisontal (W).
1059 * \param theVec defines plane.
1060 * \param theH vertical size (height).
1061 * \param theW horisontal size (width).
1062 * \return New GEOM_Object, containing the created face.
1064 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1066 * Create a Disk (circular face) with given center, normal vector and radius.
1067 * \param thePnt disk center.
1068 * \param theVec Vector, normal to the plane of the disk.
1069 * \param theR Disk radius.
1070 * \return New GEOM_Object, containing the created disk.
1072 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1073 in GEOM_Object theVec,
1076 * Create a disk (circular face), passing through three given points
1077 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1078 * \return New GEOM_Object, containing the created disk.
1080 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1081 in GEOM_Object thePnt2,
1082 in GEOM_Object thePnt3);
1085 * Create a disk specified dimensions along OX-OY coordinate axes,
1086 * Center of the disk at point (0, 0, 0).
1087 * \param theR of the Disk.
1088 * \param theOrientation Orientation belong axis OXY OYZ OZX
1089 * \return New GEOM_Object, containing the created disk.
1091 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1094 * Create a cylinder with given radius and height at
1095 * the origin of coordinate system. Axis of the cylinder
1096 * will be collinear to the OZ axis of the coordinate system.
1097 * \param theR Cylinder radius.
1098 * \param theH Cylinder height.
1099 * \return New GEOM_Object, containing the created cylinder.
1101 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1104 * Create a cylinder with given base point, axis, radius and height.
1105 * \param thePnt Central point of cylinder base.
1106 * \param theAxis Cylinder axis.
1107 * \param theR Cylinder radius.
1108 * \param theH Cylinder height.
1109 * \return New GEOM_Object, containing the created cylinder.
1111 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1112 in GEOM_Object theAxis,
1117 * Create a cone with given height and radiuses at
1118 * the origin of coordinate system. Axis of the cone will
1119 * be collinear to the OZ axis of the coordinate system.
1120 * \param theR1 Radius of the first cone base.
1121 * \param theR2 Radius of the second cone base.
1122 * \note If both radiuses are non-zero, the cone will be truncated.
1123 * \note If the radiuses are equal, a cylinder will be created instead.
1124 * \param theH Cone height.
1125 * \return New GEOM_Object, containing the created cone.
1127 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1130 * Create a cone with given base point, axis, height and radiuses.
1131 * \param thePnt Central point of the first cone base.
1132 * \param theAxis Cone axis.
1133 * \param theR1 Radius of the first cone base.
1134 * \param theR2 Radius of the second cone base.
1135 * \note If both radiuses are non-zero, the cone will be truncated.
1136 * \note If the radiuses are equal, a cylinder will be created instead.
1137 * \param theH Cone height.
1138 * \return New GEOM_Object, containing the created cone.
1140 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1141 in GEOM_Object theAxis,
1147 * Create a torus with given radiuses at the origin of coordinate system.
1148 * \param theRMajor Torus major radius.
1149 * \param theRMinor Torus minor radius.
1150 * \return New GEOM_Object, containing the created torus.
1152 GEOM_Object MakeTorusRR (in double theRMajor,
1153 in double theRMinor);
1156 * Create a torus with given center, normal vector and radiuses.
1157 * \param thePnt Torus central point.
1158 * \param theVec Torus axis of symmetry.
1159 * \param theRMajor Torus major radius.
1160 * \param theRMinor Torus minor radius.
1161 * \return New GEOM_Object, containing the created torus.
1163 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1164 in GEOM_Object theVec,
1165 in double theRMajor,
1166 in double theRMinor);
1169 * Create a sphere with given radius at the origin of coordinate system.
1170 * \param theR Sphere radius.
1171 * \return New GEOM_Object, containing the created sphere.
1173 GEOM_Object MakeSphereR (in double theR);
1176 * Create a sphere with given center and radius.
1177 * \param thePnt Sphere center.
1178 * \param theR Sphere radius.
1179 * \return New GEOM_Object, containing the created .
1181 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1184 * Create a shape by extrusion of the base shape along the vector,
1185 * i.e. all the space, transfixed by the base shape during its translation
1186 * along the vector on the given distance.
1187 * \param theBase Base shape to be extruded.
1188 * \param theVec Direction of extrusion.
1189 * \param theH Prism dimension along theVec.
1190 * \return New GEOM_Object, containing the created prism.
1192 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1193 in GEOM_Object theVec,
1195 /* The Same Prism but in 2 directions (forward&backward) */
1196 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1197 in GEOM_Object theVec,
1199 /* The Same as MakePrismVecH but with scaling */
1200 GEOM_Object MakePrismVecHWithScaling (in GEOM_Object theBase,
1201 in GEOM_Object theVec,
1203 in double theScaleFactor);
1206 * Create a shape by extrusion of the base shape along a vector, defined by two points.
1207 * \param theBase Base shape to be extruded.
1208 * \param thePoint1 First end of extrusion vector.
1209 * \param thePoint2 Second end of extrusion vector.
1210 * \return New GEOM_Object, containing the created prism.
1212 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1213 in GEOM_Object thePoint1,
1214 in GEOM_Object thePoint2);
1215 /* The same prism but in two directions forward&backward */
1216 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1217 in GEOM_Object thePoint1,
1218 in GEOM_Object thePoint2);
1219 /* The Same as MakePrismTwoPnt but with scaling */
1220 GEOM_Object MakePrismTwoPntWithScaling (in GEOM_Object theBase,
1221 in GEOM_Object thePoint1,
1222 in GEOM_Object thePoint2,
1223 in double theScaleFactor);
1226 * Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1227 * \param theBase Base shape to be extruded.
1228 * \param DX, DY, DZ end of extrusion vector.
1229 * \return New GEOM_Object, containing the created prism.
1231 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1232 in double theDX, in double theDY, in double theDZ);
1233 /* The same prism but in two directions forward&backward */
1234 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1235 in double theDX, in double theDY, in double theDZ);
1236 /* The Same as MakePrismDXDYDZ but with scaling */
1237 GEOM_Object MakePrismDXDYDZWithScaling (in GEOM_Object theBase,
1238 in double theDX, in double theDY, in double theDZ,
1239 in double theScaleFactor);
1242 * Create a shape by extrusion of the base shape along
1243 * the path shape. The path shape can be a wire or an edge.
1244 * \param theBase Base shape to be extruded.
1245 * \param thePath Path shape to extrude the base shape along it.
1246 * \return New GEOM_Object, containing the created pipe.
1248 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1251 * Create a shape by revolution of the base shape around the axis
1252 * on the given angle, i.e. all the space, transfixed by the base
1253 * shape during its rotation around the axis on the given angle.
1254 * \param theBase Base shape to be rotated.
1255 * \param theAxis Rotation axis.
1256 * \param theAngle Rotation angle in radians.
1257 * \return New GEOM_Object, containing the created revolution.
1259 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1260 in GEOM_Object theAxis,
1261 in double theAngle);
1262 /* The Same Revolution but in both ways forward&backward */
1263 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1264 in GEOM_Object theAxis,
1265 in double theAngle);
1268 * Create a filling from the given compound of contours.
1269 * \param theMinDeg a minimal degree of BSpline surface to create
1270 * \param theMaxDeg a maximal degree of BSpline surface to create
1271 * \param theTol2D a 2d tolerance to be reached
1272 * \param theTol3D a 3d tolerance to be reached
1273 * \param theNbIter a number of iteration of approximation algorithm
1274 * \param theMethod Kind of method to perform filling operation.
1275 * \return New GEOM_Object, containing the created filling surface.
1277 GEOM_Object MakeFilling (in GEOM_Object theShape,
1278 in long theMinDeg, in long theMaxDeg,
1279 in double theTol2D, in double theTol3D,
1281 in filling_oper_method theMethod,
1282 in boolean theApprox);
1285 * Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1286 * \param theSeqSections - set of specified sections.
1287 * \param theModeSolid - mode defining building solid or shell
1288 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1289 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1290 * \return New GEOM_Object, containing the created shell or solid.
1292 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1293 in boolean theModeSolid,
1295 in boolean theRuled);
1298 * Create a shape by extrusion of the profile shape along
1299 * the path shape. The path shape can be a wire or an edge.
1300 * the several profiles can be specified in the several locations of path.
1301 * \param theSeqBases - list of Bases shape to be extruded.
1302 * \param theLocations - list of locations on the path corresponding
1303 * specified list of the Bases shapes. Number of locations
1304 * should be equal to number of bases or list of locations can be empty.
1305 * \param thePath - Path shape to extrude the base shape along it.
1306 * \param theWithContact - the mode defining that the section is translated to be in
1307 * contact with the spine.
1308 * \param - WithCorrection - defining that the section is rotated to be
1309 * orthogonal to the spine tangent in the correspondent point
1310 * \return New GEOM_Object, containing the created pipe.
1312 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1313 in ListOfGO theLocations,
1314 in GEOM_Object thePath,
1315 in boolean theWithContact ,
1316 in boolean theWithCorrection );
1319 * Create a shape by extrusion of the profile shape along
1320 * the path shape. The path shape can be a shell or a face.
1321 * the several profiles can be specified in the several locations of path.
1322 * \param theSeqBases - list of Bases shape to be extruded.
1323 * \param theSeqSubBases - list of corresponding subshapes of section shapes.
1324 * \param theLocations - list of locations on the path corresponding
1325 * specified list of the Bases shapes. Number of locations
1326 * should be equal to number of bases.
1327 * \param thePath - Path shape to extrude the base shape along it.
1328 * \param theWithContact - the mode defining that the section is translated to be in
1329 * contact with the spine.
1330 * \param - WithCorrection - defining that the section is rotated to be
1331 * orthogonal to the spine tangent in the correspondent point
1332 * \return New GEOM_Object, containing the created pipe.
1334 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1335 in ListOfGO theSeqSubBases,
1336 in ListOfGO theLocations,
1337 in GEOM_Object thePath,
1338 in boolean theWithContact ,
1339 in boolean theWithCorrection );
1342 * Create solids between given sections
1343 * \param theSeqBases - list of sections (shell or face).
1344 * \param theLocations - list of corresponding vertexes
1345 * \return New GEOM_Object, containing the created solids.
1347 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1348 in ListOfGO theLocations);
1351 * Create a shape by extrusion of the base shape along
1352 * the path shape with constant bi-normal direction along the given vector.
1353 * The path shape can be a wire or an edge.
1354 * \param theBase Base shape to be extruded.
1355 * \param thePath Path shape to extrude the base shape along it.
1356 * \param theVec Vector defines a constant binormal direction to keep the
1357 * same angle beetween the Direction and the sections
1358 * along the sweep surface.
1359 * \return New GEOM_Object, containing the created pipe.
1361 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1362 in GEOM_Object thePath,
1363 in GEOM_Object theVec);
1368 * GEOM_IShapesOperations: Interface for Shapes creation:
1369 * Edge from two points, Wire from edges, Face from wire,
1370 * Shell from faces, Solid from shells, Compound from shapes
1372 interface GEOM_IShapesOperations : GEOM_IOperations
1375 * Create a linear edge with specified ends.
1376 * \param thePnt1 Point for the first end of edge.
1377 * \param thePnt2 Point for the second end of edge.
1378 * \return New GEOM_Object, containing the created edge.
1380 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1383 * Create an edge from specified wire.
1384 * \param theWire source Wire.
1385 * \param theLinearTolerance linear tolerance value
1386 * \param theAngularTolerance angular tolerance value
1387 * \return New GEOM_Object, containing the created edge.
1389 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1390 in double theLinearTolerance,
1391 in double theAngularTolerance);
1394 * Create a wire from the set of edges and wires.
1395 * \param theEdgesAndWires List of edge and/or wires.
1396 * \param theTolerance Maximum distance between vertices, that will be merged.
1397 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1398 * \return New GEOM_Object, containing the created wire.
1400 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1401 in double theTolerance);
1404 * Create a face on the given wire.
1405 * \param theWire closed Wire or Edge to build the face on.
1406 * \param isPlanarWanted If TRUE, only planar face will be built.
1407 * If impossible, NULL object will be returned.
1408 * \return New GEOM_Object, containing the created face.
1410 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1413 * Create a face on the given wires set.
1414 * \param theWires List of closed wires or edges to build the face on.
1415 * \param isPlanarWanted If TRUE, only planar face will be built.
1416 * If impossible, NULL object will be returned.
1417 * \return New GEOM_Object, containing the created face.
1419 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1422 * Create a shell from the set of faces and shells.
1423 * \param theFacesAndShells List of faces and/or shells.
1424 * \return New GEOM_Object, containing the created shell.
1426 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1429 * Create a solid, bounded by the given shell.
1430 * \param theShell Bounding shell.
1431 * \return New GEOM_Object, containing the created solid.
1433 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1436 * Create a solid, bounded by the given shells.
1437 * \param theShells Bounding shells.
1438 * \return New GEOM_Object, containing the created solid.
1440 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1443 * Create a compound of the given shapes.
1444 * \param theShapes List of shapes to put in compound.
1445 * \return New GEOM_Object, containing the created compound.
1447 GEOM_Object MakeCompound (in ListOfGO theShapes);
1450 * Replace coincident faces in theShape by one face.
1451 * \param theShape Initial shape.
1452 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1453 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1454 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1456 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1459 * Find coincident faces in theShape for possible gluing.
1460 * \param theShape Initial shape.
1461 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1464 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1467 * Replace coincident faces in theShape by one face
1468 * in compliance with given list of faces
1469 * \param theShape Initial shape.
1470 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1471 * \param theFaces List of faces for gluing.
1472 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1473 * \return New GEOM_Object, containing a copy of theShape without some faces.
1475 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1476 in ListOfGO theFaces, in boolean doKeepNonSolids);
1479 * Get all sub-shapes and groups of \a theShape,
1480 * that were created already by any other methods.
1481 * \param theShape Any shape.
1482 * \param theGroupsOnly If this parameter is TRUE, only groups will be
1483 * returned, else all found sub-shapes and groups.
1484 * \return List of existing sub-objects of \a theShape.
1486 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
1487 in boolean theGroupsOnly);
1490 * Deprecated method. Use MakeAllSubShapes() instead.
1492 ListOfGO MakeExplode (in GEOM_Object theShape,
1493 in long theShapeType,
1494 in boolean isSorted);
1497 * Explode a shape on subshapes of a given type. If the
1498 * shape itself has the given type, it is also returned.
1499 * \param theShape Shape to be exploded.
1500 * \param theShapeType Type of sub-shapes to be retrieved.
1501 * \param isSorted If this parameter is TRUE, sub-shapes will be
1502 * sorted by coordinates of their gravity centers.
1503 * \return List of sub-shapes of type theShapeType, contained in theShape.
1505 ListOfGO MakeAllSubShapes (in GEOM_Object theShape,
1506 in long theShapeType,
1507 in boolean isSorted);
1510 * Extract all subshapes of the given type from
1511 * the given shape, excluding the shape itself.
1512 * \param theShape Shape to be exploded.
1513 * \param theShapeType Type of sub-shapes to be retrieved.
1514 * \param isSorted If this parameter is TRUE, sub-shapes will be
1515 * sorted by coordinates of their gravity centers.
1516 * \return List of sub-shapes of type theShapeType, contained in theShape.
1518 ListOfGO ExtractSubShapes (in GEOM_Object theShape,
1519 in long theShapeType,
1520 in boolean isSorted);
1523 * Deprecated method. Use GetAllSubShapesIDs() instead.
1525 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1526 in long theShapeType,
1527 in boolean isSorted);
1530 * Explode a shape on subshapes of a given type.
1531 * Does the same, as MakeAllSubShapes, but returns IDs of
1532 * sub-shapes, not GEOM_Objects. It works faster.
1533 * \param theShape Shape to be exploded.
1534 * \param theShapeType Type of sub-shapes to be retrieved.
1535 * \param isSorted If this parameter is TRUE, sub-shapes will be
1536 * sorted by coordinates of their gravity centers.
1537 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1539 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
1540 in long theShapeType,
1541 in boolean isSorted);
1544 * Get a sub shape defined by its unique ID inside \a theMainShape
1545 * \note The sub shape GEOM_Objects can has ONLY ONE function.
1546 * Don't try to apply modification operations on them.
1548 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1552 * Get global index of \a theSubShape in \a theMainShape.
1553 * \param theMainShape Main shape.
1554 * \param theSubShape Sub-shape of the main shape.
1555 * \return global index of \a theSubShape in \a theMainShape.
1557 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1560 * Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1561 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1562 * to generate automatic names for sub-shapes, when publishing them in a study.
1563 * \param theMainShape Main shape.
1564 * \param theSubShape Sub-shape of the main shape.
1565 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1567 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1570 * \brief Get name of type of \a theShape.
1572 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1573 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1574 * to generate automatic names for sub-shapes, when publishing them in a study.
1575 * \param theShape The shape to get a type of.
1576 * \return String, containing a type name of \a theShape.
1578 string GetShapeTypeString (in GEOM_Object theShape);
1581 * Count number of faces in the given shape.
1582 * \param theShape Shape to count faces in.
1583 * \return Number of faces in the given shape.
1585 long NumberOfFaces (in GEOM_Object theShape);
1588 * Count number of edges in the given shape.
1589 * \param theShape Shape to count edges in.
1590 * \return Number of edges in theShape.
1592 long NumberOfEdges (in GEOM_Object theShape);
1595 * Count number of subshapes of type \a theShapeType in the given shape.
1596 * \param theShape Shape to count subshapes in.
1597 * \param theShapeType The type of subshapes to count.
1598 * \return Number of subshapes of type \a theShapeType in \a theShape.
1600 long NumberOfSubShapes (in GEOM_Object theShape,
1601 in long theShapeType);
1604 * Reverses an orientation the given shape.
1605 * \param theShape Shape to be reversed.
1606 * \return The reversed copy of theShape.
1608 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1611 * Retrieve all free faces from the given shape.
1612 * Free face is a face, which is not shared between two shells of the shape.
1613 * \param theShape Shape to find free faces in.
1614 * \return List of IDs of all free faces, contained in theShape.
1616 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1619 * Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1620 * \param theShape1 Shape to find sub-shapes in.
1621 * \param theShape2 Shape to find shared sub-shapes with.
1622 * \param theShapeType Type of sub-shapes to be retrieved.
1623 * \return List of sub-shapes of theShape1, shared with theShape2.
1625 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1626 in GEOM_Object theShape2,
1627 in long theShapeType);
1630 * Get all sub-shapes, shared by all shapes in the list \a theShapes.
1631 * \param theShapes Shapes to find common sub-shapes of.
1632 * \param theShapeType Type of sub-shapes to be retrieved.
1633 * \return List of objects, that are sub-shapes of all given shapes.
1635 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
1636 in long theShapeType);
1639 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1640 * the specified plane by the certain way, defined through \a theState parameter.
1641 * \param theShape Shape to find sub-shapes of.
1642 * \param theShapeType Type of sub-shapes to be retrieved.
1643 * \param theAx1 Vector (or line, or linear edge), specifying normal
1644 * direction and location of the plane to find shapes on.
1645 * \param theState The state of the subshapes to find.
1646 * \return List of all found sub-shapes.
1648 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1649 in long theShapeType,
1650 in GEOM_Object theAx1,
1651 in shape_state theState);
1653 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1654 * the specified plane 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 theAx1 Vector (or line, or linear edge), specifying normal
1658 * direction of the plane to find shapes on.
1659 * \param thePnt Point specifying location of the plane to find shapes on.
1660 * \param theState The state of the subshapes to find.
1661 * \return List of all found sub-shapes.
1663 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1664 in long theShapeType,
1665 in GEOM_Object theAx1,
1666 in GEOM_Object thePnt,
1667 in shape_state theState);
1672 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1673 * the specified cylinder by the certain way, defined through \a theState parameter.
1674 * \param theShape Shape to find sub-shapes of.
1675 * \param theShapeType Type of sub-shapes to be retrieved.
1676 * \param theAxis Vector (or line, or linear edge), specifying
1677 * axis of the cylinder to find shapes on.
1678 * \param theRadius Radius of the cylinder to find shapes on.
1679 * \param theState The state of the subshapes to find.
1680 * \return List of all found sub-shapes.
1682 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1683 in long theShapeType,
1684 in GEOM_Object theAxis,
1685 in double theRadius,
1686 in shape_state theState);
1689 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1690 * the specified cylinder by the certain way, defined through \a theState parameter.
1691 * \param theShape Shape to find sub-shapes of.
1692 * \param theShapeType Type of sub-shapes to be retrieved.
1693 * \param theAxis Vector (or line, or linear edge), specifying
1694 * axis of the cylinder to find shapes on.
1695 * \param thePnt Point specifying location of the bottom of the cylinder.
1696 * \param theRadius Radius of the cylinder to find shapes on.
1697 * \param theState The state of the subshapes to find.
1698 * \return List of all found sub-shapes.
1700 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1701 in long theShapeType,
1702 in GEOM_Object theAxis,
1703 in GEOM_Object thePnt,
1704 in double theRadius,
1705 in shape_state theState);
1708 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1709 * the specified sphere by the certain way, defined through \a theState parameter.
1710 * \param theShape Shape to find sub-shapes of.
1711 * \param theShapeType Type of sub-shapes to be retrieved.
1712 * \param theCenter Point, specifying center of the sphere to find shapes on.
1713 * \param theRadius Radius of the sphere to find shapes on.
1714 * \param theState The state of the subshapes to find.
1715 * \return List of all found sub-shapes.
1717 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1718 in long theShapeType,
1719 in GEOM_Object theCenter,
1720 in double theRadius,
1721 in shape_state theState);
1724 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1725 * the specified quadrangle by the certain way, defined through \a theState parameter.
1726 * \param theShape Shape to find sub-shapes of.
1727 * \param theShapeType Type of sub-shapes to be retrieved.
1728 * \param theTopLeftPoint Top left quadrangle corner
1729 * \param theTopRigthPoint Top right quadrangle corner
1730 * \param theBottomLeftPoint Bottom left quadrangle corner
1731 * \param theBottomRigthPoint Bottom right quadrangle corner
1732 * \param theState The state of the subshapes to find.
1733 * \return List of all found sub-shapes.
1735 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1736 in long theShapeType,
1737 in GEOM_Object theTopLeftPoint,
1738 in GEOM_Object theTopRigthPoint,
1739 in GEOM_Object theBottomLeftPoint,
1740 in GEOM_Object theBottomRigthPoint,
1741 in shape_state theState);
1744 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1745 * the specified plane by the certain way, defined through \a theState parameter.
1746 * \param theShape Shape to find sub-shapes of.
1747 * \param theShapeType Type of sub-shapes to be retrieved.
1748 * \param theAx1 Vector (or line, or linear edge), specifying normal
1749 * direction and location of the plane to find shapes on.
1750 * \param theState The state of the subshapes to find.
1751 * \return List of IDs of all found sub-shapes.
1753 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1754 in long theShapeType,
1755 in GEOM_Object theAx1,
1756 in shape_state theState);
1759 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1760 * the specified plane by the certain way, defined through \a theState parameter.
1761 * \param theShape Shape to find sub-shapes of.
1762 * \param theShapeType Type of sub-shapes to be retrieved.
1763 * \param theAx1 Vector (or line, or linear edge), specifying normal
1764 * direction of the plane to find shapes on.
1765 * \param thePnt Point specifying location of the plane to find shapes on.
1766 * \param theState The state of the subshapes to find.
1767 * \return List of IDs of all found sub-shapes.
1769 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1770 in long theShapeType,
1771 in GEOM_Object theAx1,
1772 in GEOM_Object thePnt,
1773 in shape_state theState);
1776 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1777 * the specified cylinder by the certain way, defined through \a theState parameter.
1778 * \param theShape Shape to find sub-shapes of.
1779 * \param theShapeType Type of sub-shapes to be retrieved.
1780 * \param theAxis Vector (or line, or linear edge), specifying
1781 * axis of the cylinder to find shapes on.
1782 * \param theRadius Radius of the cylinder to find shapes on.
1783 * \param theState The state of the subshapes to find.
1784 * \return List of IDs of all found sub-shapes.
1786 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1787 in long theShapeType,
1788 in GEOM_Object theAxis,
1789 in double theRadius,
1790 in shape_state theState);
1793 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1794 * the specified cylinder by the certain way, defined through \a theState parameter.
1795 * \param theShape Shape to find sub-shapes of.
1796 * \param theShapeType Type of sub-shapes to be retrieved.
1797 * \param theAxis Vector (or line, or linear edge), specifying
1798 * axis of the cylinder to find shapes on.
1799 * \param thePnt Point specifying location of the bottom of the cylinder.
1800 * \param theRadius Radius of the cylinder to find shapes on.
1801 * \param theState The state of the subshapes to find.
1802 * \return List of IDs all found sub-shapes.
1804 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1805 in long theShapeType,
1806 in GEOM_Object theAxis,
1807 in GEOM_Object thePnt,
1808 in double theRadius,
1809 in shape_state theState);
1812 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1813 * the specified sphere by the certain way, defined through \a theState parameter.
1814 * \param theShape Shape to find sub-shapes of.
1815 * \param theShapeType Type of sub-shapes to be retrieved.
1816 * \param theCenter Point, specifying center of the sphere to find shapes on.
1817 * \param theRadius Radius of the sphere to find shapes on.
1818 * \param theState The state of the subshapes to find.
1819 * \return List of IDs of all found sub-shapes.
1821 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1822 in long theShapeType,
1823 in GEOM_Object theCenter,
1824 in double theRadius,
1825 in shape_state theState);
1828 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1829 * the specified quadrangle by the certain way, defined through \a theState parameter.
1830 * \param theShape Shape to find sub-shapes of.
1831 * \param theShapeType Type of sub-shapes to be retrieved.
1832 * \param theTopLeftPoint Top left quadrangle corner
1833 * \param theTopRigthPoint Top right quadrangle corner
1834 * \param theBottomLeftPoint Bottom left quadrangle corner
1835 * \param theBottomRigthPoint Bottom right quadrangle corner
1836 * \param theState The state of the subshapes to find.
1837 * \return List of IDs of all found sub-shapes.
1839 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1840 in long theShapeType,
1841 in GEOM_Object theTopLeftPoint,
1842 in GEOM_Object theTopRigthPoint,
1843 in GEOM_Object theBottomLeftPoint,
1844 in GEOM_Object theBottomRigthPoint,
1845 in shape_state theState);
1848 * \brief Find subshapes complying with given status
1849 * \param theBox - the box to check state of subshapes against
1850 * \param theShape - the shape to explore
1851 * \param theShapeType - type of subshape of theShape
1852 * \param theState - required state
1853 * \return List of IDs of all found sub-shapes.
1855 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1856 in GEOM_Object theShape,
1857 in long theShapeType,
1858 in shape_state theState);
1861 * \brief Find subshapes complying with given status
1862 * \param theBox - the box to check state of subshapes against
1863 * \param theShape - the shape to explore
1864 * \param theShapeType - type of subshape of theShape
1865 * \param theState - required state
1866 * \return List of all found sub-shapes.
1868 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1869 in GEOM_Object theShape,
1870 in long theShapeType,
1871 in shape_state theState);
1874 * \brief Find subshapes complying with given status
1875 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1876 * \param theShape - the shape to explore
1877 * \param theShapeType - type of subshape of theShape
1878 * \param theState - required state
1879 * \return List of IDs of all found sub-shapes.
1881 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
1882 in GEOM_Object theShape,
1883 in short theShapeType,
1884 in shape_state theState);
1887 * \brief Find subshapes complying with given status
1888 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1889 * \param theShape - the shape to explore
1890 * \param theShapeType - type of subshape of theShape
1891 * \param theState - required state
1892 * \return List of all found sub-shapes.
1894 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
1895 in GEOM_Object theShape,
1896 in short theShapeType,
1897 in shape_state theState);
1900 * \brief Find subshapes complying with given status
1901 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1902 * \param theShape - the shape to explore
1903 * \param theShapeType - type of subshape of theShape
1904 * \param theState - required state
1905 * \return compound includes all found sub-shapes.
1907 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
1908 in GEOM_Object theShape,
1909 in short theShapeType,
1910 in shape_state theState);
1913 * Get sub-shape(s) of \a theShapeWhere, which are
1914 * coincident with \a theShapeWhat or could be a part of it.
1915 * \param theShapeWhere Shape to find sub-shapes of.
1916 * \param theShapeWhat Shape, specifying what to find.
1917 * \return Group of all found sub-shapes or a single found sub-shape.
1919 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1920 in GEOM_Object theShapeWhat);
1923 * Get sub-shape(s) of \a theShapeWhere, which are
1924 * coincident with \a theShapeWhat or could be a part of it.
1926 * Implementation of this method is based on a saved history of an operation,
1927 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1928 * arguments (an argument shape or a sub-shape of an argument shape).
1929 * The operation could be the Partition or one of boolean operations,
1930 * performed on simple shapes (not on compounds).
1932 * \param theShapeWhere Shape to find sub-shapes of.
1933 * \param theShapeWhat Shape, specifying what to find.
1934 * \return Group of all found sub-shapes or a single found sub-shape.
1936 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
1937 in GEOM_Object theShapeWhat);
1940 * Get sub-shape of theShapeWhere, which are
1941 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1942 * \param theShapeWhere Shape to find sub-shapes of.
1943 * \param theShapeWhat Shape, specifying what to find.
1944 * \return found sub-shape.
1946 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1947 in GEOM_Object theShapeWhat);
1951 * GEOM_IBlocksOperations: Interface for Blocks construction
1952 * Face from points or edges, Block from faces,
1953 * Blocks multi-translation and multi-rotation
1955 interface GEOM_IBlocksOperations : GEOM_IOperations
1958 * Creation of blocks
1962 * Create a quadrangle face from four edges. Order of Edges is not
1963 * important. It is not necessary that edges share the same vertex.
1964 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1965 * \return New GEOM_Object, containing the created face.
1967 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1968 in GEOM_Object theEdge2,
1969 in GEOM_Object theEdge3,
1970 in GEOM_Object theEdge4);
1973 * Create a quadrangle face on two edges.
1974 * The missing edges will be built by creating the shortest ones.
1975 * \param theEdge1,theEdge2 Two opposite edges for the face.
1976 * \return New GEOM_Object, containing the created face.
1978 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1979 in GEOM_Object theEdge2);
1982 * Create a quadrangle face with specified corners.
1983 * The missing edges will be built by creating the shortest ones.
1984 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1985 * \return New GEOM_Object, containing the created face.
1987 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1988 in GEOM_Object thePnt2,
1989 in GEOM_Object thePnt3,
1990 in GEOM_Object thePnt4);
1993 * Create a hexahedral solid, bounded by the six given faces. Order of
1994 * faces is not important. It is not necessary that Faces share the same edge.
1995 * \param theFace1-theFace6 Faces for the hexahedral solid.
1996 * \return New GEOM_Object, containing the created solid.
1998 GEOM_Object MakeHexa (in GEOM_Object theFace1,
1999 in GEOM_Object theFace2,
2000 in GEOM_Object theFace3,
2001 in GEOM_Object theFace4,
2002 in GEOM_Object theFace5,
2003 in GEOM_Object theFace6);
2006 * Create a hexahedral solid between two given faces.
2007 * The missing faces will be built by creating the smallest ones.
2008 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
2009 * \return New GEOM_Object, containing the created solid.
2011 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
2012 in GEOM_Object theFace2);
2015 * Extract elements of blocks and blocks compounds
2019 * Get a vertex, found in the given shape by its coordinates.
2020 * \param theShape Block or a compound of blocks.
2021 * \param theX,theY,theZ Coordinates of the sought vertex.
2022 * \param theEpsilon Maximum allowed distance between the resulting
2023 * vertex and point with the given coordinates.
2024 * \return New GEOM_Object, containing the found vertex.
2026 GEOM_Object GetPoint (in GEOM_Object theShape,
2030 in double theEpsilon);
2033 * Find a vertex of the given shape, which has minimal distance to the given point.
2034 * \param theShape Any shape.
2035 * \param thePoint Point, close to the desired vertex.
2036 * \return New GEOM_Object, containing the found vertex.
2038 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
2039 in GEOM_Object thePoint);
2042 * Get an edge, found in the given shape by two given vertices.
2043 * \param theShape Block or a compound of blocks.
2044 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2045 * \return New GEOM_Object, containing the found edge.
2047 GEOM_Object GetEdge (in GEOM_Object theShape,
2048 in GEOM_Object thePoint1,
2049 in GEOM_Object thePoint2);
2052 * Find an edge of the given shape, which has minimal distance to the given point.
2053 * \param theShape Block or a compound of blocks.
2054 * \param thePoint Point, close to the desired edge.
2055 * \return New GEOM_Object, containing the found edge.
2057 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
2058 in GEOM_Object thePoint);
2061 * Returns a face, found in the given shape by four given corner vertices.
2062 * \param theShape Block or a compound of blocks.
2063 * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
2064 * \return New GEOM_Object, containing the found face.
2066 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
2067 in GEOM_Object thePoint1,
2068 in GEOM_Object thePoint2,
2069 in GEOM_Object thePoint3,
2070 in GEOM_Object thePoint4);
2073 * Get a face of block, found in the given shape by two given edges.
2074 * \param theShape Block or a compound of blocks.
2075 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2076 * \return New GEOM_Object, containing the found face.
2078 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2079 in GEOM_Object theEdge1,
2080 in GEOM_Object theEdge2);
2083 * Find a face, opposite to the given one in the given block.
2084 * \param theBlock Must be a hexahedral solid.
2085 * \param theFace Face of \a theBlock, opposite to the desired face.
2086 * \return New GEOM_Object, containing the found face.
2088 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2089 in GEOM_Object theFace);
2092 * Find a face of the given shape, which has minimal distance to the given point.
2093 * \param theShape Block or a compound of blocks.
2094 * \param thePoint Point, close to the desired face.
2095 * \return New GEOM_Object, containing the found face.
2097 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2098 in GEOM_Object thePoint);
2101 * Find a face of block, whose outside normale has minimal angle with the given vector.
2102 * \param theShape Block or a compound of blocks.
2103 * \param theVector Vector, close to the normale of the desired face.
2104 * \return New GEOM_Object, containing the found face.
2106 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2107 in GEOM_Object theVector);
2110 * Find all subshapes of type \a theShapeType of the given shape,
2111 * which have minimal distance to the given point.
2112 * \param theShape Any shape.
2113 * \param thePoint Point, close to the desired shape.
2114 * \param theShapeType Defines what kind of subshapes is searched.
2115 * \param theTolerance The tolerance for distances comparison. All shapes
2116 * with distances to the given point in interval
2117 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2118 * \return New GEOM_Object, containing a group of all found shapes.
2120 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2121 in GEOM_Object thePoint,
2122 in long theShapeType,
2123 in double theTolerance);
2126 * Extract blocks from blocks compounds
2130 * Check, if the compound contains only specified blocks.
2131 * \param theCompound The compound to check.
2132 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2133 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2134 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2135 * \return TRUE, if the given compound contains only blocks.
2136 * \return theNbBlocks Number of specified blocks in theCompound.
2138 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2139 in long theMinNbFaces,
2140 in long theMaxNbFaces,
2141 out long theNbBlocks);
2144 * Enumeration of Blocks Compound defects.
2148 /* Each element of the compound should be a Block */
2151 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2154 /* A connection between two Blocks should be an entire face or an entire edge */
2157 /* The compound should be connexe */
2160 /* The glue between two quadrangle faces should be applied */
2165 * Description of Blocks Compound defect: type and incriminated sub-shapes.
2170 ListOfLong incriminated;
2174 * Sequence of all Blocks Compound defects.
2176 typedef sequence<BCError> BCErrors;
2179 * Check, if the compound of blocks is given.
2180 * To be considered as a compound of blocks, the
2181 * given shape must satisfy the following conditions:
2182 * - Each element of the compound should be a Block (6 faces and 12 edges).
2183 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2184 * - The compound should be connexe.
2185 * - The glue between two quadrangle faces should be applied.
2186 * \note Single block is also accepted as a valid compound of blocks.
2187 * \param theCompound The compound to check.
2188 * \return TRUE, if the given shape is a compound of blocks.
2189 * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
2191 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2192 out BCErrors theErrors);
2195 * Convert sequence of Blocks Compound errors, returned by
2196 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2197 * \param theCompound The bad compound.
2198 * \param theErrors The sequence of \a theCompound errors.
2199 * \return String, describing all the errors in form, suitable for printing.
2201 string PrintBCErrors (in GEOM_Object theCompound,
2202 in BCErrors theErrors);
2205 * Remove all seam and degenerated edges from \a theShape.
2206 * Unite faces and edges, sharing one surface.
2207 * \param theShape The compound or single solid to remove irregular edges from.
2208 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2209 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2210 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2211 * For blocks repairing recommended value is 6.
2212 * \return Improved shape.
2214 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2215 in long theOptimumNbFaces);
2218 * Check, if the given shape is a blocks compound.
2219 * Fix all detected errors.
2220 * \note Single block can be also fixed by this method.
2221 * \param theCompound The compound to check and improve.
2222 * \return Improved compound.
2224 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2227 * Get all the blocks, contained in the given compound.
2228 * \param theCompound The compound to explode.
2229 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2230 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2231 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2232 * \return List of GEOM_Objects, containing the retrieved blocks.
2234 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2235 in long theMinNbFaces,
2236 in long theMaxNbFaces);
2239 * Find block, containing the given point inside its volume or on boundary.
2240 * \param theCompound Compound, to find block in.
2241 * \param thePoint Point, close to the desired block. If the point lays on
2242 * boundary between some blocks, we return block with nearest center.
2243 * \return New GEOM_Object, containing the found block.
2245 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2246 in GEOM_Object thePoint);
2249 * Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2250 * \param theCompound Compound, to find block in.
2251 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2252 * \return New GEOM_Object, containing the found block.
2254 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2255 in ListOfGO theParts);
2258 * Return all blocks, containing all the elements, passed as the parts.
2259 * \param theCompound Compound, to find blocks in.
2260 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2261 * \return List of GEOM_Objects, containing the found blocks.
2263 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2264 in ListOfGO theParts);
2267 * Operations on blocks with gluing of result
2271 * Multi-transformate block and glue the result.
2272 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2273 * \param theBlock Hexahedral solid to be multi-transformed.
2274 * \param theDirFace1 First direction face global index.
2275 * \param theDirFace2 Second direction face global index.
2276 * \param theNbTimes Quantity of transformations to be done.
2277 * \note Global index of sub-shape can be obtained, using method
2278 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2279 * \return New GEOM_Object, containing the result shape.
2281 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2282 in long theDirFace1,
2283 in long theDirFace2,
2284 in long theNbTimes);
2287 * Multi-transformate block and glue the result.
2288 * \param theBlock Hexahedral solid to be multi-transformed.
2289 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2290 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2291 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2292 * \return New GEOM_Object, containing the result shape.
2294 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2295 in long theDirFace1U,
2296 in long theDirFace2U,
2297 in long theNbTimesU,
2298 in long theDirFace1V,
2299 in long theDirFace2V,
2300 in long theNbTimesV);
2303 * Special operation - propagation
2307 * Build all possible propagation groups.
2308 * Propagation group is a set of all edges, opposite to one (main)
2309 * edge of this group directly or through other opposite edges.
2310 * Notion of Opposite Edge make sence only on quadrangle face.
2311 * \param theShape Shape to build propagation groups on.
2312 * \return List of GEOM_Objects, each of them is a propagation group.
2314 ListOfGO Propagate (in GEOM_Object theShape);
2318 * GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
2320 interface GEOM_IBooleanOperations : GEOM_IOperations
2323 * Perform one of boolean operations on two given shapes.
2324 * \param theShape1 First argument for boolean operation.
2325 * \param theShape2 Second argument for boolean operation.
2326 * \param theOperation Indicates the operation to be done:
2327 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2328 * \return New GEOM_Object, containing the result shape.
2330 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2331 in GEOM_Object theShape2,
2332 in long theOperation);
2335 * Perform partition operation.
2336 * \param theShapes Shapes to be intersected.
2337 * \param theTools Shapes to intersect theShapes.
2338 * \note Each compound from ListShapes and ListTools will be exploded in order
2339 * to avoid possible intersection between shapes from this compound.
2340 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2341 * \param KeepNonlimitShapes: if this parameter == 0, then only shapes of
2342 * target type (equal to Limit) are kept in the result,
2343 * else standalone shapes of lower dimension
2344 * are kept also (if they exist).
2346 * After implementation new version of PartitionAlgo (October 2006)
2347 * other parameters are ignored by current functionality. They are kept
2348 * in this function only for supporting old versions.
2349 * Ignored parameters:
2350 * \param theKeepInside Shapes, outside which the results will be deleted.
2351 * Each shape from theKeepInside must belong to theShapes also.
2352 * \param theRemoveInside Shapes, inside which the results will be deleted.
2353 * Each shape from theRemoveInside must belong to theShapes also.
2354 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2355 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2357 * \return New GEOM_Object, containing the result shapes.
2359 GEOM_Object MakePartition (in ListOfGO theShapes,
2360 in ListOfGO theTools,
2361 in ListOfGO theKeepInside,
2362 in ListOfGO theRemoveInside,
2364 in boolean theRemoveWebs,
2365 in ListOfLong theMaterials,
2366 in short theKeepNonlimitShapes);
2369 * Perform partition operation.
2370 * This method may be usefull if it is needed to make a partition for
2371 * a compound containing nonintersected shapes. Performance will be better
2372 * since intersection between shapes from compound is not performed.
2374 * Description of all parameters as in previous method MakePartition()
2376 * \note Passed compounds (via ListShapes or via ListTools)
2377 * have to consist of nonintersecting shapes.
2379 * \return New GEOM_Object, containing the result shapes.
2381 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2382 in ListOfGO theTools,
2383 in ListOfGO theKeepInside,
2384 in ListOfGO theRemoveInside,
2386 in boolean theRemoveWebs,
2387 in ListOfLong theMaterials,
2388 in short theKeepNonlimitShapes);
2391 * Perform partition of the Shape with the Plane
2392 * \param theShape Shape to be intersected.
2393 * \param thePlane Tool shape, to intersect theShape.
2394 * \return New GEOM_Object, containing the result shape.
2396 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2397 in GEOM_Object thePlane);
2401 * GEOM_ICurvesOperations: Interface for curves creation.
2402 * Polyline, Circle, Spline (Bezier and Interpolation)
2404 interface GEOM_ICurvesOperations : GEOM_IOperations
2407 * Create a circle with given center, normal vector and radius.
2408 * \param thePnt Circle center.
2409 * \param theVec Vector, normal to the plane of the circle.
2410 * \param theR Circle radius.
2411 * \return New GEOM_Object, containing the created circle.
2413 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2414 in GEOM_Object theVec,
2417 * Create a circle, passing through three given points
2418 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2419 * \return New GEOM_Object, containing the created circle.
2421 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2422 in GEOM_Object thePnt2,
2423 in GEOM_Object thePnt3);
2425 * Create a circle with given center, with a radius equals the distance from center to Point1
2426 * and on a plane defined by all of three points.
2427 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2428 * \return New GEOM_Object, containing the created circle.
2430 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2431 in GEOM_Object thePnt2,
2432 in GEOM_Object thePnt3);
2434 * Create an ellipse with given center, normal vector and radiuses.
2435 * \param thePnt Ellipse center.
2436 * \param theVec Vector, normal to the plane of the ellipse.
2437 * \param theRMajor Major ellipse radius.
2438 * \param theRMinor Minor ellipse radius.
2439 * \return New GEOM_Object, containing the created ellipse.
2441 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2442 in GEOM_Object theVec,
2443 in double theRMajor,
2444 in double theRMinor);
2447 * Create an ellipse with given center, normal vector, main axis vector and radiuses.
2448 * \param thePnt Ellipse center.
2449 * \param theVec Vector, normal to the plane of the ellipse.
2450 * \param theRMajor Major ellipse radius.
2451 * \param theRMinor Minor ellipse radius.
2452 * \param theVecMaj Vector, direction of the ellipse's main axis.
2453 * \return New GEOM_Object, containing the created ellipse.
2455 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2456 in GEOM_Object theVec,
2457 in double theRMajor,
2458 in double theRMinor,
2459 in GEOM_Object theVecMaj);
2462 * Create an arc of circle, passing through three given points.
2463 * \param thePnt1 Start point of the arc.
2464 * \param thePnt2 Middle point of the arc.
2465 * \param thePnt3 End point of the arc.
2466 * \return New GEOM_Object, containing the created arc.
2468 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2469 in GEOM_Object thePnt2,
2470 in GEOM_Object thePnt3);
2473 * Create an arc of circle of center C from one point to another
2474 * \param theCenter Center point of the arc.
2475 * \param thePnt1 Start point of the arc.
2476 * \param thePnt2 End point of the arc.
2477 * \param theSense Orientation of the arc
2478 * \return New GEOM_Object, containing the created arc.
2480 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2481 in GEOM_Object thePnt1,
2482 in GEOM_Object thePnt2,
2483 in boolean theSense);
2486 * Create an arc of ellipse of center C and two points P1 P2.
2487 * \param theCenter Center point of the arc.
2488 * \param thePnt1 Major radius is distance from center to Pnt1.
2489 * \param thePnt2 define a plane and Minor radius as a shortest
2490 * distance from Pnt2 to vector Center->Pnt1.
2491 * \return New GEOM_Object, containing the created arc.
2493 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2494 in GEOM_Object thePnt1,
2495 in GEOM_Object thePnt2);
2499 * Create a polyline on the set of points.
2500 * \param thePoints Sequence of points for the polyline.
2501 * \param theIsClosed If TRUE, build a closed wire.
2502 * \return New GEOM_Object, containing the created polyline.
2504 GEOM_Object MakePolyline (in ListOfGO thePoints,
2505 in boolean theIsClosed);
2508 * Create bezier curve on the set of points.
2509 * \param thePoints Sequence of points for the bezier curve.
2510 * \param theIsClosed If TRUE, build a closed curve.
2511 * \return New GEOM_Object, containing the created bezier curve.
2513 GEOM_Object MakeSplineBezier (in ListOfGO thePoints,
2514 in boolean theIsClosed);
2517 * Create B-Spline curve on the set of points.
2518 * \param thePoints Sequence of points for the B-Spline curve.
2519 * \param theIsClosed If TRUE, build a closed curve.
2520 * \param theDoReordering If TRUE, the algo does not follow the order of
2521 * \a thePoints but searches for the closest vertex.
2522 * \return New GEOM_Object, containing the created B-Spline curve.
2524 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2525 in boolean theIsClosed,
2526 in boolean theDoReordering);
2529 * Create a sketcher (wire or face), following the textual description,
2530 * passed through \a theCommand argument. \n
2531 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2532 * Format of the description string have to be the following:
2534 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2537 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2539 * - "R angle" : Set the direction by angle
2540 * - "D dx dy" : Set the direction by DX & DY
2543 * - "TT x y" : Create segment by point at X & Y
2544 * - "T dx dy" : Create segment by point with DX & DY
2545 * - "L length" : Create segment by direction & Length
2546 * - "IX x" : Create segment by direction & Intersect. X
2547 * - "IY y" : Create segment by direction & Intersect. Y
2550 * - "C radius length" : Create arc by direction, radius and length(in degree)
2553 * - "WW" : Close Wire (to finish)
2554 * - "WF" : Close Wire and build face (to finish)
2556 * \param theCommand String, defining the sketcher in local
2557 * coordinates of the working plane.
2558 * \param theWorkingPlane Nine double values, defining origin,
2559 * OZ and OX directions of the working plane.
2560 * \return New GEOM_Object, containing the created wire.
2562 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2565 * Create a 3D sketcher, following the numerical description,
2566 * passed through points created by \a theCoordinates argument. \n
2567 * Format of the description string have to be the following:
2569 * "Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"
2572 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2575 * Create a sketcher (wire or face), following the textual description,
2576 * passed through \a theCommand argument. \n
2577 * For format of the description string see the previous method.\n
2578 * \param theCommand String, defining the sketcher in local
2579 * coordinates of the working plane.
2580 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2581 * \return New GEOM_Object, containing the created wire.
2583 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2587 * GEOM_ILocalOperations: Interface for fillet and chamfer creation.
2589 interface GEOM_ILocalOperations : GEOM_IOperations
2592 * Perform a fillet on all edges of the given shape.
2593 * \param theShape Shape, to perform fillet on.
2594 * \param theR Fillet radius.
2595 * \return New GEOM_Object, containing the result shape.
2597 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2601 * Perform a fillet on the specified edges of the given shape
2602 * \param theShape Shape, to perform fillet on.
2603 * \param theR Fillet radius.
2604 * \param theEdges Global indices of edges to perform fillet on.
2605 * \note Global index of sub-shape can be obtained, using method
2606 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2607 * \return New GEOM_Object, containing the result shape.
2609 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2611 in ListOfLong theEdges);
2612 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2615 in ListOfLong theEdges);
2618 * Perform a fillet on all edges of the specified faces of the given shape.
2619 * \param theShape Shape, to perform fillet on.
2620 * \param theR Fillet radius.
2621 * \param theFaces Global indices of faces to perform fillet on.
2622 * \note Global index of sub-shape can be obtained, using method
2623 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2624 * \return New GEOM_Object, containing the result shape.
2626 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2628 in ListOfLong theFaces);
2630 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2633 in ListOfLong theFaces);
2636 * Perform a fillet on face of the specified vertexes of the given shape.
2637 * \param theShape Shape, to perform fillet on.
2638 * \param theR Fillet radius.
2639 * \param theVertexes Global indices of vertexes to perform fillet on.
2640 * \note Global index of sub-shape can be obtained, using method
2641 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2642 * \return New GEOM_Object, containing the result shape.
2644 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2646 in ListOfLong theVertexes);
2649 * Perform a fillet on edges of the specified vertexes of the given wire.
2650 * \param theShape Shape, to perform fillet on.
2651 * \param theR Fillet radius.
2652 * \param theVertexes Global indices of vertexes to perform fillet on.
2653 * \note Global index of sub-shape can be obtained, using method
2654 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2655 * \note The list of vertices coudl be empty, in this case fillet fill be done
2656 * at all vertices in given wire
2657 * \return New GEOM_Object, containing the result shape.
2659 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2661 in ListOfLong theVertexes);
2664 * Perform a symmetric chamfer on all edges of the given shape.
2665 * \param theShape Shape, to perform chamfer on.
2666 * \param theD Chamfer size along each face.
2667 * \return New GEOM_Object, containing the result shape.
2669 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2673 * Perform a chamfer on edges, common to the specified faces.
2674 * with distance D1 on the Face1
2675 * \param theShape Shape, to perform chamfer on.
2676 * \param theD1 Chamfer size along \a theFace1.
2677 * \param theD2 Chamfer size along \a theFace2.
2678 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2679 * \note Global index of sub-shape can be obtained, using method
2680 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2681 * \return New GEOM_Object, containing the result shape.
2683 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2684 in double theD1, in double theD2,
2685 in long theFace1, in long theFace2);
2687 * The Same but with params theD = Chamfer Lenght
2688 * and theAngle = Chamfer Angle (Angle in radians)
2690 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2691 in double theD, in double theAngle,
2692 in long theFace1, in long theFace2);
2695 * Perform a chamfer on all edges of the specified faces.
2696 * with distance D1 on the first specified face (if several for one edge)
2697 * \param theShape Shape, to perform chamfer on.
2698 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2699 * connected to the edge, are in \a theFaces, \a theD1
2700 * will be get along face, which is nearer to \a theFaces beginning.
2701 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2702 * \param theFaces Sequence of global indices of faces of \a theShape.
2703 * \note Global index of sub-shape can be obtained, using method
2704 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2705 * \return New GEOM_Object, containing the result shape.
2707 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2708 in double theD1, in double theD2,
2709 in ListOfLong theFaces);
2711 * The Same but with params theD = Chamfer Lenght
2712 * and theAngle = Chamfer Angle (Angle in radians)
2714 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2715 in double theD, in double theAngle,
2716 in ListOfLong theFaces);
2719 * Perform a chamfer on edges,
2720 * with distance D1 on the first specified face (if several for one edge)
2721 * \param theShape Shape, to perform chamfer on.
2722 * \param theD1 theD2 Chamfer size
2723 * \param theEdges Sequence of edges of \a theShape.
2724 * \return New GEOM_Object, containing the result shape.
2726 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2727 in double theD1, in double theD2,
2728 in ListOfLong theEdges);
2730 * The Same but with params theD = Chamfer Lenght
2731 * and theAngle = Chamfer Angle (Angle in radians)
2733 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2734 in double theD, in double theAngle,
2735 in ListOfLong theEdges);
2738 * Perform an Archimde operation on the given shape with given parameters.
2739 * The object presenting the resulting face is returned
2740 * \param theShape Shape to be put in water.
2741 * \param theWeight Weight og the shape.
2742 * \param theWaterDensity Density of the water.
2743 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
2744 * \return New GEOM_Object, containing a section of \a theShape
2745 * by a plane, corresponding to water level.
2747 GEOM_Object MakeArchimede (in GEOM_Object theShape,
2748 in double theWeight,
2749 in double theWaterDensity,
2750 in double theMeshDeflection);
2753 * Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2754 * Present here only for compatibility.
2756 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2760 * GEOM_IHealingOperations: Interface for shape healing operations.
2761 * Shape Processing, SuppressFaces, etc.
2763 interface GEOM_IHealingOperations : GEOM_IOperations
2766 * Apply a sequence of Shape Healing operators to the given object.
2767 * \param theShapes Shape to be processed.
2768 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2769 * \param theParameters List of names of parameters
2770 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2771 * \param theValues List of values of parameters, in the same order
2772 * as parameters are listed in \a theParameters list.
2773 * \return New GEOM_Object, containing processed shape.
2775 GEOM_Object ProcessShape (in GEOM_Object theShapes,
2776 in string_array theOperators,
2777 in string_array theParameters,
2778 in string_array theValues);
2781 * Get default sequence of operators, their parameters and parameters' values
2782 * of Shape Process operation. In the current implementation the defaults are
2783 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2784 * \param theOperators Output. Default list of names of operators.
2785 * \param theParameters Output. Default list of names of parameters.
2786 * \param theValues Output. List of default values of parameters, in the same order
2787 * as parameters are listed in \a theParameters list.
2789 void GetShapeProcessParameters (out string_array theOperators,
2790 out string_array theParameters,
2791 out string_array theValues);
2793 * Get parameters and parameters' values for the given Shape Process operation.
2794 * In the current implementation the defaults are
2795 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2796 * \param theOperator Input. The operator's name.
2797 * \param theParameters Output. Default list of names of parameters.
2798 * \param theValues Output. List of default values of parameters, in the same order
2799 * as parameters are listed in \a theParameters list.
2801 void GetOperatorParameters (in string theOperator,
2802 out string_array theParameters,
2803 out string_array theValues);
2806 * Remove faces from the given object (shape).
2807 * \param theObject Shape to be processed.
2808 * \param theFaces Indices of faces to be removed, if EMPTY then the method
2809 * removes ALL faces of the given object.
2810 * \return New GEOM_Object, containing processed shape.
2812 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
2815 * Close an open wire.
2816 * \param theObject Shape to be processed.
2817 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2818 * if -1, then theObject itself is a wire.
2819 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
2820 * If FALS : closure by creation of an edge between ends.
2821 * \return New GEOM_Object, containing processed shape.
2823 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2824 in boolean isCommonVertex);
2827 * Remove internal wires and edges from the given object (face).
2828 * \param theObject Shape to be processed.
2829 * \param theWires Indices of wires to be removed, if EMPTY then the method
2830 * removes ALL internal wires of the given object.
2831 * \return New GEOM_Object, containing processed shape.
2833 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2836 * Remove internal closed contours (holes) from the given object.
2837 * \param theObject Shape to be processed.
2838 * \param theWires Indices of wires to be removed, if EMPTY then the method
2839 * removes ALL internal holes of the given object
2840 * \return New GEOM_Object, containing processed shape.
2842 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2845 * Sewing of the given object.
2846 * \param theObject Shape to be processed.
2847 * \param theTolerance Required tolerance value.
2848 * \return New GEOM_Object, containing processed shape.
2850 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2853 * Addition of a point to a given edge object.
2854 * \param theObject Shape to be processed.
2855 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
2856 * if -1, then theObject itself is the edge.
2857 * \param theValue Value of parameter on edge or length parameter,
2858 * depending on \a isByParameter.
2859 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2860 * if FALSE : \a theValue is treated as a length parameter [0..1]
2861 * \return New GEOM_Object, containing processed shape.
2863 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2864 in double theValue, in boolean isByParameter);
2867 * Get a list of wires (wrapped in GEOM_Object-s),
2868 * that constitute a free boundary of the given shape.
2869 * \param theObject Shape to get free boundary of.
2870 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2871 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
2872 * \return FALSE, if an error(s) occured during the method execution.
2874 boolean GetFreeBoundary (in GEOM_Object theObject,
2875 out ListOfGO theClosedWires,
2876 out ListOfGO theOpenWires);
2879 * Change orientation of the given object.
2880 * \param theObject Shape to be processed.
2881 * \return New GEOM_Object, containing processed shape.
2883 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2884 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2887 * Try to limit tolerance of the given object by value \a theTolerance.
2888 * \param theObject Shape to be processed.
2889 * \param theTolerance Required tolerance value.
2890 * \return New GEOM_Object, containing processed shape.
2892 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
2897 * GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2900 interface GEOM_IInsertOperations : GEOM_IOperations
2903 * Create a copy of the given object
2905 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2908 * Export the given shape into a file with given name.
2909 * \param theObject Shape to be stored in the file.
2910 * \param theFileName Name of the file to store the given shape in.
2911 * \param theFormatName Specify format for the shape storage.
2912 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2914 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2917 * Import a shape from the BRep or IGES or STEP file
2918 * (depends on given format) with given name.
2919 * \param theFileName The file, containing the shape.
2920 * \param theFormatName Specify format for the file reading.
2921 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2922 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
2923 * set to 'meter' and result model will be scaled.
2924 * \return New GEOM_Object, containing the imported shape.
2926 GEOM_Object Import (in string theFileName, in string theFormatName);
2929 * Get the supported import formats and corresponding patterns for File dialog.
2930 * \param theFormats Output. List of formats, available for import.
2931 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2932 * \return Returns available formats and patterns through the arguments.
2934 void ImportTranslators (out string_array theFormats,
2935 out string_array thePatterns);
2938 * Get the supported export formats and corresponding patterns for File dialog.
2939 * \param theFormats Output. List of formats, available for export.
2940 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2941 * \return Returns available formats and patterns through the arguments.
2943 void ExportTranslators (out string_array theFormats,
2944 out string_array thePatterns);
2947 * Load texture from file
2948 * \param theTextureFile texture file name
2949 * \return unique texture identifier
2951 long LoadTexture(in string theTextureFile);
2954 * Add texture to the study
2955 * \param theWidth texture width in pixels
2956 * \param theHeight texture height in pixels
2957 * \param theTexture texture byte array
2958 * \return unique texture identifier
2960 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
2963 * Get previously loaded texture data
2964 * \param theID texture identifier
2965 * \param theWidth texture width in pixels
2966 * \param theHeight texture height in pixels
2967 * \return texture byte array
2969 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
2972 * Get list of all avaiable texture IDs
2973 * \return list of all texture IDs avaiable for the current study
2975 ListOfLong GetAllTextures();
2979 * GEOM_IKindOfShape: namespace for shape_kind enumeration.
2981 interface GEOM_IKindOfShape
2991 SPHERE, // full sphere
2992 CYLINDER, // cylinder
2993 BOX, // box with faces, parallel to global coordinate planes
2994 ROTATED_BOX, // other box
2995 TORUS, // full torus
2997 POLYHEDRON, // solid, bounded by polygons
2998 SOLID, // other solid
3000 SPHERE2D, // spherical face (closed)
3001 CYLINDER2D, // cylindrical face with defined height
3002 TORUS2D, // toroidal face (closed)
3003 CONE2D, // conical face with defined height
3004 DISK_CIRCLE, // planar, bounded by circle
3005 DISK_ELLIPSE, // planar, bounded by ellipse
3006 POLYGON, // planar, bounded by segments
3007 PLANE, // infinite planar
3008 PLANAR, // other planar
3011 CIRCLE, // full circle
3012 ARC_CIRCLE, // arc of circle
3013 ELLIPSE, // full ellipse
3014 ARC_ELLIPSE, // arc of ellipse
3015 LINE, // infinite segment
3021 ADVANCED // all advanced shapes (temporary implementation)
3027 * GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
3028 * properties calculation (like Centre of Mass, Inertia, etc.).
3031 interface GEOM_IMeasureOperations : GEOM_IOperations
3034 * Get kind of theShape.
3035 * \param theShape Shape to get a kind of.
3036 * \param theIntegers Output. Integer and enumerated shape's parameters
3037 * (kind of surface, closed/unclosed, number of edges, etc.)
3038 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
3039 * \note Concrete meaning of each value, returned via \a theIntegers
3040 * or \a theDoubles list depends on the kind of the shape.
3041 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
3043 //short KindOfShape (in GEOM_Object theShape,
3044 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
3045 out ListOfLong theIntegers,
3046 out ListOfDouble theDoubles);
3049 * Get position (LCS) of theShape.
3050 * \param theShape Shape to calculate position of.
3051 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
3052 * Origin of the LCS is situated at the shape's center of mass.
3053 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
3054 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
3055 * Axes of the LCS are obtained from shape's location or,
3056 * if the shape is a planar face, from position of its plane.
3057 * \return Returns position of the shape through the last nine arguments.
3059 void GetPosition (in GEOM_Object theShape,
3060 out double Ox, out double Oy, out double Oz,
3061 out double Zx, out double Zy, out double Zz,
3062 out double Xx, out double Xy, out double Xz);
3065 * Get summarized length of all wires,
3066 * area of surface and volume of the given shape.
3067 * \param theShape Shape to define properties of.
3068 * \param theLength Output. Summarized length of all wires of the given shape.
3069 * \param theSurfArea Output. Area of surface of the given shape.
3070 * \param theVolume Output. Volume of the given shape.
3071 * \return Returns shape properties through the last three arguments.
3073 void GetBasicProperties (in GEOM_Object theShape,
3074 out double theLength,
3075 out double theSurfArea,
3076 out double theVolume);
3079 * Get a point, situated at the centre of mass of theShape.
3080 * \param theShape Shape to define centre of mass of.
3081 * \return New GEOM_Object, containing the created point.
3083 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
3086 * Get the vertex by index for 1D objects depends the edge/wire orientation
3087 * \param theShape Shape (wire or edge) to find the vertex on it
3088 * \param theIndex Index of vertex subshape
3089 * \return New GEOM_Object, vertex.
3091 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
3094 * Get a vector, representing the normal of theFace.
3095 * If the face is not planar, theOptionalPoint is obligatory.
3096 * \param theFace Shape (face) to define the normal of.
3097 * \param theOptionalPoint Shape (point) to define the normal at.
3098 * Can be NULL in case of planar face.
3099 * \return New GEOM_Object, containing the created normal vector.
3101 GEOM_Object GetNormal (in GEOM_Object theFace,
3102 in GEOM_Object theOptionalPoint);
3105 * Get inertia matrix and moments of inertia of theShape.
3106 * \param theShape Shape to calculate inertia of.
3107 * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
3108 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
3109 * \return Returns inertia through the last twelve arguments.
3111 void GetInertia (in GEOM_Object theShape,
3112 out double I11, out double I12, out double I13,
3113 out double I21, out double I22, out double I23,
3114 out double I31, out double I32, out double I33,
3115 out double Ix , out double Iy , out double Iz);
3118 * Get parameters of bounding box of the given shape
3119 * \param theShape Shape to obtain bounding box of.
3120 * \param Xmin,Xmax Output. Limits of shape along OX axis.
3121 * \param Ymin,Ymax Output. Limits of shape along OY axis.
3122 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
3123 * \return Returns parameters of bounding box through the last six arguments.
3125 void GetBoundingBox (in GEOM_Object theShape,
3126 out double Xmin, out double Xmax,
3127 out double Ymin, out double Ymax,
3128 out double Zmin, out double Zmax);
3131 * Get min and max tolerances of sub-shapes of theShape
3132 * \param theShape Shape, to get tolerances of.
3133 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3134 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
3135 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
3136 * \return Returns shape tolerances through the last six arguments.
3138 void GetTolerance (in GEOM_Object theShape,
3139 out double FaceMin, out double FaceMax,
3140 out double EdgeMin, out double EdgeMax,
3141 out double VertMin, out double VertMax);
3144 * Check a topology of the given shape.
3145 * \param theShape Shape to check validity of.
3146 * \param theDescription Output. Description of problems in the shape, if they are.
3147 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
3149 boolean CheckShape (in GEOM_Object theShape,
3150 out string theDescription);
3153 * Check a topology and a geometry of the given shape.
3154 * \param theShape Shape to check validity of.
3155 * \param theDescription Output. Description of problems in the shape, if they are.
3156 * \return TRUE, if the shape "seems to be valid".
3158 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
3159 out string theDescription);
3162 * Obtain description of the given shape
3163 * \param theShape Shape to be described.
3164 * \return Description of the given shape.
3166 string WhatIs (in GEOM_Object theShape);
3169 * Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on
3170 * the shape theShape.
3171 * \param theShape Shape to check.
3172 * \param coords list of coordinates.
3173 * \param tolerance tolerance.
3174 * \return list of boolean.
3176 ListOfBool AreCoordsInside(in GEOM_Object theShape, in ListOfDouble coords, in double tolerance);
3179 * Get minimal distance between the given shapes.
3180 * \param theShape1,theShape2 Shapes to find minimal distance between.
3181 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
3182 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
3183 * \return Value of the minimal distance between the given shapes.
3185 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
3186 out double X1, out double Y1, out double Z1,
3187 out double X2, out double Y2, out double Z2);
3190 * Get angle between the given lines or linear edges.
3191 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
3192 * \return Value of the angle between the given shapes.
3194 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
3197 * Get point coordinates
3199 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
3202 * Get radius of curvature of curve in the point determinated by param
3203 * \param theShape - curve.
3204 * \param theParam - parameter on curve
3205 * \return Value of curvature.
3207 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3210 * Get radius of curvature of curve in the given point
3211 * \param theShape - curve.
3212 * \param thePoint - point
3213 * \return Value of curvature.
3215 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3218 * Get max radius of curvature of surface in the point determinated by params
3219 * \param theShape - surface.
3220 * \param theUParam - U-parameter on surface
3221 * \param theVParam - V-parameter on surface
3222 * \return Value of curvature.
3224 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3225 in double theVParam);
3228 * Get max radius of curvature of surface in the given point
3229 * \param theShape - surface.
3230 * \param thePoint - point
3231 * \return Value of curvature.
3233 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3236 * Get min radius of curvature of surface in the point determinated by params
3237 * \param theShape - surface.
3238 * \param theUParam - U-parameter on surface
3239 * \param theVParam - V-parameter on surface
3240 * \return Value of curvature.
3242 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3243 in double theVParam);
3246 * Get min radius of curvature of surface in the given point
3247 * \param theShape - surface.
3248 * \param thePoint - point
3249 * \return Value of curvature.
3251 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3257 * GEOM_IGroupOperations: Interface for groups creation.
3259 interface GEOM_IGroupOperations : GEOM_IOperations
3262 * Creates a new group which will store sub shapes of theMainShape
3263 * \param theMainShape is a GEOM object on which the group is selected
3264 * \param theShapeType defines a shape type of the group
3265 * \return a newly created GEOM group
3267 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3270 * Adds a sub object with ID theSubShapeId to the group
3271 * \param theGroup is a GEOM group to which the new sub shape is added
3272 * \param theSubShapeId is a sub shape ID in the main object.
3273 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3275 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3278 * Removes a sub object with ID \a theSubShapeId from the group
3279 * \param theGroup is a GEOM group from which the sub shape is removed.
3280 * \param theSubShapeId is a sub shape ID in the main object.
3281 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3283 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3286 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3287 * \param theGroup is a GEOM group to which the new sub shapes are added.
3288 * \param theSubShapes is a list of sub shapes to be added.
3290 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3293 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3294 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3295 * \param theSubShapes is a list of sub-shapes to be removed.
3297 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3300 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3301 * \param theGroup is a GEOM group to which the new sub shapes are added.
3302 * \param theSubShapes is a list of IDs of sub shapes to be added.
3304 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3307 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3308 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3309 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3311 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3314 * Returns a type of sub objects stored in the group
3315 * \param theGroup is a GEOM group which type is returned.
3317 long GetType (in GEOM_Object theGroup);
3320 * Returns a main shape associated with the group
3321 * \param theGroup is a GEOM group for which a main shape object is requested
3322 * \return a GEOM object which is a main shape for theGroup
3324 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3327 * Returns a list of sub objects ID stored in the group
3328 * \param theGroup is a GEOM group for which a list of IDs is requested
3330 ListOfLong GetObjects (in GEOM_Object theGroup);
3335 * GEOM_IAdvancedOperations: Interface for advanced modeling functions.
3337 interface GEOM_IAdvancedOperations : GEOM_IOperations
3340 * Create a T-shape object with specified caracteristics for the main and
3341 * the incident pipes (radius, width, half-length).
3342 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3343 * \param theR1 Internal radius of main pipe
3344 * \param theW1 Width of main pipe
3345 * \param theL1 Half-length of main pipe
3346 * \param theR2 Internal radius of incident pipe (R2 < R1)
3347 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3348 * \param theL2 Half-length of incident pipe
3349 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3350 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3352 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
3353 in double theR2, in double theW2, in double theL2,
3354 in boolean theHexMesh);
3356 * Create a T-shape object with specified caracteristics for the main and
3357 * the incident pipes (radius, width, half-length).
3358 * The extremities of the main pipe are located on junctions points P1 and P2.
3359 * The extremity of the incident pipe is located on junction point P3.
3360 * \param theR1 Internal radius of main pipe
3361 * \param theW1 Width of main pipe
3362 * \param theL1 Half-length of main pipe
3363 * \param theR2 Internal radius of incident pipe (R2 < R1)
3364 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3365 * \param theL2 Half-length of incident pipe
3366 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3367 * \param theP1 1st junction point of main pipe
3368 * \param theP2 2nd junction point of main pipe
3369 * \param theP3 Junction point of incident pipe
3370 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3372 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
3373 in double theR2, in double theW2, in double theL2,
3374 in boolean theHexMesh,
3375 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3377 * Create a T-shape object with specified caracteristics for the main and
3378 * the incident pipes (radius, width, half-length). A chamfer is created
3379 * on the junction of the pipes.
3380 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3381 * \param theR1 Internal radius of main pipe
3382 * \param theW1 Width of main pipe
3383 * \param theL1 Half-length of main pipe
3384 * \param theR2 Internal radius of incident pipe (R2 < R1)
3385 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3386 * \param theL2 Half-length of incident pipe
3387 * \param theH Height of the chamfer.
3388 * \param theW Width of the chamfer.
3389 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3390 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3392 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
3393 in double theR2, in double theW2, in double theL2,
3394 in double theH, in double theW, in boolean theHexMesh);
3396 * Create a T-shape object with specified caracteristics for the main and
3397 * the incident pipes (radius, width, half-length). A chamfer is created
3398 * on the junction of the pipes.
3399 * The extremities of the main pipe are located on junctions points P1 and P2.
3400 * The extremity of the incident pipe is located on junction point P3.
3401 * \param theR1 Internal radius of main pipe
3402 * \param theW1 Width of main pipe
3403 * \param theL1 Half-length of main pipe
3404 * \param theR2 Internal radius of incident pipe (R2 < R1)
3405 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3406 * \param theL2 Half-length of incident pipe
3407 * \param theH Height of the chamfer.
3408 * \param theW Width of the chamfer.
3409 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3410 * \param theP1 1st junction point of main pipe
3411 * \param theP2 2nd junction point of main pipe
3412 * \param theP3 Junction point of incident pipe
3413 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3415 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
3416 in double theR2, in double theW2, in double theL2,
3417 in double theH, in double theW, in boolean theHexMesh,
3418 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3420 * Create a T-shape object with specified caracteristics for the main and
3421 * the incident pipes (radius, width, half-length). A fillet is created
3422 * on the junction of the pipes.
3423 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3424 * \param theR1 Internal radius of main pipe
3425 * \param theW1 Width of main pipe
3426 * \param theL1 Half-length of main pipe
3427 * \param theR2 Internal radius of incident pipe (R2 < R1)
3428 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3429 * \param theL2 Half-length of incident pipe
3430 * \param theRF Radius of curvature of fillet.
3431 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3432 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3434 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
3435 in double theR2, in double theW2, in double theL2,
3436 in double theRF, in boolean theHexMesh);
3438 * Create a T-shape object with specified caracteristics for the main and
3439 * the incident pipes (radius, width, half-length). A fillet is created
3440 * on the junction of the pipes.
3441 * The extremities of the main pipe are located on junctions points P1 and P2.
3442 * The extremity of the incident pipe is located on junction point P3.
3443 * \param theR1 Internal radius of main pipe
3444 * \param theW1 Width of main pipe
3445 * \param theL1 Half-length of main pipe
3446 * \param theR2 Internal radius of incident pipe (R2 < R1)
3447 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3448 * \param theL2 Half-length of incident pipe
3449 * \param theRF Radius of curvature of fillet.
3450 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3451 * \param theP1 1st junction point of main pipe
3452 * \param theP2 2nd junction point of main pipe
3453 * \param theP3 Junction point of incident pipe
3454 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3456 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
3457 in double theR2, in double theW2, in double theL2,
3458 in double theRF, in boolean theHexMesh,
3459 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3460 /*@@ insert new functions before this line @@ do not remove this line @@*/
3464 * GEOM_Gen: Interface to access other GEOM interfaces.
3465 * Also contains some methods to access and manage GEOM objects.
3467 interface GEOM_Gen : Engines::EngineComponent,SALOMEDS::Driver
3470 * Undo/Redo Management
3473 void Undo (in long theStudyID);
3475 void Redo (in long theStudyID);
3478 * Publishing management
3479 * Adds in theStudy a object theObject under with a name theName,
3480 * if theFather is not NULL the object is placed under thFather's SObject.
3481 * Returns a SObject where theObject is placed
3483 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3484 in GEOM_Object theObject,
3486 in GEOM_Object theFather);
3489 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3490 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3491 * \param theStudy the study, in which theObject is published already,
3492 * and in which the arguments will be published
3493 * \param theObject published GEOM object, arguments of which will be published
3494 * \param theArgs list of GEOM_Object, operation arguments to be published.
3495 * If this list is empty, all operation arguments will be published
3496 * \param theFindMethod method to search subshapes, corresponding to arguments and
3497 * their subshapes. Value from enumeration GEOM::find_shape_method.
3498 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3499 * Do not publish subshapes in place of arguments, but only
3500 * in place of subshapes of the first argument,
3501 * because the whole shape corresponds to the first argument.
3502 * Mainly to be used after transformations, but it also can be
3503 * usefull after partition with one object shape, and some other
3504 * operations, where only the first argument has to be considered.
3505 * If theObject has only one argument shape, this flag is automatically
3506 * considered as True, not regarding really passed value.
3507 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3508 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3509 * \return list of published sub-shapes
3511 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
3512 in GEOM_Object theObject,
3513 in ListOfGO theArgs,
3514 in find_shape_method theFindMethod,
3515 in boolean theInheritFirstArg,
3516 in boolean theAddPrefix);
3519 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3520 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3521 * \param theStudy the study, in which theObject is published already,
3522 * and in which the arguments will be published
3523 * \param theObject published GEOM object, arguments of which will be published
3524 * \param theArgs list of GEOM_Object, operation arguments to be published.
3525 * If this list is empty, all operation arguments will be published
3526 * \param theFindMethod method to search subshapes, corresponding to arguments and
3527 * their subshapes. Value from enumeration GEOM::find_shape_method.
3528 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3529 * Do not publish subshapes in place of arguments, but only
3530 * in place of subshapes of the first argument,
3531 * because the whole shape corresponds to the first argument.
3532 * Mainly to be used after transformations, but it also can be
3533 * usefull after partition with one object shape, and some other
3534 * operations, where only the first argument has to be considered.
3535 * If theObject has only one argument shape, this flag is automatically
3536 * considered as True, not regarding really passed value.
3537 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3538 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3539 * \return list of published sub-shapes
3541 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
3542 in GEOM_Object theObject,
3543 in ListOfGO theArgs,
3544 in find_shape_method theFindMethod,
3545 in boolean theInheritFirstArg,
3546 in boolean theAddPrefix);
3549 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3550 * To be used from GUI and from geompy.addToStudy.
3551 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
3552 * \param theSObject study object, referencing GEOM object, arguments of which will be published
3554 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
3555 in SALOMEDS::SObject theSObject,
3556 in ListOfGO theArgs,
3557 in find_shape_method theFindMethod,
3558 in boolean theInheritFirstArg,
3559 in boolean theAddPrefix);
3562 * Methods to access interfaces for objects creation and transformation
3564 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3565 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
3566 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3567 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3568 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3569 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3570 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3571 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3572 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3573 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3574 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3575 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3576 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3579 * Objects Management
3583 * Removes the object from the GEOM component
3584 * \param theObject is a GEOM object to be removed
3586 void RemoveObject (in GEOM_Object theObject);
3589 * Returns an object defined by the study and its entry in the GEOM component
3590 * \param theStudyID is a SALOMEDS Study ID
3591 * \param theEntry is an entry of the requested GEOM object in the GEOM component
3592 * \note if the object has not previously been created a NULL GEOM object is returned
3594 GEOM_Object GetObject (in long theStudyID, in string theEntry);
3597 * Add a sub shape defined by indices in \a theIndices
3598 * (contains unique IDs of sub shapes inside theMainShape)
3599 * \note The sub shape GEOM_Objects can has ONLY ONE function.
3600 * Don't try to apply modification operations on them.
3601 * \note Internal method
3603 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
3606 * GEOM object's IOR Management
3610 * Returns a GEOM Object defined by its IOR
3611 * \param theIOR a string containg an IOR of the requested GEOM object
3613 GEOM_Object GetIORFromString (in string theIOR);
3616 * Returns a string which contains an IOR of the GEOM object
3617 * \param theObject is a GEOM object which IOR is requested
3619 string GetStringFromIOR (in GEOM_Object theObject);
3622 * Returns a name with which a GEOM object was dumped into python script
3623 * \param theStudyEntry is an entry of the GEOM object in the study
3625 string GetDumpName (in string theStudyEntry);
3628 * Returns all names with which a GEOM objects was dumped
3629 * into python script to avoid the same names in SMESH script
3631 string_array GetAllDumpNames();
3634 * Publishes the named subshapes of given object in the study.
3635 * \param theStudy The study in which the object is published
3636 * \param theObject The object which named subshapes are published
3638 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
3639 //in SObject theSObject,
3640 in Object theObject);