1 // Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : GEOM_Gen.idl
23 // Author : Sergey RUIN
28 #include "SALOME_Exception.idl"
29 #include "SALOME_Component.idl"
30 #include "SALOMEDS.idl"
31 #include "SALOMEDS_Attributes.idl"
33 #include "SALOME_GenericObj.idl"
38 * Topological types of shapes (like Open Cascade types)
40 enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
41 FACE, WIRE, EDGE, VERTEX, SHAPE };
46 enum marker_type { MT_NONE, MT_POINT, MT_PLUS, MT_STAR, MT_O, MT_X, MT_O_POINT, MT_O_PLUS,
47 MT_O_STAR, MT_O_X, MT_BALL, MT_RING1, MT_RING2, MT_RING3, MT_USER };
52 enum marker_size { MS_NONE, MS_10, MS_15, MS_20, MS_25, MS_30, MS_35,
53 MS_40, MS_45, MS_50, MS_55, MS_60, MS_65, MS_70 };
56 * State of shape relatively geometrical surface like plane, sphere or cylinder.
57 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
61 /*! Shape is on surface */
65 * Shape is in the direction defined by the normal and not on surface.
66 * For plane it means above the plane,
67 * For sphere and cylinder it means outside of volume, bounded by the surface.
72 * Shape is in the direction defined by the normal and on surface.
78 * Complementary to ONOUT.
79 * For plane it means below the plane,
80 * For sphere and cylinder it means inside the volume, bounded by the surface
81 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
86 * Complementary to OUT.
93 * Kind of method to find inside one main shape some subshapes,
94 * corresponding to other given shape (its argument)
95 * Is used in functions GEOM_Gen.RestoreSubShapes<xxx>()
97 enum find_shape_method
99 /*! Use GetInPlace functionality. Suits all cases, except transformations */
102 /*! To be used only for transformation result, to find subshapes of argument.
103 * Only this method can be used after transformation.
107 /*! To find only shared subshapes, not modified by the operation */
110 /*! Use GetShapesOnShape method (can work only on solids) */
111 FSM_GetShapesOnShape,
113 /*! Use GetInPlaceByHistory method (can work only after Partition) */
114 FSM_GetInPlaceByHistory
118 typedef sequence<string> string_array;
119 typedef sequence<short> short_array;
120 typedef sequence<long> ListOfLong;
121 typedef sequence<double> ListOfDouble;
123 interface GEOM_Object;
125 typedef sequence<GEOM_Object> ListOfGO;
128 * GEOM_Object: interface of geometric object
130 interface GEOM_Object : SALOME::GenericObj
134 * Get an entry of the object in GEOM component.
139 * Get ID of study, where the object is created.
144 * Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
149 * Get a <VAR>shape_type</VAR> of the object value.
151 shape_type GetShapeType();
154 * Set name of the object.
155 * \param theName is a name which will be associated with this object.
157 void SetName (in string theName);
160 * Get name of the object associated with this object.
165 * Set color of the object.
166 * \param theColor is a color of the object.
168 void SetColor(in SALOMEDS::Color theColor);
171 * Get color of the object.
173 SALOMEDS::Color GetColor();
176 * Toggle auto color mode on the object.
177 * \param theAtoColor is a flag which toggles auto color mode.
179 void SetAutoColor(in boolean theAutoColor);
182 * Get flag of object's auto color mode.
184 boolean GetAutoColor();
187 * Set standard point marker for the object
188 * \param theType standard marker type
189 * \param theSize marker relative size
191 void SetMarkerStd(in marker_type theType, in marker_size theSize );
194 * Set custom point marker for the object. The texture can be added
195 * by LoadTexture() or AddTexture() functions.
196 * \param theTextureId texture ID
198 void SetMarkerTexture(in long theTextureId);
201 * Get type of the point marker assigned to the object
202 * \return current marker type (MT_NONE if no marker is set)
204 marker_type GetMarkerType();
207 * Get size of the point marker assigned to the object
208 * \return current marker relative size (MS_NONE if no marker is set)
210 marker_size GetMarkerSize();
213 * Get texture idenifier of the point marker assigned to the object
214 * \return marker texture ID (0 if no marker set)
216 long GetMarkerTexture();
219 * Set a Study entry where this object was published.
221 void SetStudyEntry (in string theEntry);
224 * Get a Study entry where this object was published.
226 string GetStudyEntry();
229 * Get a list of all GEOM objects on which were the arguments
230 * when this object was constructed and modified.
231 * \note This method is supposed to be used by GUI only.
233 ListOfGO GetDependency();
236 * Get a list of GEOM objects on which the last function that created or modified the object depends.
237 * \note This method is supposed to be used by GUI only.
239 ListOfGO GetLastDependency();
242 * Get the TopoDS_Shape, for colocated case only.
244 long long getShape();
247 ######################################################################
248 * Internal methods (For sub shape identification)
249 ######################################################################
253 * Get geometric shape of the object as a byte stream
255 SALOMEDS::TMPFile GetShapeStream();
258 * Returns True if this object is not a sub shape of another object.
260 boolean IsMainShape();
263 * Get a list of ID's of sub shapes in the main shape.
264 * \note Internal method, suppopsed to be used only by GEOM_Client
266 ListOfLong GetSubShapeIndices();
269 * Get a main shape object to which this object is a sub shape
270 * \note Internal method, suppopsed to be used only by GEOM_Client
272 GEOM_Object GetMainShape();
275 * Return true if geom object representes a shape.
276 * For example, method return false for GEOM_MARKER
281 * Set list of parameters
282 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
283 * used for object creation
285 void SetParameters (in string theParameters);
288 * Return list of notebook variables used for object creation separated by ":" symbol
290 string GetParameters();
295 * GEOM_IOperations: basic methods of all geometric operations
297 interface GEOM_IOperations : SALOME::GenericObj
300 * To know, if the operation was successfully performed
305 * Set the operation error code
306 * \param theErrorID is a string describing the error occured
307 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
309 void SetErrorCode (in string theErrorID);
312 * Get the operation error code
314 string GetErrorCode();
317 * Get ID of study, where the operation is defined
322 * Opens a new transaction
324 void StartOperation();
327 * Closes the previously opened trasaction
329 void FinishOperation();
332 * Aborts the previously opened transaction
334 void AbortOperation();
338 * GEOM_IBasicOperations: interface for basic geometry creation
339 * (Point, Vector, Plane, Marker)
341 interface GEOM_IBasicOperations : GEOM_IOperations
344 * Create point by three coordinates.
345 * \param theX The X coordinate of the point.
346 * \param theY The Y coordinate of the point.
347 * \param theZ The Z coordinate of the point.
348 * \return New GEOM_Object, containing the created point.
350 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
353 * Create a point, distant from the referenced point
354 * on the given distances along the coordinate axes.
355 * \param theReference The referenced point.
356 * \param theX Displacement from the referenced point along OX axis.
357 * \param theY Displacement from the referenced point along OY axis.
358 * \param theZ Displacement from the referenced point along OZ axis.
359 * \return New GEOM_Object, containing the created point.
361 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
362 in double theX, in double theY, in double theZ);
365 * Create a point, corresponding to the given parameter on the given curve.
366 * \param theRefCurve The referenced curve.
367 * \param theParameter Value of parameter on the referenced curve.
368 * \return New GEOM_Object, containing the created point.
370 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
371 in double theParameter);
374 * Create a point on the given curve, projecting given point
375 * \param theRefCurve The referenced curve.
376 * \param theXParameter X co-ordinate of point to project on curve
377 * \param theYParameter Y co-ordinate of point to project on curve
378 * \param theZParameter Z co-ordinate of point to project on curve
379 * \return New GEOM_Object, containing the created point.
381 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
382 in double theXParameter,
383 in double theYarameter,
384 in double theZPameter);
387 * Create a point, corresponding to the given parameters on the
389 * \param theRefSurf The referenced surface.
390 * \param theUParameter Value of U-parameter on the referenced surface.
391 * \param theVParameter Value of V-parameter on the referenced surface.
392 * \return New GEOM_Object, containing the created point.
394 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
395 in double theUParameter,
396 in double theVParameter);
399 * Create a point on the given surface, projecting given point
400 * \param theRefSurf The referenced surface.
401 * \param theXParameter X co-ordinate of point to project on curve
402 * \param theYParameter Y co-ordinate of point to project on curve
403 * \param theZParameter Z co-ordinate of point to project on curve
404 * \return New GEOM_Object, containing the created point.
406 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
407 in double theXParameter,
408 in double theYarameter,
409 in double theZPameter);
413 * Create a point, on two lines intersection.
414 * \param theRefLine1, theRefLine2 The referenced lines.
415 * \return New GEOM_Object, containing the created point.
417 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
418 in GEOM_Object theRefLine2);
421 * Create a vector, corresponding to tangent to the given parameter on the given curve.
422 * \param theRefCurve The referenced curve.
423 * \param theParameter Value of parameter on the referenced curve.This value should be have value
424 * \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
425 * \last parameter of curve.
426 * \return New GEOM_Object, containing the created point.
428 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
429 in double theParameter);
432 * Create a vector with the given components.
433 * \param theDX X component of the vector.
434 * \param theDY Y component of the vector.
435 * \param theDZ Z component of the vector.
436 * \return New GEOM_Object, containing the created vector.
438 GEOM_Object MakeVectorDXDYDZ (in double theDX,
443 * Create a vector between two points.
444 * \param thePnt1 Start point for the vector.
445 * \param thePnt2 End point for the vector.
446 * \return New GEOM_Object, containing the created vector.
448 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
451 * Create a line, passing through the given point
452 * and parrallel to the given direction
453 * \param thePnt Point. The resulting line will pass through it.
454 * \param theDir Direction. The resulting line will be parallel to it.
455 * \return New GEOM_Object, containing the created line.
457 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
460 * Create a line, passing through the given points
461 * \param thePnt1 First of two points, defining the line.
462 * \param thePnt2 Second of two points, defining the line.
463 * \return New GEOM_Object, containing the created line.
465 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
468 * Create a line, given by two faces intersection.
469 * \param theFace1 First of two faces, defining the line.
470 * \param theFace2 Second of two faces, defining the line.
471 * \return New GEOM_Object, containing the created line.
473 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
476 * Create a plane, passing through the three given points
477 * \param thePnt1 First of three points, defining the plane.
478 * \param thePnt2 Second of three points, defining the plane.
479 * \param thePnt3 Fird of three points, defining the plane.
480 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
481 * \return New GEOM_Object, containing the created plane.
483 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
484 in GEOM_Object thePnt2,
485 in GEOM_Object thePnt3,
486 in double theTrimSize);
489 * Create a plane, passing through the given point
490 * and normal to the given vector.
491 * \param thePnt Point, the plane has to pass through.
492 * \param theVec Vector, defining the plane normal direction.
493 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
494 * \return New GEOM_Object, containing the created plane.
496 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
497 in GEOM_Object theVec,
498 in double theTrimSize);
501 * Create a plane, similar to the existing one, but with another size of representing face.
502 * \param theFace Referenced plane or LCS(Marker).
503 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
504 * \return New GEOM_Object, containing the created plane.
506 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
507 in double theTrimSize);
510 * Create a plane, by two vectors.
511 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
512 * \param theVec Vector2, defining the plane normal direction.
513 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
514 * \return New GEOM_Object, containing the created plane.
516 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
517 in GEOM_Object theVec2,
518 in double theTrimSize);
521 * Create a plane, defined by local coordinate system.
522 * \param theLCS Referenced LCS(Marker).
523 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
524 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
525 * \return New GEOM_Object, containing the created plane.
527 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
528 in double theTrimSize,
529 in double theOrientation);
532 * Create a local coordinate system.
533 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
534 * \param theXDX,theXDY,theXDZ Three components of OX direction
535 * \param theYDX,theYDY,theYDZ Three components of OY direction
536 * \return New GEOM_Object, containing the created coordinate system.
538 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
539 in double theXDX, in double theXDY, in double theXDZ,
540 in double theYDX, in double theYDY, in double theYDZ);
543 * Create a local coordinate system from shape.
544 * \param theShape The initial shape to detect the coordinate system.
545 * \return New GEOM_Object, containing the created coordinate system.
547 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
550 * Create a local coordinate system from point and two vectors (DX, DY).
551 * \param theOrigin Point of coordinate system origin.
552 * \param theXVec Vector of X direction.
553 * \param theYVec Vector of Y direction.
554 * \return New GEOM_Object, containing the created coordinate system.
556 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin, in GEOM_Object theXVec, in GEOM_Object theYVec);
559 * Create a tangent plane to specified face in the point with specified parameters.
560 * Values of parameters should be between 0. and 1.0
561 * \param theFace - face for which tangent plane shuold be built.
562 * \param theParameterU - value of parameter by U
563 * \param theParameterV - value of parameter Vthe
564 * \param theTrimSize - defines sizes of created face
565 * \return New GEOM_Object, containing the face built on tangent plane.
567 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
568 in double theParameterU,
569 in double theParameterV,
570 in double theTrimSize);
573 interface GEOM_ITransformOperations : GEOM_IOperations
576 * Translate the given object along the vector, specified by its end points.
577 * \param theObject The object to be translated.
578 * \param thePoint1 Start point of translation vector.
579 * \param thePoint2 End point of translation vector.
582 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
583 in GEOM_Object thePoint1,
584 in GEOM_Object thePoint2);
587 * Translate the given object along the vector, specified
588 * by its end points, creating its copy before the translation.
589 * \param theObject The object to be translated.
590 * \param thePoint1 Start point of translation vector.
591 * \param thePoint2 End point of translation vector.
592 * \return New GEOM_Object, containing the translated object.
594 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
595 in GEOM_Object thePoint1,
596 in GEOM_Object thePoint2);
599 * Translate the given object along the vector, specified by its components.
600 * \param theObject The object to be translated.
601 * \param theDX,theDY,theDZ Components of translation vector.
604 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
605 in double theDX, in double theDY, in double theDZ);
608 * Translate the given object along the vector, specified
609 * by its components, creating its copy before the translation.
610 * \param theObject The object to be translated.
611 * \param theDX,theDY,theDZ Components of translation vector.
612 * \return New GEOM_Object, containing the translated object.
614 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
615 in double theDX, in double theDY, in double theDZ);
619 * Translate the given object along the given vector.
620 * \param theObject The object to be translated.
621 * \param theVector Translation vector, giving both direction and distance.
624 GEOM_Object TranslateVector (in GEOM_Object theObject,
625 in GEOM_Object theVector);
628 * Translate the given object along the given vector,
629 * creating its copy before the translation.
630 * \param theObject The object to be translated.
631 * \param theVector Translation vector, giving both direction and distance.
632 * \return New GEOM_Object, containing the translated object.
634 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
635 in GEOM_Object theVector);
638 * Translate the given object along the given vector on given distance,
639 * creating its copy before the translation.
640 * \param theObject The object to be translated.
641 * \param theVector Translation vector, giving a direction.
642 * \param theDistance Translation distance, giving a distance.
643 * \param theCope Translation copy, creating its copy if true.
644 * \return New GEOM_Object, containing the translated object.
646 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
647 in GEOM_Object theVector,
648 in double theDistance,
652 * Translate the given object along the given vector a given number times
653 * \param theObject The object to be translated.
654 * \param theVector Direction of the translation.
655 * \param theStep Distance to translate on.
656 * \param theNbTimes Quantity of translations to be done.
657 * \return New GEOM_Object, containing compound of all
658 * the shapes, obtained after each translation.
660 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
661 in GEOM_Object theVector,
666 * Conseqently apply two specified translations to theObject specified number of times.
667 * \param theObject The object to be translated.
668 * \param theVector1 Direction of the first translation.
669 * \param theStep1 Step of the first translation.
670 * \param theNbTimes1 Quantity of translations to be done along theVector1.
671 * \param theVector2 Direction of the second translation.
672 * \param theStep2 Step of the second translation.
673 * \param theNbTimes2 Quantity of translations to be done along theVector2.
674 * \return New GEOM_Object, containing compound of all
675 * the shapes, obtained after each translation.
677 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
678 in GEOM_Object theVector1,
681 in GEOM_Object theVector2,
683 in long theNbTimes2);
686 * Rotate given object around vector perpendicular to plane containing three points.
687 * \param theObject The object to be rotated.
688 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
689 * containing the three points.
690 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
693 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
694 in GEOM_Object theCentPoint,
695 in GEOM_Object thePoint1,
696 in GEOM_Object thePoint2);
700 * Rotate given object around vector perpendicular to plane containing three points.
701 * Creating its copy before the rotatation.
702 * \param theObject The object to be rotated.
703 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
704 * containing the three points.
705 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
706 * \return New GEOM_Object, containing the rotated object.
708 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
709 in GEOM_Object theCentPoint,
710 in GEOM_Object thePoint1,
711 in GEOM_Object thePoint2);
714 * Rotate the given object around the given axis on the given angle.
715 * \param theObject The object to be rotated.
716 * \param theAxis Rotation axis.
717 * \param theAngle Rotation angle in radians.
720 GEOM_Object Rotate (in GEOM_Object theObject,
721 in GEOM_Object theAxis,
726 * Rotate the given object around the given axis
727 * on the given angle, creating its copy before the rotatation.
728 * \param theObject The object to be rotated.
729 * \param theAxis Rotation axis.
730 * \param theAngle Rotation angle in radians.
731 * \return New GEOM_Object, containing the rotated object.
733 GEOM_Object RotateCopy (in GEOM_Object theObject,
734 in GEOM_Object theAxis,
739 * Rotate the given object around the given axis a given number times.
740 * Rotation angle will be 2*PI/theNbTimes.
741 * \param theObject The object to be rotated.
742 * \param theAxis The rotation axis.
743 * \param theNbTimes Quantity of rotations to be done.
744 * \return New GEOM_Object, containing compound of all the
745 * shapes, obtained after each rotation.
747 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
748 in GEOM_Object theAxis,
752 * Rotate the given object around the
753 * given axis on the given angle a given number
754 * times and multi-translate each rotation result.
755 * Translation direction passes through center of gravity
756 * of rotated shape and its projection on the rotation axis.
757 * \param theObject The object to be rotated.
758 * \param theAxis Rotation axis.
759 * \param theAngle Rotation angle in graduces.
760 * \param theNbTimes1 Quantity of rotations to be done.
761 * \param theStep Translation distance.
762 * \param theNbTimes2 Quantity of translations to be done.
763 * \return New GEOM_Object, containing compound of all the
764 * shapes, obtained after each transformation.
766 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
767 in GEOM_Object theAxis,
771 in long theNbTimes2);
774 * Replace the given object by an object,
775 * symmetrical to it relatively the given plane.
776 * \param theObject The object to be mirrored.
777 * \param thePlane Plane of symmetry.
779 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
782 * Create an object, symmetrical
783 * to the given one relatively the given plane.
784 * \param theObject The object to be mirrored.
785 * \param thePlane Plane of symmetry.
786 * \return New GEOM_Object, containing the mirrored shape.
788 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
791 * Replace the given object by an object,
792 * symmetrical to it relatively the given axis.
793 * \param theObject The object to be mirrored.
794 * \param theAxis Axis of symmetry.
797 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
800 * Create an object, symmetrical
801 * to the given one relatively the given axis.
802 * \param theObject The object to be mirrored.
803 * \param theAxis Axis of symmetry.
804 * \return New GEOM_Object, containing the mirrored object.
806 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
809 * Replace the given object by an object, symmetrical to it relatively the given point.
810 * \param theObject The object to be mirrored.
811 * \param thePoint Point of symmetry.
814 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
817 * Create an object, symmetrical to the given one relatively the given point.
818 * \param theObject The object to be mirrored.
819 * \param thePoint Point of symmetry.
820 * \return New GEOM_Object, containing the mirrored object.
822 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
825 * Replace the given object by its offset.
826 * \param theObject The base object for the offset.
827 * \param theOffset Offset value.
830 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
833 * Create new object as offset of the given one.
834 * \param theObject The base object for the offset.
835 * \param theOffset Offset value.
836 * \return New GEOM_Object, containing the offset object.
838 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
841 * Scale the given object by the factor.
842 * \param theObject The object to be scaled.
843 * \param thePoint Center point for scaling.
844 * \param theFactor Scaling factor value.
847 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
848 in double theFactor);
851 * Scale the given object by the factor, creating its copy before the scaling.
852 * \param theObject The object to be scaled.
853 * \param thePoint Center point for scaling.
854 * \param theFactor Scaling factor value.
855 * \return New GEOM_Object, containing the scaled shape.
857 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
858 in double theFactor);
861 * Scale the given object by different factors along coordinate axes.
862 * \param theObject The object to be scaled.
863 * \param thePoint Center point for scaling.
864 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
867 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
868 in GEOM_Object thePoint,
869 in double theFactorX,
870 in double theFactorY,
871 in double theFactorZ);
874 * Scale the given object by different factors along coordinate axes,
875 * creating its copy before the scaling.
876 * \param theObject The object to be scaled.
877 * \param thePoint Center point for scaling.
878 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
879 * \return New GEOM_Object, containing the scaled shape.
881 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
882 in GEOM_Object thePoint,
883 in double theFactorX,
884 in double theFactorY,
885 in double theFactorZ);
888 * Modify the Location of the given object by LCS.
889 * \param theObject The object to be displaced.
890 * \param theStartLCS Coordinate system to perform displacement from it.
891 * If \a theStartLCS is NULL, displacement
892 * will be performed from global CS.
893 * If \a theObject itself is used as \a theStartLCS,
894 * its location will be changed to \a theEndLCS.
895 * \param theEndLCS Coordinate system to perform displacement to it.
898 GEOM_Object PositionShape (in GEOM_Object theObject,
899 in GEOM_Object theStartLCS,
900 in GEOM_Object theEndLCS);
903 * Modify the Location of the given object by LCS,
904 * creating its copy before the setting.
905 * \param theObject The object to be displaced.
906 * \param theStartLCS Coordinate system to perform displacement from it.
907 * If \a theStartLCS is NULL, displacement
908 * will be performed from global CS.
909 * If \a theObject itself is used as \a theStartLCS,
910 * its location will be changed to \a theEndLCS.
911 * \param theEndLCS Coordinate system to perform displacement to it.
912 * \return New GEOM_Object, containing the displaced shape.
914 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
915 in GEOM_Object theStartLCS,
916 in GEOM_Object theEndLCS);
919 * Modify the Location of the given object by Path,
920 * \param theObject The object to be displaced.
921 * \param thePath Wire or Edge along that the object will be translated.
922 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
923 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
924 * \param theCopy is a true or false parameter. true is to reverse direction, false is to move normal direction.
925 * \return New GEOM_Object, containing the displaced shape.
928 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
929 in GEOM_Object thePath,
930 in double theDistance,
932 in boolean theReverse);
935 * Recompute the shape from its arguments.
936 * \param theObject The object to be recomputed.
939 GEOM_Object RecomputeObject (in GEOM_Object theObject);
943 * GEOM_I3DPrimOperations: Interface for 3D primitives creation
944 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
945 * Pipe (extrusion along contour), Revolution, Solid (from shell).
947 interface GEOM_I3DPrimOperations : GEOM_IOperations
950 * Create a box with specified dimensions along the coordinate axes
951 * and with edges, parallel to the coordinate axes.
952 * Center of the box will be at point (DX/2, DY/2, DZ/2).
953 * \param theDX Length of Box edges, parallel to OX axis.
954 * \param theDY Length of Box edges, parallel to OY axis.
955 * \param theDZ Length of Box edges, parallel to OZ axis.
956 * \return New GEOM_Object, containing the created box.
958 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
961 * Create a box with two specified opposite vertices,
962 * and with edges, parallel to the coordinate axes
963 * \param thePnt1 First of two opposite vertices.
964 * \param thePnt2 Second of two opposite vertices.
965 * \return New GEOM_Object, containing the created box.
967 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
970 * Create a face specified dimensions along OX-OY coordinate axes,
971 * with edges parallel to the coordinate axes.
972 * Center of the face will be at point (0, 0, 0).
973 * \param theH Height of the Face.
974 * \param theW Width of the Face.
975 * \param theOrientation Orientation belong axis OXY OYZ OZX
976 * \return New GEOM_Object, containing the created face.
978 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
980 * Create a face by normale vector or edge and two specified sizes,
981 * vertical (H) and horisontal (W).
982 * \param theVec defines plane.
983 * \param theH vertical size (height).
984 * \param theW horisontal size (width).
985 * \return New GEOM_Object, containing the created face.
987 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
989 * Create a Disk (circular face) with given center, normal vector and radius.
990 * \param thePnt disk center.
991 * \param theVec Vector, normal to the plane of the disk.
992 * \param theR Disk radius.
993 * \return New GEOM_Object, containing the created disk.
995 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
996 in GEOM_Object theVec,
999 * Create a disk (circular face), passing through three given points
1000 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1001 * \return New GEOM_Object, containing the created disk.
1003 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1004 in GEOM_Object thePnt2,
1005 in GEOM_Object thePnt3);
1008 * Create a disk specified dimensions along OX-OY coordinate axes,
1009 * Center of the disk at point (0, 0, 0).
1010 * \param theR of the Disk.
1011 * \param theOrientation Orientation belong axis OXY OYZ OZX
1012 * \return New GEOM_Object, containing the created disk.
1014 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1017 * Create a cylinder with given radius and height at
1018 * the origin of coordinate system. Axis of the cylinder
1019 * will be collinear to the OZ axis of the coordinate system.
1020 * \param theR Cylinder radius.
1021 * \param theH Cylinder height.
1022 * \return New GEOM_Object, containing the created cylinder.
1024 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1027 * Create a cylinder with given base point, axis, radius and height.
1028 * \param thePnt Central point of cylinder base.
1029 * \param theAxis Cylinder axis.
1030 * \param theR Cylinder radius.
1031 * \param theH Cylinder height.
1032 * \return New GEOM_Object, containing the created cylinder.
1034 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1035 in GEOM_Object theAxis,
1040 * Create a cone with given height and radiuses at
1041 * the origin of coordinate system. Axis of the cone will
1042 * be collinear to the OZ axis of the coordinate system.
1043 * \param theR1 Radius of the first cone base.
1044 * \param theR2 Radius of the second cone base.
1045 * \note If both radiuses are non-zero, the cone will be truncated.
1046 * \note If the radiuses are equal, a cylinder will be created instead.
1047 * \param theH Cone height.
1048 * \return New GEOM_Object, containing the created cone.
1050 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1053 * Create a cone with given base point, axis, height and radiuses.
1054 * \param thePnt Central point of the first cone base.
1055 * \param theAxis Cone axis.
1056 * \param theR1 Radius of the first cone base.
1057 * \param theR2 Radius of the second cone base.
1058 * \note If both radiuses are non-zero, the cone will be truncated.
1059 * \note If the radiuses are equal, a cylinder will be created instead.
1060 * \param theH Cone height.
1061 * \return New GEOM_Object, containing the created cone.
1063 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1064 in GEOM_Object theAxis,
1070 * Create a torus with given radiuses at the origin of coordinate system.
1071 * \param theRMajor Torus major radius.
1072 * \param theRMinor Torus minor radius.
1073 * \return New GEOM_Object, containing the created torus.
1075 GEOM_Object MakeTorusRR (in double theRMajor,
1076 in double theRMinor);
1079 * Create a torus with given center, normal vector and radiuses.
1080 * \param thePnt Torus central point.
1081 * \param theVec Torus axis of symmetry.
1082 * \param theRMajor Torus major radius.
1083 * \param theRMinor Torus minor radius.
1084 * \return New GEOM_Object, containing the created torus.
1086 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1087 in GEOM_Object theVec,
1088 in double theRMajor,
1089 in double theRMinor);
1092 * Create a sphere with given radius at the origin of coordinate system.
1093 * \param theR Sphere radius.
1094 * \return New GEOM_Object, containing the created sphere.
1096 GEOM_Object MakeSphereR (in double theR);
1099 * Create a sphere with given center and radius.
1100 * \param thePnt Sphere center.
1101 * \param theR Sphere radius.
1102 * \return New GEOM_Object, containing the created .
1104 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1107 * Create a shape by extrusion of the base shape along the vector,
1108 * i.e. all the space, transfixed by the base shape during its translation
1109 * along the vector on the given distance.
1110 * \param theBase Base shape to be extruded.
1111 * \param theVec Direction of extrusion.
1112 * \param theH Prism dimension along theVec.
1113 * \return New GEOM_Object, containing the created prism.
1115 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1116 in GEOM_Object theVec,
1118 /* The Same Prism but in 2 directions (forward&backward) */
1119 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1120 in GEOM_Object theVec,
1124 * Create a shape by extrusion of the base shape along a vector, defined by two points.
1125 * \param theBase Base shape to be extruded.
1126 * \param thePoint1 First end of extrusion vector.
1127 * \param thePoint2 Second end of extrusion vector.
1128 * \return New GEOM_Object, containing the created prism.
1130 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1131 in GEOM_Object thePoint1,
1132 in GEOM_Object thePoint2);
1133 /* The same prism but in two directions forward&backward */
1134 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1135 in GEOM_Object thePoint1,
1136 in GEOM_Object thePoint2);
1139 * Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1140 * \param theBase Base shape to be extruded.
1141 * \param DX, DY, DZ end of extrusion vector.
1142 * \return New GEOM_Object, containing the created prism.
1144 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1145 in double theDX, in double theDY, in double theDZ);
1146 /* The same prism but in two directions forward&backward */
1147 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1148 in double theDX, in double theDY, in double theDZ);
1151 * Create a shape by extrusion of the base shape along
1152 * the path shape. The path shape can be a wire or an edge.
1153 * \param theBase Base shape to be extruded.
1154 * \param thePath Path shape to extrude the base shape along it.
1155 * \return New GEOM_Object, containing the created pipe.
1157 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1160 * Create a shape by revolution of the base shape around the axis
1161 * on the given angle, i.e. all the space, transfixed by the base
1162 * shape during its rotation around the axis on the given angle.
1163 * \param theBase Base shape to be rotated.
1164 * \param theAxis Rotation axis.
1165 * \param theAngle Rotation angle in radians.
1166 * \return New GEOM_Object, containing the created revolution.
1168 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1169 in GEOM_Object theAxis,
1170 in double theAngle);
1171 /* The Same Revolution but in both ways forward&backward */
1172 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1173 in GEOM_Object theAxis,
1174 in double theAngle);
1177 * Create a filling from the given compound of contours.
1178 * \param theMinDeg a minimal degree of BSpline surface to create
1179 * \param theMaxDeg a maximal degree of BSpline surface to create
1180 * \param theTol2D a 2d tolerance to be reached
1181 * \param theTol3D a 3d tolerance to be reached
1182 * \param theNbIter a number of iteration of approximation algorithm
1183 * \return New GEOM_Object, containing the created filling surface.
1185 GEOM_Object MakeFilling (in GEOM_Object theShape,
1186 in long theMinDeg, in long theMaxDeg,
1187 in double theTol2D, in double theTol3D,
1188 in long theNbIter, in boolean theUseOri,
1189 in boolean theApprox);
1192 * Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1193 * \param theSeqSections - set of specified sections.
1194 * \param theModeSolid - mode defining building solid or shell
1195 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1196 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1197 * \return New GEOM_Object, containing the created shell or solid.
1199 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1200 in boolean theModeSolid,
1202 in boolean theRuled);
1205 * Create a shape by extrusion of the profile shape along
1206 * the path shape. The path shape can be a wire or an edge.
1207 * the several profiles can be specified in the several locations of path.
1208 * \param theSeqBases - list of Bases shape to be extruded.
1209 * \param theLocations - list of locations on the path corresponding
1210 * specified list of the Bases shapes. Number of locations
1211 * should be equal to number of bases or list of locations can be empty.
1212 * \param thePath - Path shape to extrude the base shape along it.
1213 * \param theWithContact - the mode defining that the section is translated to be in
1214 * contact with the spine.
1215 * \param - WithCorrection - defining that the section is rotated to be
1216 * orthogonal to the spine tangent in the correspondent point
1217 * \return New GEOM_Object, containing the created pipe.
1219 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1220 in ListOfGO theLocations,
1221 in GEOM_Object thePath,
1222 in boolean theWithContact ,
1223 in boolean theWithCorrection );
1226 * Create a shape by extrusion of the profile shape along
1227 * the path shape. The path shape can be a shell or a face.
1228 * the several profiles can be specified in the several locations of path.
1229 * \param theSeqBases - list of Bases shape to be extruded.
1230 * \param theSeqSubBases - list of corresponding subshapes of section shapes.
1231 * \param theLocations - list of locations on the path corresponding
1232 * specified list of the Bases shapes. Number of locations
1233 * should be equal to number of bases.
1234 * \param thePath - Path shape to extrude the base shape along it.
1235 * \param theWithContact - the mode defining that the section is translated to be in
1236 * contact with the spine.
1237 * \param - WithCorrection - defining that the section is rotated to be
1238 * orthogonal to the spine tangent in the correspondent point
1239 * \return New GEOM_Object, containing the created pipe.
1241 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1242 in ListOfGO theSeqSubBases,
1243 in ListOfGO theLocations,
1244 in GEOM_Object thePath,
1245 in boolean theWithContact ,
1246 in boolean theWithCorrection );
1249 * Create solids between given sections
1250 * \param theSeqBases - list of sections (shell or face).
1251 * \param theLocations - list of corresponding vertexes
1252 * \return New GEOM_Object, containing the created solids.
1254 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1255 in ListOfGO theLocations);
1258 * Create a shape by extrusion of the base shape along
1259 * the path shape with constant bi-normal direction along the given vector.
1260 * The path shape can be a wire or an edge.
1261 * \param theBase Base shape to be extruded.
1262 * \param thePath Path shape to extrude the base shape along it.
1263 * \param theVec Vector defines a constant binormal direction to keep the
1264 * same angle beetween the Direction and the sections
1265 * along the sweep surface.
1266 * \return New GEOM_Object, containing the created pipe.
1268 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1269 in GEOM_Object thePath,
1270 in GEOM_Object theVec);
1275 * GEOM_IShapesOperations: Interface for Shapes creation:
1276 * Edge from two points, Wire from edges, Face from wire,
1277 * Shell from faces, Solid from shells, Compound from shapes
1279 interface GEOM_IShapesOperations : GEOM_IOperations
1282 * Create a linear edge with specified ends.
1283 * \param thePnt1 Point for the first end of edge.
1284 * \param thePnt2 Point for the second end of edge.
1285 * \return New GEOM_Object, containing the created edge.
1287 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1290 * Create a wire from the set of edges and wires.
1291 * \param theEdgesAndWires List of edge and/or wires.
1292 * \param theTolerance Maximum distance between vertices, that will be merged.
1293 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1294 * \return New GEOM_Object, containing the created wire.
1296 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1297 in double theTolerance);
1300 * Create a face on the given wire.
1301 * \param theWire closed Wire or Edge to build the face on.
1302 * \param isPlanarWanted If TRUE, only planar face will be built.
1303 * If impossible, NULL object will be returned.
1304 * \return New GEOM_Object, containing the created face.
1306 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1309 * Create a face on the given wires set.
1310 * \param theWires List of closed wires or edges to build the face on.
1311 * \param isPlanarWanted If TRUE, only planar face will be built.
1312 * If impossible, NULL object will be returned.
1313 * \return New GEOM_Object, containing the created face.
1315 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1318 * Create a shell from the set of faces and shells.
1319 * \param theFacesAndShells List of faces and/or shells.
1320 * \return New GEOM_Object, containing the created shell.
1322 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1325 * Create a solid, bounded by the given shell.
1326 * \param theShell Bounding shell.
1327 * \return New GEOM_Object, containing the created solid.
1329 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1332 * Create a solid, bounded by the given shells.
1333 * \param theShells Bounding shells.
1334 * \return New GEOM_Object, containing the created solid.
1336 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1339 * Create a compound of the given shapes.
1340 * \param theShapes List of shapes to put in compound.
1341 * \return New GEOM_Object, containing the created compound.
1343 GEOM_Object MakeCompound (in ListOfGO theShapes);
1346 * Replace coincident faces in theShape by one face.
1347 * \param theShape Initial shape.
1348 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1349 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1350 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1352 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1355 * Find coincident faces in theShape for possible gluing.
1356 * \param theShape Initial shape.
1357 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1360 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1363 * Replace coincident faces in theShape by one face
1364 * in compliance with given list of faces
1365 * \param theShape Initial shape.
1366 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1367 * \param theFaces List of faces for gluing.
1368 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1369 * \return New GEOM_Object, containing a copy of theShape without some faces.
1371 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1372 in ListOfGO theFaces, in boolean doKeepNonSolids);
1375 * Explode a shape on subshapes of a given type.
1376 * \param theShape Shape to be exploded.
1377 * \param theShapeType Type of sub-shapes to be retrieved.
1378 * \param isSorted If this parameter is TRUE, sub-shapes will be
1379 * sorted by coordinates of their gravity centers.
1380 * \return List of sub-shapes of type theShapeType, contained in theShape.
1382 ListOfGO MakeExplode (in GEOM_Object theShape,
1383 in long theShapeType,
1384 in boolean isSorted);
1387 * Explode a shape on subshapes of a given type.
1388 * Does the same, as the above method, but returns IDs of sub-shapes,
1389 * not GEOM_Objects. It works faster.
1390 * \param theShape Shape to be exploded.
1391 * \param theShapeType Type of sub-shapes to be retrieved.
1392 * \param isSorted If this parameter is TRUE, sub-shapes will be
1393 * sorted by coordinates of their gravity centers.
1394 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1396 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1397 in long theShapeType,
1398 in boolean isSorted);
1401 * Get a sub shape defined by its unique ID inside \a theMainShape
1402 * \note The sub shape GEOM_Objects can has ONLY ONE function.
1403 * Don't try to apply modification operations on them.
1405 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1409 * Get global index of \a theSubShape in \a theMainShape.
1410 * \param theMainShape Main shape.
1411 * \param theSubShape Sub-shape of the main shape.
1412 * \return global index of \a theSubShape in \a theMainShape.
1414 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1417 * Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1418 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1419 * to generate automatic names for sub-shapes, when publishing them in a study.
1420 * \param theMainShape Main shape.
1421 * \param theSubShape Sub-shape of the main shape.
1422 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1424 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1427 * \brief Get name of type of \a theShape.
1429 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1430 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1431 * to generate automatic names for sub-shapes, when publishing them in a study.
1432 * \param theShape The shape to get a type of.
1433 * \return String, containing a type name of \a theShape.
1435 string GetShapeTypeString (in GEOM_Object theShape);
1438 * Count number of faces in the given shape.
1439 * \param theShape Shape to count faces in.
1440 * \return Number of faces in the given shape.
1442 long NumberOfFaces (in GEOM_Object theShape);
1445 * Count number of edges in the given shape.
1446 * \param theShape Shape to count edges in.
1447 * \return Number of edges in theShape.
1449 long NumberOfEdges (in GEOM_Object theShape);
1452 * Count number of subshapes of type \a theShapeType in the given shape.
1453 * \param theShape Shape to count subshapes in.
1454 * \param theShapeType The type of subshapes to count.
1455 * \return Number of subshapes of type \a theShapeType in \a theShape.
1457 long NumberOfSubShapes (in GEOM_Object theShape,
1458 in long theShapeType);
1461 * Reverses an orientation the given shape.
1462 * \param theShape Shape to be reversed.
1463 * \return The reversed copy of theShape.
1465 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1468 * Retrieve all free faces from the given shape.
1469 * Free face is a face, which is not shared between two shells of the shape.
1470 * \param theShape Shape to find free faces in.
1471 * \return List of IDs of all free faces, contained in theShape.
1473 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1476 * Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1477 * \param theShape1 Shape to find sub-shapes in.
1478 * \param theShape2 Shape to find shared sub-shapes with.
1479 * \param theShapeType Type of sub-shapes to be retrieved.
1480 * \return List of sub-shapes of theShape1, shared with theShape2.
1482 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1483 in GEOM_Object theShape2,
1484 in long theShapeType);
1487 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1488 * the specified plane by the certain way, defined through \a theState parameter.
1489 * \param theShape Shape to find sub-shapes of.
1490 * \param theShapeType Type of sub-shapes to be retrieved.
1491 * \param theAx1 Vector (or line, or linear edge), specifying normal
1492 * direction and location of the plane to find shapes on.
1493 * \param theState The state of the subshapes to find.
1494 * \return List of all found sub-shapes.
1496 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1497 in long theShapeType,
1498 in GEOM_Object theAx1,
1499 in shape_state theState);
1501 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1502 * the specified plane by the certain way, defined through \a theState parameter.
1503 * \param theShape Shape to find sub-shapes of.
1504 * \param theShapeType Type of sub-shapes to be retrieved.
1505 * \param theAx1 Vector (or line, or linear edge), specifying normal
1506 * direction of the plane to find shapes on.
1507 * \param thePnt Point specifying location of the plane to find shapes on.
1508 * \param theState The state of the subshapes to find.
1509 * \return List of all found sub-shapes.
1511 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1512 in long theShapeType,
1513 in GEOM_Object theAx1,
1514 in GEOM_Object thePnt,
1515 in shape_state theState);
1520 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1521 * the specified cylinder by the certain way, defined through \a theState parameter.
1522 * \param theShape Shape to find sub-shapes of.
1523 * \param theShapeType Type of sub-shapes to be retrieved.
1524 * \param theAxis Vector (or line, or linear edge), specifying
1525 * axis of the cylinder to find shapes on.
1526 * \param theRadius Radius of the cylinder to find shapes on.
1527 * \param theState The state of the subshapes to find.
1528 * \return List of all found sub-shapes.
1530 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1531 in long theShapeType,
1532 in GEOM_Object theAxis,
1533 in double theRadius,
1534 in shape_state theState);
1537 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1538 * the specified cylinder by the certain way, defined through \a theState parameter.
1539 * \param theShape Shape to find sub-shapes of.
1540 * \param theShapeType Type of sub-shapes to be retrieved.
1541 * \param theAxis Vector (or line, or linear edge), specifying
1542 * axis of the cylinder to find shapes on.
1543 * \param thePnt Point specifying location of the bottom of the cylinder.
1544 * \param theRadius Radius of the cylinder to find shapes on.
1545 * \param theState The state of the subshapes to find.
1546 * \return List of all found sub-shapes.
1548 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1549 in long theShapeType,
1550 in GEOM_Object theAxis,
1551 in GEOM_Object thePnt,
1552 in double theRadius,
1553 in shape_state theState);
1556 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1557 * the specified sphere by the certain way, defined through \a theState parameter.
1558 * \param theShape Shape to find sub-shapes of.
1559 * \param theShapeType Type of sub-shapes to be retrieved.
1560 * \param theCenter Point, specifying center of the sphere to find shapes on.
1561 * \param theRadius Radius of the sphere to find shapes on.
1562 * \param theState The state of the subshapes to find.
1563 * \return List of all found sub-shapes.
1565 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1566 in long theShapeType,
1567 in GEOM_Object theCenter,
1568 in double theRadius,
1569 in shape_state theState);
1572 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1573 * the specified quadrangle by the certain way, defined through \a theState parameter.
1574 * \param theShape Shape to find sub-shapes of.
1575 * \param theShapeType Type of sub-shapes to be retrieved.
1576 * \param theTopLeftPoint Top left quadrangle corner
1577 * \param theTopRigthPoint Top right quadrangle corner
1578 * \param theBottomLeftPoint Bottom left quadrangle corner
1579 * \param theBottomRigthPoint Bottom right quadrangle corner
1580 * \param theState The state of the subshapes to find.
1581 * \return List of all found sub-shapes.
1583 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1584 in long theShapeType,
1585 in GEOM_Object theTopLeftPoint,
1586 in GEOM_Object theTopRigthPoint,
1587 in GEOM_Object theBottomLeftPoint,
1588 in GEOM_Object theBottomRigthPoint,
1589 in shape_state theState);
1592 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1593 * the specified plane by the certain way, defined through \a theState parameter.
1594 * \param theShape Shape to find sub-shapes of.
1595 * \param theShapeType Type of sub-shapes to be retrieved.
1596 * \param theAx1 Vector (or line, or linear edge), specifying normal
1597 * direction and location of the plane to find shapes on.
1598 * \param theState The state of the subshapes to find.
1599 * \return List of IDs of all found sub-shapes.
1601 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1602 in long theShapeType,
1603 in GEOM_Object theAx1,
1604 in shape_state theState);
1607 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1608 * the specified plane by the certain way, defined through \a theState parameter.
1609 * \param theShape Shape to find sub-shapes of.
1610 * \param theShapeType Type of sub-shapes to be retrieved.
1611 * \param theAx1 Vector (or line, or linear edge), specifying normal
1612 * direction of the plane to find shapes on.
1613 * \param thePnt Point specifying location of the plane to find shapes on.
1614 * \param theState The state of the subshapes to find.
1615 * \return List of IDs of all found sub-shapes.
1617 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1618 in long theShapeType,
1619 in GEOM_Object theAx1,
1620 in GEOM_Object thePnt,
1621 in shape_state theState);
1624 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1625 * the specified cylinder by the certain way, defined through \a theState parameter.
1626 * \param theShape Shape to find sub-shapes of.
1627 * \param theShapeType Type of sub-shapes to be retrieved.
1628 * \param theAxis Vector (or line, or linear edge), specifying
1629 * axis of the cylinder to find shapes on.
1630 * \param theRadius Radius of the cylinder to find shapes on.
1631 * \param theState The state of the subshapes to find.
1632 * \return List of IDs of all found sub-shapes.
1634 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1635 in long theShapeType,
1636 in GEOM_Object theAxis,
1637 in double theRadius,
1638 in shape_state theState);
1641 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1642 * the specified cylinder by the certain way, defined through \a theState parameter.
1643 * \param theShape Shape to find sub-shapes of.
1644 * \param theShapeType Type of sub-shapes to be retrieved.
1645 * \param theAxis Vector (or line, or linear edge), specifying
1646 * axis of the cylinder to find shapes on.
1647 * \param thePnt Point specifying location of the bottom of the cylinder.
1648 * \param theRadius Radius of the cylinder to find shapes on.
1649 * \param theState The state of the subshapes to find.
1650 * \return List of IDs all found sub-shapes.
1652 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1653 in long theShapeType,
1654 in GEOM_Object theAxis,
1655 in GEOM_Object thePnt,
1656 in double theRadius,
1657 in shape_state theState);
1660 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1661 * the specified sphere by the certain way, defined through \a theState parameter.
1662 * \param theShape Shape to find sub-shapes of.
1663 * \param theShapeType Type of sub-shapes to be retrieved.
1664 * \param theCenter Point, specifying center of the sphere to find shapes on.
1665 * \param theRadius Radius of the sphere to find shapes on.
1666 * \param theState The state of the subshapes to find.
1667 * \return List of IDs of all found sub-shapes.
1669 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1670 in long theShapeType,
1671 in GEOM_Object theCenter,
1672 in double theRadius,
1673 in shape_state theState);
1676 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1677 * the specified quadrangle by the certain way, defined through \a theState parameter.
1678 * \param theShape Shape to find sub-shapes of.
1679 * \param theShapeType Type of sub-shapes to be retrieved.
1680 * \param theTopLeftPoint Top left quadrangle corner
1681 * \param theTopRigthPoint Top right quadrangle corner
1682 * \param theBottomLeftPoint Bottom left quadrangle corner
1683 * \param theBottomRigthPoint Bottom right quadrangle corner
1684 * \param theState The state of the subshapes to find.
1685 * \return List of IDs of all found sub-shapes.
1687 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1688 in long theShapeType,
1689 in GEOM_Object theTopLeftPoint,
1690 in GEOM_Object theTopRigthPoint,
1691 in GEOM_Object theBottomLeftPoint,
1692 in GEOM_Object theBottomRigthPoint,
1693 in shape_state theState);
1696 * \brief Find subshapes complying with given status
1697 * \param theBox - the box to check state of subshapes against
1698 * \param theShape - the shape to explore
1699 * \param theShapeType - type of subshape of theShape
1700 * \param theState - required state
1701 * \return List of IDs of all found sub-shapes.
1703 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1704 in GEOM_Object theShape,
1705 in long theShapeType,
1706 in shape_state theState);
1709 * \brief Find subshapes complying with given status
1710 * \param theBox - the box to check state of subshapes against
1711 * \param theShape - the shape to explore
1712 * \param theShapeType - type of subshape of theShape
1713 * \param theState - required state
1714 * \return List of all found sub-shapes.
1716 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1717 in GEOM_Object theShape,
1718 in long theShapeType,
1719 in shape_state theState);
1722 * \brief Find subshapes complying with given status
1723 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1724 * \param theShape - the shape to explore
1725 * \param theShapeType - type of subshape of theShape
1726 * \param theState - required state
1727 * \return List of IDs of all found sub-shapes.
1729 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
1730 in GEOM_Object theShape,
1731 in short theShapeType,
1732 in shape_state theState);
1735 * \brief Find subshapes complying with given status
1736 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1737 * \param theShape - the shape to explore
1738 * \param theShapeType - type of subshape of theShape
1739 * \param theState - required state
1740 * \return List of all found sub-shapes.
1742 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
1743 in GEOM_Object theShape,
1744 in short theShapeType,
1745 in shape_state theState);
1748 * \brief Find subshapes complying with given status
1749 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1750 * \param theShape - the shape to explore
1751 * \param theShapeType - type of subshape of theShape
1752 * \param theState - required state
1753 * \return compound includes all found sub-shapes.
1755 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
1756 in GEOM_Object theShape,
1757 in short theShapeType,
1758 in shape_state theState);
1761 * Get sub-shape(s) of \a theShapeWhere, which are
1762 * coincident with \a theShapeWhat or could be a part of it.
1763 * \param theShapeWhere Shape to find sub-shapes of.
1764 * \param theShapeWhat Shape, specifying what to find.
1765 * \return Group of all found sub-shapes or a single found sub-shape.
1767 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1768 in GEOM_Object theShapeWhat);
1771 * Get sub-shape(s) of \a theShapeWhere, which are
1772 * coincident with \a theShapeWhat or could be a part of it.
1774 * Implementation of this method is based on a saved history of an operation,
1775 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1776 * arguments (an argument shape or a sub-shape of an argument shape).
1777 * The operation could be the Partition or one of boolean operations,
1778 * performed on simple shapes (not on compounds).
1780 * \param theShapeWhere Shape to find sub-shapes of.
1781 * \param theShapeWhat Shape, specifying what to find.
1782 * \return Group of all found sub-shapes or a single found sub-shape.
1784 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
1785 in GEOM_Object theShapeWhat);
1788 * Get sub-shape of theShapeWhere, which are
1789 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1790 * \param theShapeWhere Shape to find sub-shapes of.
1791 * \param theShapeWhat Shape, specifying what to find.
1792 * \return found sub-shape.
1794 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1795 in GEOM_Object theShapeWhat);
1799 * GEOM_IBlocksOperations: Interface for Blocks construction
1800 * Face from points or edges, Block from faces,
1801 * Blocks multi-translation and multi-rotation
1803 interface GEOM_IBlocksOperations : GEOM_IOperations
1806 * Creation of blocks
1810 * Create a quadrangle face from four edges. Order of Edges is not
1811 * important. It is not necessary that edges share the same vertex.
1812 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1813 * \return New GEOM_Object, containing the created face.
1815 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1816 in GEOM_Object theEdge2,
1817 in GEOM_Object theEdge3,
1818 in GEOM_Object theEdge4);
1821 * Create a quadrangle face on two edges.
1822 * The missing edges will be built by creating the shortest ones.
1823 * \param theEdge1,theEdge2 Two opposite edges for the face.
1824 * \return New GEOM_Object, containing the created face.
1826 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1827 in GEOM_Object theEdge2);
1830 * Create a quadrangle face with specified corners.
1831 * The missing edges will be built by creating the shortest ones.
1832 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1833 * \return New GEOM_Object, containing the created face.
1835 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1836 in GEOM_Object thePnt2,
1837 in GEOM_Object thePnt3,
1838 in GEOM_Object thePnt4);
1841 * Create a hexahedral solid, bounded by the six given faces. Order of
1842 * faces is not important. It is not necessary that Faces share the same edge.
1843 * \param theFace1-theFace6 Faces for the hexahedral solid.
1844 * \return New GEOM_Object, containing the created solid.
1846 GEOM_Object MakeHexa (in GEOM_Object theFace1,
1847 in GEOM_Object theFace2,
1848 in GEOM_Object theFace3,
1849 in GEOM_Object theFace4,
1850 in GEOM_Object theFace5,
1851 in GEOM_Object theFace6);
1854 * Create a hexahedral solid between two given faces.
1855 * The missing faces will be built by creating the smallest ones.
1856 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1857 * \return New GEOM_Object, containing the created solid.
1859 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1860 in GEOM_Object theFace2);
1863 * Extract elements of blocks and blocks compounds
1867 * Get a vertex, found in the given shape by its coordinates.
1868 * \param theShape Block or a compound of blocks.
1869 * \param theX,theY,theZ Coordinates of the sought vertex.
1870 * \param theEpsilon Maximum allowed distance between the resulting
1871 * vertex and point with the given coordinates.
1872 * \return New GEOM_Object, containing the found vertex.
1874 GEOM_Object GetPoint (in GEOM_Object theShape,
1878 in double theEpsilon);
1881 * Get an edge, found in the given shape by two given vertices.
1882 * \param theShape Block or a compound of blocks.
1883 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1884 * \return New GEOM_Object, containing the found edge.
1886 GEOM_Object GetEdge (in GEOM_Object theShape,
1887 in GEOM_Object thePoint1,
1888 in GEOM_Object thePoint2);
1891 * Find an edge of the given shape, which has minimal distance to the given point.
1892 * \param theShape Block or a compound of blocks.
1893 * \param thePoint Point, close to the desired edge.
1894 * \return New GEOM_Object, containing the found edge.
1896 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1897 in GEOM_Object thePoint);
1900 * Returns a face, found in the given shape by four given corner vertices.
1901 * \param theShape Block or a compound of blocks.
1902 * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1903 * \return New GEOM_Object, containing the found face.
1905 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1906 in GEOM_Object thePoint1,
1907 in GEOM_Object thePoint2,
1908 in GEOM_Object thePoint3,
1909 in GEOM_Object thePoint4);
1912 * Get a face of block, found in the given shape by two given edges.
1913 * \param theShape Block or a compound of blocks.
1914 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
1915 * \return New GEOM_Object, containing the found face.
1917 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
1918 in GEOM_Object theEdge1,
1919 in GEOM_Object theEdge2);
1922 * Find a face, opposite to the given one in the given block.
1923 * \param theBlock Must be a hexahedral solid.
1924 * \param theFace Face of \a theBlock, opposite to the desired face.
1925 * \return New GEOM_Object, containing the found face.
1927 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
1928 in GEOM_Object theFace);
1931 * Find a face of the given shape, which has minimal distance to the given point.
1932 * \param theShape Block or a compound of blocks.
1933 * \param thePoint Point, close to the desired face.
1934 * \return New GEOM_Object, containing the found face.
1936 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
1937 in GEOM_Object thePoint);
1940 * Find a face of block, whose outside normale has minimal angle with the given vector.
1941 * \param theShape Block or a compound of blocks.
1942 * \param theVector Vector, close to the normale of the desired face.
1943 * \return New GEOM_Object, containing the found face.
1945 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
1946 in GEOM_Object theVector);
1949 * Extract blocks from blocks compounds
1953 * Check, if the compound contains only specified blocks.
1954 * \param theCompound The compound to check.
1955 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
1956 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1957 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1958 * \return TRUE, if the given compound contains only blocks.
1959 * \return theNbBlocks Number of specified blocks in theCompound.
1961 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
1962 in long theMinNbFaces,
1963 in long theMaxNbFaces,
1964 out long theNbBlocks);
1967 * Enumeration of Blocks Compound defects.
1971 /* Each element of the compound should be a Block */
1974 /* An element is a potential block, but has degenerated and/or seam edge(s). */
1977 /* A connection between two Blocks should be an entire face or an entire edge */
1980 /* The compound should be connexe */
1983 /* The glue between two quadrangle faces should be applied */
1988 * Description of Blocks Compound defect: type and incriminated sub-shapes.
1993 ListOfLong incriminated;
1997 * Sequence of all Blocks Compound defects.
1999 typedef sequence<BCError> BCErrors;
2002 * Check, if the compound of blocks is given.
2003 * To be considered as a compound of blocks, the
2004 * given shape must satisfy the following conditions:
2005 * - Each element of the compound should be a Block (6 faces and 12 edges).
2006 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2007 * - The compound should be connexe.
2008 * - The glue between two quadrangle faces should be applied.
2009 * \note Single block is also accepted as a valid compound of blocks.
2010 * \param theCompound The compound to check.
2011 * \return TRUE, if the given shape is a compound of blocks.
2012 * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
2014 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2015 out BCErrors theErrors);
2018 * Convert sequence of Blocks Compound errors, returned by
2019 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2020 * \param theCompound The bad compound.
2021 * \param theErrors The sequence of \a theCompound errors.
2022 * \return String, describing all the errors in form, suitable for printing.
2024 string PrintBCErrors (in GEOM_Object theCompound,
2025 in BCErrors theErrors);
2028 * Remove all seam and degenerated edges from \a theShape.
2029 * Unite faces and edges, sharing one surface.
2030 * \param theShape The compound or single solid to remove irregular edges from.
2031 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2032 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2033 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2034 * For blocks repairing recommended value is 6.
2035 * \return Improved shape.
2037 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2038 in long theOptimumNbFaces);
2041 * Check, if the given shape is a blocks compound.
2042 * Fix all detected errors.
2043 * \note Single block can be also fixed by this method.
2044 * \param theCompound The compound to check and improve.
2045 * \return Improved compound.
2047 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2050 * Get all the blocks, contained in the given compound.
2051 * \param theCompound The compound to explode.
2052 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2053 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2054 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2055 * \return List of GEOM_Objects, containing the retrieved blocks.
2057 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2058 in long theMinNbFaces,
2059 in long theMaxNbFaces);
2062 * Find block, containing the given point inside its volume or on boundary.
2063 * \param theCompound Compound, to find block in.
2064 * \param thePoint Point, close to the desired block. If the point lays on
2065 * boundary between some blocks, we return block with nearest center.
2066 * \return New GEOM_Object, containing the found block.
2068 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2069 in GEOM_Object thePoint);
2072 * Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2073 * \param theCompound Compound, to find block in.
2074 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2075 * \return New GEOM_Object, containing the found block.
2077 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2078 in ListOfGO theParts);
2081 * Return all blocks, containing all the elements, passed as the parts.
2082 * \param theCompound Compound, to find blocks in.
2083 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2084 * \return List of GEOM_Objects, containing the found blocks.
2086 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2087 in ListOfGO theParts);
2090 * Operations on blocks with gluing of result
2094 * Multi-transformate block and glue the result.
2095 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2096 * \param theBlock Hexahedral solid to be multi-transformed.
2097 * \param theDirFace1 First direction face global index.
2098 * \param theDirFace2 Second direction face global index.
2099 * \param theNbTimes Quantity of transformations to be done.
2100 * \note Global index of sub-shape can be obtained, using method
2101 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2102 * \return New GEOM_Object, containing the result shape.
2104 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2105 in long theDirFace1,
2106 in long theDirFace2,
2107 in long theNbTimes);
2110 * Multi-transformate block and glue the result.
2111 * \param theBlock Hexahedral solid to be multi-transformed.
2112 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2113 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2114 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2115 * \return New GEOM_Object, containing the result shape.
2117 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2118 in long theDirFace1U,
2119 in long theDirFace2U,
2120 in long theNbTimesU,
2121 in long theDirFace1V,
2122 in long theDirFace2V,
2123 in long theNbTimesV);
2126 * Special operation - propagation
2130 * Build all possible propagation groups.
2131 * Propagation group is a set of all edges, opposite to one (main)
2132 * edge of this group directly or through other opposite edges.
2133 * Notion of Opposite Edge make sence only on quadrangle face.
2134 * \param theShape Shape to build propagation groups on.
2135 * \return List of GEOM_Objects, each of them is a propagation group.
2137 ListOfGO Propagate (in GEOM_Object theShape);
2141 * GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
2143 interface GEOM_IBooleanOperations : GEOM_IOperations
2146 * Perform one of boolean operations on two given shapes.
2147 * \param theShape1 First argument for boolean operation.
2148 * \param theShape2 Second argument for boolean operation.
2149 * \param theOperation Indicates the operation to be done:
2150 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2151 * \return New GEOM_Object, containing the result shape.
2153 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2154 in GEOM_Object theShape2,
2155 in long theOperation);
2158 * Perform partition operation.
2159 * \param theShapes Shapes to be intersected.
2160 * \param theTools Shapes to intersect theShapes.
2161 * \note Each compound from ListShapes and ListTools will be exploded in order
2162 * to avoid possible intersection between shapes from this compound.
2163 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2164 # \param KeepNonlimitShapes: if this parameter == 0 - only shapes with
2165 # type <= Limit are kept in the result,
2166 # else - shapes with type > Limit are kept
2167 # also (if they exist)
2169 * After implementation new version of PartitionAlgo (October 2006)
2170 * other parameters are ignored by current functionality. They are kept
2171 * in this function only for supporting old versions.
2172 * Ignored parameters:
2173 * \param theKeepInside Shapes, outside which the results will be deleted.
2174 * Each shape from theKeepInside must belong to theShapes also.
2175 * \param theRemoveInside Shapes, inside which the results will be deleted.
2176 * Each shape from theRemoveInside must belong to theShapes also.
2177 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2178 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2180 * \return New GEOM_Object, containing the result shapes.
2182 GEOM_Object MakePartition (in ListOfGO theShapes,
2183 in ListOfGO theTools,
2184 in ListOfGO theKeepInside,
2185 in ListOfGO theRemoveInside,
2187 in boolean theRemoveWebs,
2188 in ListOfLong theMaterials,
2189 in short theKeepNonlimitShapes);
2192 * Perform partition operation.
2193 * This method may be usefull if it is needed to make a partition for
2194 * a compound containing nonintersected shapes. Performance will be better
2195 * since intersection between shapes from compound is not performed.
2197 * Description of all parameters as in previous method MakePartition()
2199 * \note Passed compounds (via ListShapes or via ListTools)
2200 * have to consist of nonintersecting shapes.
2202 * \return New GEOM_Object, containing the result shapes.
2204 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2205 in ListOfGO theTools,
2206 in ListOfGO theKeepInside,
2207 in ListOfGO theRemoveInside,
2209 in boolean theRemoveWebs,
2210 in ListOfLong theMaterials,
2211 in short theKeepNonlimitShapes);
2214 * Perform partition of the Shape with the Plane
2215 * \param theShape Shape to be intersected.
2216 * \param thePlane Tool shape, to intersect theShape.
2217 * \return New GEOM_Object, containing the result shape.
2219 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2220 in GEOM_Object thePlane);
2224 * GEOM_ICurvesOperations: Interface for curves creation.
2225 * Polyline, Circle, Spline (Bezier and Interpolation)
2227 interface GEOM_ICurvesOperations : GEOM_IOperations
2230 * Create a circle with given center, normal vector and radius.
2231 * \param thePnt Circle center.
2232 * \param theVec Vector, normal to the plane of the circle.
2233 * \param theR Circle radius.
2234 * \return New GEOM_Object, containing the created circle.
2236 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2237 in GEOM_Object theVec,
2240 * Create a circle, passing through three given points
2241 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2242 * \return New GEOM_Object, containing the created circle.
2244 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2245 in GEOM_Object thePnt2,
2246 in GEOM_Object thePnt3);
2248 * Create a circle with given center, with a radius equals the distance from center to Point1
2249 * and on a plane defined by all of three points.
2250 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2251 * \return New GEOM_Object, containing the created circle.
2253 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2254 in GEOM_Object thePnt2,
2255 in GEOM_Object thePnt3);
2257 * Create an ellipse with given center, normal vector and radiuses.
2258 * \param thePnt Ellipse center.
2259 * \param theVec Vector, normal to the plane of the ellipse.
2260 * \param theRMajor Major ellipse radius.
2261 * \param theRMinor Minor ellipse radius.
2262 * \return New GEOM_Object, containing the created ellipse.
2264 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2265 in GEOM_Object theVec,
2266 in double theRMajor,
2267 in double theRMinor);
2270 * Create an ellipse with given center, normal vector, main axis vector and radiuses.
2271 * \param thePnt Ellipse center.
2272 * \param theVec Vector, normal to the plane of the ellipse.
2273 * \param theRMajor Major ellipse radius.
2274 * \param theRMinor Minor ellipse radius.
2275 * \param theVecMaj Vector, direction of the ellipse's main axis.
2276 * \return New GEOM_Object, containing the created ellipse.
2278 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2279 in GEOM_Object theVec,
2280 in double theRMajor,
2281 in double theRMinor,
2282 in GEOM_Object theVecMaj);
2285 * Create an arc of circle, passing through three given points.
2286 * \param thePnt1 Start point of the arc.
2287 * \param thePnt2 Middle point of the arc.
2288 * \param thePnt3 End point of the arc.
2289 * \return New GEOM_Object, containing the created arc.
2291 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2292 in GEOM_Object thePnt2,
2293 in GEOM_Object thePnt3);
2296 * Create an arc of circle of center C from one point to another
2297 * \param theCenter Center point of the arc.
2298 * \param thePnt1 Start point of the arc.
2299 * \param thePnt2 End point of the arc.
2300 * \param theSense Orientation of the arc
2301 * \return New GEOM_Object, containing the created arc.
2303 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2304 in GEOM_Object thePnt1,
2305 in GEOM_Object thePnt2,
2306 in boolean theSense);
2309 * Create an arc of ellipse of center C and two points P1 P2.
2310 * \param theCenter Center point of the arc.
2311 * \param thePnt1 Major radius is distance from center to Pnt1.
2312 * \param thePnt2 define a plane and Minor radius as a shortest distance from Pnt2 to vector Center->Pnt1.
2313 * \return New GEOM_Object, containing the created arc.
2315 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2316 in GEOM_Object thePnt1,
2317 in GEOM_Object thePnt2);
2321 * Create a polyline on the set of points.
2322 * \param thePoints Sequence of points for the polyline.
2323 * \return New GEOM_Object, containing the created polyline.
2325 GEOM_Object MakePolyline (in ListOfGO thePoints);
2328 * Create bezier curve on the set of points.
2329 * \param thePoints Sequence of points for the bezier curve.
2330 * \return New GEOM_Object, containing the created bezier curve.
2332 GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
2335 * Create B-Spline curve on the set of points.
2336 * \param thePoints Sequence of points for the B-Spline curve.
2337 * \param theIsClosed If TRUE, build a closed curve.
2338 * \return New GEOM_Object, containing the created B-Spline curve.
2340 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2341 in boolean theIsClosed);
2344 * Create a sketcher (wire or face), following the textual description,
2345 * passed through \a theCommand argument. \n
2346 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2347 * Format of the description string have to be the following:
2349 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2352 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2354 * - "R angle" : Set the direction by angle
2355 * - "D dx dy" : Set the direction by DX & DY
2358 * - "TT x y" : Create segment by point at X & Y
2359 * - "T dx dy" : Create segment by point with DX & DY
2360 * - "L length" : Create segment by direction & Length
2361 * - "IX x" : Create segment by direction & Intersect. X
2362 * - "IY y" : Create segment by direction & Intersect. Y
2365 * - "C radius length" : Create arc by direction, radius and length(in degree)
2368 * - "WW" : Close Wire (to finish)
2369 * - "WF" : Close Wire and build face (to finish)
2371 * \param theCommand String, defining the sketcher in local
2372 * coordinates of the working plane.
2373 * \param theWorkingPlane Nine double values, defining origin,
2374 * OZ and OX directions of the working plane.
2375 * \return New GEOM_Object, containing the created wire.
2377 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2380 * Create a 3D sketcher, following the numerical description,
2381 * passed through points created by \a theCoordinates argument. \n
2382 * Format of the description string have to be the following:
2384 * "Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"
2387 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2390 * Create a sketcher (wire or face), following the textual description,
2391 * passed through \a theCommand argument. \n
2392 * For format of the description string see the previous method.\n
2393 * \param theCommand String, defining the sketcher in local
2394 * coordinates of the working plane.
2395 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2396 * \return New GEOM_Object, containing the created wire.
2398 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2402 * GEOM_ILocalOperations: Interface for fillet and chamfer creation.
2404 interface GEOM_ILocalOperations : GEOM_IOperations
2407 * Perform a fillet on all edges of the given shape.
2408 * \param theShape Shape, to perform fillet on.
2409 * \param theR Fillet radius.
2410 * \return New GEOM_Object, containing the result shape.
2412 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2416 * Perform a fillet on the specified edges of the given shape
2417 * \param theShape Shape, to perform fillet on.
2418 * \param theR Fillet radius.
2419 * \param theEdges Global indices of edges to perform fillet on.
2420 * \note Global index of sub-shape can be obtained, using method
2421 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2422 * \return New GEOM_Object, containing the result shape.
2424 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2426 in ListOfLong theEdges);
2427 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2430 in ListOfLong theEdges);
2433 * Perform a fillet on all edges of the specified faces of the given shape.
2434 * \param theShape Shape, to perform fillet on.
2435 * \param theR Fillet radius.
2436 * \param theFaces Global indices of faces to perform fillet on.
2437 * \note Global index of sub-shape can be obtained, using method
2438 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2439 * \return New GEOM_Object, containing the result shape.
2441 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2443 in ListOfLong theFaces);
2445 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2448 in ListOfLong theFaces);
2451 * Perform a fillet on face of the specified vertexes of the given shape.
2452 * \param theShape Shape, to perform fillet on.
2453 * \param theR Fillet radius.
2454 * \param theVertexes Global indices of vertexes to perform fillet on.
2455 * \note Global index of sub-shape can be obtained, using method
2456 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2457 * \return New GEOM_Object, containing the result shape.
2459 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2461 in ListOfLong theVertexes);
2464 * Perform a fillet on edges of the specified vertexes of the given wire.
2465 * \param theShape Shape, to perform fillet on.
2466 * \param theR Fillet radius.
2467 * \param theVertexes Global indices of vertexes to perform fillet on.
2468 * \note Global index of sub-shape can be obtained, using method
2469 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2470 * \note The list of vertices coudl be empty, in this case fillet fill be done
2471 * at all vertices in given wire
2472 * \return New GEOM_Object, containing the result shape.
2474 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2476 in ListOfLong theVertexes);
2479 * Perform a symmetric chamfer on all edges of the given shape.
2480 * \param theShape Shape, to perform chamfer on.
2481 * \param theD Chamfer size along each face.
2482 * \return New GEOM_Object, containing the result shape.
2484 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2488 * Perform a chamfer on edges, common to the specified faces.
2489 * with distance D1 on the Face1
2490 * \param theShape Shape, to perform chamfer on.
2491 * \param theD1 Chamfer size along \a theFace1.
2492 * \param theD2 Chamfer size along \a theFace2.
2493 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2494 * \note Global index of sub-shape can be obtained, using method
2495 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2496 * \return New GEOM_Object, containing the result shape.
2498 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2499 in double theD1, in double theD2,
2500 in long theFace1, in long theFace2);
2502 * The Same but with params theD = Chamfer Lenght
2503 * and theAngle = Chamfer Angle (Angle in radians)
2505 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2506 in double theD, in double theAngle,
2507 in long theFace1, in long theFace2);
2510 * Perform a chamfer on all edges of the specified faces.
2511 * with distance D1 on the first specified face (if several for one edge)
2512 * \param theShape Shape, to perform chamfer on.
2513 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2514 * connected to the edge, are in \a theFaces, \a theD1
2515 * will be get along face, which is nearer to \a theFaces beginning.
2516 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2517 * \param theFaces Sequence of global indices of faces of \a theShape.
2518 * \note Global index of sub-shape can be obtained, using method
2519 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2520 * \return New GEOM_Object, containing the result shape.
2522 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2523 in double theD1, in double theD2,
2524 in ListOfLong theFaces);
2526 * The Same but with params theD = Chamfer Lenght
2527 * and theAngle = Chamfer Angle (Angle in radians)
2529 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2530 in double theD, in double theAngle,
2531 in ListOfLong theFaces);
2534 * Perform a chamfer on edges,
2535 * with distance D1 on the first specified face (if several for one edge)
2536 * \param theShape Shape, to perform chamfer on.
2537 * \param theD1 theD2 Chamfer size
2538 * \param theEdges Sequence of edges of \a theShape.
2539 * \return New GEOM_Object, containing the result shape.
2541 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2542 in double theD1, in double theD2,
2543 in ListOfLong theEdges);
2545 * The Same but with params theD = Chamfer Lenght
2546 * and theAngle = Chamfer Angle (Angle in radians)
2548 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2549 in double theD, in double theAngle,
2550 in ListOfLong theEdges);
2553 * Perform an Archimde operation on the given shape with given parameters.
2554 * The object presenting the resulting face is returned
2555 * \param theShape Shape to be put in water.
2556 * \param theWeight Weight og the shape.
2557 * \param theWaterDensity Density of the water.
2558 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
2559 * \return New GEOM_Object, containing a section of \a theShape
2560 * by a plane, corresponding to water level.
2562 GEOM_Object MakeArchimede (in GEOM_Object theShape,
2563 in double theWeight,
2564 in double theWaterDensity,
2565 in double theMeshDeflection);
2568 * Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2569 * Present here only for compatibility.
2571 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2575 * GEOM_IHealingOperations: Interface for shape healing operations.
2576 * Shape Processing, SuppressFaces, etc.
2578 interface GEOM_IHealingOperations : GEOM_IOperations
2581 * Apply a sequence of Shape Healing operators to the given object.
2582 * \param theShapes Shape to be processed.
2583 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2584 * \param theParameters List of names of parameters
2585 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2586 * \param theValues List of values of parameters, in the same order
2587 * as parameters are listed in \a theParameters list.
2588 * \return New GEOM_Object, containing processed shape.
2590 GEOM_Object ProcessShape (in GEOM_Object theShapes,
2591 in string_array theOperators,
2592 in string_array theParameters,
2593 in string_array theValues);
2596 * Get default sequence of operators, their parameters and parameters' values
2597 * of Shape Process operation. In the current implementation the defaults are
2598 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2599 * \param theOperators Output. Default list of names of operators.
2600 * \param theParameters Output. Default list of names of parameters.
2601 * \param theValues Output. List of default values of parameters, in the same order
2602 * as parameters are listed in \a theParameters list.
2604 void GetShapeProcessParameters (out string_array theOperators,
2605 out string_array theParameters,
2606 out string_array theValues);
2608 * Get parameters and parameters' values for the given Shape Process operation.
2609 * In the current implementation the defaults are
2610 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2611 * \param theOperator Input. The operator's name.
2612 * \param theParameters Output. Default list of names of parameters.
2613 * \param theValues Output. List of default values of parameters, in the same order
2614 * as parameters are listed in \a theParameters list.
2616 void GetOperatorParameters (in string theOperator,
2617 out string_array theParameters,
2618 out string_array theValues);
2621 * Remove faces from the given object (shape).
2622 * \param theObject Shape to be processed.
2623 * \param theFaces Indices of faces to be removed, if EMPTY then the method
2624 * removes ALL faces of the given object.
2625 * \return New GEOM_Object, containing processed shape.
2627 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
2630 * Close an open wire.
2631 * \param theObject Shape to be processed.
2632 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2633 * if -1, then theObject itself is a wire.
2634 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
2635 * If FALS : closure by creation of an edge between ends.
2636 * \return New GEOM_Object, containing processed shape.
2638 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2639 in boolean isCommonVertex);
2642 * Remove internal wires and edges from the given object (face).
2643 * \param theObject Shape to be processed.
2644 * \param theWires Indices of wires to be removed, if EMPTY then the method
2645 * removes ALL internal wires of the given object.
2646 * \return New GEOM_Object, containing processed shape.
2648 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2651 * Remove internal closed contours (holes) from the given object.
2652 * \param theObject Shape to be processed.
2653 * \param theWires Indices of wires to be removed, if EMPTY then the method
2654 * removes ALL internal holes of the given object
2655 * \return New GEOM_Object, containing processed shape.
2657 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2660 * Sewing of the given object.
2661 * \param theObject Shape to be processed.
2662 * \param theTolerance Required tolerance value.
2663 * \return New GEOM_Object, containing processed shape.
2665 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2668 * Addition of a point to a given edge object.
2669 * \param theObject Shape to be processed.
2670 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
2671 * if -1, then theObject itself is the edge.
2672 * \param theValue Value of parameter on edge or length parameter,
2673 * depending on \a isByParameter.
2674 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2675 * if FALSE : \a theValue is treated as a length parameter [0..1]
2676 * \return New GEOM_Object, containing processed shape.
2678 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2679 in double theValue, in boolean isByParameter);
2682 * Get a list of wires (wrapped in GEOM_Object-s),
2683 * that constitute a free boundary of the given shape.
2684 * \param theObject Shape to get free boundary of.
2685 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2686 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
2687 * \return FALSE, if an error(s) occured during the method execution.
2689 boolean GetFreeBoundary (in GEOM_Object theObject,
2690 out ListOfGO theClosedWires,
2691 out ListOfGO theOpenWires);
2694 * Change orientation of the given object.
2695 * \param theObject Shape to be processed.
2696 * \return New GEOM_Object, containing processed shape.
2698 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2699 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2704 * GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2707 interface GEOM_IInsertOperations : GEOM_IOperations
2710 * Create a copy of the given object
2712 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2715 * Export the given shape into a file with given name.
2716 * \param theObject Shape to be stored in the file.
2717 * \param theFileName Name of the file to store the given shape in.
2718 * \param theFormatName Specify format for the shape storage.
2719 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2721 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2724 * Import a shape from the BRep or IGES or STEP file
2725 * (depends on given format) with given name.
2726 * \param theFileName The file, containing the shape.
2727 * \param theFormatName Specify format for the file reading.
2728 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2729 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
2730 * set to 'meter' and result model will be scaled.
2731 * \return New GEOM_Object, containing the imported shape.
2733 GEOM_Object Import (in string theFileName, in string theFormatName);
2736 * Get the supported import formats and corresponding patterns for File dialog.
2737 * \param theFormats Output. List of formats, available for import.
2738 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2739 * \return Returns available formats and patterns through the arguments.
2741 void ImportTranslators (out string_array theFormats,
2742 out string_array thePatterns);
2745 * Get the supported export formats and corresponding patterns for File dialog.
2746 * \param theFormats Output. List of formats, available for export.
2747 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2748 * \return Returns available formats and patterns through the arguments.
2750 void ExportTranslators (out string_array theFormats,
2751 out string_array thePatterns);
2754 * Load texture from file
2755 * \param theTextureFile texture file name
2756 * \return unique texture identifier
2758 long LoadTexture(in string theTextureFile);
2761 * Add texture to the study
2762 * \param theWidth texture width in pixels
2763 * \param theHeight texture height in pixels
2764 * \param theTexture texture byte array
2765 * \return unique texture identifier
2767 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
2770 * Get previously loaded texture data
2771 * \param theID texture identifier
2772 * \param theWidth texture width in pixels
2773 * \param theHeight texture height in pixels
2774 * \return texture byte array
2776 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
2779 * Get list of all avaiable texture IDs
2780 * \return list of all texture IDs avaiable for the current study
2782 ListOfLong GetAllTextures();
2786 * GEOM_IKindOfShape: namespace for shape_kind enumeration.
2788 interface GEOM_IKindOfShape
2798 SPHERE, // full sphere
2799 CYLINDER, // cylinder
2800 BOX, // box with faces, parallel to global coordinate planes
2801 ROTATED_BOX, // other box
2802 TORUS, // full torus
2804 POLYHEDRON, // solid, bounded by polygons
2805 SOLID, // other solid
2807 SPHERE2D, // spherical face (closed)
2808 CYLINDER2D, // cylindrical face with defined height
2809 TORUS2D, // toroidal face (closed)
2810 CONE2D, // conical face with defined height
2811 DISK_CIRCLE, // planar, bounded by circle
2812 DISK_ELLIPSE, // planar, bounded by ellipse
2813 POLYGON, // planar, bounded by segments
2814 PLANE, // infinite planar
2815 PLANAR, // other planar
2818 CIRCLE, // full circle
2819 ARC_CIRCLE, // arc of circle
2820 ELLIPSE, // full ellipse
2821 ARC_ELLIPSE, // arc of ellipse
2822 LINE, // infinite segment
2832 * GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
2833 * properties calculation (like Centre of Mass, Inertia, etc.).
2836 interface GEOM_IMeasureOperations : GEOM_IOperations
2839 * Get kind of theShape.
2840 * \param theShape Shape to get a kind of.
2841 * \param theIntegers Output. Integer and enumerated shape's parameters
2842 * (kind of surface, closed/unclosed, number of edges, etc.)
2843 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
2844 * \note Concrete meaning of each value, returned via \a theIntegers
2845 * or \a theDoubles list depends on the kind of the shape.
2846 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
2848 //short KindOfShape (in GEOM_Object theShape,
2849 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
2850 out ListOfLong theIntegers,
2851 out ListOfDouble theDoubles);
2854 * Get position (LCS) of theShape.
2855 * \param theShape Shape to calculate position of.
2856 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
2857 * Origin of the LCS is situated at the shape's center of mass.
2858 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
2859 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
2860 * Axes of the LCS are obtained from shape's location or,
2861 * if the shape is a planar face, from position of its plane.
2862 * \return Returns position of the shape through the last nine arguments.
2864 void GetPosition (in GEOM_Object theShape,
2865 out double Ox, out double Oy, out double Oz,
2866 out double Zx, out double Zy, out double Zz,
2867 out double Xx, out double Xy, out double Xz);
2870 * Get summarized length of all wires,
2871 * area of surface and volume of the given shape.
2872 * \param theShape Shape to define properties of.
2873 * \param theLength Output. Summarized length of all wires of the given shape.
2874 * \param theSurfArea Output. Area of surface of the given shape.
2875 * \param theVolume Output. Volume of the given shape.
2876 * \return Returns shape properties through the last three arguments.
2878 void GetBasicProperties (in GEOM_Object theShape,
2879 out double theLength,
2880 out double theSurfArea,
2881 out double theVolume);
2884 * Get a point, situated at the centre of mass of theShape.
2885 * \param theShape Shape to define centre of mass of.
2886 * \return New GEOM_Object, containing the created point.
2888 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
2892 * Get the vertex by index for 1D objects depends the edge/wire orientation
2893 * \param theShape Shape (wire or edge) to find the vertex on it
2894 * \param theIndex Index of vertex subshape
2895 * \return New GEOM_Object, vertex.
2897 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
2900 * Get a vector, representing the normal of theFace.
2901 * If the face is not planar, theOptionalPoint is obligatory.
2902 * \param theFace Shape (face) to define the normal of.
2903 * \param theOptionalPoint Shape (point) to define the normal at.
2904 * Can be NULL in case of planar face.
2905 * \return New GEOM_Object, containing the created normal vector.
2907 GEOM_Object GetNormal (in GEOM_Object theFace,
2908 in GEOM_Object theOptionalPoint);
2911 * Get inertia matrix and moments of inertia of theShape.
2912 * \param theShape Shape to calculate inertia of.
2913 * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
2914 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
2915 * \return Returns inertia through the last twelve arguments.
2917 void GetInertia (in GEOM_Object theShape,
2918 out double I11, out double I12, out double I13,
2919 out double I21, out double I22, out double I23,
2920 out double I31, out double I32, out double I33,
2921 out double Ix , out double Iy , out double Iz);
2924 * Get parameters of bounding box of the given shape
2925 * \param theShape Shape to obtain bounding box of.
2926 * \param Xmin,Xmax Output. Limits of shape along OX axis.
2927 * \param Ymin,Ymax Output. Limits of shape along OY axis.
2928 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
2929 * \return Returns parameters of bounding box through the last six arguments.
2931 void GetBoundingBox (in GEOM_Object theShape,
2932 out double Xmin, out double Xmax,
2933 out double Ymin, out double Ymax,
2934 out double Zmin, out double Zmax);
2937 * Get min and max tolerances of sub-shapes of theShape
2938 * \param theShape Shape, to get tolerances of.
2939 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
2940 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
2941 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
2942 * \return Returns shape tolerances through the last six arguments.
2944 void GetTolerance (in GEOM_Object theShape,
2945 out double FaceMin, out double FaceMax,
2946 out double EdgeMin, out double EdgeMax,
2947 out double VertMin, out double VertMax);
2950 * Check a topology of the given shape.
2951 * \param theShape Shape to check validity of.
2952 * \param theDescription Output. Description of problems in the shape, if they are.
2953 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
2955 boolean CheckShape (in GEOM_Object theShape,
2956 out string theDescription);
2959 * Check a topology and a geometry of the given shape.
2960 * \param theShape Shape to check validity of.
2961 * \param theDescription Output. Description of problems in the shape, if they are.
2962 * \return TRUE, if the shape "seems to be valid".
2964 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
2965 out string theDescription);
2968 * Obtain description of the given shape
2969 * \param theShape Shape to be described.
2970 * \return Description of the given shape.
2972 string WhatIs (in GEOM_Object theShape);
2975 * Get minimal distance between the given shapes.
2976 * \param theShape1,theShape2 Shapes to find minimal distance between.
2977 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
2978 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
2979 * \return Value of the minimal distance between the given shapes.
2981 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
2982 out double X1, out double Y1, out double Z1,
2983 out double X2, out double Y2, out double Z2);
2986 * Get angle between the given lines or linear edges.
2987 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
2988 * \return Value of the angle between the given shapes.
2990 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
2993 * Get point coordinates
2995 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
2998 * Get radius of curvature of curve in the point determinated by param
2999 * \param theShape - curve.
3000 * \param theParam - parameter on curve
3001 * \return Value of curvature.
3003 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3006 * Get radius of curvature of curve in the given point
3007 * \param theShape - curve.
3008 * \param thePoint - point
3009 * \return Value of curvature.
3011 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3014 * Get max radius of curvature of surface in the point determinated by params
3015 * \param theShape - surface.
3016 * \param theUParam - U-parameter on surface
3017 * \param theVParam - V-parameter on surface
3018 * \return Value of curvature.
3020 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3021 in double theVParam);
3024 * Get max radius of curvature of surface in the given point
3025 * \param theShape - surface.
3026 * \param thePoint - point
3027 * \return Value of curvature.
3029 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3032 * Get min radius of curvature of surface in the point determinated by params
3033 * \param theShape - surface.
3034 * \param theUParam - U-parameter on surface
3035 * \param theVParam - V-parameter on surface
3036 * \return Value of curvature.
3038 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3039 in double theVParam);
3042 * Get min radius of curvature of surface in the given point
3043 * \param theShape - surface.
3044 * \param thePoint - point
3045 * \return Value of curvature.
3047 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3053 * GEOM_IGroupOperations: Interface for groups creation.
3055 interface GEOM_IGroupOperations : GEOM_IOperations
3058 * Creates a new group which will store sub shapes of theMainShape
3059 * \param theMainShape is a GEOM object on which the group is selected
3060 * \param theShapeType defines a shape type of the group
3061 * \return a newly created GEOM group
3063 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3066 * Adds a sub object with ID theSubShapeId to the group
3067 * \param theGroup is a GEOM group to which the new sub shape is added
3068 * \param theSubShapeId is a sub shape ID in the main object.
3069 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3071 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3074 * Removes a sub object with ID \a theSubShapeId from the group
3075 * \param theGroup is a GEOM group from which the sub shape is removed.
3076 * \param theSubShapeId is a sub shape ID in the main object.
3077 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3079 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3082 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3083 * \param theGroup is a GEOM group to which the new sub shapes are added.
3084 * \param theSubShapes is a list of sub shapes to be added.
3086 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3089 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3090 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3091 * \param theSubShapes is a list of sub-shapes to be removed.
3093 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3096 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3097 * \param theGroup is a GEOM group to which the new sub shapes are added.
3098 * \param theSubShapes is a list of IDs of sub shapes to be added.
3100 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3103 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3104 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3105 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3107 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3110 * Returns a type of sub objects stored in the group
3111 * \param theGroup is a GEOM group which type is returned.
3113 long GetType (in GEOM_Object theGroup);
3116 * Returns a main shape associated with the group
3117 * \param theGroup is a GEOM group for which a main shape object is requested
3118 * \return a GEOM object which is a main shape for theGroup
3120 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3123 * Returns a list of sub objects ID stored in the group
3124 * \param theGroup is a GEOM group for which a list of IDs is requested
3126 ListOfLong GetObjects (in GEOM_Object theGroup);
3131 * GEOM_IAdvancedOperations: Interface for advanced modeling functions.
3133 interface GEOM_IAdvancedOperations : GEOM_IOperations
3135 /*@@ insert new functions before this line @@*/
3139 * GEOM_Gen: Interface to access other GEOM interfaces.
3140 * Also contains some methods to access and manage GEOM objects.
3142 interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
3145 * Undo/Redo Management
3148 void Undo (in long theStudyID);
3150 void Redo (in long theStudyID);
3153 * Publishing management
3154 * Adds in theStudy a object theObject under with a name theName,
3155 * if theFather is not NULL the object is placed under thFather's SObject.
3156 * Returns a SObject where theObject is placed
3158 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3159 in GEOM_Object theObject,
3161 in GEOM_Object theFather);
3164 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3165 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3166 * \param theStudy the study, in which theObject is published already,
3167 * and in which the arguments will be published
3168 * \param theObject published GEOM object, arguments of which will be published
3169 * \param theArgs list of GEOM_Object, operation arguments to be published.
3170 * If this list is empty, all operation arguments will be published
3171 * \param theFindMethod method to search subshapes, corresponding to arguments and
3172 * their subshapes. Value from enumeration GEOM::find_shape_method.
3173 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3174 * Do not publish subshapes in place of arguments, but only
3175 * in place of subshapes of the first argument,
3176 * because the whole shape corresponds to the first argument.
3177 * Mainly to be used after transformations, but it also can be
3178 * usefull after partition with one object shape, and some other
3179 * operations, where only the first argument has to be considered.
3180 * If theObject has only one argument shape, this flag is automatically
3181 * considered as True, not regarding really passed value.
3182 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3183 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3184 * \return list of published sub-shapes
3186 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
3187 in GEOM_Object theObject,
3188 in ListOfGO theArgs,
3189 in find_shape_method theFindMethod,
3190 in boolean theInheritFirstArg,
3191 in boolean theAddPrefix);
3194 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3195 * To be used from GUI and from geompy.addToStudy.
3196 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
3197 * \param theSObject study object, referencing GEOM object, arguments of which will be published
3199 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
3200 in SALOMEDS::SObject theSObject,
3201 in ListOfGO theArgs,
3202 in find_shape_method theFindMethod,
3203 in boolean theInheritFirstArg,
3204 in boolean theAddPrefix);
3207 * Methods to access interfaces for objects creation and transformation
3209 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3210 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
3211 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3212 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3213 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3214 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3215 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3216 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3217 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3218 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3219 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3220 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3221 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3224 * Objects Management
3228 * Removes the object from the GEOM component
3229 * \param theObject is a GEOM object to be removed
3231 void RemoveObject (in GEOM_Object theObject);
3234 * Returns an object defined by the study and its entry in the GEOM component
3235 * \param theStudyID is a SALOMEDS Study ID
3236 * \param theEntry is an entry of the requested GEOM object in the GEOM component
3237 * \note if the object has not previously been created a NULL GEOM object is returned
3239 GEOM_Object GetObject (in long theStudyID, in string theEntry);
3242 * Add a sub shape defined by indices in \a theIndices
3243 * (contains unique IDs of sub shapes inside theMainShape)
3244 * \note The sub shape GEOM_Objects can has ONLY ONE function.
3245 * Don't try to apply modification operations on them.
3246 * \note Internal method
3248 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
3251 * GEOM object's IOR Management
3255 * Returns a GEOM Object defined by its IOR
3256 * \param theIOR a string containg an IOR of the requested GEOM object
3258 GEOM_Object GetIORFromString (in string theIOR);
3261 * Returns a string which contains an IOR of the GEOM object
3262 * \param theObject is a GEOM object which IOR is requested
3264 string GetStringFromIOR (in GEOM_Object theObject);
3267 * Returns a name with which a GEOM object was dumped into python script
3268 * \param theStudyEntry is an entry of the GEOM object in the study
3270 string GetDumpName (in string theStudyEntry);
3273 * Returns all names with which a GEOM objects was dumped
3274 * into python script to avoid the same names in SMESH script
3276 string_array GetAllDumpNames();
3279 * Publishes the named subshapes of given object in the study.
3280 * \param theStudy The study in which the object is published
3281 * \param theObject The object which named subshapes are published
3283 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
3284 //in SObject theSObject,
3285 in Object theObject);