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 * \brief Pattern for block division of the disk
183 * Used in the functions GEOM_IAdvancedOperations.MakeDividedDisk(), GEOM_ICurvesOperations.MakeDividedDiskPntVecR()
194 typedef sequence<string> string_array;
195 typedef sequence<short> short_array;
196 typedef sequence<boolean> ListOfBool;
197 typedef sequence<long> ListOfLong;
198 typedef sequence<double> ListOfDouble;
200 interface GEOM_Object;
202 typedef sequence<GEOM_Object> ListOfGO;
206 * \brief Interface of geometric object
208 interface GEOM_Object : SALOME::GenericObj
212 * \brief Get an entry of the object in GEOM component.
217 * \brief Get ID of study, where the object is created.
222 * \brief Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
227 * \brief Get a <VAR>shape_type</VAR> of the object value.
229 shape_type GetShapeType();
232 * \brief Get the topology type of the object value.
234 * In contrast to the shape type, this function returns type of the most
235 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
239 shape_type GetTopologyType();
242 * \brief Get a minimal type of the top-level shapes contained in the object.
244 * This function is useful for the compounds only; for simple shapes it
245 * exactly the same value as GetShapeType().
246 * Note, that compounds are procesed recursively.
248 * \sa GetShapeType(), GetTopologyType(), GetMaxShapeType()
250 shape_type GetMinShapeType();
253 * \brief Get a maximal type of the top-level shapes contained in the object.
255 * This function is useful for the compounds only; for simple shapes it
256 * exactly the same value as GetShapeType().
257 * Note, that compounds are procesed recursively.
259 * \sa GetShapeType(), GetTopologyType(), GetMinShapeType()
261 shape_type GetMaxShapeType();
264 * \brief Set name of the object.
266 * \param theName is a name which will be associated with this object.
268 void SetName (in string theName);
271 * \brief Get name of the object associated with this object.
276 * \brief Set color of the object.
278 * \param theColor is a color of the object.
280 void SetColor(in SALOMEDS::Color theColor);
283 * Get color of the object.
285 SALOMEDS::Color GetColor();
288 * Toggle auto color mode on the object.
289 * \param theAutoColor is a flag which toggles auto color mode.
291 void SetAutoColor(in boolean theAutoColor);
294 * \brief Get flag of object's auto color mode.
296 boolean GetAutoColor();
299 * \brief Set standard point marker for the object
300 * \param theType standard marker type
301 * \param theSize marker relative size
303 void SetMarkerStd(in marker_type theType, in marker_size theSize );
306 * \brief Set custom point marker for the object.
308 * The texture can be added by LoadTexture() or AddTexture() functions.
309 * \param theTextureId texture ID
311 void SetMarkerTexture(in long theTextureId);
314 * \brief Get type of the point marker assigned to the object
315 * \return current marker type (MT_NONE if no marker is set)
317 marker_type GetMarkerType();
320 * \brief Get size of the point marker assigned to the object
321 * \return current marker relative size (MS_NONE if no marker is set)
323 marker_size GetMarkerSize();
326 * \brief Get texture idenifier of the point marker assigned to the object
327 * \return marker texture ID (0 if no marker set)
329 long GetMarkerTexture();
332 * \brief Set a Study entry where this object was published.
334 void SetStudyEntry (in string theEntry);
337 * \brief Get a Study entry where this object was published.
339 string GetStudyEntry();
342 * \brief Get a list of all GEOM_Object on which were the arguments
343 * when this object was constructed and modified.
344 * \note This method is supposed to be used by GUI only.
346 ListOfGO GetDependency();
349 * \brief Get a list of GEOM_Object on which the last function that created or modified the object depends.
350 * \note This method is supposed to be used by GUI only.
352 ListOfGO GetLastDependency();
355 * \brief Get the TopoDS_Shape, for colocated case only.
357 long long getShape();
359 // ######################################################################
360 // # Internal methods (For sub-shape identification)
361 // ######################################################################
363 * \brief Get geometric shape of the object as a byte stream
365 SALOMEDS::TMPFile GetShapeStream();
368 * \brief Returns True if this object is not a sub-shape of another object.
370 boolean IsMainShape();
373 * \brief Get a list of ID's of sub-shapes in the main shape.
374 * \note Internal method, suppopsed to be used only by GEOM_Client
376 ListOfLong GetSubShapeIndices();
379 * \brief Get a main shape object to which this object is a sub-shape
380 * \note Internal method, suppopsed to be used only by GEOM_Client
382 GEOM_Object GetMainShape();
385 * \brief Return true if geom object representes a shape.
387 * For example, method return false for GEOM_MARKER
392 * \brief Return true if passed object is identical to this object
394 * \param other object being compared with this one
396 boolean IsSame(in GEOM_Object other);
399 * Set list of parameters
400 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
401 * used for object creation
403 void SetParameters (in string theParameters);
406 * \brief Return list of notebook variables used for object creation separated by ":" symbol
408 string GetParameters();
411 // # GEOM_IOperations:
413 * \brief Basic methods of all geometric operations
415 interface GEOM_IOperations : SALOME::GenericObj
418 * \brief To know, if the operation was successfully performed
423 * \brief Set the operation error code
424 * \param theErrorID is a string describing the error occured
425 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
427 void SetErrorCode (in string theErrorID);
430 * \brief Get the operation error code
432 string GetErrorCode();
435 * \brief Get ID of study, where the operation is defined
440 * \brief Opens a new transaction
442 void StartOperation();
445 * \brief Closes the previously opened trasaction
447 void FinishOperation();
450 * \brief Aborts the previously opened transaction
452 void AbortOperation();
454 //# GEOM_IBasicOperations:
456 * \brief Interface for basic geometry creation
458 * (Point, Vector, Plane, Marker)
460 interface GEOM_IBasicOperations : GEOM_IOperations
463 * \brief Create point by three coordinates.
464 * \param theX The X coordinate of the point.
465 * \param theY The Y coordinate of the point.
466 * \param theZ The Z coordinate of the point.
467 * \return New GEOM_Object, containing the created point.
469 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
472 * \brief Create a point, distant from the referenced point
473 * on the given distances along the coordinate axes.
474 * \param theReference The referenced point.
475 * \param theX Displacement from the referenced point along OX axis.
476 * \param theY Displacement from the referenced point along OY axis.
477 * \param theZ Displacement from the referenced point along OZ axis.
478 * \return New GEOM_Object, containing the created point.
480 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
481 in double theX, in double theY, in double theZ);
484 * Create a point, corresponding to the given parameter on the given curve.
485 * \param theRefCurve The referenced curve.
486 * \param theParameter Value of parameter on the referenced curve.
487 * \return New GEOM_Object, containing the created point.
489 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
490 in double theParameter);
493 * \brief Create a point, corresponding to the given length on the given curve.
494 * \param theRefCurve The referenced curve.
495 * \param theLength Length on the referenced curve. It can be negative.
496 * \param theStartPoint Any vertex close to one of edge's
497 * ends to select start point among them.
498 * If NULL, fist vertex is used.
499 * \return New GEOM_Object, containing the created point.
501 GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve,
503 in GEOM_Object theStartPoint);
506 * \brief Create a point on the given curve, projecting given point
507 * \param theRefCurve The referenced curve.
508 * \param theXParameter X co-ordinate of point to project on curve
509 * \param theYParameter Y co-ordinate of point to project on curve
510 * \param theZParameter Z co-ordinate of point to project on curve
511 * \return New GEOM_Object, containing the created point.
513 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
514 in double theXParameter,
515 in double theYParameter,
516 in double theZParameter);
519 * \brief Create a point, corresponding to the given parameters on the
521 * \param theRefSurf The referenced surface.
522 * \param theUParameter Value of U-parameter on the referenced surface.
523 * \param theVParameter Value of V-parameter on the referenced surface.
524 * \return New GEOM_Object, containing the created point.
526 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
527 in double theUParameter,
528 in double theVParameter);
531 * \brief Create a point on the given surface, projecting given point
532 * \param theRefSurf The referenced surface.
533 * \param theXParameter X co-ordinate of point to project on curve
534 * \param theYParameter Y co-ordinate of point to project on curve
535 * \param theZParameter Z co-ordinate of point to project on curve
536 * \return New GEOM_Object, containing the created point.
538 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
539 in double theXParameter,
540 in double theYParameter,
541 in double theZParameter);
545 * \brief Create a point, on two lines intersection.
546 * \param theRefLine1, theRefLine2 The referenced lines.
547 * \return New GEOM_Object, containing the created point.
549 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
550 in GEOM_Object theRefLine2);
553 * \brief Create a vector, corresponding to tangent to the given parameter on the given curve.
554 * \param theRefCurve The referenced curve.
555 * \param theParameter Value of parameter on the referenced curve.This value should be have value
556 * between 0. and 1.. Value of 0. corresponds first parameter of curve; value
557 * 1. corresponds last parameter of curve.
558 * \return New GEOM_Object, containing the created point.
560 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
561 in double theParameter);
564 * \brief Create a vector with the given components.
565 * \param theDX X component of the vector.
566 * \param theDY Y component of the vector.
567 * \param theDZ Z component of the vector.
568 * \return New GEOM_Object, containing the created vector.
570 GEOM_Object MakeVectorDXDYDZ (in double theDX,
575 * \brief Create a vector between two points.
576 * \param thePnt1 Start point for the vector.
577 * \param thePnt2 End point for the vector.
578 * \return New GEOM_Object, containing the created vector.
580 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
583 * C\brief reate a line, passing through the given point
584 * and parrallel to the given direction
585 * \param thePnt Point. The resulting line will pass through it.
586 * \param theDir Direction. The resulting line will be parallel to it.
587 * \return New GEOM_Object, containing the created line.
589 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
592 * \brief Create a line, passing through the given points
593 * \param thePnt1 First of two points, defining the line.
594 * \param thePnt2 Second of two points, defining the line.
595 * \return New GEOM_Object, containing the created line.
597 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
600 * \brief Create a line, given by two faces intersection.
601 * \param theFace1 First of two faces, defining the line.
602 * \param theFace2 Second of two faces, defining the line.
603 * \return New GEOM_Object, containing the created line.
605 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
608 * \brief Create a plane, passing through the three given points
609 * \param thePnt1 First of three points, defining the plane.
610 * \param thePnt2 Second of three points, defining the plane.
611 * \param thePnt3 Fird of three points, defining the plane.
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 MakePlaneThreePnt (in GEOM_Object thePnt1,
616 in GEOM_Object thePnt2,
617 in GEOM_Object thePnt3,
618 in double theTrimSize);
621 * \brief Create a plane, passing through the given point
622 * and normal to the given vector.
623 * \param thePnt Point, the plane has to pass through.
624 * \param theVec Vector, defining the plane normal direction.
625 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
626 * \return New GEOM_Object, containing the created plane.
628 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
629 in GEOM_Object theVec,
630 in double theTrimSize);
633 * \brief Create a plane, similar to the existing one, but with another size of representing face.
634 * \param theFace Referenced plane or LCS(Marker).
635 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
636 * \return New GEOM_Object, containing the created plane.
638 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
639 in double theTrimSize);
642 * \brief Create a plane, by two vectors.
643 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
644 * \param theVec2 Vector2, defining the plane normal direction.
645 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
646 * \return New GEOM_Object, containing the created plane.
648 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
649 in GEOM_Object theVec2,
650 in double theTrimSize);
653 * \brief Create a plane, defined by local coordinate system.
654 * \param theLCS Referenced LCS(Marker).
655 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
656 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
657 * \return New GEOM_Object, containing the created plane.
659 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
660 in double theTrimSize,
661 in double theOrientation);
664 * \brief Create a local coordinate system.
665 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
666 * \param theXDX,theXDY,theXDZ Three components of OX direction
667 * \param theYDX,theYDY,theYDZ Three components of OY direction
668 * \return New GEOM_Object, containing the created coordinate system.
670 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
671 in double theXDX, in double theXDY, in double theXDZ,
672 in double theYDX, in double theYDY, in double theYDZ);
675 * \brief Create a local coordinate system from shape.
676 * \param theShape The initial shape to detect the coordinate system.
677 * \return New GEOM_Object, containing the created coordinate system.
679 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
682 * \brief Create a local coordinate system from point and two vectors (DX, DY).
683 * \param theOrigin Point of coordinate system origin.
684 * \param theXVec Vector of X direction.
685 * \param theYVec Vector of Y direction.
686 * \return New GEOM_Object, containing the created coordinate system.
688 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin,
689 in GEOM_Object theXVec, in GEOM_Object theYVec);
692 * \brief Create a tangent plane to specified face in the point with specified parameters.
694 * Values of parameters should be between 0. and 1.0
695 * \param theFace - face for which tangent plane shuold be built.
696 * \param theParameterU - value of parameter by U
697 * \param theParameterV - value of parameter Vthe
698 * \param theTrimSize - defines sizes of created face
699 * \return New GEOM_Object, containing the face built on tangent plane.
701 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
702 in double theParameterU,
703 in double theParameterV,
704 in double theTrimSize);
707 interface GEOM_ITransformOperations : GEOM_IOperations
710 * \brief Translate the given object along the vector, specified by its end points.
711 * \param theObject The object to be translated.
712 * \param thePoint1 Start point of translation vector.
713 * \param thePoint2 End point of translation vector.
716 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
717 in GEOM_Object thePoint1,
718 in GEOM_Object thePoint2);
721 * \brief Translate the given object along the vector, specified
722 * by its end points, creating its copy before the translation.
723 * \param theObject The object to be translated.
724 * \param thePoint1 Start point of translation vector.
725 * \param thePoint2 End point of translation vector.
726 * \return New GEOM_Object, containing the translated object.
728 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
729 in GEOM_Object thePoint1,
730 in GEOM_Object thePoint2);
733 * \brief Translate the given object along the vector, specified by its components.
734 * \param theObject The object to be translated.
735 * \param theDX,theDY,theDZ Components of translation vector.
738 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
739 in double theDX, in double theDY, in double theDZ);
742 * \brief Translate the given object along the vector, specified
743 * by its components, creating its copy before the translation.
744 * \param theObject The object to be translated.
745 * \param theDX,theDY,theDZ Components of translation vector.
746 * \return New GEOM_Object, containing the translated object.
748 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
749 in double theDX, in double theDY, in double theDZ);
753 * \brief Translate the given object along the given vector.
754 * \param theObject The object to be translated.
755 * \param theVector Translation vector, giving both direction and distance.
758 GEOM_Object TranslateVector (in GEOM_Object theObject,
759 in GEOM_Object theVector);
762 * \brief Translate the given object along the given vector,
763 * creating its copy before the translation.
764 * \param theObject The object to be translated.
765 * \param theVector Translation vector, giving both direction and distance.
766 * \return New GEOM_Object, containing the translated object.
768 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
769 in GEOM_Object theVector);
772 * \brief Translate the given object along the given vector on given distance,
773 * creating its copy before the translation.
774 * \param theObject The object to be translated.
775 * \param theVector Translation vector, giving a direction.
776 * \param theDistance Translation distance, giving a distance.
777 * \param theCopy Translation copy, creating its copy if true.
778 * \return New GEOM_Object, containing the translated object.
780 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
781 in GEOM_Object theVector,
782 in double theDistance,
786 * \brief Translate the given object along the given vector a given number times
787 * \param theObject The object to be translated.
788 * \param theVector Direction of the translation.
789 * \param theStep Distance to translate on.
790 * \param theNbTimes Quantity of translations to be done.
791 * \return New GEOM_Object, containing compound of all
792 * the shapes, obtained after each translation.
794 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
795 in GEOM_Object theVector,
800 * \brief Conseqently apply two specified translations to theObject specified number of times.
801 * \param theObject The object to be translated.
802 * \param theVector1 Direction of the first translation.
803 * \param theStep1 Step of the first translation.
804 * \param theNbTimes1 Quantity of translations to be done along theVector1.
805 * \param theVector2 Direction of the second translation.
806 * \param theStep2 Step of the second translation.
807 * \param theNbTimes2 Quantity of translations to be done along theVector2.
808 * \return New GEOM_Object, containing compound of all
809 * the shapes, obtained after each translation.
811 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
812 in GEOM_Object theVector1,
815 in GEOM_Object theVector2,
817 in long theNbTimes2);
820 * \brief Rotate given object around vector perpendicular to plane containing three points.
821 * \param theObject The object to be rotated.
822 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
823 * containing the three points.
824 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
827 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
828 in GEOM_Object theCentPoint,
829 in GEOM_Object thePoint1,
830 in GEOM_Object thePoint2);
834 * \brief Rotate given object around vector perpendicular to plane containing three points.
836 * Creating its copy before the rotatation.
837 * \param theObject The object to be rotated.
838 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
839 * containing the three points.
840 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
841 * \return New GEOM_Object, containing the rotated object.
843 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
844 in GEOM_Object theCentPoint,
845 in GEOM_Object thePoint1,
846 in GEOM_Object thePoint2);
849 * \brief Rotate the given object around the given axis on the given angle.
850 * \param theObject The object to be rotated.
851 * \param theAxis Rotation axis.
852 * \param theAngle Rotation angle in radians.
855 GEOM_Object Rotate (in GEOM_Object theObject,
856 in GEOM_Object theAxis,
861 * Rotate the given object around the given axis
862 * on the given angle, creating its copy before the rotatation.
863 * \param theObject The object to be rotated.
864 * \param theAxis Rotation axis.
865 * \param theAngle Rotation angle in radians.
866 * \return New GEOM_Object, containing the rotated object.
868 GEOM_Object RotateCopy (in GEOM_Object theObject,
869 in GEOM_Object theAxis,
874 * \brief Rotate the given object around the given axis a given number times.
876 * Rotation angle will be 2*PI/theNbTimes.
877 * \param theObject The object to be rotated.
878 * \param theAxis The rotation axis.
879 * \param theNbTimes Quantity of rotations to be done.
880 * \return New GEOM_Object, containing compound of all the
881 * shapes, obtained after each rotation.
883 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
884 in GEOM_Object theAxis,
888 * \brief Rotate the given object around the
889 * given axis on the given angle a given number
890 * times and multi-translate each rotation result.
892 * Translation direction passes through center of gravity
893 * of rotated shape and its projection on the rotation axis.
894 * \param theObject The object to be rotated.
895 * \param theAxis Rotation axis.
896 * \param theAngle Rotation angle in graduces.
897 * \param theNbTimes1 Quantity of rotations to be done.
898 * \param theStep Translation distance.
899 * \param theNbTimes2 Quantity of translations to be done.
900 * \return New GEOM_Object, containing compound of all the
901 * shapes, obtained after each transformation.
903 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
904 in GEOM_Object theAxis,
908 in long theNbTimes2);
911 * \brief Replace the given object by an object,
912 * symmetrical to it relatively the given plane.
913 * \param theObject The object to be mirrored.
914 * \param thePlane Plane of symmetry.
916 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
919 * \brief Create an object, symmetrical
920 * to the given one relatively the given plane.
921 * \param theObject The object to be mirrored.
922 * \param thePlane Plane of symmetry.
923 * \return New GEOM_Object, containing the mirrored shape.
925 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
928 * \brief Replace the given object by an object,
929 * symmetrical to it relatively the given axis.
930 * \param theObject The object to be mirrored.
931 * \param theAxis Axis of symmetry.
934 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
937 * \brief Create an object, symmetrical
938 * to the given one relatively the given axis.
939 * \param theObject The object to be mirrored.
940 * \param theAxis Axis of symmetry.
941 * \return New GEOM_Object, containing the mirrored object.
943 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
946 * \brief Replace the given object by an object, symmetrical to it relatively the given point.
947 * \param theObject The object to be mirrored.
948 * \param thePoint Point of symmetry.
951 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
954 * \brief Create an object, symmetrical to the given one relatively the given point.
955 * \param theObject The object to be mirrored.
956 * \param thePoint Point of symmetry.
957 * \return New GEOM_Object, containing the mirrored object.
959 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
962 * \brief Replace the given object by its offset.
963 * \param theObject The base object for the offset.
964 * \param theOffset Offset value.
967 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
970 * \brief Create new object as offset of the given one.
971 * \param theObject The base object for the offset.
972 * \param theOffset Offset value.
973 * \return New GEOM_Object, containing the offset object.
975 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
978 * \brief Create new object as projection of the given one on a 2D surface.
979 * \param theSource The source object for the projection. It can be a point, edge or wire.
980 * \param theTarget The target object. It can be planar or cylindrical face.
981 * \return New GEOM_Object, containing the projection.
983 GEOM_Object ProjectShapeCopy (in GEOM_Object theSource, in GEOM_Object theTarget);
986 * \brief Scale the given object by the factor.
987 * \param theObject The object to be scaled.
988 * \param thePoint Center point for scaling.
989 * \param theFactor Scaling factor value.
992 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
993 in double theFactor);
996 * \brief Scale the given object by the factor, creating its copy before the scaling.
997 * \param theObject The object to be scaled.
998 * \param thePoint Center point for scaling.
999 * \param theFactor Scaling factor value.
1000 * \return New GEOM_Object, containing the scaled shape.
1002 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
1003 in double theFactor);
1006 * \brief Scale the given object by different factors along coordinate axes.
1007 * \param theObject The object to be scaled.
1008 * \param thePoint Center point for scaling.
1009 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1010 * \return theObject.
1012 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
1013 in GEOM_Object thePoint,
1014 in double theFactorX,
1015 in double theFactorY,
1016 in double theFactorZ);
1019 * \brief Scale the given object by different factors along coordinate axes,
1020 * creating its copy before the scaling.
1021 * \param theObject The object to be scaled.
1022 * \param thePoint Center point for scaling.
1023 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1024 * \return New GEOM_Object, containing the scaled shape.
1026 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
1027 in GEOM_Object thePoint,
1028 in double theFactorX,
1029 in double theFactorY,
1030 in double theFactorZ);
1033 * \brief Modify the Location of the given object by LCS.
1034 * \param theObject The object to be displaced.
1035 * \param theStartLCS Coordinate system to perform displacement from it.
1036 * If \a theStartLCS is NULL, displacement
1037 * will be performed from global CS.
1038 * If \a theObject itself is used as \a theStartLCS,
1039 * its location will be changed to \a theEndLCS.
1040 * \param theEndLCS Coordinate system to perform displacement to it.
1041 * \return theObject.
1043 GEOM_Object PositionShape (in GEOM_Object theObject,
1044 in GEOM_Object theStartLCS,
1045 in GEOM_Object theEndLCS);
1048 * \brief Modify the Location of the given object by LCS,
1049 * creating its copy before the setting.
1050 * \param theObject The object to be displaced.
1051 * \param theStartLCS Coordinate system to perform displacement from it.
1052 * If \a theStartLCS is NULL, displacement
1053 * will be performed from global CS.
1054 * If \a theObject itself is used as \a theStartLCS,
1055 * its location will be changed to \a theEndLCS.
1056 * \param theEndLCS Coordinate system to perform displacement to it.
1057 * \return New GEOM_Object, containing the displaced shape.
1059 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
1060 in GEOM_Object theStartLCS,
1061 in GEOM_Object theEndLCS);
1064 * \brief Modify the Location of the given object by Path,
1065 * \param theObject The object to be displaced.
1066 * \param thePath Wire or Edge along that the object will be translated.
1067 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
1068 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
1069 * \param theReverse is a true or false parameter. true is to reverse direction, false is to move normal direction.
1070 * \return New GEOM_Object, containing the displaced shape.
1072 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
1073 in GEOM_Object thePath,
1074 in double theDistance,
1076 in boolean theReverse);
1079 * \brief Transform the shape in the same way what was used for the sample shape creation.
1080 * \param theObject The object to be transformed.
1081 * \param theSample The object containing information about required transformation.
1082 * \note Implementation of this method is limited by multi-transformations now.
1083 * \note Internal method.
1084 * \return New GEOM_Object, containing the transformed shape.
1086 GEOM_Object TransformLikeOtherCopy (in GEOM_Object theObject,
1087 in GEOM_Object theSample);
1090 * \brief Recompute the shape from its arguments.
1091 * \param theObject The object to be recomputed.
1092 * \return theObject.
1094 GEOM_Object RecomputeObject (in GEOM_Object theObject);
1097 // # GEOM_I3DPrimOperations:
1099 * \brief Interface for 3D primitives creation
1101 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
1102 * Pipe (extrusion along contour), Revolution, Solid (from shell).
1104 interface GEOM_I3DPrimOperations : GEOM_IOperations
1107 * \brief Create a box with specified dimensions along the coordinate axes
1108 * and with edges, parallel to the coordinate axes.
1110 * Center of the box will be at point (DX/2, DY/2, DZ/2).
1111 * \param theDX Length of Box edges, parallel to OX axis.
1112 * \param theDY Length of Box edges, parallel to OY axis.
1113 * \param theDZ Length of Box edges, parallel to OZ axis.
1114 * \return New GEOM_Object, containing the created box.
1116 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
1119 * \brief Create a box with two specified opposite vertices,
1120 * and with edges, parallel to the coordinate axes
1121 * \param thePnt1 First of two opposite vertices.
1122 * \param thePnt2 Second of two opposite vertices.
1123 * \return New GEOM_Object, containing the created box.
1125 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1128 * \brief Create a face specified dimensions along OX-OY coordinate axes,
1129 * with edges parallel to the coordinate axes.
1131 * Center of the face will be at point (0, 0, 0).
1132 * \param theH Height of the Face.
1133 * \param theW Width of the Face.
1134 * \param theOrientation Orientation belong axis OXY OYZ OZX
1135 * \return New GEOM_Object, containing the created face.
1137 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1139 * \brief Create a face by normale vector or edge and two specified sizes,
1140 * vertical (H) and horisontal (W).
1141 * \param theObj defines plane.
1142 * \param theH vertical size (height).
1143 * \param theW horisontal size (width).
1144 * \return New GEOM_Object, containing the created face.
1146 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1148 * \brief Create a Disk (circular face) with given center, normal vector and radius.
1149 * \param thePnt disk center.
1150 * \param theVec Vector, normal to the plane of the disk.
1151 * \param theR Disk radius.
1152 * \return New GEOM_Object, containing the created disk.
1154 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1155 in GEOM_Object theVec,
1158 * \brief Create a disk (circular face), passing through three given points
1159 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1160 * \return New GEOM_Object, containing the created disk.
1162 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1163 in GEOM_Object thePnt2,
1164 in GEOM_Object thePnt3);
1167 * \brief Create a disk specified dimensions along OX-OY coordinate axes.
1169 * Center of the disk at point (0, 0, 0).
1170 * \param theR of the Disk.
1171 * \param theOrientation Orientation belong axis OXY OYZ OZX
1172 * \return New GEOM_Object, containing the created disk.
1174 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1177 * \brief Create a cylinder with given radius and height at
1178 * the origin of coordinate system.
1180 * Axis of the cylinder will be collinear to the OZ axis of the coordinate system.
1181 * \param theR Cylinder radius.
1182 * \param theH Cylinder height.
1183 * \return New GEOM_Object, containing the created cylinder.
1185 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1188 * \brief Create a cylinder with given base point, axis, radius and height.
1189 * \param thePnt Central point of cylinder base.
1190 * \param theAxis Cylinder axis.
1191 * \param theR Cylinder radius.
1192 * \param theH Cylinder height.
1193 * \return New GEOM_Object, containing the created cylinder.
1195 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1196 in GEOM_Object theAxis,
1201 * \brief Create a cone with given height and radiuses at
1202 * the origin of coordinate system.
1204 * Axis of the cone will be collinear to the OZ axis of the coordinate system.
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 MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1215 * \brief Create a cone with given base point, axis, height and radiuses.
1216 * \param thePnt Central point of the first cone base.
1217 * \param theAxis Cone axis.
1218 * \param theR1 Radius of the first cone base.
1219 * \param theR2 Radius of the second cone base.
1220 * \note If both radiuses are non-zero, the cone will be truncated.
1221 * \note If the radiuses are equal, a cylinder will be created instead.
1222 * \param theH Cone height.
1223 * \return New GEOM_Object, containing the created cone.
1225 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1226 in GEOM_Object theAxis,
1232 * \brief Create a torus with given radiuses at the origin of coordinate system.
1233 * \param theRMajor Torus major radius.
1234 * \param theRMinor Torus minor radius.
1235 * \return New GEOM_Object, containing the created torus.
1237 GEOM_Object MakeTorusRR (in double theRMajor,
1238 in double theRMinor);
1241 * \brief Create a torus with given center, normal vector and radiuses.
1242 * \param thePnt Torus central point.
1243 * \param theVec Torus axis of symmetry.
1244 * \param theRMajor Torus major radius.
1245 * \param theRMinor Torus minor radius.
1246 * \return New GEOM_Object, containing the created torus.
1248 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1249 in GEOM_Object theVec,
1250 in double theRMajor,
1251 in double theRMinor);
1254 * \brief Create a sphere with given radius at the origin of coordinate system.
1255 * \param theR Sphere radius.
1256 * \return New GEOM_Object, containing the created sphere.
1258 GEOM_Object MakeSphereR (in double theR);
1261 * \brief Create a sphere with given center and radius.
1262 * \param thePnt Sphere center.
1263 * \param theR Sphere radius.
1264 * \return New GEOM_Object, containing the created .
1266 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1269 * \brief Create a shape by extrusion of the base shape along the vector
1271 * All the space, transfixed by the base shape during its translation
1272 * along the vector on the given distance.
1273 * \param theBase Base shape to be extruded.
1274 * \param theVec Direction of extrusion.
1275 * \param theH Prism dimension along theVec.
1276 * \return New GEOM_Object, containing the created prism.
1278 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1279 in GEOM_Object theVec,
1281 /* \brief The Same Prism but in 2 directions (forward&backward) */
1282 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1283 in GEOM_Object theVec,
1285 /* \brief The Same as MakePrismVecH but with scaling */
1286 GEOM_Object MakePrismVecHWithScaling (in GEOM_Object theBase,
1287 in GEOM_Object theVec,
1289 in double theScaleFactor);
1292 * \brief Create a shape by extrusion of the base shape along a vector, defined by two points.
1293 * \param theBase Base shape to be extruded.
1294 * \param thePoint1 First end of extrusion vector.
1295 * \param thePoint2 Second end of extrusion vector.
1296 * \return New GEOM_Object, containing the created prism.
1298 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1299 in GEOM_Object thePoint1,
1300 in GEOM_Object thePoint2);
1301 /* \brief The same prism but in two directions forward&backward */
1302 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1303 in GEOM_Object thePoint1,
1304 in GEOM_Object thePoint2);
1305 /* \brief The Same as MakePrismTwoPnt but with scaling */
1306 GEOM_Object MakePrismTwoPntWithScaling (in GEOM_Object theBase,
1307 in GEOM_Object thePoint1,
1308 in GEOM_Object thePoint2,
1309 in double theScaleFactor);
1312 * \brief Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1313 * \param theBase Base shape to be extruded.
1314 * \param theDX, theDY, theDZ end of extrusion vector.
1315 * \return New GEOM_Object, containing the created prism.
1317 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1318 in double theDX, in double theDY, in double theDZ);
1319 /* \brief The same prism but in two directions forward&backward */
1320 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1321 in double theDX, in double theDY, in double theDZ);
1322 /* \brief The Same as MakePrismDXDYDZ but with scaling */
1323 GEOM_Object MakePrismDXDYDZWithScaling (in GEOM_Object theBase,
1324 in double theDX, in double theDY, in double theDZ,
1325 in double theScaleFactor);
1329 * \brief Add / Remove material to / from a solid by extrusion of the base shape on the given distance.
1330 * \param theInitShape Initial shape on which to perform the feature.It has to be a solid or
1331 * a compound made of a single solid
1332 * \param theBase Edge or wire defining the base shape to be extruded.
1333 * \param theHeight Prism dimension along the normal of the face.
1334 * \param theAngle Draft angel in degrees
1335 * \param theFuse If true material is added else material is removed
1336 * \return New GEOM_Object, containing the modified shape
1338 GEOM_Object MakeDraftPrism (in GEOM_Object theInitShape,
1339 in GEOM_Object theBase,
1340 in double theHeight,
1342 in boolean theFuse);
1345 * \brief Create a shape by extrusion of the base shape along
1346 * the path shape. The path shape can be a wire or an edge.
1347 * \param theBase Base shape to be extruded.
1348 * \param thePath Path shape to extrude the base shape along it.
1349 * \return New GEOM_Object, containing the created pipe.
1351 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1354 * \brief Create a shape by revolution of the base shape around the axis
1355 * on the given angle.
1357 * All the space, transfixed by the base
1358 * shape during its rotation around the axis on the given angle.
1359 * \param theBase Base shape to be rotated.
1360 * \param theAxis Rotation axis.
1361 * \param theAngle Rotation angle in radians.
1362 * \return New GEOM_Object, containing the created revolution.
1364 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1365 in GEOM_Object theAxis,
1366 in double theAngle);
1367 /* The Same Revolution but in both ways forward&backward */
1368 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1369 in GEOM_Object theAxis,
1370 in double theAngle);
1373 * \brief Create a filling from the given compound of contours.
1374 * \param theShape Initial shape on which to perform the feature.
1375 * \param theMinDeg a minimal degree of BSpline surface to create
1376 * \param theMaxDeg a maximal degree of BSpline surface to create
1377 * \param theTol2D a 2d tolerance to be reached
1378 * \param theTol3D a 3d tolerance to be reached
1379 * \param theNbIter a number of iteration of approximation algorithm
1380 * \param theMethod Kind of method to perform filling operation.
1381 * \param theApprox Boolean indicating if result should be approximated
1382 * \return New GEOM_Object, containing the created filling surface.
1384 GEOM_Object MakeFilling (in GEOM_Object theShape,
1385 in long theMinDeg, in long theMaxDeg,
1386 in double theTol2D, in double theTol3D,
1388 in filling_oper_method theMethod,
1389 in boolean theApprox);
1392 * \brief Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1393 * \param theSeqSections - set of specified sections.
1394 * \param theModeSolid - mode defining building solid or shell
1395 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1396 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1397 * \return New GEOM_Object, containing the created shell or solid.
1399 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1400 in boolean theModeSolid,
1402 in boolean theRuled);
1405 * \brief Create a shape by extrusion of the profile shape along
1408 * The path shape can be a wire or an edge.
1409 * the several profiles can be specified in the several locations of path.
1410 * \param theSeqBases - list of Bases shape to be extruded.
1411 * \param theLocations - list of locations on the path corresponding
1412 * specified list of the Bases shapes. Number of locations
1413 * should be equal to number of bases or list of locations can be empty.
1414 * \param thePath - Path shape to extrude the base shape along it.
1415 * \param theWithContact - the mode defining that the section is translated to be in
1416 * contact with the spine.
1417 * \param theWithCorrection - defining that the section is rotated to be
1418 * orthogonal to the spine tangent in the correspondent point
1419 * \return New GEOM_Object, containing the created pipe.
1421 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1422 in ListOfGO theLocations,
1423 in GEOM_Object thePath,
1424 in boolean theWithContact ,
1425 in boolean theWithCorrection );
1428 * \brief Create a shape by extrusion of the profile shape along
1431 * The path shape can be a shell or a face.
1432 * the several profiles can be specified in the several locations of path.
1433 * \param theSeqBases - list of Bases shape to be extruded.
1434 * \param theSeqSubBases - list of corresponding sub-shapes of section shapes.
1435 * \param theLocations - list of locations on the path corresponding
1436 * specified list of the Bases shapes. Number of locations
1437 * should be equal to number of bases.
1438 * \param thePath - Path shape to extrude the base shape along it.
1439 * \param theWithContact - the mode defining that the section is translated to be in
1440 * contact with the spine.
1441 * \param theWithCorrection - defining that the section is rotated to be
1442 * orthogonal to the spine tangent in the correspondent point
1443 * \return New GEOM_Object, containing the created pipe.
1445 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1446 in ListOfGO theSeqSubBases,
1447 in ListOfGO theLocations,
1448 in GEOM_Object thePath,
1449 in boolean theWithContact ,
1450 in boolean theWithCorrection );
1453 * \brief Create solids between given sections
1454 * \param theSeqBases - list of sections (shell or face).
1455 * \param theLocations - list of corresponding vertexes
1456 * \return New GEOM_Object, containing the created solids.
1458 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1459 in ListOfGO theLocations);
1462 * \brief Create a shape by extrusion of the base shape along
1463 * the path shape with constant bi-normal direction along the given vector.
1465 * The path shape can be a wire or an edge.
1466 * \param theBase Base shape to be extruded.
1467 * \param thePath Path shape to extrude the base shape along it.
1468 * \param theVec Vector defines a constant binormal direction to keep the
1469 * same angle beetween the Direction and the sections
1470 * along the sweep surface.
1471 * \return New GEOM_Object, containing the created pipe.
1473 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1474 in GEOM_Object thePath,
1475 in GEOM_Object theVec);
1479 // # GEOM_IShapesOperations
1481 * \brief Interface for Shapes creation:
1483 * Edge from two points, Wire from edges, Face from wire,
1484 * Shell from faces, Solid from shells, Compound from shapes
1486 interface GEOM_IShapesOperations : GEOM_IOperations
1489 * \brief Create a linear edge with specified ends.
1490 * \param thePnt1 Point for the first end of edge.
1491 * \param thePnt2 Point for the second end of edge.
1492 * \return New GEOM_Object, containing the created edge.
1494 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1497 * \brief Create an edge on another edge, corresponding to the given length on the given edge.
1498 * \param theRefCurve The referenced edge.
1499 * \param theLength Length on the referenced edge. It can be
1500 * negative for extrapolation on base curve.
1501 * \param theStartPoint Any vertex close to one of edge's
1502 * ends to select start point among them.
1503 * If NULL, fist vertex is used.
1504 * \return New GEOM_Object, containing the created edge.
1506 GEOM_Object MakeEdgeOnCurveByLength (in GEOM_Object theRefCurve,
1507 in double theLength,
1508 in GEOM_Object theStartPoint);
1511 * \brief Create an edge from specified wire.
1512 * \param theWire source Wire.
1513 * \param theLinearTolerance linear tolerance value
1514 * \param theAngularTolerance angular tolerance value
1515 * \return New GEOM_Object, containing the created edge.
1517 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1518 in double theLinearTolerance,
1519 in double theAngularTolerance);
1522 * \brief Create a wire from the set of edges and wires.
1523 * \param theEdgesAndWires List of edge and/or wires.
1524 * \param theTolerance Maximum distance between vertices, that will be merged.
1525 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1526 * \return New GEOM_Object, containing the created wire.
1528 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1529 in double theTolerance);
1532 * \brief Create a face on the given wire.
1533 * \param theWire closed Wire or Edge to build the face on.
1534 * \param isPlanarWanted If TRUE, only planar face will be built.
1535 * If impossible, NULL object will be returned.
1536 * \return New GEOM_Object, containing the created face.
1538 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1541 * \brief Create a face on the given wires set.
1542 * \param theWires List of closed wires or edges to build the face on.
1543 * \param isPlanarWanted If TRUE, only planar face will be built.
1544 * If impossible, NULL object will be returned.
1545 * \return New GEOM_Object, containing the created face.
1547 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1550 * \brief Create a shell from the set of faces and shells.
1551 * \param theFacesAndShells List of faces and/or shells.
1552 * \return New GEOM_Object, containing the created shell.
1554 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1557 * \brief Create a solid, bounded by the given shell.
1558 * \param theShell Bounding shell.
1559 * \return New GEOM_Object, containing the created solid.
1561 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1564 * \brief Create a solid, bounded by the given shells.
1565 * \param theShells Bounding shells.
1566 * \return New GEOM_Object, containing the created solid.
1568 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1571 * \brief Create a compound of the given shapes.
1572 * \param theShapes List of shapes to put in compound.
1573 * \return New GEOM_Object, containing the created compound.
1575 GEOM_Object MakeCompound (in ListOfGO theShapes);
1578 * \brief Replace coincident faces in theShape by one face.
1579 * \param theShape Initial shape.
1580 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1581 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1582 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1584 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1587 * Find coincident faces in theShape for possible gluing.
1588 * \param theShape Initial shape.
1589 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1592 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1595 * \brief Replace coincident faces in theShape by one face
1596 * in compliance with given list of faces
1597 * \param theShape Initial shape.
1598 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1599 * \param theFaces List of faces for gluing.
1600 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1601 * \param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
1602 * will be glued, otherwise only the edges,
1603 * belonging to <VAR>theFaces</VAR>.
1604 * \return New GEOM_Object, containing a copy of theShape without some faces.
1606 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1607 in ListOfGO theFaces, in boolean doKeepNonSolids,
1608 in boolean doGlueAllEdges);
1611 * \brief Replace coincident edges in theShape by one edge.
1612 * \param theShape Initial shape.
1613 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1614 * \return New GEOM_Object, containing a copy of theShape without coincident edges.
1616 GEOM_Object MakeGlueEdges (in GEOM_Object theShape, in double theTolerance);
1619 * Find coincident edges in theShape for possible gluing.
1620 * \param theShape Initial shape.
1621 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1624 ListOfGO GetGlueEdges (in GEOM_Object theShape, in double theTolerance);
1627 * \brief Replace coincident edges in theShape by one edge
1628 * in compliance with given list of edges
1629 * \param theShape Initial shape.
1630 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1631 * \param theEdges List of edges for gluing.
1632 * \return New GEOM_Object, containing a copy of theShape without some edges.
1634 GEOM_Object MakeGlueEdgesByList (in GEOM_Object theShape,
1635 in double theTolerance,
1636 in ListOfGO theEdges);
1639 * \brief Get all sub-shapes and groups of \a theShape,
1640 * that were created already by any other methods.
1641 * \param theShape Any shape.
1642 * \param theGroupsOnly If this parameter is TRUE, only groups will be
1643 * returned, else all found sub-shapes and groups.
1644 * \return List of existing sub-objects of \a theShape.
1646 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
1647 in boolean theGroupsOnly);
1650 * \brief Deprecated method.
1652 * Use MakeAllSubShapes() instead.
1654 ListOfGO MakeExplode (in GEOM_Object theShape,
1655 in long theShapeType,
1656 in boolean isSorted);
1659 * \brief Explode a shape on sub-shapes of a given type.
1661 * If the shape itself has the given type, it is also returned.
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 MakeAllSubShapes (in GEOM_Object theShape,
1669 in long theShapeType,
1670 in boolean isSorted);
1673 * \brief Extract all sub-shapes of the given type from
1674 * the given shape, excluding the shape itself.
1675 * \param theShape Shape to be exploded.
1676 * \param theShapeType Type of sub-shapes to be retrieved.
1677 * \param isSorted If this parameter is TRUE, sub-shapes will be
1678 * sorted by coordinates of their gravity centers.
1679 * \return List of sub-shapes of type theShapeType, contained in theShape.
1681 ListOfGO ExtractSubShapes (in GEOM_Object theShape,
1682 in long theShapeType,
1683 in boolean isSorted);
1686 * \brief Deprecated method. Use GetAllSubShapesIDs() instead.
1688 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1689 in long theShapeType,
1690 in boolean isSorted);
1693 * \brief Explode a shape on sub-shapes of a given type.
1695 * Does the same, as MakeAllSubShapes, but returns IDs of
1696 * sub-shapes, not GEOM_Object. It works faster.
1697 * \param theShape Shape to be exploded.
1698 * \param theShapeType Type of sub-shapes to be retrieved.
1699 * \param isSorted If this parameter is TRUE, sub-shapes will be
1700 * sorted by coordinates of their gravity centers.
1701 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1703 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
1704 in long theShapeType,
1705 in boolean isSorted);
1708 * \brief Get a sub-shape defined by its unique ID inside \a theMainShape
1709 * \param theMainShape Main shape.
1710 * \param theID Unique ID of sub-shape inside \a theMainShape.
1711 * \return GEOM_Object, corresponding to found sub-shape.
1712 * \note The sub-shape GEOM_Object can has ONLY ONE function.
1713 * Don't try to apply modification operations (without copy) on them.
1715 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1719 * \brief Get a set of sub-shapes defined by their unique IDs inside \a theMainShape
1720 * \param theMainShape Main shape.
1721 * \param theIndices List of unique IDs of sub-shapes inside \a theMainShape.
1722 * \return List of GEOM_Object, corresponding to found sub-shapes.
1723 * \note The sub-shape GEOM_Object can has ONLY ONE function.
1724 * Don't try to apply modification operations (without copy) on them.
1726 ListOfGO MakeSubShapes (in GEOM_Object theMainShape,
1727 in ListOfLong theIndices);
1730 * Get global index of \a theSubShape in \a theMainShape.
1731 * \param theMainShape Main shape.
1732 * \param theSubShape Sub-shape of the main shape.
1733 * \return global index of \a theSubShape in \a theMainShape.
1735 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1738 * \brief Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1740 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1741 * to generate automatic names for sub-shapes, when publishing them in a study.
1742 * \param theMainShape Main shape.
1743 * \param theSubShape Sub-shape of the main shape.
1744 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1746 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1749 * \brief Get name of type of \a theShape.
1751 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1752 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1753 * to generate automatic names for sub-shapes, when publishing them in a study.
1754 * \param theShape The shape to get a type of.
1755 * \return String, containing a type name of \a theShape.
1757 string GetShapeTypeString (in GEOM_Object theShape);
1760 * \brief Count number of faces in the given shape.
1761 * \param theShape Shape to count faces in.
1762 * \return Number of faces in the given shape.
1764 long NumberOfFaces (in GEOM_Object theShape);
1767 * \brief Count number of edges in the given shape.
1768 * \param theShape Shape to count edges in.
1769 * \return Number of edges in theShape.
1771 long NumberOfEdges (in GEOM_Object theShape);
1774 * \brief Count number of sub-shapes of type \a theShapeType in the given shape.
1775 * \param theShape Shape to count sub-shapes in.
1776 * \param theShapeType The type of sub-shapes to count.
1777 * \return Number of sub-shapes of type \a theShapeType in \a theShape.
1779 long NumberOfSubShapes (in GEOM_Object theShape,
1780 in long theShapeType);
1783 * Reverses an orientation the given shape.
1784 * \param theShape Shape to be reversed.
1785 * \return The reversed copy of theShape.
1787 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1790 * \brief Retrieve all free faces from the given shape.
1792 * Free face is a face, which is not shared between two shells of the shape.
1793 * \param theShape Shape to find free faces in.
1794 * \return List of IDs of all free faces, contained in theShape.
1796 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1799 * \brief Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1800 * \param theShape1 Shape to find sub-shapes in.
1801 * \param theShape2 Shape to find shared sub-shapes with.
1802 * \param theShapeType Type of sub-shapes to be retrieved.
1803 * \return List of sub-shapes of theShape1, shared with theShape2.
1805 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1806 in GEOM_Object theShape2,
1807 in long theShapeType);
1810 * \brief Get all sub-shapes, shared by all shapes in the list \a theShapes.
1811 * \param theShapes Shapes to find common sub-shapes of.
1812 * \param theShapeType Type of sub-shapes to be retrieved.
1813 * \return List of objects, that are sub-shapes of all given shapes.
1815 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
1816 in long theShapeType);
1819 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1820 * the specified plane by the certain way, defined through \a theState parameter.
1821 * \param theShape Shape to find sub-shapes of.
1822 * \param theShapeType Type of sub-shapes to be retrieved.
1823 * \param theAx1 Vector (or line, or linear edge), specifying normal
1824 * direction and location of the plane to find shapes on.
1825 * \param theState The state of the sub-shapes to find.
1826 * \return List of all found sub-shapes.
1828 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1829 in long theShapeType,
1830 in GEOM_Object theAx1,
1831 in shape_state theState);
1833 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1834 * the specified plane by the certain way, defined through \a theState parameter.
1835 * \param theShape Shape to find sub-shapes of.
1836 * \param theShapeType Type of sub-shapes to be retrieved.
1837 * \param theAx1 Vector (or line, or linear edge), specifying normal
1838 * direction of the plane to find shapes on.
1839 * \param thePnt Point specifying location of the plane to find shapes on.
1840 * \param theState The state of the sub-shapes to find.
1841 * \return List of all found sub-shapes.
1843 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1844 in long theShapeType,
1845 in GEOM_Object theAx1,
1846 in GEOM_Object thePnt,
1847 in shape_state theState);
1852 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1853 * the specified cylinder by the certain way, defined through \a theState parameter.
1854 * \param theShape Shape to find sub-shapes of.
1855 * \param theShapeType Type of sub-shapes to be retrieved.
1856 * \param theAxis Vector (or line, or linear edge), specifying
1857 * axis of the cylinder to find shapes on.
1858 * \param theRadius Radius of the cylinder to find shapes on.
1859 * \param theState The state of the sub-shapes to find.
1860 * \return List of all found sub-shapes.
1862 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1863 in long theShapeType,
1864 in GEOM_Object theAxis,
1865 in double theRadius,
1866 in shape_state theState);
1869 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1870 * the specified cylinder by the certain way, defined through \a theState parameter.
1871 * \param theShape Shape to find sub-shapes of.
1872 * \param theShapeType Type of sub-shapes to be retrieved.
1873 * \param theAxis Vector (or line, or linear edge), specifying
1874 * axis of the cylinder to find shapes on.
1875 * \param thePnt Point specifying location of the bottom of the cylinder.
1876 * \param theRadius Radius of the cylinder to find shapes on.
1877 * \param theState The state of the sub-shapes to find.
1878 * \return List of all found sub-shapes.
1880 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1881 in long theShapeType,
1882 in GEOM_Object theAxis,
1883 in GEOM_Object thePnt,
1884 in double theRadius,
1885 in shape_state theState);
1888 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1889 * the specified sphere by the certain way, defined through \a theState parameter.
1890 * \param theShape Shape to find sub-shapes of.
1891 * \param theShapeType Type of sub-shapes to be retrieved.
1892 * \param theCenter Point, specifying center of the sphere to find shapes on.
1893 * \param theRadius Radius of the sphere to find shapes on.
1894 * \param theState The state of the sub-shapes to find.
1895 * \return List of all found sub-shapes.
1897 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1898 in long theShapeType,
1899 in GEOM_Object theCenter,
1900 in double theRadius,
1901 in shape_state theState);
1904 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1905 * the specified quadrangle by the certain way, defined through \a theState parameter.
1906 * \param theShape Shape to find sub-shapes of.
1907 * \param theShapeType Type of sub-shapes to be retrieved.
1908 * \param theTopLeftPoint Top left quadrangle corner
1909 * \param theTopRigthPoint Top right quadrangle corner
1910 * \param theBottomLeftPoint Bottom left quadrangle corner
1911 * \param theBottomRigthPoint Bottom right quadrangle corner
1912 * \param theState The state of the sub-shapes to find.
1913 * \return List of all found sub-shapes.
1915 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1916 in long theShapeType,
1917 in GEOM_Object theTopLeftPoint,
1918 in GEOM_Object theTopRigthPoint,
1919 in GEOM_Object theBottomLeftPoint,
1920 in GEOM_Object theBottomRigthPoint,
1921 in shape_state theState);
1924 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1925 * the specified plane by the certain way, defined through \a theState parameter.
1926 * \param theShape Shape to find sub-shapes of.
1927 * \param theShapeType Type of sub-shapes to be retrieved.
1928 * \param theAx1 Vector (or line, or linear edge), specifying normal
1929 * direction and location of the plane to find shapes on.
1930 * \param theState The state of the sub-shapes to find.
1931 * \return List of IDs of all found sub-shapes.
1933 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1934 in long theShapeType,
1935 in GEOM_Object theAx1,
1936 in shape_state theState);
1939 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1940 * the specified plane by the certain way, defined through \a theState parameter.
1941 * \param theShape Shape to find sub-shapes of.
1942 * \param theShapeType Type of sub-shapes to be retrieved.
1943 * \param theAx1 Vector (or line, or linear edge), specifying normal
1944 * direction of the plane to find shapes on.
1945 * \param thePnt Point specifying location of the plane to find shapes on.
1946 * \param theState The state of the sub-shapes to find.
1947 * \return List of IDs of all found sub-shapes.
1949 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1950 in long theShapeType,
1951 in GEOM_Object theAx1,
1952 in GEOM_Object thePnt,
1953 in shape_state theState);
1956 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1957 * the specified cylinder by the certain way, defined through \a theState parameter.
1958 * \param theShape Shape to find sub-shapes of.
1959 * \param theShapeType Type of sub-shapes to be retrieved.
1960 * \param theAxis Vector (or line, or linear edge), specifying
1961 * axis of the cylinder to find shapes on.
1962 * \param theRadius Radius of the cylinder to find shapes on.
1963 * \param theState The state of the sub-shapes to find.
1964 * \return List of IDs of all found sub-shapes.
1966 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1967 in long theShapeType,
1968 in GEOM_Object theAxis,
1969 in double theRadius,
1970 in shape_state theState);
1973 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1974 * the specified cylinder by the certain way, defined through \a theState parameter.
1975 * \param theShape Shape to find sub-shapes of.
1976 * \param theShapeType Type of sub-shapes to be retrieved.
1977 * \param theAxis Vector (or line, or linear edge), specifying
1978 * axis of the cylinder to find shapes on.
1979 * \param thePnt Point specifying location of the bottom of the cylinder.
1980 * \param theRadius Radius of the cylinder to find shapes on.
1981 * \param theState The state of the sub-shapes to find.
1982 * \return List of IDs all found sub-shapes.
1984 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1985 in long theShapeType,
1986 in GEOM_Object theAxis,
1987 in GEOM_Object thePnt,
1988 in double theRadius,
1989 in shape_state theState);
1992 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1993 * the specified sphere by the certain way, defined through \a theState parameter.
1994 * \param theShape Shape to find sub-shapes of.
1995 * \param theShapeType Type of sub-shapes to be retrieved.
1996 * \param theCenter Point, specifying center of the sphere to find shapes on.
1997 * \param theRadius Radius of the sphere to find shapes on.
1998 * \param theState The state of the sub-shapes to find.
1999 * \return List of IDs of all found sub-shapes.
2001 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
2002 in long theShapeType,
2003 in GEOM_Object theCenter,
2004 in double theRadius,
2005 in shape_state theState);
2008 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2009 * the specified quadrangle by the certain way, defined through \a theState parameter.
2010 * \param theShape Shape to find sub-shapes of.
2011 * \param theShapeType Type of sub-shapes to be retrieved.
2012 * \param theTopLeftPoint Top left quadrangle corner
2013 * \param theTopRigthPoint Top right quadrangle corner
2014 * \param theBottomLeftPoint Bottom left quadrangle corner
2015 * \param theBottomRigthPoint Bottom right quadrangle corner
2016 * \param theState The state of the sub-shapes to find.
2017 * \return List of IDs of all found sub-shapes.
2019 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
2020 in long theShapeType,
2021 in GEOM_Object theTopLeftPoint,
2022 in GEOM_Object theTopRigthPoint,
2023 in GEOM_Object theBottomLeftPoint,
2024 in GEOM_Object theBottomRigthPoint,
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 IDs of all found sub-shapes.
2035 ListOfLong GetShapesOnBoxIDs (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 theBox - the box to check state of sub-shapes against
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 all found sub-shapes.
2048 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
2049 in GEOM_Object theShape,
2050 in long 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 IDs of all found sub-shapes.
2061 ListOfLong GetShapesOnShapeIDs (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 List of all found sub-shapes.
2074 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
2075 in GEOM_Object theShape,
2076 in short theShapeType,
2077 in shape_state theState);
2080 * \brief Find sub-shapes complying with given status
2081 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2082 * \param theShape - the shape to explore
2083 * \param theShapeType - type of sub-shape of theShape
2084 * \param theState - required state
2085 * \return compound includes all found sub-shapes.
2087 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
2088 in GEOM_Object theShape,
2089 in short theShapeType,
2090 in shape_state theState);
2093 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2094 * coincident with \a theShapeWhat or could be a part of it.
2095 * \param theShapeWhere Shape to find sub-shapes of.
2096 * \param theShapeWhat Shape, specifying what to find.
2097 * \return Group of all found sub-shapes or a single found sub-shape.
2099 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
2100 in GEOM_Object theShapeWhat);
2103 * Old implementation of GetInPlace functionality, based on shape properties.
2105 GEOM_Object GetInPlaceOld (in GEOM_Object theShapeWhere,
2106 in GEOM_Object theShapeWhat);
2109 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2110 * coincident with \a theShapeWhat or could be a part of it.
2112 * Implementation of this method is based on a saved history of an operation,
2113 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
2114 * arguments (an argument shape or a sub-shape of an argument shape).
2115 * The operation could be the Partition or one of boolean operations,
2116 * performed on simple shapes (not on compounds).
2118 * \param theShapeWhere Shape to find sub-shapes of.
2119 * \param theShapeWhat Shape, specifying what to find.
2120 * \return Group of all found sub-shapes or a single found sub-shape.
2122 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
2123 in GEOM_Object theShapeWhat);
2126 * \brief Get sub-shape of theShapeWhere, which are
2127 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2128 * \param theShapeWhere Shape to find sub-shapes of.
2129 * \param theShapeWhat Shape, specifying what to find.
2130 * \return found sub-shape.
2132 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
2133 in GEOM_Object theShapeWhat);
2136 * \brief Get sub-shape Ids of theShapeWhere, which are
2137 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2138 * \param theShapeWhere Shape to find sub-shapes of.
2139 * \param theShapeWhat Shape, specifying what to find.
2140 * \return found sub-shape Ids.
2142 ListOfLong GetSameIDs (in GEOM_Object theShapeWhere,
2143 in GEOM_Object theShapeWhat);
2147 // # GEOM_IBlocksOperations:
2149 * \brief Interface for Blocks construction
2150 * Face from points or edges, Block from faces,
2151 * Blocks multi-translation and multi-rotation
2153 interface GEOM_IBlocksOperations : GEOM_IOperations
2156 // # Creation of blocks
2159 * \brief Create a quadrangle face from four edges. Order of Edges is not
2160 * important. It is not necessary that edges share the same vertex.
2161 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
2162 * \return New GEOM_Object, containing the created face.
2164 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
2165 in GEOM_Object theEdge2,
2166 in GEOM_Object theEdge3,
2167 in GEOM_Object theEdge4);
2170 * \brief Create a quadrangle face on two edges.
2172 * The missing edges will be built by creating the shortest ones.
2173 * \param theEdge1,theEdge2 Two opposite edges for the face.
2174 * \return New GEOM_Object, containing the created face.
2176 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
2177 in GEOM_Object theEdge2);
2180 * \brief Create a quadrangle face with specified corners.
2182 * The missing edges will be built by creating the shortest ones.
2183 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
2184 * \return New GEOM_Object, containing the created face.
2186 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
2187 in GEOM_Object thePnt2,
2188 in GEOM_Object thePnt3,
2189 in GEOM_Object thePnt4);
2192 * \brief Create a hexahedral solid, bounded by the six given faces. Order of
2193 * faces is not important.
2195 * It is not necessary that Faces share the same edge.
2196 * \param theFace1,theFace2,theFace3,theFace4,theFace5,theFace6 Faces for the hexahedral solid.
2197 * \return New GEOM_Object, containing the created solid.
2199 GEOM_Object MakeHexa (in GEOM_Object theFace1,
2200 in GEOM_Object theFace2,
2201 in GEOM_Object theFace3,
2202 in GEOM_Object theFace4,
2203 in GEOM_Object theFace5,
2204 in GEOM_Object theFace6);
2207 * \brief Create a hexahedral solid between two given faces.
2209 * The missing faces will be built by creating the smallest ones.
2210 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
2211 * \return New GEOM_Object, containing the created solid.
2213 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
2214 in GEOM_Object theFace2);
2217 // # Extract elements of blocks and blocks compounds
2221 * \brief Get a vertex, found in the given shape by its coordinates.
2222 * \param theShape Block or a compound of blocks.
2223 * \param theX,theY,theZ Coordinates of the sought vertex.
2224 * \param theEpsilon Maximum allowed distance between the resulting
2225 * vertex and point with the given coordinates.
2226 * \return New GEOM_Object, containing the found vertex.
2228 GEOM_Object GetPoint (in GEOM_Object theShape,
2232 in double theEpsilon);
2235 * \brief Find a vertex of the given shape, which has minimal distance to the given point.
2236 * \param theShape Any shape.
2237 * \param thePoint Point, close to the desired vertex.
2238 * \return New GEOM_Object, containing the found vertex.
2240 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
2241 in GEOM_Object thePoint);
2244 * \brief Get an edge, found in the given shape by two given vertices.
2245 * \param theShape Block or a compound of blocks.
2246 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2247 * \return New GEOM_Object, containing the found edge.
2249 GEOM_Object GetEdge (in GEOM_Object theShape,
2250 in GEOM_Object thePoint1,
2251 in GEOM_Object thePoint2);
2254 * \brief Find an edge of the given shape, which has minimal distance to the given point.
2255 * \param theShape Block or a compound of blocks.
2256 * \param thePoint Point, close to the desired edge.
2257 * \return New GEOM_Object, containing the found edge.
2259 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
2260 in GEOM_Object thePoint);
2263 * \brief Returns a face, found in the given shape by four given corner vertices.
2264 * \param theShape Block or a compound of blocks.
2265 * \param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
2266 * \return New GEOM_Object, containing the found face.
2268 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
2269 in GEOM_Object thePoint1,
2270 in GEOM_Object thePoint2,
2271 in GEOM_Object thePoint3,
2272 in GEOM_Object thePoint4);
2275 * \brief Get a face of block, found in the given shape by two given edges.
2276 * \param theShape Block or a compound of blocks.
2277 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2278 * \return New GEOM_Object, containing the found face.
2280 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2281 in GEOM_Object theEdge1,
2282 in GEOM_Object theEdge2);
2285 * \brief Find a face, opposite to the given one in the given block.
2286 * \param theBlock Must be a hexahedral solid.
2287 * \param theFace Face of \a theBlock, opposite to the desired face.
2288 * \return New GEOM_Object, containing the found face.
2290 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2291 in GEOM_Object theFace);
2294 * \brief Find a face of the given shape, which has minimal distance to the given point.
2295 * \param theShape Block or a compound of blocks.
2296 * \param thePoint Point, close to the desired face.
2297 * \return New GEOM_Object, containing the found face.
2299 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2300 in GEOM_Object thePoint);
2303 * \brief Find a face of block, whose outside normale has minimal angle with the given vector.
2304 * \param theBlock Block or a compound of blocks.
2305 * \param theVector Vector, close to the normale of the desired face.
2306 * \return New GEOM_Object, containing the found face.
2308 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2309 in GEOM_Object theVector);
2312 * \brief Find all sub-shapes of type \a theShapeType of the given shape,
2313 * which have minimal distance to the given point.
2314 * \param theShape Any shape.
2315 * \param thePoint Point, close to the desired shape.
2316 * \param theShapeType Defines what kind of sub-shapes is searched.
2317 * \param theTolerance The tolerance for distances comparison. All shapes
2318 * with distances to the given point in interval
2319 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2320 * \return New GEOM_Object, containing a group of all found shapes.
2322 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2323 in GEOM_Object thePoint,
2324 in long theShapeType,
2325 in double theTolerance);
2327 // # Extract blocks from blocks compounds
2331 * \brief Check, if the compound contains only specified blocks.
2332 * \param theCompound The compound to check.
2333 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2334 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2335 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2336 * \param theNbBlocks Number of specified blocks in theCompound.
2337 * \return TRUE, if the given compound contains only blocks.
2339 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2340 in long theMinNbFaces,
2341 in long theMaxNbFaces,
2342 out long theNbBlocks);
2345 * \brief Enumeration of Blocks Compound defects.
2349 /* Each element of the compound should be a Block */
2352 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2355 /* A connection between two Blocks should be an entire face or an entire edge */
2358 /* The compound should be connexe */
2361 /* The glue between two quadrangle faces should be applied */
2366 * \brief Description of Blocks Compound defect: type and incriminated sub-shapes.
2371 ListOfLong incriminated;
2375 * \brief Sequence of all Blocks Compound defects.
2377 typedef sequence<BCError> BCErrors;
2380 * \brief Check, if the compound of blocks is given.
2382 * To be considered as a compound of blocks, the
2383 * given shape must satisfy the following conditions:
2384 * - Each element of the compound should be a Block (6 faces and 12 edges).
2385 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2386 * - The compound should be connexe.
2387 * - The glue between two quadrangle faces should be applied.
2388 * \note Single block is also accepted as a valid compound of blocks.
2389 * \param theCompound The compound to check.
2390 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
2391 * \return TRUE, if the given shape is a compound of blocks.
2393 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2394 out BCErrors theErrors);
2397 * \brief Convert sequence of Blocks Compound errors, returned by
2398 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2399 * \param theCompound The bad compound.
2400 * \param theErrors The sequence of \a theCompound errors.
2401 * \return String, describing all the errors in form, suitable for printing.
2403 string PrintBCErrors (in GEOM_Object theCompound,
2404 in BCErrors theErrors);
2407 * \brief Remove all seam and degenerated edges from \a theShape.
2409 * Unite faces and edges, sharing one surface.
2410 * \param theShape The compound or single solid to remove irregular edges from.
2411 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2412 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2413 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2414 * For blocks repairing recommended value is 6.
2415 * \return Improved shape.
2417 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2418 in long theOptimumNbFaces);
2421 * \brief Check, if the given shape is a blocks compound.
2423 * Fix all detected errors.
2424 * \note Single block can be also fixed by this method.
2425 * \param theCompound The compound to check and improve.
2426 * \return Improved compound.
2428 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2431 * \brief Get all the blocks, contained in the given compound.
2433 * \param theCompound The compound to explode.
2434 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2435 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2436 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2437 * \return List of GEOM_Object, containing the retrieved blocks.
2439 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2440 in long theMinNbFaces,
2441 in long theMaxNbFaces);
2444 * \brief Find block, containing the given point inside its volume or on boundary.
2445 * \param theCompound Compound, to find block in.
2446 * \param thePoint Point, close to the desired block. If the point lays on
2447 * boundary between some blocks, we return block with nearest center.
2448 * \return New GEOM_Object, containing the found block.
2450 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2451 in GEOM_Object thePoint);
2454 * \brief Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2455 * \param theCompound Compound, to find block in.
2456 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2457 * \return New GEOM_Object, containing the found block.
2459 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2460 in ListOfGO theParts);
2463 * \brief Return all blocks, containing all the elements, passed as the parts.
2464 * \param theCompound Compound, to find blocks in.
2465 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2466 * \return List of GEOM_Object, containing the found blocks.
2468 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2469 in ListOfGO theParts);
2471 // # Operations on blocks with gluing of result
2474 * \brief Multi-transformate block and glue the result.
2476 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2477 * \param theBlock Hexahedral solid to be multi-transformed.
2478 * \param theDirFace1 First direction face global index.
2479 * \param theDirFace2 Second direction face global index.
2480 * \param theNbTimes Quantity of transformations to be done.
2481 * \note Global index of sub-shape can be obtained, using method
2482 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2483 * \return New GEOM_Object, containing the result shape.
2485 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2486 in long theDirFace1,
2487 in long theDirFace2,
2488 in long theNbTimes);
2491 * \brief Multi-transformate block and glue the result.
2492 * \param theBlock Hexahedral solid to be multi-transformed.
2493 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2494 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2495 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2496 * \return New GEOM_Object, containing the result shape.
2498 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2499 in long theDirFace1U,
2500 in long theDirFace2U,
2501 in long theNbTimesU,
2502 in long theDirFace1V,
2503 in long theDirFace2V,
2504 in long theNbTimesV);
2506 // # Special operation - propagation
2510 * \brief Build all possible propagation groups.
2512 * Propagation group is a set of all edges, opposite to one (main)
2513 * edge of this group directly or through other opposite edges.
2514 * Notion of Opposite Edge make sence only on quadrangle face.
2515 * \param theShape Shape to build propagation groups on.
2516 * \return List of GEOM_Object, each of them is a propagation group.
2518 ListOfGO Propagate (in GEOM_Object theShape);
2521 // # GEOM_IBooleanOperations
2523 * \brief Interface for boolean operations (Cut, Fuse, Common)
2525 interface GEOM_IBooleanOperations : GEOM_IOperations
2528 * \brief Perform one of boolean operations on two given shapes.
2529 * \param theShape1 First argument for boolean operation.
2530 * \param theShape2 Second argument for boolean operation.
2531 * \param theOperation Indicates the operation to be done:
2532 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2533 * \return New GEOM_Object, containing the result shape.
2535 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2536 in GEOM_Object theShape2,
2537 in long theOperation);
2540 * \brief Perform partition operation.
2542 * \param theShapes Shapes to be intersected.
2543 * \param theTools Shapes to intersect theShapes.
2544 * \note Each compound from ListShapes and ListTools will be exploded in order
2545 * to avoid possible intersection between shapes from this compound.
2546 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2547 * \param theKeepNonlimitShapes: if this parameter == 0, then only shapes of
2548 * target type (equal to Limit) are kept in the result,
2549 * else standalone shapes of lower dimension
2550 * are kept also (if they exist).
2552 * After implementation new version of PartitionAlgo (October 2006)
2553 * other parameters are ignored by current functionality. They are kept
2554 * in this function only for supporting old versions.
2555 * Ignored parameters:
2556 * \param theKeepInside Shapes, outside which the results will be deleted.
2557 * Each shape from theKeepInside must belong to theShapes also.
2558 * \param theRemoveInside Shapes, inside which the results will be deleted.
2559 * Each shape from theRemoveInside must belong to theShapes also.
2560 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2561 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2563 * \return New GEOM_Object, containing the result shapes.
2565 GEOM_Object MakePartition (in ListOfGO theShapes,
2566 in ListOfGO theTools,
2567 in ListOfGO theKeepInside,
2568 in ListOfGO theRemoveInside,
2570 in boolean theRemoveWebs,
2571 in ListOfLong theMaterials,
2572 in short theKeepNonlimitShapes);
2575 * \brief Perform partition operation.
2577 * This method may be usefull if it is needed to make a partition for
2578 * a compound containing nonintersected shapes. Performance will be better
2579 * since intersection between shapes from compound is not performed.
2581 * Description of all parameters as in previous method MakePartition()
2583 * \note Passed compounds (via ListShapes or via ListTools)
2584 * have to consist of nonintersecting shapes.
2586 * \return New GEOM_Object, containing the result shapes.
2588 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2589 in ListOfGO theTools,
2590 in ListOfGO theKeepInside,
2591 in ListOfGO theRemoveInside,
2593 in boolean theRemoveWebs,
2594 in ListOfLong theMaterials,
2595 in short theKeepNonlimitShapes);
2598 * \brief Perform partition of the Shape with the Plane
2599 * \param theShape Shape to be intersected.
2600 * \param thePlane Tool shape, to intersect theShape.
2601 * \return New GEOM_Object, containing the result shape.
2603 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2604 in GEOM_Object thePlane);
2607 // # GEOM_ICurvesOperations:
2609 * \brief Interface for curves creation.
2611 * Polyline, Circle, Spline (Bezier and Interpolation)
2613 interface GEOM_ICurvesOperations : GEOM_IOperations
2616 * \brief Create a circle with given center, normal vector and radius.
2617 * \param thePnt Circle center.
2618 * \param theVec Vector, normal to the plane of the circle.
2619 * \param theR Circle radius.
2620 * \return New GEOM_Object, containing the created circle.
2622 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2623 in GEOM_Object theVec,
2626 * \brief Create a circle, passing through three given points
2627 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2628 * \return New GEOM_Object, containing the created circle.
2630 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2631 in GEOM_Object thePnt2,
2632 in GEOM_Object thePnt3);
2634 * \brief Create a circle with given center, with a radius equals the distance from center to Point1
2635 * and on a plane defined by all of three points.
2636 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2637 * \return New GEOM_Object, containing the created circle.
2639 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2640 in GEOM_Object thePnt2,
2641 in GEOM_Object thePnt3);
2643 * \brief Create an ellipse with given center, normal vector and radiuses.
2644 * \param thePnt Ellipse center.
2645 * \param theVec Vector, normal to the plane of the ellipse.
2646 * \param theRMajor Major ellipse radius.
2647 * \param theRMinor Minor ellipse radius.
2648 * \return New GEOM_Object, containing the created ellipse.
2650 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2651 in GEOM_Object theVec,
2652 in double theRMajor,
2653 in double theRMinor);
2656 * \brief Create an ellipse with given center, normal vector, main axis vector and radiuses.
2657 * \param thePnt Ellipse center.
2658 * \param theVec Vector, normal to the plane of the ellipse.
2659 * \param theRMajor Major ellipse radius.
2660 * \param theRMinor Minor ellipse radius.
2661 * \param theVecMaj Vector, direction of the ellipse's main axis.
2662 * \return New GEOM_Object, containing the created ellipse.
2664 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2665 in GEOM_Object theVec,
2666 in double theRMajor,
2667 in double theRMinor,
2668 in GEOM_Object theVecMaj);
2671 * \brief Create an arc of circle, passing through three given points.
2672 * \param thePnt1 Start point of the arc.
2673 * \param thePnt2 Middle point of the arc.
2674 * \param thePnt3 End point of the arc.
2675 * \return New GEOM_Object, containing the created arc.
2677 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2678 in GEOM_Object thePnt2,
2679 in GEOM_Object thePnt3);
2682 * \brief Create an arc of circle of center C from one point to another
2683 * \param theCenter Center point of the arc.
2684 * \param thePnt1 Start point of the arc.
2685 * \param thePnt2 End point of the arc.
2686 * \param theSense Orientation of the arc
2687 * \return New GEOM_Object, containing the created arc.
2689 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2690 in GEOM_Object thePnt1,
2691 in GEOM_Object thePnt2,
2692 in boolean theSense);
2695 * \brief Create an arc of ellipse of center C and two points P1 P2.
2696 * \param theCenter Center point of the arc.
2697 * \param thePnt1 Major radius is distance from center to Pnt1.
2698 * \param thePnt2 define a plane and Minor radius as a shortest
2699 * distance from Pnt2 to vector Center->Pnt1.
2700 * \return New GEOM_Object, containing the created arc.
2702 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2703 in GEOM_Object thePnt1,
2704 in GEOM_Object thePnt2);
2708 * \brief Create a polyline on the set of points.
2709 * \param thePoints Sequence of points for the polyline.
2710 * \param theIsClosed If TRUE, build a closed wire.
2711 * \return New GEOM_Object, containing the created polyline.
2713 GEOM_Object MakePolyline (in ListOfGO thePoints,
2714 in boolean theIsClosed);
2717 * \brief Create bezier curve on the set of points.
2718 * \param thePoints Sequence of points for the bezier curve.
2719 * \param theIsClosed If TRUE, build a closed curve.
2720 * \return New GEOM_Object, containing the created bezier curve.
2722 GEOM_Object MakeSplineBezier (in ListOfGO thePoints,
2723 in boolean theIsClosed);
2726 * \brief Create B-Spline curve on the set of points.
2727 * \param thePoints Sequence of points for the B-Spline curve.
2728 * \param theIsClosed If TRUE, build a closed curve.
2729 * \param theDoReordering If TRUE, the algo does not follow the order of
2730 * \a thePoints but searches for the closest vertex.
2731 * \return New GEOM_Object, containing the created B-Spline curve.
2733 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2734 in boolean theIsClosed,
2735 in boolean theDoReordering);
2738 * \brief Creates a curve using the parametric definition of the basic points.
2739 * \param thexExpr parametric equation of the coordinates X.
2740 * \param theyExpr parametric equation of the coordinates Y.
2741 * \param thezExpr parametric equation of the coordinates Z.
2742 * \param theParamMin the minimal value of the parameter.
2743 * \param theParamMax the maximum value of the parameter.
2744 * \param theParamStep the step of the parameter.
2745 * \param theCurveType the type of the curve.
2746 * \return New GEOM_Object, containing the created curve.
2748 GEOM_Object MakeCurveParametric(in string thexExpr,
2751 in double theParamMin,
2752 in double theParamMax,
2753 in double theParamStep,
2754 in curve_type theCurveType);
2757 * \brief Creates a curve using the parametric definition of the basic points.
2758 * \param thexExpr parametric equation of the coordinates X.
2759 * \param theyExpr parametric equation of the coordinates Y.
2760 * \param thezExpr parametric equation of the coordinates Z.
2761 * \param theParamMin the minimal value of the parameter.
2762 * \param theParamMax the maximum value of the parameter.
2763 * \param theParamNbStep the number of steps of the parameter discretization.
2764 * \param theCurveType the type of the curve.
2765 * \return New GEOM_Object, containing the created curve.
2767 GEOM_Object MakeCurveParametricNew(in string thexExpr,
2770 in double theParamMin,
2771 in double theParamMax,
2772 in long theParamNbStep,
2773 in curve_type theCurveType);
2776 * \brief Create a sketcher (wire or face), following the textual description,
2777 * passed through \a theCommand argument.
2779 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2780 * Format of the description string have to be the following:
2782 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2785 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2787 * - "R angle" : Set the direction by angle
2788 * - "D dx dy" : Set the direction by DX & DY
2791 * - "TT x y" : Create segment by point at X & Y
2792 * - "T dx dy" : Create segment by point with DX & DY
2793 * - "L length" : Create segment by direction & Length
2794 * - "IX x" : Create segment by direction & Intersect. X
2795 * - "IY y" : Create segment by direction & Intersect. Y
2798 * - "C radius length" : Create arc by direction, radius and length(in degree)
2801 * - "WW" : Close Wire (to finish)
2802 * - "WF" : Close Wire and build face (to finish)
2804 * \param theCommand String, defining the sketcher in local
2805 * coordinates of the working plane.
2806 * \param theWorkingPlane Nine double values, defining origin,
2807 * OZ and OX directions of the working plane.
2808 * \return New GEOM_Object, containing the created wire.
2810 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2813 * \brief Create a 3D sketcher, following the numerical description,
2814 * passed through points created by \a theCoordinates argument.
2816 * Format of the description string have to be the following:
2818 * "Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"
2821 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2824 * \brief Create a sketcher (wire or face), following the textual description,
2825 * passed through \a theCommand argument.
2827 * For format of the description string see the previous method.\n
2828 * \param theCommand String, defining the sketcher in local
2829 * coordinates of the working plane.
2830 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2831 * \return New GEOM_Object, containing the created wire.
2833 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2836 // # GEOM_ILocalOperations:
2838 * \brief Interface for fillet and chamfer creation.
2840 interface GEOM_ILocalOperations : GEOM_IOperations
2843 * \brief Perform a fillet on all edges of the given shape.
2844 * \param theShape Shape, to perform fillet on.
2845 * \param theR Fillet radius.
2846 * \return New GEOM_Object, containing the result shape.
2848 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2852 * \brief Perform a fillet on the specified edges of the given shape
2853 * \param theShape Shape, to perform fillet on.
2854 * \param theR Fillet radius.
2855 * \param theEdges Global indices of edges to perform fillet on.
2856 * \note Global index of sub-shape can be obtained, using method
2857 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2858 * \return New GEOM_Object, containing the result shape.
2860 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2862 in ListOfLong theEdges);
2863 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2866 in ListOfLong theEdges);
2869 * \brief Perform a fillet on all edges of the specified faces of the given shape.
2870 * \param theShape Shape, to perform fillet on.
2871 * \param theR Fillet radius.
2872 * \param theFaces Global indices of faces to perform fillet on.
2873 * \note Global index of sub-shape can be obtained, using method
2874 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2875 * \return New GEOM_Object, containing the result shape.
2877 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2879 in ListOfLong theFaces);
2881 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2884 in ListOfLong theFaces);
2887 * \brief Perform a fillet on a face or a shell at the specified vertexes.
2888 * \param theShape Shape, to perform fillet on.
2889 * \param theR Fillet radius.
2890 * \param theVertexes Global indices of vertexes to perform fillet on.
2891 * \note Global index of sub-shape can be obtained, using method
2892 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2893 * \return New GEOM_Object, containing the result shape.
2895 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2897 in ListOfLong theVertexes);
2900 * \brief Perform a fillet on edges of the specified vertexes of the given wire.
2901 * \param theShape Shape, to perform fillet on.
2902 * \param theR Fillet radius.
2903 * \param theVertexes Global indices of vertexes to perform fillet on.
2904 * \note Global index of sub-shape can be obtained, using method
2905 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2906 * \note The list of vertices coudl be empty, in this case fillet fill be done
2907 * at all vertices in given wire
2908 * \param doIgnoreSecantVertices If FALSE, fillet radius is always limited
2909 * by the length of the edges, nearest to the fillet vertex.
2910 * But sometimes the next edge is C1 continuous with the one, nearest to
2911 * the fillet point, and such two (or more) edges can be united to allow
2912 * bigger radius. Set this flag to TRUE to allow collinear edges union,
2913 * thus ignoring the secant vertex (vertices).
2914 * \return New GEOM_Object, containing the result shape.
2916 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2918 in ListOfLong theVertexes,
2919 in boolean doIgnoreSecantVertices);
2922 * \brief Perform a symmetric chamfer on all edges of the given shape.
2923 * \param theShape Shape, to perform chamfer on.
2924 * \param theD Chamfer size along each face.
2925 * \return New GEOM_Object, containing the result shape.
2927 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2931 * \brief Perform a chamfer on edges, common to the specified faces.
2932 * with distance D1 on the Face1
2933 * \param theShape Shape, to perform chamfer on.
2934 * \param theD1 Chamfer size along \a theFace1.
2935 * \param theD2 Chamfer size along \a theFace2.
2936 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2937 * \note Global index of sub-shape can be obtained, using method
2938 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2939 * \return New GEOM_Object, containing the result shape.
2941 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2942 in double theD1, in double theD2,
2943 in long theFace1, in long theFace2);
2945 * \brief The Same but with params theD = Chamfer Lenght
2946 * and theAngle = Chamfer Angle (Angle in radians)
2948 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2949 in double theD, in double theAngle,
2950 in long theFace1, in long theFace2);
2953 * \brief Perform a chamfer on all edges of the specified faces.
2954 * with distance D1 on the first specified face (if several for one edge)
2955 * \param theShape Shape, to perform chamfer on.
2956 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2957 * connected to the edge, are in \a theFaces, \a theD1
2958 * will be get along face, which is nearer to \a theFaces beginning.
2959 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2960 * \param theFaces Sequence of global indices of faces of \a theShape.
2961 * \note Global index of sub-shape can be obtained, using method
2962 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2963 * \return New GEOM_Object, containing the result shape.
2965 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2966 in double theD1, in double theD2,
2967 in ListOfLong theFaces);
2969 * The Same but with params theD = Chamfer Lenght
2970 * and theAngle = Chamfer Angle (Angle in radians)
2972 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2973 in double theD, in double theAngle,
2974 in ListOfLong theFaces);
2977 * \brief Perform a chamfer on edges,
2978 * with distance D1 on the first specified face (if several for one edge)
2979 * \param theShape Shape, to perform chamfer on.
2980 * \param theD1,theD2 Chamfer size
2981 * \param theEdges Sequence of edges of \a theShape.
2982 * \return New GEOM_Object, containing the result shape.
2984 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2985 in double theD1, in double theD2,
2986 in ListOfLong theEdges);
2988 * The Same but with params theD = Chamfer Lenght
2989 * and theAngle = Chamfer Angle (Angle in radians)
2991 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2992 in double theD, in double theAngle,
2993 in ListOfLong theEdges);
2996 * \brief Perform an Archimde operation on the given shape with given parameters.
2997 * The object presenting the resulting face is returned
2998 * \param theShape Shape to be put in water.
2999 * \param theWeight Weight og the shape.
3000 * \param theWaterDensity Density of the water.
3001 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
3002 * \return New GEOM_Object, containing a section of \a theShape
3003 * by a plane, corresponding to water level.
3005 GEOM_Object MakeArchimede (in GEOM_Object theShape,
3006 in double theWeight,
3007 in double theWaterDensity,
3008 in double theMeshDeflection);
3011 * \brief Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3013 * Present here only for compatibility.
3015 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
3018 // # GEOM_IHealingOperations:
3020 * \brief Interface for shape healing operations
3022 * Shape Processing, SuppressFaces, etc.
3024 interface GEOM_IHealingOperations : GEOM_IOperations
3027 * \brief Apply a sequence of Shape Healing operators to the given object.
3028 * \param theShapes Shape to be processed.
3029 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
3030 * \param theParameters List of names of parameters
3031 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
3032 * \param theValues List of values of parameters, in the same order
3033 * as parameters are listed in \a theParameters list.
3034 * \return New GEOM_Object, containing processed shape.
3036 GEOM_Object ProcessShape (in GEOM_Object theShapes,
3037 in string_array theOperators,
3038 in string_array theParameters,
3039 in string_array theValues);
3042 * \brief Get default sequence of operators, their parameters and parameters' values
3043 * of Shape Process operation.
3045 * In the current implementation the defaults are
3046 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3047 * \param theOperators Output. Default list of names of operators.
3048 * \param theParameters Output. Default list of names of parameters.
3049 * \param theValues Output. List of default values of parameters, in the same order
3050 * as parameters are listed in \a theParameters list.
3052 void GetShapeProcessParameters (out string_array theOperators,
3053 out string_array theParameters,
3054 out string_array theValues);
3056 * \brief Get parameters and parameters' values for the given Shape Process operation.
3058 * In the current implementation the defaults are
3059 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3060 * \param theOperator Input. The operator's name.
3061 * \param theParameters Output. Default list of names of parameters.
3062 * \param theValues Output. List of default values of parameters, in the same order
3063 * as parameters are listed in \a theParameters list.
3065 void GetOperatorParameters (in string theOperator,
3066 out string_array theParameters,
3067 out string_array theValues);
3070 * \brief Remove faces from the given object (shape).
3071 * \param theObject Shape to be processed.
3072 * \param theFaces Indices of faces to be removed, if EMPTY then the method
3073 * removes ALL faces of the given object.
3074 * \return New GEOM_Object, containing processed shape.
3076 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
3079 * \brief Close an open wire.
3080 * \param theObject Shape to be processed.
3081 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
3082 * if -1, then theObject itself is a wire.
3083 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
3084 * If FALS : closure by creation of an edge between ends.
3085 * \return New GEOM_Object, containing processed shape.
3087 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
3088 in boolean isCommonVertex);
3091 * \brief Remove internal wires and edges from the given object (face).
3092 * \param theObject Shape to be processed.
3093 * \param theWires Indices of wires to be removed, if EMPTY then the method
3094 * removes ALL internal wires of the given object.
3095 * \return New GEOM_Object, containing processed shape.
3097 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
3100 * \brief Remove internal closed contours (holes) from the given object.
3101 * \param theObject Shape to be processed.
3102 * \param theWires Indices of wires to be removed, if EMPTY then the method
3103 * removes ALL internal holes of the given object
3104 * \return New GEOM_Object, containing processed shape.
3106 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
3109 * Sewing of the given object.
3110 * \param theObject Shape to be processed.
3111 * \param theTolerance Required tolerance value.
3112 * \return New GEOM_Object, containing processed shape.
3114 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
3117 * \brief Addition of a point to a given edge object.
3118 * \param theObject Shape to be processed.
3119 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
3120 * if -1, then theObject itself is the edge.
3121 * \param theValue Value of parameter on edge or length parameter,
3122 * depending on \a isByParameter.
3123 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
3124 * if FALSE : \a theValue is treated as a length parameter [0..1]
3125 * \return New GEOM_Object, containing processed shape.
3127 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
3128 in double theValue, in boolean isByParameter);
3131 * \brief Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
3132 * \param theWire Wire to minimize the number of C1 continuous edges in.
3133 * \param theVertices A list of vertices to suppress. If the list
3134 * is empty, all vertices in a wire will be assumed.
3135 * \return New GEOM_Object with modified wire.
3137 GEOM_Object FuseCollinearEdgesWithinWire (in GEOM_Object theWire,
3138 in ListOfGO theVertices);
3141 * \brief Get a list of wires (wrapped in GEOM_Object-s),
3142 * that constitute a free boundary of the given shape.
3143 * \param theObject Shape to get free boundary of.
3144 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
3145 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
3146 * \return FALSE, if an error(s) occured during the method execution.
3148 boolean GetFreeBoundary (in GEOM_Object theObject,
3149 out ListOfGO theClosedWires,
3150 out ListOfGO theOpenWires);
3153 * \brief Change orientation of the given object.
3154 * \param theObject Shape to be processed.
3155 * \return New GEOM_Object, containing processed shape.
3157 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
3158 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
3161 * \brief Try to limit tolerance of the given object by value \a theTolerance.
3162 * \param theObject Shape to be processed.
3163 * \param theTolerance Required tolerance value.
3164 * \return New GEOM_Object, containing processed shape.
3166 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
3170 // # GEOM_IInsertOperations:
3172 * \brief Interface for shape insert operations (like copy, import).
3175 interface GEOM_IInsertOperations : GEOM_IOperations
3178 * \brief Create a copy of the given object
3180 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
3183 * \brief Export the given shape into a file with given name.
3184 * \param theObject Shape to be stored in the file.
3185 * \param theFileName Name of the file to store the given shape in.
3186 * \param theFormatName Specify format for the shape storage.
3187 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3189 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
3192 * \brief Import a shape from the BRep or IGES or STEP file
3193 * (depends on given format) with given name.
3194 * \param theFileName The file, containing the shape.
3195 * \param theFormatName Specify format for the file reading.
3196 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3197 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
3198 * set to 'meter' and result model will be scaled.
3199 * \return New GEOM_Object, containing the imported shape.
3201 GEOM_Object ImportFile (in string theFileName, in string theFormatName);
3204 * \brief Get the supported import formats and corresponding patterns for File dialog.
3205 * \param theFormats Output. List of formats, available for import.
3206 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3207 * \return Returns available formats and patterns through the arguments.
3209 void ImportTranslators (out string_array theFormats,
3210 out string_array thePatterns);
3213 * \brief Get the supported export formats and corresponding patterns for File dialog.
3214 * \param theFormats Output. List of formats, available for export.
3215 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3216 * \return Returns available formats and patterns through the arguments.
3218 void ExportTranslators (out string_array theFormats,
3219 out string_array thePatterns);
3222 * \brief Load texture from file
3223 * \param theTextureFile texture file name
3224 * \return unique texture identifier
3226 long LoadTexture(in string theTextureFile);
3229 * \brief Add texture to the study
3230 * \param theWidth texture width in pixels
3231 * \param theHeight texture height in pixels
3232 * \param theTexture texture byte array
3233 * \return unique texture identifier
3235 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
3238 * \brief Get previously loaded texture data
3239 * \param theID texture identifier
3240 * \param theWidth texture width in pixels
3241 * \param theHeight texture height in pixels
3242 * \return texture byte array
3244 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
3247 * \brief Get list of all avaiable texture IDs
3248 * \return list of all texture IDs avaiable for the current study
3250 ListOfLong GetAllTextures();
3253 // # GEOM_IKindOfShape:
3255 * \brief Interface for shape_kind enumeration.
3257 interface GEOM_IKindOfShape
3271 /*! box with faces, parallel to global coordinate planes */
3279 /*! solid, bounded by polygons */
3284 /*! spherical face (closed) */
3286 /*! cylindrical face with defined height */
3288 /*! toroidal face (closed) */
3290 /*! conical face with defined height */
3292 /*! planar, bounded by circle */
3294 /*! planar, bounded by ellipse */
3296 /*! planar, bounded by segments */
3298 /*! infinite planar */
3307 /*! arc of circle */
3311 /*! arc of ellipse */
3313 /*! infinite segment */
3322 /*! all advanced shapes (temporary implementation) */
3327 // # GEOM_IMeasureOperations:
3329 * \brief Interface for measurement (distance, whatis) and
3330 * properties calculation (like Centre of Mass, Inertia, etc.).
3333 interface GEOM_IMeasureOperations : GEOM_IOperations
3336 * \brief Get kind of theShape.
3337 * \param theShape Shape to get a kind of.
3338 * \param theIntegers Output. Integer and enumerated shape's parameters
3339 * (kind of surface, closed/unclosed, number of edges, etc.)
3340 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
3341 * \note Concrete meaning of each value, returned via \a theIntegers
3342 * or \a theDoubles list depends on the kind of the shape.
3343 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
3345 //short KindOfShape (in GEOM_Object theShape,
3346 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
3347 out ListOfLong theIntegers,
3348 out ListOfDouble theDoubles);
3351 * \brief Get position (LCS) of theShape.
3352 * \param theShape Shape to calculate position of.
3353 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
3354 * Origin of the LCS is situated at the shape's center of mass.
3355 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
3356 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
3357 * Axes of the LCS are obtained from shape's location or,
3358 * if the shape is a planar face, from position of its plane.
3359 * \return Returns position of the shape through the last nine arguments.
3361 void GetPosition (in GEOM_Object theShape,
3362 out double Ox, out double Oy, out double Oz,
3363 out double Zx, out double Zy, out double Zz,
3364 out double Xx, out double Xy, out double Xz);
3367 * \brief Get summarized length of all wires,
3368 * area of surface and volume of the given shape.
3369 * \param theShape Shape to define properties of.
3370 * \param theLength Output. Summarized length of all wires of the given shape.
3371 * \param theSurfArea Output. Area of surface of the given shape.
3372 * \param theVolume Output. Volume of the given shape.
3373 * \return Returns shape properties through the last three arguments.
3375 void GetBasicProperties (in GEOM_Object theShape,
3376 out double theLength,
3377 out double theSurfArea,
3378 out double theVolume);
3381 * \brief Get a point, situated at the centre of mass of theShape.
3382 * \param theShape Shape to define centre of mass of.
3383 * \return New GEOM_Object, containing the created point.
3385 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
3388 * Get the vertex by index for 1D objects depends the edge/wire orientation
3389 * \param theShape Shape (wire or edge) to find the vertex on it
3390 * \param theIndex Index of vertex sub-shape
3391 * \return New GEOM_Object, vertex.
3393 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
3396 * \brief Get a vector, representing the normal of theFace.
3397 * If the face is not planar, theOptionalPoint is obligatory.
3398 * \param theFace Shape (face) to define the normal of.
3399 * \param theOptionalPoint Shape (point) to define the normal at.
3400 * Can be NULL in case of planar face.
3401 * \return New GEOM_Object, containing the created normal vector.
3403 GEOM_Object GetNormal (in GEOM_Object theFace,
3404 in GEOM_Object theOptionalPoint);
3407 * \brief Get inertia matrix and moments of inertia of theShape.
3408 * \param theShape Shape to calculate inertia of.
3409 * \param I11,I12,I13,I21,I22,I23,I31,I32,I33 Output. Components of the inertia matrix of the given shape.
3410 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
3411 * \return Returns inertia through the last twelve arguments.
3413 void GetInertia (in GEOM_Object theShape,
3414 out double I11, out double I12, out double I13,
3415 out double I21, out double I22, out double I23,
3416 out double I31, out double I32, out double I33,
3417 out double Ix , out double Iy , out double Iz);
3420 * \brief Get parameters of bounding box of the given shape
3421 * \param theShape Shape to obtain bounding box of.
3422 * \param Xmin,Xmax Output. Limits of shape along OX axis.
3423 * \param Ymin,Ymax Output. Limits of shape along OY axis.
3424 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
3425 * \return Returns parameters of bounding box through the last six arguments.
3427 void GetBoundingBox (in GEOM_Object theShape,
3428 out double Xmin, out double Xmax,
3429 out double Ymin, out double Ymax,
3430 out double Zmin, out double Zmax);
3433 * \brief Get min and max tolerances of sub-shapes of theShape
3434 * \param theShape Shape, to get tolerances of.
3435 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3436 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
3437 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
3438 * \return Returns shape tolerances through the last six arguments.
3440 void GetTolerance (in GEOM_Object theShape,
3441 out double FaceMin, out double FaceMax,
3442 out double EdgeMin, out double EdgeMax,
3443 out double VertMin, out double VertMax);
3446 * \brief Check a topology of the given shape.
3447 * \param theShape Shape to check validity of.
3448 * \param theDescription Output. Description of problems in the shape, if they are.
3449 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
3451 boolean CheckShape (in GEOM_Object theShape,
3452 out string theDescription);
3455 * \brief Check a topology and a geometry of the given shape.
3456 * \param theShape Shape to check validity of.
3457 * \param theDescription Output. Description of problems in the shape, if they are.
3458 * \return TRUE, if the shape "seems to be valid".
3460 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
3461 out string theDescription);
3464 * \brief Check a topology of the given shape on self-intersections presence.
3465 * \param theShape Shape to check validity of.
3466 * \param theIntersections Output. List of intersected sub-shapes IDs, it contains pairs of IDs.
3467 * \return TRUE, if the shape does not have any self-intersections.
3469 boolean CheckSelfIntersections (in GEOM_Object theShape,
3470 out ListOfLong theIntersections);
3473 * \brief Check if the given shape can be an argument for MakeSolid operation
3474 * \param theShape Shape to be described.
3475 * \return Empty string if a solid can be made on this shape, error code otherwise.
3477 string IsGoodForSolid (in GEOM_Object theShape);
3480 * O\brief btain description of the given shape
3481 * \param theShape Shape to be described.
3482 * \return Description of the given shape.
3484 string WhatIs (in GEOM_Object theShape);
3487 * \brief Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on
3488 * the shape theShape.
3489 * \param theShape Shape to check.
3490 * \param coords list of coordinates.
3491 * \param tolerance tolerance.
3492 * \return list of boolean.
3494 ListOfBool AreCoordsInside(in GEOM_Object theShape, in ListOfDouble coords, in double tolerance);
3497 * \brief Get minimal distance between the given shapes.
3498 * \param theShape1,theShape2 Shapes to find minimal distance between.
3499 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
3500 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
3501 * \return Value of the minimal distance between the given shapes.
3503 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
3504 out double X1, out double Y1, out double Z1,
3505 out double X2, out double Y2, out double Z2);
3508 * \brief Get angle between the given lines or linear edges.
3509 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
3510 * \return Value of the angle between the given shapes.
3512 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
3515 * \brief Get angle between the given vectors.
3516 * \param theShape1,theShape2 Vectors to find angle between.
3517 * \return Value of the angle between the given vectors.
3519 double GetAngleBtwVectors (in GEOM_Object theShape1, in GEOM_Object theShape2);
3522 * \brief Get point coordinates
3524 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
3527 * \brief Get radius of curvature of curve in the point determinated by param
3528 * \param theShape - curve.
3529 * \param theParam - parameter on curve
3530 * \return Value of curvature.
3532 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3535 * \brief Get radius of curvature of curve in the given point
3536 * \param theShape - curve.
3537 * \param thePoint - point
3538 * \return Value of curvature.
3540 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3543 * \brief Get max radius of curvature of surface in the point determinated by params
3544 * \param theShape - surface.
3545 * \param theUParam - U-parameter on surface
3546 * \param theVParam - V-parameter on surface
3547 * \return Value of curvature.
3549 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3550 in double theVParam);
3553 * \brief Get max radius of curvature of surface in the given point
3554 * \param theShape - surface.
3555 * \param thePoint - point
3556 * \return Value of curvature.
3558 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3561 * \brief Get min radius of curvature of surface in the point determinated by params
3562 * \param theShape - surface.
3563 * \param theUParam - U-parameter on surface
3564 * \param theVParam - V-parameter on surface
3565 * \return Value of curvature.
3567 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3568 in double theVParam);
3571 * \brief Get min radius of curvature of surface in the given point
3572 * \param theShape - surface.
3573 * \param thePoint - point
3574 * \return Value of curvature.
3576 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3580 // # GEOM_IGroupOperations:
3582 * \brief Interface for groups creation.
3584 interface GEOM_IGroupOperations : GEOM_IOperations
3587 * \brief Creates a new group which will store sub-shapes of theMainShape
3588 * \param theMainShape is a GEOM_Object on which the group is selected
3589 * \param theShapeType defines a shape type of the group
3590 * \return a newly created GEOM group
3592 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3595 * \brief Adds a sub-object with ID theSubShapeId to the group
3596 * \param theGroup is a GEOM group to which the new sub-shape is added
3597 * \param theSubShapeId is a sub-shape ID in the main object.
3598 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
3600 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3603 * \brief Removes a sub-object with ID \a theSubShapeId from the group
3604 * \param theGroup is a GEOM group from which the sub-shape is removed.
3605 * \param theSubShapeId is a sub-shape ID in the main object.
3606 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
3608 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3611 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3612 * \param theGroup is a GEOM group to which the new sub-shapes are added.
3613 * \param theSubShapes is a list of sub-shapes to be added.
3615 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3618 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
3619 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3620 * \param theSubShapes is a list of sub-shapes to be removed.
3622 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3625 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3626 * \param theGroup is a GEOM group to which the new sub-shapes are added.
3627 * \param theSubShapes is a list of IDs of sub-shapes to be added.
3629 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3632 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
3633 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3634 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3636 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3639 * \brief Returns a type of sub-objects stored in the group
3640 * \param theGroup is a GEOM group which type is returned.
3642 long GetType (in GEOM_Object theGroup);
3645 * \brief Returns a main shape associated with the group
3646 * \param theGroup is a GEOM group for which a main shape object is requested
3647 * \return a GEOM_Object which is a main shape for theGroup
3649 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3652 * \brief Returns a list of sub-objects ID stored in the group
3653 * \param theGroup is a GEOM group for which a list of IDs is requested
3655 ListOfLong GetObjects (in GEOM_Object theGroup);
3658 // # GEOM_IAdvancedOperations:
3660 * \brief Interface for advanced modeling functions.
3662 interface GEOM_IAdvancedOperations : GEOM_IOperations
3665 * \brief Create a T-shape object with specified caracteristics for the main and
3666 * the incident pipes (radius, width, half-length).
3668 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3669 * \param theR1 Internal radius of main pipe
3670 * \param theW1 Width of main pipe
3671 * \param theL1 Half-length of main pipe
3672 * \param theR2 Internal radius of incident pipe (R2 < R1)
3673 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3674 * \param theL2 Half-length of incident pipe
3675 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3676 * \return List of GEOM_Object, containing the created shape and propagation groups.
3678 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
3679 in double theR2, in double theW2, in double theL2,
3680 in boolean theHexMesh);
3682 * \brief Create a T-shape object with specified caracteristics for the main and
3683 * the incident pipes (radius, width, half-length).
3685 * The extremities of the main pipe are located on junctions points P1 and P2.
3686 * The extremity of the incident pipe is located on junction point P3.
3687 * \param theR1 Internal radius of main pipe
3688 * \param theW1 Width of main pipe
3689 * \param theL1 Half-length of main pipe
3690 * \param theR2 Internal radius of incident pipe (R2 < R1)
3691 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3692 * \param theL2 Half-length of incident pipe
3693 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3694 * \param theP1 1st junction point of main pipe
3695 * \param theP2 2nd junction point of main pipe
3696 * \param theP3 Junction point of incident pipe
3697 * \return List of GEOM_Object, containing the created shape and propagation groups.
3699 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
3700 in double theR2, in double theW2, in double theL2,
3701 in boolean theHexMesh,
3702 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3704 * \brief Create a T-shape object with specified caracteristics for the main and
3705 * the incident pipes (radius, width, half-length). A chamfer is created
3706 * on the junction of the pipes.
3708 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3709 * \param theR1 Internal radius of main pipe
3710 * \param theW1 Width of main pipe
3711 * \param theL1 Half-length of main pipe
3712 * \param theR2 Internal radius of incident pipe (R2 < R1)
3713 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3714 * \param theL2 Half-length of incident pipe
3715 * \param theH Height of the chamfer.
3716 * \param theW Width of the chamfer.
3717 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3718 * \return List of GEOM_Object, containing the created shape and propagation groups.
3720 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
3721 in double theR2, in double theW2, in double theL2,
3722 in double theH, in double theW, in boolean theHexMesh);
3724 * \brief Create a T-shape object with specified caracteristics for the main and
3725 * the incident pipes (radius, width, half-length).
3727 * A chamfer is created on the junction of the pipes.
3728 * The extremities of the main pipe are located on junctions points P1 and P2.
3729 * The extremity of the incident pipe is located on junction point P3.
3730 * \param theR1 Internal radius of main pipe
3731 * \param theW1 Width of main pipe
3732 * \param theL1 Half-length of main pipe
3733 * \param theR2 Internal radius of incident pipe (R2 < R1)
3734 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3735 * \param theL2 Half-length of incident pipe
3736 * \param theH Height of the chamfer.
3737 * \param theW Width of the chamfer.
3738 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3739 * \param theP1 1st junction point of main pipe
3740 * \param theP2 2nd junction point of main pipe
3741 * \param theP3 Junction point of incident pipe
3742 * \return List of GEOM_Object, containing the created shape and propagation groups.
3744 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
3745 in double theR2, in double theW2, in double theL2,
3746 in double theH, in double theW, in boolean theHexMesh,
3747 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3749 * \brief Create a T-shape object with specified caracteristics for the main and
3750 * the incident pipes (radius, width, half-length).
3752 * A fillet is created on the junction of the pipes.
3753 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3754 * \param theR1 Internal radius of main pipe
3755 * \param theW1 Width of main pipe
3756 * \param theL1 Half-length of main pipe
3757 * \param theR2 Internal radius of incident pipe (R2 < R1)
3758 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3759 * \param theL2 Half-length of incident pipe
3760 * \param theRF Radius of curvature of fillet.
3761 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3762 * \return List of GEOM_Object, containing the created shape and propagation groups.
3764 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
3765 in double theR2, in double theW2, in double theL2,
3766 in double theRF, in boolean theHexMesh);
3768 * \brief Create a T-shape object with specified caracteristics for the main and
3769 * the incident pipes (radius, width, half-length).
3771 * A fillet is created on the junction of the pipes.
3772 * The extremities of the main pipe are located on junctions points P1 and P2.
3773 * The extremity of the incident pipe is located on junction point P3.
3774 * \param theR1 Internal radius of main pipe
3775 * \param theW1 Width of main pipe
3776 * \param theL1 Half-length of main pipe
3777 * \param theR2 Internal radius of incident pipe (R2 < R1)
3778 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3779 * \param theL2 Half-length of incident pipe
3780 * \param theRF Radius of curvature of fillet.
3781 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3782 * \param theP1 1st junction point of main pipe
3783 * \param theP2 2nd junction point of main pipe
3784 * \param theP3 Junction point of incident pipe
3785 * \return List of GEOM_Object, containing the created shape and propagation groups.
3787 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
3788 in double theR2, in double theW2, in double theL2,
3789 in double theRF, in boolean theHexMesh,
3790 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3792 * This function allows to create a disk already divided into blocks. It
3793 * can be use to create divided pipes for later meshing in hexaedra.
3794 * \param theR Radius of the disk
3795 * \param theRatio Relative size of the central square diagonal against the disk diameter
3796 * \param theOrientation Plane on which the disk will be built
3797 * \return New GEOM_Object, containing the created shape.
3799 GEOM_Object MakeDividedDisk (in double theR,
3801 in short theOrientation,
3802 in pattern thePattern);
3805 * \brief Create a Disk prepared for hexa meshing with given center, normal vector and radius.
3806 * \param thePnt disk center.
3807 * \param theVec Vector, normal to the plane of the disk.
3808 * \param theR Disk radius.
3809 * \param theRatio Relative size of the central square diagonal against the disk diameter
3810 * \return New GEOM_Object, containing the created disk.
3812 GEOM_Object MakeDividedDiskPntVecR ( in GEOM_Object thePnt,
3813 in GEOM_Object theVec,
3816 in pattern thePattern);
3819 * Builds a cylinder prepared for hexa meshes
3820 * \param theR Radius of the cylinder
3821 * \param theH Height of the cylinder
3822 * \return New GEOM_Object, containing the created shape.
3824 GEOM_Object MakeDividedCylinder (in double theR,
3826 in pattern thePattern );
3828 /*@@ insert new functions before this line @@ do not remove this line @@*/
3833 * \brief Interface to access other GEOM interfaces.
3835 * Also contains some methods to access and manage GEOM_Object.
3837 interface GEOM_Gen : Engines::EngineComponent,SALOMEDS::Driver
3840 * \brief Undo/Redo Management
3843 void Undo (in long theStudyID);
3845 void Redo (in long theStudyID);
3848 * \brief Publishing management
3850 * Adds in theStudy a object theObject under with a name theName,
3851 * if theFather is not NULL the object is placed under thFather's SObject.
3852 * Returns a SObject where theObject is placed
3854 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3855 in GEOM_Object theObject,
3857 in GEOM_Object theFather);
3860 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
3862 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3863 * \param theStudy the study, in which theObject is published already,
3864 * and in which the arguments will be published
3865 * \param theObject published GEOM_Object, arguments of which will be published
3866 * \param theArgs list of GEOM_Object, operation arguments to be published.
3867 * If this list is empty, all operation arguments will be published
3868 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
3869 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
3870 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3871 * Do not publish sub-shapes in place of arguments, but only
3872 * in place of sub-shapes of the first argument,
3873 * because the whole shape corresponds to the first argument.
3874 * Mainly to be used after transformations, but it also can be
3875 * usefull after partition with one object shape, and some other
3876 * operations, where only the first argument has to be considered.
3877 * If theObject has only one argument shape, this flag is automatically
3878 * considered as True, not regarding really passed value.
3879 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3880 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
3881 * \return list of published sub-shapes
3883 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
3884 in GEOM_Object theObject,
3885 in ListOfGO theArgs,
3886 in find_shape_method theFindMethod,
3887 in boolean theInheritFirstArg,
3888 in boolean theAddPrefix);
3891 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
3893 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3894 * \param theStudy the study, in which theObject is published already,
3895 * and in which the arguments will be published
3896 * \param theObject published GEOM_Object, arguments of which will be published
3897 * \param theArgs list of GEOM_Object, operation arguments to be published.
3898 * If this list is empty, all operation arguments will be published
3899 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
3900 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
3901 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3902 * Do not publish sub-shapes in place of arguments, but only
3903 * in place of sub-shapes of the first argument,
3904 * because the whole shape corresponds to the first argument.
3905 * Mainly to be used after transformations, but it also can be
3906 * usefull after partition with one object shape, and some other
3907 * operations, where only the first argument has to be considered.
3908 * If theObject has only one argument shape, this flag is automatically
3909 * considered as True, not regarding really passed value.
3910 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3911 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
3912 * \return list of published sub-shapes
3914 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
3915 in GEOM_Object theObject,
3916 in ListOfGO theArgs,
3917 in find_shape_method theFindMethod,
3918 in boolean theInheritFirstArg,
3919 in boolean theAddPrefix);
3922 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
3924 * To be used from GUI and from geompy.addToStudy.
3925 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
3926 * \param theStudy the study, in which theObject is published already,
3927 * and in which the arguments will be published
3928 * \param theSObject study object, referencing GEOM_Object, arguments of which will be published
3929 * \param theArgs list of GEOM_Object, operation arguments to be published.
3930 * If this list is empty, all operation arguments will be published
3931 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
3932 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
3933 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3934 * Do not publish sub-shapes in place of arguments, but only
3935 * in place of sub-shapes of the first argument,
3936 * because the whole shape corresponds to the first argument.
3937 * Mainly to be used after transformations, but it also can be
3938 * usefull after partition with one object shape, and some other
3939 * operations, where only the first argument has to be considered.
3940 * If theObject has only one argument shape, this flag is automatically
3941 * considered as True, not regarding really passed value.
3942 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3943 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
3945 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
3946 in SALOMEDS::SObject theSObject,
3947 in ListOfGO theArgs,
3948 in find_shape_method theFindMethod,
3949 in boolean theInheritFirstArg,
3950 in boolean theAddPrefix);
3952 // # Methods to access interfaces for objects creation and transformation
3954 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3955 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
3956 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3957 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3958 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3959 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3960 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3961 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3962 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3963 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3964 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3965 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3966 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3968 // # Objects Management
3972 * \brief Removes the object from the GEOM component
3973 * \param theObject is a GEOM_Object to be removed
3975 void RemoveObject (in GEOM_Object theObject);
3978 * \brief Returns an object defined by the study and its entry in the GEOM component
3979 * \param theStudyID is a SALOMEDS Study ID
3980 * \param theEntry is an entry of the requested GEOM_Object in the GEOM component
3981 * \note if the object has not previously been created a NULL GEOM_Object is returned
3983 GEOM_Object GetObject (in long theStudyID, in string theEntry);
3986 * \brief Add a sub-shape defined by indices in \a theIndices
3987 * (contains unique IDs of sub-shapes inside \a theMainShape)
3988 * \note The sub-shape GEOM_Object can has ONLY ONE function.
3989 * Don't try to apply modification operations on them.
3990 * \note Internal method
3992 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
3994 // # GEOM_Objects IOR Management
3997 * \brief Returns a GEOM_Object defined by its IOR
3998 * \param theIOR a string containg an IOR of the requested GEOM_Object
4000 GEOM_Object GetIORFromString (in string theIOR);
4003 * \brief Returns a string which contains an IOR of the GEOM_Object
4004 * \param theObject is a GEOM_Object which IOR is requested
4006 string GetStringFromIOR (in GEOM_Object theObject);
4009 * \brief Returns a name with which a GEOM_Object was dumped into python script
4010 * \param theStudyEntry is an entry of the GEOM_Object in the study
4012 string GetDumpName (in string theStudyEntry);
4015 * \brief Returns all names with which a GEOM_Object was dumped
4016 * into python script to avoid the same names in SMESH script
4018 string_array GetAllDumpNames();
4021 * \brief Publishes the named sub-shapes of given object in the study.
4022 * \param theStudy The study in which the object is published
4023 * \param theObject The object which named sub-shapes are published
4025 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
4026 //in SObject theSObject,
4027 in Object theObject);