1 // Copyright (C) 2007-2012 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 * \brief Topological types of shapes (like Open Cascade types)
44 /*! A collection of solids */
46 /*! A part of 3D space bound by a shell */
48 /*! A collection of faces connected by some edges of their wire boundaries */
50 /*! Part of a plane (in 2D geometry) or a surface (in 3D geometry) bounded by a close wire */
52 /*! A sequence of edges connected by their vertices */
54 /*! Edge, a shape corresponding to a curve, and bound by a vertex at each extremity */
56 /*! A zero-dimensional shape corresponding to a point in geometry */
64 enum marker_type { MT_NONE, MT_POINT, MT_PLUS, MT_STAR, MT_O, MT_X, MT_O_POINT, MT_O_PLUS,
65 MT_O_STAR, MT_O_X, MT_BALL, MT_RING1, MT_RING2, MT_RING3, MT_USER };
70 enum marker_size { MS_NONE, MS_10, MS_15, MS_20, MS_25, MS_30, MS_35,
71 MS_40, MS_45, MS_50, MS_55, MS_60, MS_65, MS_70 };
74 * \brief State of shape relatively geometrical surface like plane, sphere or cylinder.
76 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
80 /*! Shape is on surface */
84 * Shape is in the direction defined by the normal and not on surface.
85 * For plane it means above the plane,
86 * For sphere and cylinder it means outside of volume, bounded by the surface.
91 * Shape is in the direction defined by the normal and on surface.
97 * Complementary to ONOUT.
98 * For plane it means below the plane,
99 * For sphere and cylinder it means inside the volume, bounded by the surface
100 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
105 * Complementary to OUT.
112 * \brief Kind of method to find inside one main shape some sub-shapes,
113 * corresponding to other given shape (its argument)
115 * Is used in functions GEOM_Gen.RestoreSubShapesO(), GEOM_Gen.RestoreSubShapesSO()
117 enum find_shape_method
119 /*! Use GetInPlace functionality. Suits all cases, except transformations */
122 /*! To be used only for transformation result, to find sub-shapes of argument.
123 * Only this method can be used after transformation.
127 /*! To find only shared sub-shapes, not modified by the operation */
130 /*! Use GetShapesOnShape method (can work only on solids) */
131 FSM_GetShapesOnShape,
133 /*! Use GetInPlaceByHistory method (can work only after Partition) */
134 FSM_GetInPlaceByHistory,
136 /*! To be used only for multi-transformation result.
137 * Only this method can be used after multi-transformation.
143 * \brief Kind of method to perform filling operation
145 * Is used in functions GEOM_I3DPrimOperations.MakeFilling()
147 enum filling_oper_method
149 /*! Default (standard behaviour) */
152 /*! Use edges orientation - orientation of edges is used: if the edge is
153 * reversed, the curve from this edge is reversed before using it in
154 * the filling algorithm.
158 /*! Auto-correct edges orientation - changes the orientation of the curves
159 * using minimization of sum of distances between the end points of the edges.
165 * \brief Kind of the curves.
167 * Used in the functions GEOM_ICurvesOperations.MakeCurveParametric(), GEOM_ICurvesOperations.MakeCurveParametricNew()
170 /*! Polyline curve */
176 /*! Interpolation, curve */
181 typedef sequence<string> string_array;
182 typedef sequence<short> short_array;
183 typedef sequence<boolean> ListOfBool;
184 typedef sequence<long> ListOfLong;
185 typedef sequence<double> ListOfDouble;
187 interface GEOM_Object;
189 typedef sequence<GEOM_Object> ListOfGO;
193 * \brief Interface of geometric object
195 interface GEOM_Object : SALOME::GenericObj
199 * \brief Get an entry of the object in GEOM component.
204 * \brief Get ID of study, where the object is created.
209 * \brief Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
214 * \brief Get a <VAR>shape_type</VAR> of the object value.
216 shape_type GetShapeType();
219 * \brief Get the topology type of the object value.
221 * In contrast to the shape type, this function returns type of the most
222 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
226 shape_type GetTopologyType();
229 * \brief Get a minimal type of the top-level shapes contained in the object.
231 * This function is useful for the compounds only; for simple shapes it
232 * exactly the same value as GetShapeType().
233 * Note, that compounds are procesed recursively.
235 * \sa GetShapeType(), GetTopologyType(), GetMaxShapeType()
237 shape_type GetMinShapeType();
240 * \brief Get a maximal type of the top-level shapes contained in the object.
242 * This function is useful for the compounds only; for simple shapes it
243 * exactly the same value as GetShapeType().
244 * Note, that compounds are procesed recursively.
246 * \sa GetShapeType(), GetTopologyType(), GetMinShapeType()
248 shape_type GetMaxShapeType();
251 * \brief Set name of the object.
253 * \param theName is a name which will be associated with this object.
255 void SetName (in string theName);
258 * \brief Get name of the object associated with this object.
263 * \brief Set color of the object.
265 * \param theColor is a color of the object.
267 void SetColor(in SALOMEDS::Color theColor);
270 * Get color of the object.
272 SALOMEDS::Color GetColor();
275 * Toggle auto color mode on the object.
276 * \param theAutoColor is a flag which toggles auto color mode.
278 void SetAutoColor(in boolean theAutoColor);
281 * \brief Get flag of object's auto color mode.
283 boolean GetAutoColor();
286 * \brief Set standard point marker for the object
287 * \param theType standard marker type
288 * \param theSize marker relative size
290 void SetMarkerStd(in marker_type theType, in marker_size theSize );
293 * \brief Set custom point marker for the object.
295 * The texture can be added by LoadTexture() or AddTexture() functions.
296 * \param theTextureId texture ID
298 void SetMarkerTexture(in long theTextureId);
301 * \brief Get type of the point marker assigned to the object
302 * \return current marker type (MT_NONE if no marker is set)
304 marker_type GetMarkerType();
307 * \brief Get size of the point marker assigned to the object
308 * \return current marker relative size (MS_NONE if no marker is set)
310 marker_size GetMarkerSize();
313 * \brief Get texture idenifier of the point marker assigned to the object
314 * \return marker texture ID (0 if no marker set)
316 long GetMarkerTexture();
319 * \brief Set a Study entry where this object was published.
321 void SetStudyEntry (in string theEntry);
324 * \brief Get a Study entry where this object was published.
326 string GetStudyEntry();
329 * \brief Get a list of all GEOM_Object on which were the arguments
330 * when this object was constructed and modified.
331 * \note This method is supposed to be used by GUI only.
333 ListOfGO GetDependency();
336 * \brief Get a list of GEOM_Object on which the last function that created or modified the object depends.
337 * \note This method is supposed to be used by GUI only.
339 ListOfGO GetLastDependency();
342 * \brief Get the TopoDS_Shape, for colocated case only.
344 long long getShape();
346 // ######################################################################
347 // # Internal methods (For sub-shape identification)
348 // ######################################################################
350 * \brief Get geometric shape of the object as a byte stream
352 SALOMEDS::TMPFile GetShapeStream();
355 * \brief Returns True if this object is not a sub-shape of another object.
357 boolean IsMainShape();
360 * \brief Get a list of ID's of sub-shapes in the main shape.
361 * \note Internal method, suppopsed to be used only by GEOM_Client
363 ListOfLong GetSubShapeIndices();
366 * \brief Get a main shape object to which this object is a sub-shape
367 * \note Internal method, suppopsed to be used only by GEOM_Client
369 GEOM_Object GetMainShape();
372 * \brief Return true if geom object representes a shape.
374 * For example, method return false for GEOM_MARKER
379 * \brief Return true if passed object is identical to this object
381 * \param other object being compared with this one
383 boolean IsSame(in GEOM_Object other);
386 * Set list of parameters
387 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
388 * used for object creation
390 void SetParameters (in string theParameters);
393 * \brief Return list of notebook variables used for object creation separated by ":" symbol
395 string GetParameters();
398 // # GEOM_IOperations:
400 * \brief Basic methods of all geometric operations
402 interface GEOM_IOperations : SALOME::GenericObj
405 * \brief To know, if the operation was successfully performed
410 * \brief Set the operation error code
411 * \param theErrorID is a string describing the error occured
412 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
414 void SetErrorCode (in string theErrorID);
417 * \brief Get the operation error code
419 string GetErrorCode();
422 * \brief Get ID of study, where the operation is defined
427 * \brief Opens a new transaction
429 void StartOperation();
432 * \brief Closes the previously opened trasaction
434 void FinishOperation();
437 * \brief Aborts the previously opened transaction
439 void AbortOperation();
441 //# GEOM_IBasicOperations:
443 * \brief Interface for basic geometry creation
445 * (Point, Vector, Plane, Marker)
447 interface GEOM_IBasicOperations : GEOM_IOperations
450 * \brief Create point by three coordinates.
451 * \param theX The X coordinate of the point.
452 * \param theY The Y coordinate of the point.
453 * \param theZ The Z coordinate of the point.
454 * \return New GEOM_Object, containing the created point.
456 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
459 * \brief Create a point, distant from the referenced point
460 * on the given distances along the coordinate axes.
461 * \param theReference The referenced point.
462 * \param theX Displacement from the referenced point along OX axis.
463 * \param theY Displacement from the referenced point along OY axis.
464 * \param theZ Displacement from the referenced point along OZ axis.
465 * \return New GEOM_Object, containing the created point.
467 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
468 in double theX, in double theY, in double theZ);
471 * Create a point, corresponding to the given parameter on the given curve.
472 * \param theRefCurve The referenced curve.
473 * \param theParameter Value of parameter on the referenced curve.
474 * \return New GEOM_Object, containing the created point.
476 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
477 in double theParameter);
480 * \brief Create a point, corresponding to the given length on the given curve.
481 * \param theRefCurve The referenced curve.
482 * \param theLength Length on the referenced curve. It can be negative.
483 * \param theStartPoint Any vertex close to one of edge's
484 * ends to select start point among them.
485 * If NULL, fist vertex is used.
486 * \return New GEOM_Object, containing the created point.
488 GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve,
490 in GEOM_Object theStartPoint);
493 * \brief Create a point on the given curve, projecting given point
494 * \param theRefCurve The referenced curve.
495 * \param theXParameter X co-ordinate of point to project on curve
496 * \param theYParameter Y co-ordinate of point to project on curve
497 * \param theZParameter Z co-ordinate of point to project on curve
498 * \return New GEOM_Object, containing the created point.
500 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
501 in double theXParameter,
502 in double theYParameter,
503 in double theZParameter);
506 * \brief Create a point, corresponding to the given parameters on the
508 * \param theRefSurf The referenced surface.
509 * \param theUParameter Value of U-parameter on the referenced surface.
510 * \param theVParameter Value of V-parameter on the referenced surface.
511 * \return New GEOM_Object, containing the created point.
513 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
514 in double theUParameter,
515 in double theVParameter);
518 * \brief Create a point on the given surface, projecting given point
519 * \param theRefSurf The referenced surface.
520 * \param theXParameter X co-ordinate of point to project on curve
521 * \param theYParameter Y co-ordinate of point to project on curve
522 * \param theZParameter Z co-ordinate of point to project on curve
523 * \return New GEOM_Object, containing the created point.
525 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
526 in double theXParameter,
527 in double theYParameter,
528 in double theZParameter);
532 * \brief Create a point, on two lines intersection.
533 * \param theRefLine1, theRefLine2 The referenced lines.
534 * \return New GEOM_Object, containing the created point.
536 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
537 in GEOM_Object theRefLine2);
540 * \brief Create a vector, corresponding to tangent to the given parameter on the given curve.
541 * \param theRefCurve The referenced curve.
542 * \param theParameter Value of parameter on the referenced curve.This value should be have value
543 * between 0. and 1.. Value of 0. corresponds first parameter of curve; value
544 * 1. corresponds last parameter of curve.
545 * \return New GEOM_Object, containing the created point.
547 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
548 in double theParameter);
551 * \brief Create a vector with the given components.
552 * \param theDX X component of the vector.
553 * \param theDY Y component of the vector.
554 * \param theDZ Z component of the vector.
555 * \return New GEOM_Object, containing the created vector.
557 GEOM_Object MakeVectorDXDYDZ (in double theDX,
562 * \brief Create a vector between two points.
563 * \param thePnt1 Start point for the vector.
564 * \param thePnt2 End point for the vector.
565 * \return New GEOM_Object, containing the created vector.
567 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
570 * C\brief reate a line, passing through the given point
571 * and parrallel to the given direction
572 * \param thePnt Point. The resulting line will pass through it.
573 * \param theDir Direction. The resulting line will be parallel to it.
574 * \return New GEOM_Object, containing the created line.
576 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
579 * \brief Create a line, passing through the given points
580 * \param thePnt1 First of two points, defining the line.
581 * \param thePnt2 Second of two points, defining the line.
582 * \return New GEOM_Object, containing the created line.
584 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
587 * \brief Create a line, given by two faces intersection.
588 * \param theFace1 First of two faces, defining the line.
589 * \param theFace2 Second of two faces, defining the line.
590 * \return New GEOM_Object, containing the created line.
592 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
595 * \brief Create a plane, passing through the three given points
596 * \param thePnt1 First of three points, defining the plane.
597 * \param thePnt2 Second of three points, defining the plane.
598 * \param thePnt3 Fird of three points, defining the plane.
599 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
600 * \return New GEOM_Object, containing the created plane.
602 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
603 in GEOM_Object thePnt2,
604 in GEOM_Object thePnt3,
605 in double theTrimSize);
608 * \brief Create a plane, passing through the given point
609 * and normal to the given vector.
610 * \param thePnt Point, the plane has to pass through.
611 * \param theVec Vector, defining the plane normal direction.
612 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
613 * \return New GEOM_Object, containing the created plane.
615 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
616 in GEOM_Object theVec,
617 in double theTrimSize);
620 * \brief Create a plane, similar to the existing one, but with another size of representing face.
621 * \param theFace Referenced plane or LCS(Marker).
622 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
623 * \return New GEOM_Object, containing the created plane.
625 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
626 in double theTrimSize);
629 * \brief Create a plane, by two vectors.
630 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
631 * \param theVec2 Vector2, defining the plane normal direction.
632 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
633 * \return New GEOM_Object, containing the created plane.
635 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
636 in GEOM_Object theVec2,
637 in double theTrimSize);
640 * \brief Create a plane, defined by local coordinate system.
641 * \param theLCS Referenced LCS(Marker).
642 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
643 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
644 * \return New GEOM_Object, containing the created plane.
646 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
647 in double theTrimSize,
648 in double theOrientation);
651 * \brief Create a local coordinate system.
652 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
653 * \param theXDX,theXDY,theXDZ Three components of OX direction
654 * \param theYDX,theYDY,theYDZ Three components of OY direction
655 * \return New GEOM_Object, containing the created coordinate system.
657 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
658 in double theXDX, in double theXDY, in double theXDZ,
659 in double theYDX, in double theYDY, in double theYDZ);
662 * \brief Create a local coordinate system from shape.
663 * \param theShape The initial shape to detect the coordinate system.
664 * \return New GEOM_Object, containing the created coordinate system.
666 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
669 * \brief Create a local coordinate system from point and two vectors (DX, DY).
670 * \param theOrigin Point of coordinate system origin.
671 * \param theXVec Vector of X direction.
672 * \param theYVec Vector of Y direction.
673 * \return New GEOM_Object, containing the created coordinate system.
675 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin,
676 in GEOM_Object theXVec, in GEOM_Object theYVec);
679 * \brief Create a tangent plane to specified face in the point with specified parameters.
681 * Values of parameters should be between 0. and 1.0
682 * \param theFace - face for which tangent plane shuold be built.
683 * \param theParameterU - value of parameter by U
684 * \param theParameterV - value of parameter Vthe
685 * \param theTrimSize - defines sizes of created face
686 * \return New GEOM_Object, containing the face built on tangent plane.
688 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
689 in double theParameterU,
690 in double theParameterV,
691 in double theTrimSize);
694 interface GEOM_ITransformOperations : GEOM_IOperations
697 * \brief Translate the given object along the vector, specified by its end points.
698 * \param theObject The object to be translated.
699 * \param thePoint1 Start point of translation vector.
700 * \param thePoint2 End point of translation vector.
703 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
704 in GEOM_Object thePoint1,
705 in GEOM_Object thePoint2);
708 * \brief Translate the given object along the vector, specified
709 * by its end points, creating its copy before the translation.
710 * \param theObject The object to be translated.
711 * \param thePoint1 Start point of translation vector.
712 * \param thePoint2 End point of translation vector.
713 * \return New GEOM_Object, containing the translated object.
715 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
716 in GEOM_Object thePoint1,
717 in GEOM_Object thePoint2);
720 * \brief Translate the given object along the vector, specified by its components.
721 * \param theObject The object to be translated.
722 * \param theDX,theDY,theDZ Components of translation vector.
725 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
726 in double theDX, in double theDY, in double theDZ);
729 * \brief Translate the given object along the vector, specified
730 * by its components, creating its copy before the translation.
731 * \param theObject The object to be translated.
732 * \param theDX,theDY,theDZ Components of translation vector.
733 * \return New GEOM_Object, containing the translated object.
735 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
736 in double theDX, in double theDY, in double theDZ);
740 * \brief Translate the given object along the given vector.
741 * \param theObject The object to be translated.
742 * \param theVector Translation vector, giving both direction and distance.
745 GEOM_Object TranslateVector (in GEOM_Object theObject,
746 in GEOM_Object theVector);
749 * \brief Translate the given object along the given vector,
750 * creating its copy before the translation.
751 * \param theObject The object to be translated.
752 * \param theVector Translation vector, giving both direction and distance.
753 * \return New GEOM_Object, containing the translated object.
755 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
756 in GEOM_Object theVector);
759 * \brief Translate the given object along the given vector on given distance,
760 * creating its copy before the translation.
761 * \param theObject The object to be translated.
762 * \param theVector Translation vector, giving a direction.
763 * \param theDistance Translation distance, giving a distance.
764 * \param theCopy Translation copy, creating its copy if true.
765 * \return New GEOM_Object, containing the translated object.
767 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
768 in GEOM_Object theVector,
769 in double theDistance,
773 * \brief Translate the given object along the given vector a given number times
774 * \param theObject The object to be translated.
775 * \param theVector Direction of the translation.
776 * \param theStep Distance to translate on.
777 * \param theNbTimes Quantity of translations to be done.
778 * \return New GEOM_Object, containing compound of all
779 * the shapes, obtained after each translation.
781 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
782 in GEOM_Object theVector,
787 * \brief Conseqently apply two specified translations to theObject specified number of times.
788 * \param theObject The object to be translated.
789 * \param theVector1 Direction of the first translation.
790 * \param theStep1 Step of the first translation.
791 * \param theNbTimes1 Quantity of translations to be done along theVector1.
792 * \param theVector2 Direction of the second translation.
793 * \param theStep2 Step of the second translation.
794 * \param theNbTimes2 Quantity of translations to be done along theVector2.
795 * \return New GEOM_Object, containing compound of all
796 * the shapes, obtained after each translation.
798 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
799 in GEOM_Object theVector1,
802 in GEOM_Object theVector2,
804 in long theNbTimes2);
807 * \brief Rotate given object around vector perpendicular to plane containing three points.
808 * \param theObject The object to be rotated.
809 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
810 * containing the three points.
811 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
814 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
815 in GEOM_Object theCentPoint,
816 in GEOM_Object thePoint1,
817 in GEOM_Object thePoint2);
821 * \brief Rotate given object around vector perpendicular to plane containing three points.
823 * Creating its copy before the rotatation.
824 * \param theObject The object to be rotated.
825 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
826 * containing the three points.
827 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
828 * \return New GEOM_Object, containing the rotated object.
830 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
831 in GEOM_Object theCentPoint,
832 in GEOM_Object thePoint1,
833 in GEOM_Object thePoint2);
836 * \brief Rotate the given object around the given axis on the given angle.
837 * \param theObject The object to be rotated.
838 * \param theAxis Rotation axis.
839 * \param theAngle Rotation angle in radians.
842 GEOM_Object Rotate (in GEOM_Object theObject,
843 in GEOM_Object theAxis,
848 * Rotate the given object around the given axis
849 * on the given angle, creating its copy before the rotatation.
850 * \param theObject The object to be rotated.
851 * \param theAxis Rotation axis.
852 * \param theAngle Rotation angle in radians.
853 * \return New GEOM_Object, containing the rotated object.
855 GEOM_Object RotateCopy (in GEOM_Object theObject,
856 in GEOM_Object theAxis,
861 * \brief Rotate the given object around the given axis a given number times.
863 * Rotation angle will be 2*PI/theNbTimes.
864 * \param theObject The object to be rotated.
865 * \param theAxis The rotation axis.
866 * \param theNbTimes Quantity of rotations to be done.
867 * \return New GEOM_Object, containing compound of all the
868 * shapes, obtained after each rotation.
870 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
871 in GEOM_Object theAxis,
875 * \brief Rotate the given object around the
876 * given axis on the given angle a given number
877 * times and multi-translate each rotation result.
879 * Translation direction passes through center of gravity
880 * of rotated shape and its projection on the rotation axis.
881 * \param theObject The object to be rotated.
882 * \param theAxis Rotation axis.
883 * \param theAngle Rotation angle in graduces.
884 * \param theNbTimes1 Quantity of rotations to be done.
885 * \param theStep Translation distance.
886 * \param theNbTimes2 Quantity of translations to be done.
887 * \return New GEOM_Object, containing compound of all the
888 * shapes, obtained after each transformation.
890 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
891 in GEOM_Object theAxis,
895 in long theNbTimes2);
898 * \brief Replace the given object by an object,
899 * symmetrical to it relatively the given plane.
900 * \param theObject The object to be mirrored.
901 * \param thePlane Plane of symmetry.
903 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
906 * \brief Create an object, symmetrical
907 * to the given one relatively the given plane.
908 * \param theObject The object to be mirrored.
909 * \param thePlane Plane of symmetry.
910 * \return New GEOM_Object, containing the mirrored shape.
912 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
915 * \brief Replace the given object by an object,
916 * symmetrical to it relatively the given axis.
917 * \param theObject The object to be mirrored.
918 * \param theAxis Axis of symmetry.
921 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
924 * \brief Create an object, symmetrical
925 * to the given one relatively the given axis.
926 * \param theObject The object to be mirrored.
927 * \param theAxis Axis of symmetry.
928 * \return New GEOM_Object, containing the mirrored object.
930 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
933 * \brief Replace the given object by an object, symmetrical to it relatively the given point.
934 * \param theObject The object to be mirrored.
935 * \param thePoint Point of symmetry.
938 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
941 * \brief Create an object, symmetrical to the given one relatively the given point.
942 * \param theObject The object to be mirrored.
943 * \param thePoint Point of symmetry.
944 * \return New GEOM_Object, containing the mirrored object.
946 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
949 * \brief Replace the given object by its offset.
950 * \param theObject The base object for the offset.
951 * \param theOffset Offset value.
954 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
957 * \brief Create new object as offset of the given one.
958 * \param theObject The base object for the offset.
959 * \param theOffset Offset value.
960 * \return New GEOM_Object, containing the offset object.
962 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
965 * \brief Create new object as projection of the given one on a 2D surface.
966 * \param theSource The source object for the projection. It can be a point, edge or wire.
967 * \param theTarget The target object. It can be planar or cylindrical face.
968 * \return New GEOM_Object, containing the projection.
970 GEOM_Object ProjectShapeCopy (in GEOM_Object theSource, in GEOM_Object theTarget);
973 * \brief Scale the given object by the factor.
974 * \param theObject The object to be scaled.
975 * \param thePoint Center point for scaling.
976 * \param theFactor Scaling factor value.
979 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
980 in double theFactor);
983 * \brief Scale the given object by the factor, creating its copy before the scaling.
984 * \param theObject The object to be scaled.
985 * \param thePoint Center point for scaling.
986 * \param theFactor Scaling factor value.
987 * \return New GEOM_Object, containing the scaled shape.
989 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
990 in double theFactor);
993 * \brief Scale the given object by different factors along coordinate axes.
994 * \param theObject The object to be scaled.
995 * \param thePoint Center point for scaling.
996 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
999 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
1000 in GEOM_Object thePoint,
1001 in double theFactorX,
1002 in double theFactorY,
1003 in double theFactorZ);
1006 * \brief Scale the given object by different factors along coordinate axes,
1007 * creating its copy before the scaling.
1008 * \param theObject The object to be scaled.
1009 * \param thePoint Center point for scaling.
1010 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1011 * \return New GEOM_Object, containing the scaled shape.
1013 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
1014 in GEOM_Object thePoint,
1015 in double theFactorX,
1016 in double theFactorY,
1017 in double theFactorZ);
1020 * \brief Modify the Location of the given object by LCS.
1021 * \param theObject The object to be displaced.
1022 * \param theStartLCS Coordinate system to perform displacement from it.
1023 * If \a theStartLCS is NULL, displacement
1024 * will be performed from global CS.
1025 * If \a theObject itself is used as \a theStartLCS,
1026 * its location will be changed to \a theEndLCS.
1027 * \param theEndLCS Coordinate system to perform displacement to it.
1028 * \return theObject.
1030 GEOM_Object PositionShape (in GEOM_Object theObject,
1031 in GEOM_Object theStartLCS,
1032 in GEOM_Object theEndLCS);
1035 * \brief Modify the Location of the given object by LCS,
1036 * creating its copy before the setting.
1037 * \param theObject The object to be displaced.
1038 * \param theStartLCS Coordinate system to perform displacement from it.
1039 * If \a theStartLCS is NULL, displacement
1040 * will be performed from global CS.
1041 * If \a theObject itself is used as \a theStartLCS,
1042 * its location will be changed to \a theEndLCS.
1043 * \param theEndLCS Coordinate system to perform displacement to it.
1044 * \return New GEOM_Object, containing the displaced shape.
1046 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
1047 in GEOM_Object theStartLCS,
1048 in GEOM_Object theEndLCS);
1051 * \brief Modify the Location of the given object by Path,
1052 * \param theObject The object to be displaced.
1053 * \param thePath Wire or Edge along that the object will be translated.
1054 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
1055 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
1056 * \param theReverse is a true or false parameter. true is to reverse direction, false is to move normal direction.
1057 * \return New GEOM_Object, containing the displaced shape.
1059 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
1060 in GEOM_Object thePath,
1061 in double theDistance,
1063 in boolean theReverse);
1066 * \brief Transform the shape in the same way what was used for the sample shape creation.
1067 * \param theObject The object to be transformed.
1068 * \param theSample The object containing information about required transformation.
1069 * \note Implementation of this method is limited by multi-transformations now.
1070 * \note Internal method.
1071 * \return New GEOM_Object, containing the transformed shape.
1073 GEOM_Object TransformLikeOtherCopy (in GEOM_Object theObject,
1074 in GEOM_Object theSample);
1077 * \brief Recompute the shape from its arguments.
1078 * \param theObject The object to be recomputed.
1079 * \return theObject.
1081 GEOM_Object RecomputeObject (in GEOM_Object theObject);
1084 // # GEOM_I3DPrimOperations:
1086 * \brief Interface for 3D primitives creation
1088 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
1089 * Pipe (extrusion along contour), Revolution, Solid (from shell).
1091 interface GEOM_I3DPrimOperations : GEOM_IOperations
1094 * \brief Create a box with specified dimensions along the coordinate axes
1095 * and with edges, parallel to the coordinate axes.
1097 * Center of the box will be at point (DX/2, DY/2, DZ/2).
1098 * \param theDX Length of Box edges, parallel to OX axis.
1099 * \param theDY Length of Box edges, parallel to OY axis.
1100 * \param theDZ Length of Box edges, parallel to OZ axis.
1101 * \return New GEOM_Object, containing the created box.
1103 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
1106 * \brief Create a box with two specified opposite vertices,
1107 * and with edges, parallel to the coordinate axes
1108 * \param thePnt1 First of two opposite vertices.
1109 * \param thePnt2 Second of two opposite vertices.
1110 * \return New GEOM_Object, containing the created box.
1112 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1115 * \brief Create a face specified dimensions along OX-OY coordinate axes,
1116 * with edges parallel to the coordinate axes.
1118 * Center of the face will be at point (0, 0, 0).
1119 * \param theH Height of the Face.
1120 * \param theW Width of the Face.
1121 * \param theOrientation Orientation belong axis OXY OYZ OZX
1122 * \return New GEOM_Object, containing the created face.
1124 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1126 * \brief Create a face by normale vector or edge and two specified sizes,
1127 * vertical (H) and horisontal (W).
1128 * \param theObj defines plane.
1129 * \param theH vertical size (height).
1130 * \param theW horisontal size (width).
1131 * \return New GEOM_Object, containing the created face.
1133 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1135 * \brief Create a Disk (circular face) with given center, normal vector and radius.
1136 * \param thePnt disk center.
1137 * \param theVec Vector, normal to the plane of the disk.
1138 * \param theR Disk radius.
1139 * \return New GEOM_Object, containing the created disk.
1141 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1142 in GEOM_Object theVec,
1145 * \brief Create a disk (circular face), passing through three given points
1146 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1147 * \return New GEOM_Object, containing the created disk.
1149 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1150 in GEOM_Object thePnt2,
1151 in GEOM_Object thePnt3);
1154 * \brief Create a disk specified dimensions along OX-OY coordinate axes.
1156 * Center of the disk at point (0, 0, 0).
1157 * \param theR of the Disk.
1158 * \param theOrientation Orientation belong axis OXY OYZ OZX
1159 * \return New GEOM_Object, containing the created disk.
1161 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1164 * \brief Create a cylinder with given radius and height at
1165 * the origin of coordinate system.
1167 * Axis of the cylinder will be collinear to the OZ axis of the coordinate system.
1168 * \param theR Cylinder radius.
1169 * \param theH Cylinder height.
1170 * \return New GEOM_Object, containing the created cylinder.
1172 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1175 * \brief Create a cylinder with given base point, axis, radius and height.
1176 * \param thePnt Central point of cylinder base.
1177 * \param theAxis Cylinder axis.
1178 * \param theR Cylinder radius.
1179 * \param theH Cylinder height.
1180 * \return New GEOM_Object, containing the created cylinder.
1182 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1183 in GEOM_Object theAxis,
1188 * \brief Create a cone with given height and radiuses at
1189 * the origin of coordinate system.
1191 * Axis of the cone will be collinear to the OZ axis of the coordinate system.
1192 * \param theR1 Radius of the first cone base.
1193 * \param theR2 Radius of the second cone base.
1194 * \note If both radiuses are non-zero, the cone will be truncated.
1195 * \note If the radiuses are equal, a cylinder will be created instead.
1196 * \param theH Cone height.
1197 * \return New GEOM_Object, containing the created cone.
1199 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1202 * \brief Create a cone with given base point, axis, height and radiuses.
1203 * \param thePnt Central point of the first cone base.
1204 * \param theAxis Cone axis.
1205 * \param theR1 Radius of the first cone base.
1206 * \param theR2 Radius of the second cone base.
1207 * \note If both radiuses are non-zero, the cone will be truncated.
1208 * \note If the radiuses are equal, a cylinder will be created instead.
1209 * \param theH Cone height.
1210 * \return New GEOM_Object, containing the created cone.
1212 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1213 in GEOM_Object theAxis,
1219 * \brief Create a torus with given radiuses at the origin of coordinate system.
1220 * \param theRMajor Torus major radius.
1221 * \param theRMinor Torus minor radius.
1222 * \return New GEOM_Object, containing the created torus.
1224 GEOM_Object MakeTorusRR (in double theRMajor,
1225 in double theRMinor);
1228 * \brief Create a torus with given center, normal vector and radiuses.
1229 * \param thePnt Torus central point.
1230 * \param theVec Torus axis of symmetry.
1231 * \param theRMajor Torus major radius.
1232 * \param theRMinor Torus minor radius.
1233 * \return New GEOM_Object, containing the created torus.
1235 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1236 in GEOM_Object theVec,
1237 in double theRMajor,
1238 in double theRMinor);
1241 * \brief Create a sphere with given radius at the origin of coordinate system.
1242 * \param theR Sphere radius.
1243 * \return New GEOM_Object, containing the created sphere.
1245 GEOM_Object MakeSphereR (in double theR);
1248 * \brief Create a sphere with given center and radius.
1249 * \param thePnt Sphere center.
1250 * \param theR Sphere radius.
1251 * \return New GEOM_Object, containing the created .
1253 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1256 * \brief Create a shape by extrusion of the base shape along the vector
1258 * All the space, transfixed by the base shape during its translation
1259 * along the vector on the given distance.
1260 * \param theBase Base shape to be extruded.
1261 * \param theVec Direction of extrusion.
1262 * \param theH Prism dimension along theVec.
1263 * \return New GEOM_Object, containing the created prism.
1265 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1266 in GEOM_Object theVec,
1268 /* \brief The Same Prism but in 2 directions (forward&backward) */
1269 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1270 in GEOM_Object theVec,
1272 /* \brief The Same as MakePrismVecH but with scaling */
1273 GEOM_Object MakePrismVecHWithScaling (in GEOM_Object theBase,
1274 in GEOM_Object theVec,
1276 in double theScaleFactor);
1279 * \brief Create a shape by extrusion of the base shape along a vector, defined by two points.
1280 * \param theBase Base shape to be extruded.
1281 * \param thePoint1 First end of extrusion vector.
1282 * \param thePoint2 Second end of extrusion vector.
1283 * \return New GEOM_Object, containing the created prism.
1285 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1286 in GEOM_Object thePoint1,
1287 in GEOM_Object thePoint2);
1288 /* \brief The same prism but in two directions forward&backward */
1289 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1290 in GEOM_Object thePoint1,
1291 in GEOM_Object thePoint2);
1292 /* \brief The Same as MakePrismTwoPnt but with scaling */
1293 GEOM_Object MakePrismTwoPntWithScaling (in GEOM_Object theBase,
1294 in GEOM_Object thePoint1,
1295 in GEOM_Object thePoint2,
1296 in double theScaleFactor);
1299 * \brief Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1300 * \param theBase Base shape to be extruded.
1301 * \param theDX, theDY, theDZ end of extrusion vector.
1302 * \return New GEOM_Object, containing the created prism.
1304 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1305 in double theDX, in double theDY, in double theDZ);
1306 /* \brief The same prism but in two directions forward&backward */
1307 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1308 in double theDX, in double theDY, in double theDZ);
1309 /* \brief The Same as MakePrismDXDYDZ but with scaling */
1310 GEOM_Object MakePrismDXDYDZWithScaling (in GEOM_Object theBase,
1311 in double theDX, in double theDY, in double theDZ,
1312 in double theScaleFactor);
1316 * \brief Add / Remove material to / from a solid by extrusion of the base shape on the given distance.
1317 * \param theInitShape Initial shape on which to perform the feature.It has to be a solid or
1318 * a compound made of a single solid
1319 * \param theBase Edge or wire defining the base shape to be extruded.
1320 * \param theHeight Prism dimension along the normal of the face.
1321 * \param theAngle Draft angel in degrees
1322 * \param theFuse If true material is added else material is removed
1323 * \return New GEOM_Object, containing the modified shape
1325 GEOM_Object MakeDraftPrism (in GEOM_Object theInitShape,
1326 in GEOM_Object theBase,
1327 in double theHeight,
1329 in boolean theFuse);
1332 * \brief Create a shape by extrusion of the base shape along
1333 * the path shape. The path shape can be a wire or an edge.
1334 * \param theBase Base shape to be extruded.
1335 * \param thePath Path shape to extrude the base shape along it.
1336 * \return New GEOM_Object, containing the created pipe.
1338 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1341 * \brief Create a shape by revolution of the base shape around the axis
1342 * on the given angle.
1344 * All the space, transfixed by the base
1345 * shape during its rotation around the axis on the given angle.
1346 * \param theBase Base shape to be rotated.
1347 * \param theAxis Rotation axis.
1348 * \param theAngle Rotation angle in radians.
1349 * \return New GEOM_Object, containing the created revolution.
1351 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1352 in GEOM_Object theAxis,
1353 in double theAngle);
1354 /* The Same Revolution but in both ways forward&backward */
1355 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1356 in GEOM_Object theAxis,
1357 in double theAngle);
1360 * \brief Create a filling from the given compound of contours.
1361 * \param theShape Initial shape on which to perform the feature.
1362 * \param theMinDeg a minimal degree of BSpline surface to create
1363 * \param theMaxDeg a maximal degree of BSpline surface to create
1364 * \param theTol2D a 2d tolerance to be reached
1365 * \param theTol3D a 3d tolerance to be reached
1366 * \param theNbIter a number of iteration of approximation algorithm
1367 * \param theMethod Kind of method to perform filling operation.
1368 * \param theApprox Boolean indicating if result should be approximated
1369 * \return New GEOM_Object, containing the created filling surface.
1371 GEOM_Object MakeFilling (in GEOM_Object theShape,
1372 in long theMinDeg, in long theMaxDeg,
1373 in double theTol2D, in double theTol3D,
1375 in filling_oper_method theMethod,
1376 in boolean theApprox);
1379 * \brief Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1380 * \param theSeqSections - set of specified sections.
1381 * \param theModeSolid - mode defining building solid or shell
1382 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1383 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1384 * \return New GEOM_Object, containing the created shell or solid.
1386 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1387 in boolean theModeSolid,
1389 in boolean theRuled);
1392 * \brief Create a shape by extrusion of the profile shape along
1395 * The path shape can be a wire or an edge.
1396 * the several profiles can be specified in the several locations of path.
1397 * \param theSeqBases - list of Bases shape to be extruded.
1398 * \param theLocations - list of locations on the path corresponding
1399 * specified list of the Bases shapes. Number of locations
1400 * should be equal to number of bases or list of locations can be empty.
1401 * \param thePath - Path shape to extrude the base shape along it.
1402 * \param theWithContact - the mode defining that the section is translated to be in
1403 * contact with the spine.
1404 * \param theWithCorrection - defining that the section is rotated to be
1405 * orthogonal to the spine tangent in the correspondent point
1406 * \return New GEOM_Object, containing the created pipe.
1408 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1409 in ListOfGO theLocations,
1410 in GEOM_Object thePath,
1411 in boolean theWithContact ,
1412 in boolean theWithCorrection );
1415 * \brief Create a shape by extrusion of the profile shape along
1418 * The path shape can be a shell or a face.
1419 * the several profiles can be specified in the several locations of path.
1420 * \param theSeqBases - list of Bases shape to be extruded.
1421 * \param theSeqSubBases - list of corresponding sub-shapes of section shapes.
1422 * \param theLocations - list of locations on the path corresponding
1423 * specified list of the Bases shapes. Number of locations
1424 * should be equal to number of bases.
1425 * \param thePath - Path shape to extrude the base shape along it.
1426 * \param theWithContact - the mode defining that the section is translated to be in
1427 * contact with the spine.
1428 * \param theWithCorrection - defining that the section is rotated to be
1429 * orthogonal to the spine tangent in the correspondent point
1430 * \return New GEOM_Object, containing the created pipe.
1432 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1433 in ListOfGO theSeqSubBases,
1434 in ListOfGO theLocations,
1435 in GEOM_Object thePath,
1436 in boolean theWithContact ,
1437 in boolean theWithCorrection );
1440 * \brief Create solids between given sections
1441 * \param theSeqBases - list of sections (shell or face).
1442 * \param theLocations - list of corresponding vertexes
1443 * \return New GEOM_Object, containing the created solids.
1445 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1446 in ListOfGO theLocations);
1449 * \brief Create a shape by extrusion of the base shape along
1450 * the path shape with constant bi-normal direction along the given vector.
1452 * The path shape can be a wire or an edge.
1453 * \param theBase Base shape to be extruded.
1454 * \param thePath Path shape to extrude the base shape along it.
1455 * \param theVec Vector defines a constant binormal direction to keep the
1456 * same angle beetween the Direction and the sections
1457 * along the sweep surface.
1458 * \return New GEOM_Object, containing the created pipe.
1460 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1461 in GEOM_Object thePath,
1462 in GEOM_Object theVec);
1466 // # GEOM_IShapesOperations
1468 * \brief Interface for Shapes creation:
1470 * Edge from two points, Wire from edges, Face from wire,
1471 * Shell from faces, Solid from shells, Compound from shapes
1473 interface GEOM_IShapesOperations : GEOM_IOperations
1476 * \brief Create a linear edge with specified ends.
1477 * \param thePnt1 Point for the first end of edge.
1478 * \param thePnt2 Point for the second end of edge.
1479 * \return New GEOM_Object, containing the created edge.
1481 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1484 * \brief Create an edge on another edge, corresponding to the given length on the given edge.
1485 * \param theRefCurve The referenced edge.
1486 * \param theLength Length on the referenced edge. It can be
1487 * negative for extrapolation on base curve.
1488 * \param theStartPoint Any vertex close to one of edge's
1489 * ends to select start point among them.
1490 * If NULL, fist vertex is used.
1491 * \return New GEOM_Object, containing the created edge.
1493 GEOM_Object MakeEdgeOnCurveByLength (in GEOM_Object theRefCurve,
1494 in double theLength,
1495 in GEOM_Object theStartPoint);
1498 * \brief Create an edge from specified wire.
1499 * \param theWire source Wire.
1500 * \param theLinearTolerance linear tolerance value
1501 * \param theAngularTolerance angular tolerance value
1502 * \return New GEOM_Object, containing the created edge.
1504 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1505 in double theLinearTolerance,
1506 in double theAngularTolerance);
1509 * \brief Create a wire from the set of edges and wires.
1510 * \param theEdgesAndWires List of edge and/or wires.
1511 * \param theTolerance Maximum distance between vertices, that will be merged.
1512 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1513 * \return New GEOM_Object, containing the created wire.
1515 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1516 in double theTolerance);
1519 * \brief Create a face on the given wire.
1520 * \param theWire closed Wire or Edge to build the face on.
1521 * \param isPlanarWanted If TRUE, only planar face will be built.
1522 * If impossible, NULL object will be returned.
1523 * \return New GEOM_Object, containing the created face.
1525 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1528 * \brief Create a face on the given wires set.
1529 * \param theWires List of closed wires or edges to build the face on.
1530 * \param isPlanarWanted If TRUE, only planar face will be built.
1531 * If impossible, NULL object will be returned.
1532 * \return New GEOM_Object, containing the created face.
1534 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1537 * \brief Create a shell from the set of faces and shells.
1538 * \param theFacesAndShells List of faces and/or shells.
1539 * \return New GEOM_Object, containing the created shell.
1541 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1544 * \brief Create a solid, bounded by the given shell.
1545 * \param theShell Bounding shell.
1546 * \return New GEOM_Object, containing the created solid.
1548 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1551 * \brief Create a solid, bounded by the given shells.
1552 * \param theShells Bounding shells.
1553 * \return New GEOM_Object, containing the created solid.
1555 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1558 * \brief Create a compound of the given shapes.
1559 * \param theShapes List of shapes to put in compound.
1560 * \return New GEOM_Object, containing the created compound.
1562 GEOM_Object MakeCompound (in ListOfGO theShapes);
1565 * \brief Replace coincident faces in theShape by one face.
1566 * \param theShape Initial shape.
1567 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1568 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1569 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1571 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1574 * Find coincident faces in theShape for possible gluing.
1575 * \param theShape Initial shape.
1576 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1579 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1582 * \brief Replace coincident faces in theShape by one face
1583 * in compliance with given list of faces
1584 * \param theShape Initial shape.
1585 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1586 * \param theFaces List of faces for gluing.
1587 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1588 * \param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
1589 * will be glued, otherwise only the edges,
1590 * belonging to <VAR>theFaces</VAR>.
1591 * \return New GEOM_Object, containing a copy of theShape without some faces.
1593 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1594 in ListOfGO theFaces, in boolean doKeepNonSolids,
1595 in boolean doGlueAllEdges);
1598 * \brief Replace coincident edges in theShape by one edge.
1599 * \param theShape Initial shape.
1600 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1601 * \return New GEOM_Object, containing a copy of theShape without coincident edges.
1603 GEOM_Object MakeGlueEdges (in GEOM_Object theShape, in double theTolerance);
1606 * Find coincident edges in theShape for possible gluing.
1607 * \param theShape Initial shape.
1608 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1611 ListOfGO GetGlueEdges (in GEOM_Object theShape, in double theTolerance);
1614 * \brief Replace coincident edges in theShape by one edge
1615 * in compliance with given list of edges
1616 * \param theShape Initial shape.
1617 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1618 * \param theEdges List of edges for gluing.
1619 * \return New GEOM_Object, containing a copy of theShape without some edges.
1621 GEOM_Object MakeGlueEdgesByList (in GEOM_Object theShape,
1622 in double theTolerance,
1623 in ListOfGO theEdges);
1626 * \brief Get all sub-shapes and groups of \a theShape,
1627 * that were created already by any other methods.
1628 * \param theShape Any shape.
1629 * \param theGroupsOnly If this parameter is TRUE, only groups will be
1630 * returned, else all found sub-shapes and groups.
1631 * \return List of existing sub-objects of \a theShape.
1633 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
1634 in boolean theGroupsOnly);
1637 * \brief Deprecated method.
1639 * Use MakeAllSubShapes() instead.
1641 ListOfGO MakeExplode (in GEOM_Object theShape,
1642 in long theShapeType,
1643 in boolean isSorted);
1646 * \brief Explode a shape on sub-shapes of a given type.
1648 * If the shape itself has the given type, it is also returned.
1649 * \param theShape Shape to be exploded.
1650 * \param theShapeType Type of sub-shapes to be retrieved.
1651 * \param isSorted If this parameter is TRUE, sub-shapes will be
1652 * sorted by coordinates of their gravity centers.
1653 * \return List of sub-shapes of type theShapeType, contained in theShape.
1655 ListOfGO MakeAllSubShapes (in GEOM_Object theShape,
1656 in long theShapeType,
1657 in boolean isSorted);
1660 * \brief Extract all sub-shapes of the given type from
1661 * the given shape, excluding the shape itself.
1662 * \param theShape Shape to be exploded.
1663 * \param theShapeType Type of sub-shapes to be retrieved.
1664 * \param isSorted If this parameter is TRUE, sub-shapes will be
1665 * sorted by coordinates of their gravity centers.
1666 * \return List of sub-shapes of type theShapeType, contained in theShape.
1668 ListOfGO ExtractSubShapes (in GEOM_Object theShape,
1669 in long theShapeType,
1670 in boolean isSorted);
1673 * \brief Deprecated method. Use GetAllSubShapesIDs() instead.
1675 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1676 in long theShapeType,
1677 in boolean isSorted);
1680 * \brief Explode a shape on sub-shapes of a given type.
1682 * Does the same, as MakeAllSubShapes, but returns IDs of
1683 * sub-shapes, not GEOM_Object. It works faster.
1684 * \param theShape Shape to be exploded.
1685 * \param theShapeType Type of sub-shapes to be retrieved.
1686 * \param isSorted If this parameter is TRUE, sub-shapes will be
1687 * sorted by coordinates of their gravity centers.
1688 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1690 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
1691 in long theShapeType,
1692 in boolean isSorted);
1695 * \brief Get a sub-shape defined by its unique ID inside \a theMainShape
1696 * \param theMainShape Main shape.
1697 * \param theID Unique ID of sub-shape inside \a theMainShape.
1698 * \return GEOM_Object, corresponding to found sub-shape.
1699 * \note The sub-shape GEOM_Object can has ONLY ONE function.
1700 * Don't try to apply modification operations (without copy) on them.
1702 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1706 * \brief Get a set of sub-shapes defined by their unique IDs inside \a theMainShape
1707 * \param theMainShape Main shape.
1708 * \param theIndices List of unique IDs of sub-shapes inside \a theMainShape.
1709 * \return List of GEOM_Object, corresponding to found sub-shapes.
1710 * \note The sub-shape GEOM_Object can has ONLY ONE function.
1711 * Don't try to apply modification operations (without copy) on them.
1713 ListOfGO MakeSubShapes (in GEOM_Object theMainShape,
1714 in ListOfLong theIndices);
1717 * Get global index of \a theSubShape in \a theMainShape.
1718 * \param theMainShape Main shape.
1719 * \param theSubShape Sub-shape of the main shape.
1720 * \return global index of \a theSubShape in \a theMainShape.
1722 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1725 * \brief Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1727 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1728 * to generate automatic names for sub-shapes, when publishing them in a study.
1729 * \param theMainShape Main shape.
1730 * \param theSubShape Sub-shape of the main shape.
1731 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1733 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1736 * \brief Get name of type of \a theShape.
1738 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1739 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1740 * to generate automatic names for sub-shapes, when publishing them in a study.
1741 * \param theShape The shape to get a type of.
1742 * \return String, containing a type name of \a theShape.
1744 string GetShapeTypeString (in GEOM_Object theShape);
1747 * \brief Count number of faces in the given shape.
1748 * \param theShape Shape to count faces in.
1749 * \return Number of faces in the given shape.
1751 long NumberOfFaces (in GEOM_Object theShape);
1754 * \brief Count number of edges in the given shape.
1755 * \param theShape Shape to count edges in.
1756 * \return Number of edges in theShape.
1758 long NumberOfEdges (in GEOM_Object theShape);
1761 * \brief Count number of sub-shapes of type \a theShapeType in the given shape.
1762 * \param theShape Shape to count sub-shapes in.
1763 * \param theShapeType The type of sub-shapes to count.
1764 * \return Number of sub-shapes of type \a theShapeType in \a theShape.
1766 long NumberOfSubShapes (in GEOM_Object theShape,
1767 in long theShapeType);
1770 * Reverses an orientation the given shape.
1771 * \param theShape Shape to be reversed.
1772 * \return The reversed copy of theShape.
1774 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1777 * \brief Retrieve all free faces from the given shape.
1779 * Free face is a face, which is not shared between two shells of the shape.
1780 * \param theShape Shape to find free faces in.
1781 * \return List of IDs of all free faces, contained in theShape.
1783 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1786 * \brief Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1787 * \param theShape1 Shape to find sub-shapes in.
1788 * \param theShape2 Shape to find shared sub-shapes with.
1789 * \param theShapeType Type of sub-shapes to be retrieved.
1790 * \return List of sub-shapes of theShape1, shared with theShape2.
1792 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1793 in GEOM_Object theShape2,
1794 in long theShapeType);
1797 * \brief Get all sub-shapes, shared by all shapes in the list \a theShapes.
1798 * \param theShapes Shapes to find common sub-shapes of.
1799 * \param theShapeType Type of sub-shapes to be retrieved.
1800 * \return List of objects, that are sub-shapes of all given shapes.
1802 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
1803 in long theShapeType);
1806 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1807 * the specified plane by the certain way, defined through \a theState parameter.
1808 * \param theShape Shape to find sub-shapes of.
1809 * \param theShapeType Type of sub-shapes to be retrieved.
1810 * \param theAx1 Vector (or line, or linear edge), specifying normal
1811 * direction and location of the plane to find shapes on.
1812 * \param theState The state of the sub-shapes to find.
1813 * \return List of all found sub-shapes.
1815 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1816 in long theShapeType,
1817 in GEOM_Object theAx1,
1818 in shape_state theState);
1820 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1821 * the specified plane by the certain way, defined through \a theState parameter.
1822 * \param theShape Shape to find sub-shapes of.
1823 * \param theShapeType Type of sub-shapes to be retrieved.
1824 * \param theAx1 Vector (or line, or linear edge), specifying normal
1825 * direction of the plane to find shapes on.
1826 * \param thePnt Point specifying location of the plane to find shapes on.
1827 * \param theState The state of the sub-shapes to find.
1828 * \return List of all found sub-shapes.
1830 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1831 in long theShapeType,
1832 in GEOM_Object theAx1,
1833 in GEOM_Object thePnt,
1834 in shape_state theState);
1839 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1840 * the specified cylinder by the certain way, defined through \a theState parameter.
1841 * \param theShape Shape to find sub-shapes of.
1842 * \param theShapeType Type of sub-shapes to be retrieved.
1843 * \param theAxis Vector (or line, or linear edge), specifying
1844 * axis of the cylinder to find shapes on.
1845 * \param theRadius Radius of the cylinder to find shapes on.
1846 * \param theState The state of the sub-shapes to find.
1847 * \return List of all found sub-shapes.
1849 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1850 in long theShapeType,
1851 in GEOM_Object theAxis,
1852 in double theRadius,
1853 in shape_state theState);
1856 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1857 * the specified cylinder by the certain way, defined through \a theState parameter.
1858 * \param theShape Shape to find sub-shapes of.
1859 * \param theShapeType Type of sub-shapes to be retrieved.
1860 * \param theAxis Vector (or line, or linear edge), specifying
1861 * axis of the cylinder to find shapes on.
1862 * \param thePnt Point specifying location of the bottom of the cylinder.
1863 * \param theRadius Radius of the cylinder to find shapes on.
1864 * \param theState The state of the sub-shapes to find.
1865 * \return List of all found sub-shapes.
1867 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1868 in long theShapeType,
1869 in GEOM_Object theAxis,
1870 in GEOM_Object thePnt,
1871 in double theRadius,
1872 in shape_state theState);
1875 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1876 * the specified sphere by the certain way, defined through \a theState parameter.
1877 * \param theShape Shape to find sub-shapes of.
1878 * \param theShapeType Type of sub-shapes to be retrieved.
1879 * \param theCenter Point, specifying center of the sphere to find shapes on.
1880 * \param theRadius Radius of the sphere to find shapes on.
1881 * \param theState The state of the sub-shapes to find.
1882 * \return List of all found sub-shapes.
1884 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1885 in long theShapeType,
1886 in GEOM_Object theCenter,
1887 in double theRadius,
1888 in shape_state theState);
1891 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1892 * the specified quadrangle by the certain way, defined through \a theState parameter.
1893 * \param theShape Shape to find sub-shapes of.
1894 * \param theShapeType Type of sub-shapes to be retrieved.
1895 * \param theTopLeftPoint Top left quadrangle corner
1896 * \param theTopRigthPoint Top right quadrangle corner
1897 * \param theBottomLeftPoint Bottom left quadrangle corner
1898 * \param theBottomRigthPoint Bottom right quadrangle corner
1899 * \param theState The state of the sub-shapes to find.
1900 * \return List of all found sub-shapes.
1902 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1903 in long theShapeType,
1904 in GEOM_Object theTopLeftPoint,
1905 in GEOM_Object theTopRigthPoint,
1906 in GEOM_Object theBottomLeftPoint,
1907 in GEOM_Object theBottomRigthPoint,
1908 in shape_state theState);
1911 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1912 * the specified plane by the certain way, defined through \a theState parameter.
1913 * \param theShape Shape to find sub-shapes of.
1914 * \param theShapeType Type of sub-shapes to be retrieved.
1915 * \param theAx1 Vector (or line, or linear edge), specifying normal
1916 * direction and location of the plane to find shapes on.
1917 * \param theState The state of the sub-shapes to find.
1918 * \return List of IDs of all found sub-shapes.
1920 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1921 in long theShapeType,
1922 in GEOM_Object theAx1,
1923 in shape_state theState);
1926 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1927 * the specified plane by the certain way, defined through \a theState parameter.
1928 * \param theShape Shape to find sub-shapes of.
1929 * \param theShapeType Type of sub-shapes to be retrieved.
1930 * \param theAx1 Vector (or line, or linear edge), specifying normal
1931 * direction of the plane to find shapes on.
1932 * \param thePnt Point specifying location of the plane to find shapes on.
1933 * \param theState The state of the sub-shapes to find.
1934 * \return List of IDs of all found sub-shapes.
1936 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1937 in long theShapeType,
1938 in GEOM_Object theAx1,
1939 in GEOM_Object thePnt,
1940 in shape_state theState);
1943 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1944 * the specified cylinder by the certain way, defined through \a theState parameter.
1945 * \param theShape Shape to find sub-shapes of.
1946 * \param theShapeType Type of sub-shapes to be retrieved.
1947 * \param theAxis Vector (or line, or linear edge), specifying
1948 * axis of the cylinder to find shapes on.
1949 * \param theRadius Radius of the cylinder to find shapes on.
1950 * \param theState The state of the sub-shapes to find.
1951 * \return List of IDs of all found sub-shapes.
1953 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1954 in long theShapeType,
1955 in GEOM_Object theAxis,
1956 in double theRadius,
1957 in shape_state theState);
1960 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1961 * the specified cylinder by the certain way, defined through \a theState parameter.
1962 * \param theShape Shape to find sub-shapes of.
1963 * \param theShapeType Type of sub-shapes to be retrieved.
1964 * \param theAxis Vector (or line, or linear edge), specifying
1965 * axis of the cylinder to find shapes on.
1966 * \param thePnt Point specifying location of the bottom of the cylinder.
1967 * \param theRadius Radius of the cylinder to find shapes on.
1968 * \param theState The state of the sub-shapes to find.
1969 * \return List of IDs all found sub-shapes.
1971 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1972 in long theShapeType,
1973 in GEOM_Object theAxis,
1974 in GEOM_Object thePnt,
1975 in double theRadius,
1976 in shape_state theState);
1979 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1980 * the specified sphere by the certain way, defined through \a theState parameter.
1981 * \param theShape Shape to find sub-shapes of.
1982 * \param theShapeType Type of sub-shapes to be retrieved.
1983 * \param theCenter Point, specifying center of the sphere to find shapes on.
1984 * \param theRadius Radius of the sphere to find shapes on.
1985 * \param theState The state of the sub-shapes to find.
1986 * \return List of IDs of all found sub-shapes.
1988 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1989 in long theShapeType,
1990 in GEOM_Object theCenter,
1991 in double theRadius,
1992 in shape_state theState);
1995 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1996 * the specified quadrangle by the certain way, defined through \a theState parameter.
1997 * \param theShape Shape to find sub-shapes of.
1998 * \param theShapeType Type of sub-shapes to be retrieved.
1999 * \param theTopLeftPoint Top left quadrangle corner
2000 * \param theTopRigthPoint Top right quadrangle corner
2001 * \param theBottomLeftPoint Bottom left quadrangle corner
2002 * \param theBottomRigthPoint Bottom right quadrangle corner
2003 * \param theState The state of the sub-shapes to find.
2004 * \return List of IDs of all found sub-shapes.
2006 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
2007 in long theShapeType,
2008 in GEOM_Object theTopLeftPoint,
2009 in GEOM_Object theTopRigthPoint,
2010 in GEOM_Object theBottomLeftPoint,
2011 in GEOM_Object theBottomRigthPoint,
2012 in shape_state theState);
2015 * \brief Find sub-shapes complying with given status
2016 * \param theBox - the box to check state of sub-shapes against
2017 * \param theShape - the shape to explore
2018 * \param theShapeType - type of sub-shape of theShape
2019 * \param theState - required state
2020 * \return List of IDs of all found sub-shapes.
2022 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
2023 in GEOM_Object theShape,
2024 in long theShapeType,
2025 in shape_state theState);
2028 * \brief Find sub-shapes complying with given status
2029 * \param theBox - the box to check state of sub-shapes against
2030 * \param theShape - the shape to explore
2031 * \param theShapeType - type of sub-shape of theShape
2032 * \param theState - required state
2033 * \return List of all found sub-shapes.
2035 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
2036 in GEOM_Object theShape,
2037 in long theShapeType,
2038 in shape_state theState);
2041 * \brief Find sub-shapes complying with given status
2042 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2043 * \param theShape - the shape to explore
2044 * \param theShapeType - type of sub-shape of theShape
2045 * \param theState - required state
2046 * \return List of IDs of all found sub-shapes.
2048 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
2049 in GEOM_Object theShape,
2050 in short theShapeType,
2051 in shape_state theState);
2054 * \brief Find sub-shapes complying with given status
2055 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2056 * \param theShape - the shape to explore
2057 * \param theShapeType - type of sub-shape of theShape
2058 * \param theState - required state
2059 * \return List of all found sub-shapes.
2061 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
2062 in GEOM_Object theShape,
2063 in short theShapeType,
2064 in shape_state theState);
2067 * \brief Find sub-shapes complying with given status
2068 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2069 * \param theShape - the shape to explore
2070 * \param theShapeType - type of sub-shape of theShape
2071 * \param theState - required state
2072 * \return compound includes all found sub-shapes.
2074 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
2075 in GEOM_Object theShape,
2076 in short theShapeType,
2077 in shape_state theState);
2080 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2081 * coincident with \a theShapeWhat or could be a part of it.
2082 * \param theShapeWhere Shape to find sub-shapes of.
2083 * \param theShapeWhat Shape, specifying what to find.
2084 * \return Group of all found sub-shapes or a single found sub-shape.
2086 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
2087 in GEOM_Object theShapeWhat);
2090 * Old implementation of GetInPlace functionality, based on shape properties.
2092 GEOM_Object GetInPlaceOld (in GEOM_Object theShapeWhere,
2093 in GEOM_Object theShapeWhat);
2096 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2097 * coincident with \a theShapeWhat or could be a part of it.
2099 * Implementation of this method is based on a saved history of an operation,
2100 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
2101 * arguments (an argument shape or a sub-shape of an argument shape).
2102 * The operation could be the Partition or one of boolean operations,
2103 * performed on simple shapes (not on compounds).
2105 * \param theShapeWhere Shape to find sub-shapes of.
2106 * \param theShapeWhat Shape, specifying what to find.
2107 * \return Group of all found sub-shapes or a single found sub-shape.
2109 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
2110 in GEOM_Object theShapeWhat);
2113 * \brief Get sub-shape of theShapeWhere, which are
2114 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2115 * \param theShapeWhere Shape to find sub-shapes of.
2116 * \param theShapeWhat Shape, specifying what to find.
2117 * \return found sub-shape.
2119 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
2120 in GEOM_Object theShapeWhat);
2123 // # GEOM_IBlocksOperations:
2125 * \brief Interface for Blocks construction
2126 * Face from points or edges, Block from faces,
2127 * Blocks multi-translation and multi-rotation
2129 interface GEOM_IBlocksOperations : GEOM_IOperations
2132 // # Creation of blocks
2135 * \brief Create a quadrangle face from four edges. Order of Edges is not
2136 * important. It is not necessary that edges share the same vertex.
2137 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
2138 * \return New GEOM_Object, containing the created face.
2140 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
2141 in GEOM_Object theEdge2,
2142 in GEOM_Object theEdge3,
2143 in GEOM_Object theEdge4);
2146 * \brief Create a quadrangle face on two edges.
2148 * The missing edges will be built by creating the shortest ones.
2149 * \param theEdge1,theEdge2 Two opposite edges for the face.
2150 * \return New GEOM_Object, containing the created face.
2152 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
2153 in GEOM_Object theEdge2);
2156 * \brief Create a quadrangle face with specified corners.
2158 * The missing edges will be built by creating the shortest ones.
2159 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
2160 * \return New GEOM_Object, containing the created face.
2162 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
2163 in GEOM_Object thePnt2,
2164 in GEOM_Object thePnt3,
2165 in GEOM_Object thePnt4);
2168 * \brief Create a hexahedral solid, bounded by the six given faces. Order of
2169 * faces is not important.
2171 * It is not necessary that Faces share the same edge.
2172 * \param theFace1,theFace2,theFace3,theFace4,theFace5,theFace6 Faces for the hexahedral solid.
2173 * \return New GEOM_Object, containing the created solid.
2175 GEOM_Object MakeHexa (in GEOM_Object theFace1,
2176 in GEOM_Object theFace2,
2177 in GEOM_Object theFace3,
2178 in GEOM_Object theFace4,
2179 in GEOM_Object theFace5,
2180 in GEOM_Object theFace6);
2183 * \brief Create a hexahedral solid between two given faces.
2185 * The missing faces will be built by creating the smallest ones.
2186 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
2187 * \return New GEOM_Object, containing the created solid.
2189 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
2190 in GEOM_Object theFace2);
2193 // # Extract elements of blocks and blocks compounds
2197 * \brief Get a vertex, found in the given shape by its coordinates.
2198 * \param theShape Block or a compound of blocks.
2199 * \param theX,theY,theZ Coordinates of the sought vertex.
2200 * \param theEpsilon Maximum allowed distance between the resulting
2201 * vertex and point with the given coordinates.
2202 * \return New GEOM_Object, containing the found vertex.
2204 GEOM_Object GetPoint (in GEOM_Object theShape,
2208 in double theEpsilon);
2211 * \brief Find a vertex of the given shape, which has minimal distance to the given point.
2212 * \param theShape Any shape.
2213 * \param thePoint Point, close to the desired vertex.
2214 * \return New GEOM_Object, containing the found vertex.
2216 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
2217 in GEOM_Object thePoint);
2220 * \brief Get an edge, found in the given shape by two given vertices.
2221 * \param theShape Block or a compound of blocks.
2222 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2223 * \return New GEOM_Object, containing the found edge.
2225 GEOM_Object GetEdge (in GEOM_Object theShape,
2226 in GEOM_Object thePoint1,
2227 in GEOM_Object thePoint2);
2230 * \brief Find an edge of the given shape, which has minimal distance to the given point.
2231 * \param theShape Block or a compound of blocks.
2232 * \param thePoint Point, close to the desired edge.
2233 * \return New GEOM_Object, containing the found edge.
2235 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
2236 in GEOM_Object thePoint);
2239 * \brief Returns a face, found in the given shape by four given corner vertices.
2240 * \param theShape Block or a compound of blocks.
2241 * \param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
2242 * \return New GEOM_Object, containing the found face.
2244 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
2245 in GEOM_Object thePoint1,
2246 in GEOM_Object thePoint2,
2247 in GEOM_Object thePoint3,
2248 in GEOM_Object thePoint4);
2251 * \brief Get a face of block, found in the given shape by two given edges.
2252 * \param theShape Block or a compound of blocks.
2253 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2254 * \return New GEOM_Object, containing the found face.
2256 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2257 in GEOM_Object theEdge1,
2258 in GEOM_Object theEdge2);
2261 * \brief Find a face, opposite to the given one in the given block.
2262 * \param theBlock Must be a hexahedral solid.
2263 * \param theFace Face of \a theBlock, opposite to the desired face.
2264 * \return New GEOM_Object, containing the found face.
2266 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2267 in GEOM_Object theFace);
2270 * \brief Find a face of the given shape, which has minimal distance to the given point.
2271 * \param theShape Block or a compound of blocks.
2272 * \param thePoint Point, close to the desired face.
2273 * \return New GEOM_Object, containing the found face.
2275 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2276 in GEOM_Object thePoint);
2279 * \brief Find a face of block, whose outside normale has minimal angle with the given vector.
2280 * \param theBlock Block or a compound of blocks.
2281 * \param theVector Vector, close to the normale of the desired face.
2282 * \return New GEOM_Object, containing the found face.
2284 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2285 in GEOM_Object theVector);
2288 * \brief Find all sub-shapes of type \a theShapeType of the given shape,
2289 * which have minimal distance to the given point.
2290 * \param theShape Any shape.
2291 * \param thePoint Point, close to the desired shape.
2292 * \param theShapeType Defines what kind of sub-shapes is searched.
2293 * \param theTolerance The tolerance for distances comparison. All shapes
2294 * with distances to the given point in interval
2295 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2296 * \return New GEOM_Object, containing a group of all found shapes.
2298 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2299 in GEOM_Object thePoint,
2300 in long theShapeType,
2301 in double theTolerance);
2303 // # Extract blocks from blocks compounds
2307 * \brief Check, if the compound contains only specified blocks.
2308 * \param theCompound The compound to check.
2309 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2310 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2311 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2312 * \param theNbBlocks Number of specified blocks in theCompound.
2313 * \return TRUE, if the given compound contains only blocks.
2315 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2316 in long theMinNbFaces,
2317 in long theMaxNbFaces,
2318 out long theNbBlocks);
2321 * \brief Enumeration of Blocks Compound defects.
2325 /* Each element of the compound should be a Block */
2328 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2331 /* A connection between two Blocks should be an entire face or an entire edge */
2334 /* The compound should be connexe */
2337 /* The glue between two quadrangle faces should be applied */
2342 * \brief Description of Blocks Compound defect: type and incriminated sub-shapes.
2347 ListOfLong incriminated;
2351 * \brief Sequence of all Blocks Compound defects.
2353 typedef sequence<BCError> BCErrors;
2356 * \brief Check, if the compound of blocks is given.
2358 * To be considered as a compound of blocks, the
2359 * given shape must satisfy the following conditions:
2360 * - Each element of the compound should be a Block (6 faces and 12 edges).
2361 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2362 * - The compound should be connexe.
2363 * - The glue between two quadrangle faces should be applied.
2364 * \note Single block is also accepted as a valid compound of blocks.
2365 * \param theCompound The compound to check.
2366 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
2367 * \return TRUE, if the given shape is a compound of blocks.
2369 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2370 out BCErrors theErrors);
2373 * \brief Convert sequence of Blocks Compound errors, returned by
2374 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2375 * \param theCompound The bad compound.
2376 * \param theErrors The sequence of \a theCompound errors.
2377 * \return String, describing all the errors in form, suitable for printing.
2379 string PrintBCErrors (in GEOM_Object theCompound,
2380 in BCErrors theErrors);
2383 * \brief Remove all seam and degenerated edges from \a theShape.
2385 * Unite faces and edges, sharing one surface.
2386 * \param theShape The compound or single solid to remove irregular edges from.
2387 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2388 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2389 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2390 * For blocks repairing recommended value is 6.
2391 * \return Improved shape.
2393 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2394 in long theOptimumNbFaces);
2397 * \brief Check, if the given shape is a blocks compound.
2399 * Fix all detected errors.
2400 * \note Single block can be also fixed by this method.
2401 * \param theCompound The compound to check and improve.
2402 * \return Improved compound.
2404 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2407 * \brief Get all the blocks, contained in the given compound.
2409 * \param theCompound The compound to explode.
2410 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2411 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2412 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2413 * \return List of GEOM_Object, containing the retrieved blocks.
2415 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2416 in long theMinNbFaces,
2417 in long theMaxNbFaces);
2420 * \brief Find block, containing the given point inside its volume or on boundary.
2421 * \param theCompound Compound, to find block in.
2422 * \param thePoint Point, close to the desired block. If the point lays on
2423 * boundary between some blocks, we return block with nearest center.
2424 * \return New GEOM_Object, containing the found block.
2426 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2427 in GEOM_Object thePoint);
2430 * \brief Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2431 * \param theCompound Compound, to find block in.
2432 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2433 * \return New GEOM_Object, containing the found block.
2435 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2436 in ListOfGO theParts);
2439 * \brief Return all blocks, containing all the elements, passed as the parts.
2440 * \param theCompound Compound, to find blocks in.
2441 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2442 * \return List of GEOM_Object, containing the found blocks.
2444 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2445 in ListOfGO theParts);
2447 // # Operations on blocks with gluing of result
2450 * \brief Multi-transformate block and glue the result.
2452 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2453 * \param theBlock Hexahedral solid to be multi-transformed.
2454 * \param theDirFace1 First direction face global index.
2455 * \param theDirFace2 Second direction face global index.
2456 * \param theNbTimes Quantity of transformations to be done.
2457 * \note Global index of sub-shape can be obtained, using method
2458 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2459 * \return New GEOM_Object, containing the result shape.
2461 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2462 in long theDirFace1,
2463 in long theDirFace2,
2464 in long theNbTimes);
2467 * \brief Multi-transformate block and glue the result.
2468 * \param theBlock Hexahedral solid to be multi-transformed.
2469 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2470 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2471 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2472 * \return New GEOM_Object, containing the result shape.
2474 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2475 in long theDirFace1U,
2476 in long theDirFace2U,
2477 in long theNbTimesU,
2478 in long theDirFace1V,
2479 in long theDirFace2V,
2480 in long theNbTimesV);
2482 // # Special operation - propagation
2486 * \brief Build all possible propagation groups.
2488 * Propagation group is a set of all edges, opposite to one (main)
2489 * edge of this group directly or through other opposite edges.
2490 * Notion of Opposite Edge make sence only on quadrangle face.
2491 * \param theShape Shape to build propagation groups on.
2492 * \return List of GEOM_Object, each of them is a propagation group.
2494 ListOfGO Propagate (in GEOM_Object theShape);
2497 // # GEOM_IBooleanOperations
2499 * \brief Interface for boolean operations (Cut, Fuse, Common)
2501 interface GEOM_IBooleanOperations : GEOM_IOperations
2504 * \brief Perform one of boolean operations on two given shapes.
2505 * \param theShape1 First argument for boolean operation.
2506 * \param theShape2 Second argument for boolean operation.
2507 * \param theOperation Indicates the operation to be done:
2508 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2509 * \return New GEOM_Object, containing the result shape.
2511 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2512 in GEOM_Object theShape2,
2513 in long theOperation);
2516 * \brief Perform partition operation.
2518 * \param theShapes Shapes to be intersected.
2519 * \param theTools Shapes to intersect theShapes.
2520 * \note Each compound from ListShapes and ListTools will be exploded in order
2521 * to avoid possible intersection between shapes from this compound.
2522 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2523 * \param theKeepNonlimitShapes: if this parameter == 0, then only shapes of
2524 * target type (equal to Limit) are kept in the result,
2525 * else standalone shapes of lower dimension
2526 * are kept also (if they exist).
2528 * After implementation new version of PartitionAlgo (October 2006)
2529 * other parameters are ignored by current functionality. They are kept
2530 * in this function only for supporting old versions.
2531 * Ignored parameters:
2532 * \param theKeepInside Shapes, outside which the results will be deleted.
2533 * Each shape from theKeepInside must belong to theShapes also.
2534 * \param theRemoveInside Shapes, inside which the results will be deleted.
2535 * Each shape from theRemoveInside must belong to theShapes also.
2536 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2537 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2539 * \return New GEOM_Object, containing the result shapes.
2541 GEOM_Object MakePartition (in ListOfGO theShapes,
2542 in ListOfGO theTools,
2543 in ListOfGO theKeepInside,
2544 in ListOfGO theRemoveInside,
2546 in boolean theRemoveWebs,
2547 in ListOfLong theMaterials,
2548 in short theKeepNonlimitShapes);
2551 * \brief Perform partition operation.
2553 * This method may be usefull if it is needed to make a partition for
2554 * a compound containing nonintersected shapes. Performance will be better
2555 * since intersection between shapes from compound is not performed.
2557 * Description of all parameters as in previous method MakePartition()
2559 * \note Passed compounds (via ListShapes or via ListTools)
2560 * have to consist of nonintersecting shapes.
2562 * \return New GEOM_Object, containing the result shapes.
2564 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2565 in ListOfGO theTools,
2566 in ListOfGO theKeepInside,
2567 in ListOfGO theRemoveInside,
2569 in boolean theRemoveWebs,
2570 in ListOfLong theMaterials,
2571 in short theKeepNonlimitShapes);
2574 * \brief Perform partition of the Shape with the Plane
2575 * \param theShape Shape to be intersected.
2576 * \param thePlane Tool shape, to intersect theShape.
2577 * \return New GEOM_Object, containing the result shape.
2579 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2580 in GEOM_Object thePlane);
2583 // # GEOM_ICurvesOperations:
2585 * \brief Interface for curves creation.
2587 * Polyline, Circle, Spline (Bezier and Interpolation)
2589 interface GEOM_ICurvesOperations : GEOM_IOperations
2592 * \brief Create a circle with given center, normal vector and radius.
2593 * \param thePnt Circle center.
2594 * \param theVec Vector, normal to the plane of the circle.
2595 * \param theR Circle radius.
2596 * \return New GEOM_Object, containing the created circle.
2598 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2599 in GEOM_Object theVec,
2602 * \brief Create a circle, passing through three given points
2603 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2604 * \return New GEOM_Object, containing the created circle.
2606 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2607 in GEOM_Object thePnt2,
2608 in GEOM_Object thePnt3);
2610 * \brief Create a circle with given center, with a radius equals the distance from center to Point1
2611 * and on a plane defined by all of three points.
2612 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2613 * \return New GEOM_Object, containing the created circle.
2615 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2616 in GEOM_Object thePnt2,
2617 in GEOM_Object thePnt3);
2619 * \brief Create an ellipse with given center, normal vector and radiuses.
2620 * \param thePnt Ellipse center.
2621 * \param theVec Vector, normal to the plane of the ellipse.
2622 * \param theRMajor Major ellipse radius.
2623 * \param theRMinor Minor ellipse radius.
2624 * \return New GEOM_Object, containing the created ellipse.
2626 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2627 in GEOM_Object theVec,
2628 in double theRMajor,
2629 in double theRMinor);
2632 * \brief Create an ellipse with given center, normal vector, main axis vector and radiuses.
2633 * \param thePnt Ellipse center.
2634 * \param theVec Vector, normal to the plane of the ellipse.
2635 * \param theRMajor Major ellipse radius.
2636 * \param theRMinor Minor ellipse radius.
2637 * \param theVecMaj Vector, direction of the ellipse's main axis.
2638 * \return New GEOM_Object, containing the created ellipse.
2640 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2641 in GEOM_Object theVec,
2642 in double theRMajor,
2643 in double theRMinor,
2644 in GEOM_Object theVecMaj);
2647 * \brief Create an arc of circle, passing through three given points.
2648 * \param thePnt1 Start point of the arc.
2649 * \param thePnt2 Middle point of the arc.
2650 * \param thePnt3 End point of the arc.
2651 * \return New GEOM_Object, containing the created arc.
2653 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2654 in GEOM_Object thePnt2,
2655 in GEOM_Object thePnt3);
2658 * \brief Create an arc of circle of center C from one point to another
2659 * \param theCenter Center point of the arc.
2660 * \param thePnt1 Start point of the arc.
2661 * \param thePnt2 End point of the arc.
2662 * \param theSense Orientation of the arc
2663 * \return New GEOM_Object, containing the created arc.
2665 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2666 in GEOM_Object thePnt1,
2667 in GEOM_Object thePnt2,
2668 in boolean theSense);
2671 * \brief Create an arc of ellipse of center C and two points P1 P2.
2672 * \param theCenter Center point of the arc.
2673 * \param thePnt1 Major radius is distance from center to Pnt1.
2674 * \param thePnt2 define a plane and Minor radius as a shortest
2675 * distance from Pnt2 to vector Center->Pnt1.
2676 * \return New GEOM_Object, containing the created arc.
2678 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2679 in GEOM_Object thePnt1,
2680 in GEOM_Object thePnt2);
2684 * \brief Create a polyline on the set of points.
2685 * \param thePoints Sequence of points for the polyline.
2686 * \param theIsClosed If TRUE, build a closed wire.
2687 * \return New GEOM_Object, containing the created polyline.
2689 GEOM_Object MakePolyline (in ListOfGO thePoints,
2690 in boolean theIsClosed);
2693 * \brief Create bezier curve on the set of points.
2694 * \param thePoints Sequence of points for the bezier curve.
2695 * \param theIsClosed If TRUE, build a closed curve.
2696 * \return New GEOM_Object, containing the created bezier curve.
2698 GEOM_Object MakeSplineBezier (in ListOfGO thePoints,
2699 in boolean theIsClosed);
2702 * \brief Create B-Spline curve on the set of points.
2703 * \param thePoints Sequence of points for the B-Spline curve.
2704 * \param theIsClosed If TRUE, build a closed curve.
2705 * \param theDoReordering If TRUE, the algo does not follow the order of
2706 * \a thePoints but searches for the closest vertex.
2707 * \return New GEOM_Object, containing the created B-Spline curve.
2709 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2710 in boolean theIsClosed,
2711 in boolean theDoReordering);
2714 * \brief Creates a curve using the parametric definition of the basic points.
2715 * \param thexExpr parametric equation of the coordinates X.
2716 * \param theyExpr parametric equation of the coordinates Y.
2717 * \param thezExpr parametric equation of the coordinates Z.
2718 * \param theParamMin the minimal value of the parameter.
2719 * \param theParamMax the maximum value of the parameter.
2720 * \param theParamStep the step of the parameter.
2721 * \param theCurveType the type of the curve.
2722 * \return New GEOM_Object, containing the created curve.
2724 GEOM_Object MakeCurveParametric(in string thexExpr,
2727 in double theParamMin,
2728 in double theParamMax,
2729 in double theParamStep,
2730 in curve_type theCurveType);
2733 * \brief Creates a curve using the parametric definition of the basic points.
2734 * \param thexExpr parametric equation of the coordinates X.
2735 * \param theyExpr parametric equation of the coordinates Y.
2736 * \param thezExpr parametric equation of the coordinates Z.
2737 * \param theParamMin the minimal value of the parameter.
2738 * \param theParamMax the maximum value of the parameter.
2739 * \param theParamNbStep the number of steps of the parameter discretization.
2740 * \param theCurveType the type of the curve.
2741 * \return New GEOM_Object, containing the created curve.
2743 GEOM_Object MakeCurveParametricNew(in string thexExpr,
2746 in double theParamMin,
2747 in double theParamMax,
2748 in long theParamNbStep,
2749 in curve_type theCurveType);
2752 * \brief Create a sketcher (wire or face), following the textual description,
2753 * passed through \a theCommand argument.
2755 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2756 * Format of the description string have to be the following:
2758 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2761 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2763 * - "R angle" : Set the direction by angle
2764 * - "D dx dy" : Set the direction by DX & DY
2767 * - "TT x y" : Create segment by point at X & Y
2768 * - "T dx dy" : Create segment by point with DX & DY
2769 * - "L length" : Create segment by direction & Length
2770 * - "IX x" : Create segment by direction & Intersect. X
2771 * - "IY y" : Create segment by direction & Intersect. Y
2774 * - "C radius length" : Create arc by direction, radius and length(in degree)
2777 * - "WW" : Close Wire (to finish)
2778 * - "WF" : Close Wire and build face (to finish)
2780 * \param theCommand String, defining the sketcher in local
2781 * coordinates of the working plane.
2782 * \param theWorkingPlane Nine double values, defining origin,
2783 * OZ and OX directions of the working plane.
2784 * \return New GEOM_Object, containing the created wire.
2786 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2789 * \brief Create a 3D sketcher, following the numerical description,
2790 * passed through points created by \a theCoordinates argument.
2792 * Format of the description string have to be the following:
2794 * "Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"
2797 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2800 * \brief Create a sketcher (wire or face), following the textual description,
2801 * passed through \a theCommand argument.
2803 * For format of the description string see the previous method.\n
2804 * \param theCommand String, defining the sketcher in local
2805 * coordinates of the working plane.
2806 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2807 * \return New GEOM_Object, containing the created wire.
2809 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2812 // # GEOM_ILocalOperations:
2814 * \brief Interface for fillet and chamfer creation.
2816 interface GEOM_ILocalOperations : GEOM_IOperations
2819 * \brief Perform a fillet on all edges of the given shape.
2820 * \param theShape Shape, to perform fillet on.
2821 * \param theR Fillet radius.
2822 * \return New GEOM_Object, containing the result shape.
2824 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2828 * \brief Perform a fillet on the specified edges of the given shape
2829 * \param theShape Shape, to perform fillet on.
2830 * \param theR Fillet radius.
2831 * \param theEdges Global indices of edges to perform fillet on.
2832 * \note Global index of sub-shape can be obtained, using method
2833 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2834 * \return New GEOM_Object, containing the result shape.
2836 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2838 in ListOfLong theEdges);
2839 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2842 in ListOfLong theEdges);
2845 * \brief Perform a fillet on all edges of the specified faces of the given shape.
2846 * \param theShape Shape, to perform fillet on.
2847 * \param theR Fillet radius.
2848 * \param theFaces Global indices of faces to perform fillet on.
2849 * \note Global index of sub-shape can be obtained, using method
2850 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2851 * \return New GEOM_Object, containing the result shape.
2853 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2855 in ListOfLong theFaces);
2857 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2860 in ListOfLong theFaces);
2863 * \brief Perform a fillet on a face or a shell at the specified vertexes.
2864 * \param theShape Shape, to perform fillet on.
2865 * \param theR Fillet radius.
2866 * \param theVertexes Global indices of vertexes to perform fillet on.
2867 * \note Global index of sub-shape can be obtained, using method
2868 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2869 * \return New GEOM_Object, containing the result shape.
2871 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2873 in ListOfLong theVertexes);
2876 * \brief Perform a fillet on edges of the specified vertexes of the given wire.
2877 * \param theShape Shape, to perform fillet on.
2878 * \param theR Fillet radius.
2879 * \param theVertexes Global indices of vertexes to perform fillet on.
2880 * \note Global index of sub-shape can be obtained, using method
2881 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2882 * \note The list of vertices coudl be empty, in this case fillet fill be done
2883 * at all vertices in given wire
2884 * \return New GEOM_Object, containing the result shape.
2886 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2888 in ListOfLong theVertexes);
2891 * \brief Perform a symmetric chamfer on all edges of the given shape.
2892 * \param theShape Shape, to perform chamfer on.
2893 * \param theD Chamfer size along each face.
2894 * \return New GEOM_Object, containing the result shape.
2896 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2900 * \brief Perform a chamfer on edges, common to the specified faces.
2901 * with distance D1 on the Face1
2902 * \param theShape Shape, to perform chamfer on.
2903 * \param theD1 Chamfer size along \a theFace1.
2904 * \param theD2 Chamfer size along \a theFace2.
2905 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2906 * \note Global index of sub-shape can be obtained, using method
2907 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2908 * \return New GEOM_Object, containing the result shape.
2910 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2911 in double theD1, in double theD2,
2912 in long theFace1, in long theFace2);
2914 * \brief The Same but with params theD = Chamfer Lenght
2915 * and theAngle = Chamfer Angle (Angle in radians)
2917 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2918 in double theD, in double theAngle,
2919 in long theFace1, in long theFace2);
2922 * \brief Perform a chamfer on all edges of the specified faces.
2923 * with distance D1 on the first specified face (if several for one edge)
2924 * \param theShape Shape, to perform chamfer on.
2925 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2926 * connected to the edge, are in \a theFaces, \a theD1
2927 * will be get along face, which is nearer to \a theFaces beginning.
2928 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2929 * \param theFaces Sequence of global indices of faces of \a theShape.
2930 * \note Global index of sub-shape can be obtained, using method
2931 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2932 * \return New GEOM_Object, containing the result shape.
2934 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2935 in double theD1, in double theD2,
2936 in ListOfLong theFaces);
2938 * The Same but with params theD = Chamfer Lenght
2939 * and theAngle = Chamfer Angle (Angle in radians)
2941 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2942 in double theD, in double theAngle,
2943 in ListOfLong theFaces);
2946 * \brief Perform a chamfer on edges,
2947 * with distance D1 on the first specified face (if several for one edge)
2948 * \param theShape Shape, to perform chamfer on.
2949 * \param theD1,theD2 Chamfer size
2950 * \param theEdges Sequence of edges of \a theShape.
2951 * \return New GEOM_Object, containing the result shape.
2953 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2954 in double theD1, in double theD2,
2955 in ListOfLong theEdges);
2957 * The Same but with params theD = Chamfer Lenght
2958 * and theAngle = Chamfer Angle (Angle in radians)
2960 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2961 in double theD, in double theAngle,
2962 in ListOfLong theEdges);
2965 * \brief Perform an Archimde operation on the given shape with given parameters.
2966 * The object presenting the resulting face is returned
2967 * \param theShape Shape to be put in water.
2968 * \param theWeight Weight og the shape.
2969 * \param theWaterDensity Density of the water.
2970 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
2971 * \return New GEOM_Object, containing a section of \a theShape
2972 * by a plane, corresponding to water level.
2974 GEOM_Object MakeArchimede (in GEOM_Object theShape,
2975 in double theWeight,
2976 in double theWaterDensity,
2977 in double theMeshDeflection);
2980 * \brief Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2982 * Present here only for compatibility.
2984 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2987 // # GEOM_IHealingOperations:
2989 * \brief Interface for shape healing operations
2991 * Shape Processing, SuppressFaces, etc.
2993 interface GEOM_IHealingOperations : GEOM_IOperations
2996 * \brief Apply a sequence of Shape Healing operators to the given object.
2997 * \param theShapes Shape to be processed.
2998 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2999 * \param theParameters List of names of parameters
3000 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
3001 * \param theValues List of values of parameters, in the same order
3002 * as parameters are listed in \a theParameters list.
3003 * \return New GEOM_Object, containing processed shape.
3005 GEOM_Object ProcessShape (in GEOM_Object theShapes,
3006 in string_array theOperators,
3007 in string_array theParameters,
3008 in string_array theValues);
3011 * \brief Get default sequence of operators, their parameters and parameters' values
3012 * of Shape Process operation.
3014 * In the current implementation the defaults are
3015 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3016 * \param theOperators Output. Default list of names of operators.
3017 * \param theParameters Output. Default list of names of parameters.
3018 * \param theValues Output. List of default values of parameters, in the same order
3019 * as parameters are listed in \a theParameters list.
3021 void GetShapeProcessParameters (out string_array theOperators,
3022 out string_array theParameters,
3023 out string_array theValues);
3025 * \brief Get parameters and parameters' values for the given Shape Process operation.
3027 * In the current implementation the defaults are
3028 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3029 * \param theOperator Input. The operator's name.
3030 * \param theParameters Output. Default list of names of parameters.
3031 * \param theValues Output. List of default values of parameters, in the same order
3032 * as parameters are listed in \a theParameters list.
3034 void GetOperatorParameters (in string theOperator,
3035 out string_array theParameters,
3036 out string_array theValues);
3039 * \brief Remove faces from the given object (shape).
3040 * \param theObject Shape to be processed.
3041 * \param theFaces Indices of faces to be removed, if EMPTY then the method
3042 * removes ALL faces of the given object.
3043 * \return New GEOM_Object, containing processed shape.
3045 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
3048 * \brief Close an open wire.
3049 * \param theObject Shape to be processed.
3050 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
3051 * if -1, then theObject itself is a wire.
3052 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
3053 * If FALS : closure by creation of an edge between ends.
3054 * \return New GEOM_Object, containing processed shape.
3056 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
3057 in boolean isCommonVertex);
3060 * \brief Remove internal wires and edges from the given object (face).
3061 * \param theObject Shape to be processed.
3062 * \param theWires Indices of wires to be removed, if EMPTY then the method
3063 * removes ALL internal wires of the given object.
3064 * \return New GEOM_Object, containing processed shape.
3066 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
3069 * \brief Remove internal closed contours (holes) from the given object.
3070 * \param theObject Shape to be processed.
3071 * \param theWires Indices of wires to be removed, if EMPTY then the method
3072 * removes ALL internal holes of the given object
3073 * \return New GEOM_Object, containing processed shape.
3075 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
3078 * Sewing of the given object.
3079 * \param theObject Shape to be processed.
3080 * \param theTolerance Required tolerance value.
3081 * \return New GEOM_Object, containing processed shape.
3083 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
3086 * \brief Addition of a point to a given edge object.
3087 * \param theObject Shape to be processed.
3088 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
3089 * if -1, then theObject itself is the edge.
3090 * \param theValue Value of parameter on edge or length parameter,
3091 * depending on \a isByParameter.
3092 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
3093 * if FALSE : \a theValue is treated as a length parameter [0..1]
3094 * \return New GEOM_Object, containing processed shape.
3096 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
3097 in double theValue, in boolean isByParameter);
3100 * \brief Get a list of wires (wrapped in GEOM_Object-s),
3101 * that constitute a free boundary of the given shape.
3102 * \param theObject Shape to get free boundary of.
3103 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
3104 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
3105 * \return FALSE, if an error(s) occured during the method execution.
3107 boolean GetFreeBoundary (in GEOM_Object theObject,
3108 out ListOfGO theClosedWires,
3109 out ListOfGO theOpenWires);
3112 * \brief Change orientation of the given object.
3113 * \param theObject Shape to be processed.
3114 * \return New GEOM_Object, containing processed shape.
3116 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
3117 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
3120 * \brief Try to limit tolerance of the given object by value \a theTolerance.
3121 * \param theObject Shape to be processed.
3122 * \param theTolerance Required tolerance value.
3123 * \return New GEOM_Object, containing processed shape.
3125 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
3129 // # GEOM_IInsertOperations:
3131 * \brief Interface for shape insert operations (like copy, import).
3134 interface GEOM_IInsertOperations : GEOM_IOperations
3137 * \brief Create a copy of the given object
3139 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
3142 * \brief Export the given shape into a file with given name.
3143 * \param theObject Shape to be stored in the file.
3144 * \param theFileName Name of the file to store the given shape in.
3145 * \param theFormatName Specify format for the shape storage.
3146 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3148 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
3151 * \brief Import a shape from the BRep or IGES or STEP file
3152 * (depends on given format) with given name.
3153 * \param theFileName The file, containing the shape.
3154 * \param theFormatName Specify format for the file reading.
3155 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3156 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
3157 * set to 'meter' and result model will be scaled.
3158 * \return New GEOM_Object, containing the imported shape.
3160 GEOM_Object ImportFile (in string theFileName, in string theFormatName);
3163 * \brief Get the supported import formats and corresponding patterns for File dialog.
3164 * \param theFormats Output. List of formats, available for import.
3165 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3166 * \return Returns available formats and patterns through the arguments.
3168 void ImportTranslators (out string_array theFormats,
3169 out string_array thePatterns);
3172 * \brief Get the supported export formats and corresponding patterns for File dialog.
3173 * \param theFormats Output. List of formats, available for export.
3174 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3175 * \return Returns available formats and patterns through the arguments.
3177 void ExportTranslators (out string_array theFormats,
3178 out string_array thePatterns);
3181 * \brief Load texture from file
3182 * \param theTextureFile texture file name
3183 * \return unique texture identifier
3185 long LoadTexture(in string theTextureFile);
3188 * \brief Add texture to the study
3189 * \param theWidth texture width in pixels
3190 * \param theHeight texture height in pixels
3191 * \param theTexture texture byte array
3192 * \return unique texture identifier
3194 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
3197 * \brief Get previously loaded texture data
3198 * \param theID texture identifier
3199 * \param theWidth texture width in pixels
3200 * \param theHeight texture height in pixels
3201 * \return texture byte array
3203 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
3206 * \brief Get list of all avaiable texture IDs
3207 * \return list of all texture IDs avaiable for the current study
3209 ListOfLong GetAllTextures();
3212 // # GEOM_IKindOfShape:
3214 * \brief Interface for shape_kind enumeration.
3216 interface GEOM_IKindOfShape
3230 /*! box with faces, parallel to global coordinate planes */
3238 /*! solid, bounded by polygons */
3243 /*! spherical face (closed) */
3245 /*! cylindrical face with defined height */
3247 /*! toroidal face (closed) */
3249 /*! conical face with defined height */
3251 /*! planar, bounded by circle */
3253 /*! planar, bounded by ellipse */
3255 /*! planar, bounded by segments */
3257 /*! infinite planar */
3266 /*! arc of circle */
3270 /*! arc of ellipse */
3272 /*! infinite segment */
3281 /*! all advanced shapes (temporary implementation) */
3286 // # GEOM_IMeasureOperations:
3288 * \brief Interface for measurement (distance, whatis) and
3289 * properties calculation (like Centre of Mass, Inertia, etc.).
3292 interface GEOM_IMeasureOperations : GEOM_IOperations
3295 * \brief Get kind of theShape.
3296 * \param theShape Shape to get a kind of.
3297 * \param theIntegers Output. Integer and enumerated shape's parameters
3298 * (kind of surface, closed/unclosed, number of edges, etc.)
3299 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
3300 * \note Concrete meaning of each value, returned via \a theIntegers
3301 * or \a theDoubles list depends on the kind of the shape.
3302 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
3304 //short KindOfShape (in GEOM_Object theShape,
3305 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
3306 out ListOfLong theIntegers,
3307 out ListOfDouble theDoubles);
3310 * \brief Get position (LCS) of theShape.
3311 * \param theShape Shape to calculate position of.
3312 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
3313 * Origin of the LCS is situated at the shape's center of mass.
3314 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
3315 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
3316 * Axes of the LCS are obtained from shape's location or,
3317 * if the shape is a planar face, from position of its plane.
3318 * \return Returns position of the shape through the last nine arguments.
3320 void GetPosition (in GEOM_Object theShape,
3321 out double Ox, out double Oy, out double Oz,
3322 out double Zx, out double Zy, out double Zz,
3323 out double Xx, out double Xy, out double Xz);
3326 * \brief Get summarized length of all wires,
3327 * area of surface and volume of the given shape.
3328 * \param theShape Shape to define properties of.
3329 * \param theLength Output. Summarized length of all wires of the given shape.
3330 * \param theSurfArea Output. Area of surface of the given shape.
3331 * \param theVolume Output. Volume of the given shape.
3332 * \return Returns shape properties through the last three arguments.
3334 void GetBasicProperties (in GEOM_Object theShape,
3335 out double theLength,
3336 out double theSurfArea,
3337 out double theVolume);
3340 * \brief Get a point, situated at the centre of mass of theShape.
3341 * \param theShape Shape to define centre of mass of.
3342 * \return New GEOM_Object, containing the created point.
3344 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
3347 * Get the vertex by index for 1D objects depends the edge/wire orientation
3348 * \param theShape Shape (wire or edge) to find the vertex on it
3349 * \param theIndex Index of vertex sub-shape
3350 * \return New GEOM_Object, vertex.
3352 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
3355 * \brief Get a vector, representing the normal of theFace.
3356 * If the face is not planar, theOptionalPoint is obligatory.
3357 * \param theFace Shape (face) to define the normal of.
3358 * \param theOptionalPoint Shape (point) to define the normal at.
3359 * Can be NULL in case of planar face.
3360 * \return New GEOM_Object, containing the created normal vector.
3362 GEOM_Object GetNormal (in GEOM_Object theFace,
3363 in GEOM_Object theOptionalPoint);
3366 * \brief Get inertia matrix and moments of inertia of theShape.
3367 * \param theShape Shape to calculate inertia of.
3368 * \param I11,I12,I13,I21,I22,I23,I31,I32,I33 Output. Components of the inertia matrix of the given shape.
3369 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
3370 * \return Returns inertia through the last twelve arguments.
3372 void GetInertia (in GEOM_Object theShape,
3373 out double I11, out double I12, out double I13,
3374 out double I21, out double I22, out double I23,
3375 out double I31, out double I32, out double I33,
3376 out double Ix , out double Iy , out double Iz);
3379 * \brief Get parameters of bounding box of the given shape
3380 * \param theShape Shape to obtain bounding box of.
3381 * \param Xmin,Xmax Output. Limits of shape along OX axis.
3382 * \param Ymin,Ymax Output. Limits of shape along OY axis.
3383 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
3384 * \return Returns parameters of bounding box through the last six arguments.
3386 void GetBoundingBox (in GEOM_Object theShape,
3387 out double Xmin, out double Xmax,
3388 out double Ymin, out double Ymax,
3389 out double Zmin, out double Zmax);
3392 * \brief Get min and max tolerances of sub-shapes of theShape
3393 * \param theShape Shape, to get tolerances of.
3394 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3395 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
3396 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
3397 * \return Returns shape tolerances through the last six arguments.
3399 void GetTolerance (in GEOM_Object theShape,
3400 out double FaceMin, out double FaceMax,
3401 out double EdgeMin, out double EdgeMax,
3402 out double VertMin, out double VertMax);
3405 * \brief Check a topology of the given shape.
3406 * \param theShape Shape to check validity of.
3407 * \param theDescription Output. Description of problems in the shape, if they are.
3408 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
3410 boolean CheckShape (in GEOM_Object theShape,
3411 out string theDescription);
3414 * \brief Check a topology and a geometry of the given shape.
3415 * \param theShape Shape to check validity of.
3416 * \param theDescription Output. Description of problems in the shape, if they are.
3417 * \return TRUE, if the shape "seems to be valid".
3419 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
3420 out string theDescription);
3423 * \brief Check a topology of the given shape on self-intersections presence.
3424 * \param theShape Shape to check validity of.
3425 * \param theIntersections Output. List of intersected sub-shapes IDs, it contains pairs of IDs.
3426 * \return TRUE, if the shape does not have any self-intersections.
3428 boolean CheckSelfIntersections (in GEOM_Object theShape,
3429 out ListOfLong theIntersections);
3432 * \brief Check if the given shape can be an argument for MakeSolid operation
3433 * \param theShape Shape to be described.
3434 * \return Empty string if a solid can be made on this shape, error code otherwise.
3436 string IsGoodForSolid (in GEOM_Object theShape);
3439 * O\brief btain description of the given shape
3440 * \param theShape Shape to be described.
3441 * \return Description of the given shape.
3443 string WhatIs (in GEOM_Object theShape);
3446 * \brief Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on
3447 * the shape theShape.
3448 * \param theShape Shape to check.
3449 * \param coords list of coordinates.
3450 * \param tolerance tolerance.
3451 * \return list of boolean.
3453 ListOfBool AreCoordsInside(in GEOM_Object theShape, in ListOfDouble coords, in double tolerance);
3456 * \brief Get minimal distance between the given shapes.
3457 * \param theShape1,theShape2 Shapes to find minimal distance between.
3458 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
3459 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
3460 * \return Value of the minimal distance between the given shapes.
3462 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
3463 out double X1, out double Y1, out double Z1,
3464 out double X2, out double Y2, out double Z2);
3467 * \brief Get angle between the given lines or linear edges.
3468 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
3469 * \return Value of the angle between the given shapes.
3471 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
3474 * \brief Get angle between the given vectors.
3475 * \param theShape1,theShape2 Vectors to find angle between.
3476 * \return Value of the angle between the given vectors.
3478 double GetAngleBtwVectors (in GEOM_Object theShape1, in GEOM_Object theShape2);
3481 * \brief Get point coordinates
3483 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
3486 * \brief Get radius of curvature of curve in the point determinated by param
3487 * \param theShape - curve.
3488 * \param theParam - parameter on curve
3489 * \return Value of curvature.
3491 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3494 * \brief Get radius of curvature of curve in the given point
3495 * \param theShape - curve.
3496 * \param thePoint - point
3497 * \return Value of curvature.
3499 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3502 * \brief Get max radius of curvature of surface in the point determinated by params
3503 * \param theShape - surface.
3504 * \param theUParam - U-parameter on surface
3505 * \param theVParam - V-parameter on surface
3506 * \return Value of curvature.
3508 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3509 in double theVParam);
3512 * \brief Get max radius of curvature of surface in the given point
3513 * \param theShape - surface.
3514 * \param thePoint - point
3515 * \return Value of curvature.
3517 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3520 * \brief Get min radius of curvature of surface in the point determinated by params
3521 * \param theShape - surface.
3522 * \param theUParam - U-parameter on surface
3523 * \param theVParam - V-parameter on surface
3524 * \return Value of curvature.
3526 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3527 in double theVParam);
3530 * \brief Get min radius of curvature of surface in the given point
3531 * \param theShape - surface.
3532 * \param thePoint - point
3533 * \return Value of curvature.
3535 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3539 // # GEOM_IGroupOperations:
3541 * \brief Interface for groups creation.
3543 interface GEOM_IGroupOperations : GEOM_IOperations
3546 * \brief Creates a new group which will store sub-shapes of theMainShape
3547 * \param theMainShape is a GEOM_Object on which the group is selected
3548 * \param theShapeType defines a shape type of the group
3549 * \return a newly created GEOM group
3551 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3554 * \brief Adds a sub-object with ID theSubShapeId to the group
3555 * \param theGroup is a GEOM group to which the new sub-shape is added
3556 * \param theSubShapeId is a sub-shape ID in the main object.
3557 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
3559 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3562 * \brief Removes a sub-object with ID \a theSubShapeId from the group
3563 * \param theGroup is a GEOM group from which the sub-shape is removed.
3564 * \param theSubShapeId is a sub-shape ID in the main object.
3565 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
3567 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3570 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3571 * \param theGroup is a GEOM group to which the new sub-shapes are added.
3572 * \param theSubShapes is a list of sub-shapes to be added.
3574 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3577 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
3578 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3579 * \param theSubShapes is a list of sub-shapes to be removed.
3581 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3584 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3585 * \param theGroup is a GEOM group to which the new sub-shapes are added.
3586 * \param theSubShapes is a list of IDs of sub-shapes to be added.
3588 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3591 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
3592 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3593 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3595 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3598 * \brief Returns a type of sub-objects stored in the group
3599 * \param theGroup is a GEOM group which type is returned.
3601 long GetType (in GEOM_Object theGroup);
3604 * \brief Returns a main shape associated with the group
3605 * \param theGroup is a GEOM group for which a main shape object is requested
3606 * \return a GEOM_Object which is a main shape for theGroup
3608 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3611 * \brief Returns a list of sub-objects ID stored in the group
3612 * \param theGroup is a GEOM group for which a list of IDs is requested
3614 ListOfLong GetObjects (in GEOM_Object theGroup);
3617 // # GEOM_IAdvancedOperations:
3619 * \brief Interface for advanced modeling functions.
3621 interface GEOM_IAdvancedOperations : GEOM_IOperations
3624 * \brief Create a T-shape object with specified caracteristics for the main and
3625 * the incident pipes (radius, width, half-length).
3627 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3628 * \param theR1 Internal radius of main pipe
3629 * \param theW1 Width of main pipe
3630 * \param theL1 Half-length of main pipe
3631 * \param theR2 Internal radius of incident pipe (R2 < R1)
3632 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3633 * \param theL2 Half-length of incident pipe
3634 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3635 * \return List of GEOM_Object, containing the created shape and propagation groups.
3637 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
3638 in double theR2, in double theW2, in double theL2,
3639 in boolean theHexMesh);
3641 * \brief Create a T-shape object with specified caracteristics for the main and
3642 * the incident pipes (radius, width, half-length).
3644 * The extremities of the main pipe are located on junctions points P1 and P2.
3645 * The extremity of the incident pipe is located on junction point P3.
3646 * \param theR1 Internal radius of main pipe
3647 * \param theW1 Width of main pipe
3648 * \param theL1 Half-length of main pipe
3649 * \param theR2 Internal radius of incident pipe (R2 < R1)
3650 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3651 * \param theL2 Half-length of incident pipe
3652 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3653 * \param theP1 1st junction point of main pipe
3654 * \param theP2 2nd junction point of main pipe
3655 * \param theP3 Junction point of incident pipe
3656 * \return List of GEOM_Object, containing the created shape and propagation groups.
3658 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
3659 in double theR2, in double theW2, in double theL2,
3660 in boolean theHexMesh,
3661 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3663 * \brief Create a T-shape object with specified caracteristics for the main and
3664 * the incident pipes (radius, width, half-length). A chamfer is created
3665 * on the junction of the pipes.
3667 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3668 * \param theR1 Internal radius of main pipe
3669 * \param theW1 Width of main pipe
3670 * \param theL1 Half-length of main pipe
3671 * \param theR2 Internal radius of incident pipe (R2 < R1)
3672 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3673 * \param theL2 Half-length of incident pipe
3674 * \param theH Height of the chamfer.
3675 * \param theW Width of the chamfer.
3676 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3677 * \return List of GEOM_Object, containing the created shape and propagation groups.
3679 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
3680 in double theR2, in double theW2, in double theL2,
3681 in double theH, in double theW, in boolean theHexMesh);
3683 * \brief Create a T-shape object with specified caracteristics for the main and
3684 * the incident pipes (radius, width, half-length).
3686 * A chamfer is created on the junction of the pipes.
3687 * The extremities of the main pipe are located on junctions points P1 and P2.
3688 * The extremity of the incident pipe is located on junction point P3.
3689 * \param theR1 Internal radius of main pipe
3690 * \param theW1 Width of main pipe
3691 * \param theL1 Half-length of main pipe
3692 * \param theR2 Internal radius of incident pipe (R2 < R1)
3693 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3694 * \param theL2 Half-length of incident pipe
3695 * \param theH Height of the chamfer.
3696 * \param theW Width of the chamfer.
3697 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3698 * \param theP1 1st junction point of main pipe
3699 * \param theP2 2nd junction point of main pipe
3700 * \param theP3 Junction point of incident pipe
3701 * \return List of GEOM_Object, containing the created shape and propagation groups.
3703 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
3704 in double theR2, in double theW2, in double theL2,
3705 in double theH, in double theW, in boolean theHexMesh,
3706 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3708 * \brief Create a T-shape object with specified caracteristics for the main and
3709 * the incident pipes (radius, width, half-length).
3711 * A fillet is created on the junction of the pipes.
3712 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3713 * \param theR1 Internal radius of main pipe
3714 * \param theW1 Width of main pipe
3715 * \param theL1 Half-length of main pipe
3716 * \param theR2 Internal radius of incident pipe (R2 < R1)
3717 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3718 * \param theL2 Half-length of incident pipe
3719 * \param theRF Radius of curvature of fillet.
3720 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3721 * \return List of GEOM_Object, containing the created shape and propagation groups.
3723 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
3724 in double theR2, in double theW2, in double theL2,
3725 in double theRF, in boolean theHexMesh);
3727 * \brief Create a T-shape object with specified caracteristics for the main and
3728 * the incident pipes (radius, width, half-length).
3730 * A fillet is created on the junction of the pipes.
3731 * The extremities of the main pipe are located on junctions points P1 and P2.
3732 * The extremity of the incident pipe is located on junction point P3.
3733 * \param theR1 Internal radius of main pipe
3734 * \param theW1 Width of main pipe
3735 * \param theL1 Half-length of main pipe
3736 * \param theR2 Internal radius of incident pipe (R2 < R1)
3737 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3738 * \param theL2 Half-length of incident pipe
3739 * \param theRF Radius of curvature of fillet.
3740 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3741 * \param theP1 1st junction point of main pipe
3742 * \param theP2 2nd junction point of main pipe
3743 * \param theP3 Junction point of incident pipe
3744 * \return List of GEOM_Object, containing the created shape and propagation groups.
3746 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
3747 in double theR2, in double theW2, in double theL2,
3748 in double theRF, in boolean theHexMesh,
3749 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3750 /*@@ insert new functions before this line @@ do not remove this line @@*/
3755 * \brief Interface to access other GEOM interfaces.
3757 * Also contains some methods to access and manage GEOM_Object.
3759 interface GEOM_Gen : Engines::EngineComponent,SALOMEDS::Driver
3762 * \brief Undo/Redo Management
3765 void Undo (in long theStudyID);
3767 void Redo (in long theStudyID);
3770 * \brief Publishing management
3772 * Adds in theStudy a object theObject under with a name theName,
3773 * if theFather is not NULL the object is placed under thFather's SObject.
3774 * Returns a SObject where theObject is placed
3776 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3777 in GEOM_Object theObject,
3779 in GEOM_Object theFather);
3782 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
3784 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3785 * \param theStudy the study, in which theObject is published already,
3786 * and in which the arguments will be published
3787 * \param theObject published GEOM_Object, arguments of which will be published
3788 * \param theArgs list of GEOM_Object, operation arguments to be published.
3789 * If this list is empty, all operation arguments will be published
3790 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
3791 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
3792 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3793 * Do not publish sub-shapes in place of arguments, but only
3794 * in place of sub-shapes of the first argument,
3795 * because the whole shape corresponds to the first argument.
3796 * Mainly to be used after transformations, but it also can be
3797 * usefull after partition with one object shape, and some other
3798 * operations, where only the first argument has to be considered.
3799 * If theObject has only one argument shape, this flag is automatically
3800 * considered as True, not regarding really passed value.
3801 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3802 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
3803 * \return list of published sub-shapes
3805 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
3806 in GEOM_Object theObject,
3807 in ListOfGO theArgs,
3808 in find_shape_method theFindMethod,
3809 in boolean theInheritFirstArg,
3810 in boolean theAddPrefix);
3813 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
3815 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3816 * \param theStudy the study, in which theObject is published already,
3817 * and in which the arguments will be published
3818 * \param theObject published GEOM_Object, arguments of which will be published
3819 * \param theArgs list of GEOM_Object, operation arguments to be published.
3820 * If this list is empty, all operation arguments will be published
3821 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
3822 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
3823 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3824 * Do not publish sub-shapes in place of arguments, but only
3825 * in place of sub-shapes of the first argument,
3826 * because the whole shape corresponds to the first argument.
3827 * Mainly to be used after transformations, but it also can be
3828 * usefull after partition with one object shape, and some other
3829 * operations, where only the first argument has to be considered.
3830 * If theObject has only one argument shape, this flag is automatically
3831 * considered as True, not regarding really passed value.
3832 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3833 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
3834 * \return list of published sub-shapes
3836 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
3837 in GEOM_Object theObject,
3838 in ListOfGO theArgs,
3839 in find_shape_method theFindMethod,
3840 in boolean theInheritFirstArg,
3841 in boolean theAddPrefix);
3844 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
3846 * To be used from GUI and from geompy.addToStudy.
3847 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
3848 * \param theStudy the study, in which theObject is published already,
3849 * and in which the arguments will be published
3850 * \param theSObject study object, referencing GEOM_Object, arguments of which will be published
3851 * \param theArgs list of GEOM_Object, operation arguments to be published.
3852 * If this list is empty, all operation arguments will be published
3853 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
3854 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
3855 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3856 * Do not publish sub-shapes in place of arguments, but only
3857 * in place of sub-shapes of the first argument,
3858 * because the whole shape corresponds to the first argument.
3859 * Mainly to be used after transformations, but it also can be
3860 * usefull after partition with one object shape, and some other
3861 * operations, where only the first argument has to be considered.
3862 * If theObject has only one argument shape, this flag is automatically
3863 * considered as True, not regarding really passed value.
3864 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3865 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
3867 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
3868 in SALOMEDS::SObject theSObject,
3869 in ListOfGO theArgs,
3870 in find_shape_method theFindMethod,
3871 in boolean theInheritFirstArg,
3872 in boolean theAddPrefix);
3874 // # Methods to access interfaces for objects creation and transformation
3876 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3877 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
3878 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3879 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3880 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3881 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3882 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3883 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3884 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3885 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3886 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3887 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3888 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3890 // # Objects Management
3894 * \brief Removes the object from the GEOM component
3895 * \param theObject is a GEOM_Object to be removed
3897 void RemoveObject (in GEOM_Object theObject);
3900 * \brief Returns an object defined by the study and its entry in the GEOM component
3901 * \param theStudyID is a SALOMEDS Study ID
3902 * \param theEntry is an entry of the requested GEOM_Object in the GEOM component
3903 * \note if the object has not previously been created a NULL GEOM_Object is returned
3905 GEOM_Object GetObject (in long theStudyID, in string theEntry);
3908 * \brief Add a sub-shape defined by indices in \a theIndices
3909 * (contains unique IDs of sub-shapes inside \a theMainShape)
3910 * \note The sub-shape GEOM_Object can has ONLY ONE function.
3911 * Don't try to apply modification operations on them.
3912 * \note Internal method
3914 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
3916 // # GEOM_Objects IOR Management
3919 * \brief Returns a GEOM_Object defined by its IOR
3920 * \param theIOR a string containg an IOR of the requested GEOM_Object
3922 GEOM_Object GetIORFromString (in string theIOR);
3925 * \brief Returns a string which contains an IOR of the GEOM_Object
3926 * \param theObject is a GEOM_Object which IOR is requested
3928 string GetStringFromIOR (in GEOM_Object theObject);
3931 * \brief Returns a name with which a GEOM_Object was dumped into python script
3932 * \param theStudyEntry is an entry of the GEOM_Object in the study
3934 string GetDumpName (in string theStudyEntry);
3937 * \brief Returns all names with which a GEOM_Object was dumped
3938 * into python script to avoid the same names in SMESH script
3940 string_array GetAllDumpNames();
3943 * \brief Publishes the named sub-shapes of given object in the study.
3944 * \param theStudy The study in which the object is published
3945 * \param theObject The object which named sub-shapes are published
3947 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
3948 //in SObject theSObject,
3949 in Object theObject);