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 in BRep format
364 * \note GEOM_IInsertOperations::RestoreShape() method can be used to restore shape from a BRep stream.
366 SALOMEDS::TMPFile GetShapeStream();
369 * \brief Returns True if this object is not a sub-shape of another object.
371 boolean IsMainShape();
374 * \brief Get a list of ID's of sub-shapes in the main shape.
375 * \note Internal method, suppopsed to be used only by GEOM_Client
377 ListOfLong GetSubShapeIndices();
380 * \brief Get a main shape object to which this object is a sub-shape
381 * \note Internal method, suppopsed to be used only by GEOM_Client
383 GEOM_Object GetMainShape();
386 * \brief Return true if geom object representes a shape.
388 * For example, method return false for GEOM_MARKER
393 * \brief Return true if passed object is identical to this object
395 * \param other object being compared with this one
397 boolean IsSame(in GEOM_Object other);
400 * Set list of parameters
401 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
402 * used for object creation
404 void SetParameters (in string theParameters);
407 * \brief Return list of notebook variables used for object creation separated by ":" symbol
409 string GetParameters();
412 // # GEOM_IOperations:
414 * \brief Basic methods of all geometric operations
416 interface GEOM_IOperations : SALOME::GenericObj
419 * \brief To know, if the operation was successfully performed
424 * \brief Set the operation error code
425 * \param theErrorID is a string describing the error occured
426 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
428 void SetErrorCode (in string theErrorID);
431 * \brief Get the operation error code
433 string GetErrorCode();
436 * \brief Get ID of study, where the operation is defined
441 * \brief Opens a new transaction
443 void StartOperation();
446 * \brief Closes the previously opened trasaction
448 void FinishOperation();
451 * \brief Aborts the previously opened transaction
453 void AbortOperation();
455 //# GEOM_IBasicOperations:
457 * \brief Interface for basic geometry creation
459 * (Point, Vector, Plane, Marker)
461 interface GEOM_IBasicOperations : GEOM_IOperations
464 * \brief Create point by three coordinates.
465 * \param theX The X coordinate of the point.
466 * \param theY The Y coordinate of the point.
467 * \param theZ The Z coordinate of the point.
468 * \return New GEOM_Object, containing the created point.
470 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
473 * \brief Create a point, distant from the referenced point
474 * on the given distances along the coordinate axes.
475 * \param theReference The referenced point.
476 * \param theX Displacement from the referenced point along OX axis.
477 * \param theY Displacement from the referenced point along OY axis.
478 * \param theZ Displacement from the referenced point along OZ axis.
479 * \return New GEOM_Object, containing the created point.
481 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
482 in double theX, in double theY, in double theZ);
485 * Create a point, corresponding to the given parameter on the given curve.
486 * \param theRefCurve The referenced curve.
487 * \param theParameter Value of parameter on the referenced curve.
488 * \return New GEOM_Object, containing the created point.
490 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
491 in double theParameter);
494 * \brief Create a point, corresponding to the given length on the given curve.
495 * \param theRefCurve The referenced curve.
496 * \param theLength Length on the referenced curve. It can be negative.
497 * \param theStartPoint Any vertex close to one of edge's
498 * ends to select start point among them.
499 * If NULL, fist vertex is used.
500 * \return New GEOM_Object, containing the created point.
502 GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve,
504 in GEOM_Object theStartPoint);
507 * \brief Create a point on the given curve, projecting given point
508 * \param theRefCurve The referenced curve.
509 * \param theXParameter X co-ordinate of point to project on curve
510 * \param theYParameter Y co-ordinate of point to project on curve
511 * \param theZParameter Z co-ordinate of point to project on curve
512 * \return New GEOM_Object, containing the created point.
514 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
515 in double theXParameter,
516 in double theYParameter,
517 in double theZParameter);
520 * \brief Create a point, corresponding to the given parameters on the
522 * \param theRefSurf The referenced surface.
523 * \param theUParameter Value of U-parameter on the referenced surface.
524 * \param theVParameter Value of V-parameter on the referenced surface.
525 * \return New GEOM_Object, containing the created point.
527 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
528 in double theUParameter,
529 in double theVParameter);
532 * \brief Create a point on the given surface, projecting given point
533 * \param theRefSurf The referenced surface.
534 * \param theXParameter X co-ordinate of point to project on curve
535 * \param theYParameter Y co-ordinate of point to project on curve
536 * \param theZParameter Z co-ordinate of point to project on curve
537 * \return New GEOM_Object, containing the created point.
539 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
540 in double theXParameter,
541 in double theYParameter,
542 in double theZParameter);
545 * \brief Create a point, which lays on the given face.
546 * The point will lay in arbitrary place of the face.
547 * The only condition on it is a non-zero distance to the face boundary.
548 * Such point can be used to uniquely identify the face inside any
549 * shape in case, when the shape does not contain overlapped faces.
550 * \param theFace The referenced face.
551 * \return New GEOM_Object, containing the created point.
553 GEOM_Object MakePointOnFace (in GEOM_Object theFace);
556 * \brief Create a point, on two lines intersection.
557 * \param theRefLine1, theRefLine2 The referenced lines.
558 * \return New GEOM_Object, containing the created point.
560 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
561 in GEOM_Object theRefLine2);
564 * \brief Create a vector, corresponding to tangent to the given parameter on the given curve.
565 * \param theRefCurve The referenced curve.
566 * \param theParameter Value of parameter on the referenced curve.This value should be have value
567 * between 0. and 1.. Value of 0. corresponds first parameter of curve; value
568 * 1. corresponds last parameter of curve.
569 * \return New GEOM_Object, containing the created point.
571 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
572 in double theParameter);
575 * \brief Create a vector with the given components.
576 * \param theDX X component of the vector.
577 * \param theDY Y component of the vector.
578 * \param theDZ Z component of the vector.
579 * \return New GEOM_Object, containing the created vector.
581 GEOM_Object MakeVectorDXDYDZ (in double theDX,
586 * \brief Create a vector between two points.
587 * \param thePnt1 Start point for the vector.
588 * \param thePnt2 End point for the vector.
589 * \return New GEOM_Object, containing the created vector.
591 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
594 * C\brief reate a line, passing through the given point
595 * and parrallel to the given direction
596 * \param thePnt Point. The resulting line will pass through it.
597 * \param theDir Direction. The resulting line will be parallel to it.
598 * \return New GEOM_Object, containing the created line.
600 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
603 * \brief Create a line, passing through the given points
604 * \param thePnt1 First of two points, defining the line.
605 * \param thePnt2 Second of two points, defining the line.
606 * \return New GEOM_Object, containing the created line.
608 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
611 * \brief Create a line, given by two faces intersection.
612 * \param theFace1 First of two faces, defining the line.
613 * \param theFace2 Second of two faces, defining the line.
614 * \return New GEOM_Object, containing the created line.
616 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
619 * \brief Create a plane, passing through the three given points
620 * \param thePnt1 First of three points, defining the plane.
621 * \param thePnt2 Second of three points, defining the plane.
622 * \param thePnt3 Fird of three points, defining the plane.
623 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
624 * \return New GEOM_Object, containing the created plane.
626 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
627 in GEOM_Object thePnt2,
628 in GEOM_Object thePnt3,
629 in double theTrimSize);
632 * \brief Create a plane, passing through the given point
633 * and normal to the given vector.
634 * \param thePnt Point, the plane has to pass through.
635 * \param theVec Vector, defining the plane normal direction.
636 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
637 * \return New GEOM_Object, containing the created plane.
639 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
640 in GEOM_Object theVec,
641 in double theTrimSize);
644 * \brief Create a plane, similar to the existing one, but with another size of representing face.
645 * \param theFace Referenced plane or LCS(Marker).
646 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
647 * \return New GEOM_Object, containing the created plane.
649 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
650 in double theTrimSize);
653 * \brief Create a plane, by two vectors.
654 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
655 * \param theVec2 Vector2, defining the plane normal direction.
656 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
657 * \return New GEOM_Object, containing the created plane.
659 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
660 in GEOM_Object theVec2,
661 in double theTrimSize);
664 * \brief Create a plane, defined by local coordinate system.
665 * \param theLCS Referenced LCS(Marker).
666 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
667 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
668 * \return New GEOM_Object, containing the created plane.
670 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
671 in double theTrimSize,
672 in double theOrientation);
675 * \brief Create a local coordinate system.
676 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
677 * \param theXDX,theXDY,theXDZ Three components of OX direction
678 * \param theYDX,theYDY,theYDZ Three components of OY direction
679 * \return New GEOM_Object, containing the created coordinate system.
681 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
682 in double theXDX, in double theXDY, in double theXDZ,
683 in double theYDX, in double theYDY, in double theYDZ);
686 * \brief Create a local coordinate system from shape.
687 * \param theShape The initial shape to detect the coordinate system.
688 * \return New GEOM_Object, containing the created coordinate system.
690 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
693 * \brief Create a local coordinate system from point and two vectors (DX, DY).
694 * \param theOrigin Point of coordinate system origin.
695 * \param theXVec Vector of X direction.
696 * \param theYVec Vector of Y direction.
697 * \return New GEOM_Object, containing the created coordinate system.
699 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin,
700 in GEOM_Object theXVec, in GEOM_Object theYVec);
703 * \brief Create a tangent plane to specified face in the point with specified parameters.
705 * Values of parameters should be between 0. and 1.0
706 * \param theFace - face for which tangent plane shuold be built.
707 * \param theParameterU - value of parameter by U
708 * \param theParameterV - value of parameter Vthe
709 * \param theTrimSize - defines sizes of created face
710 * \return New GEOM_Object, containing the face built on tangent plane.
712 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
713 in double theParameterU,
714 in double theParameterV,
715 in double theTrimSize);
718 interface GEOM_ITransformOperations : GEOM_IOperations
721 * \brief Translate the given object along the vector, specified by its end points.
722 * \param theObject The object to be translated.
723 * \param thePoint1 Start point of translation vector.
724 * \param thePoint2 End point of translation vector.
727 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
728 in GEOM_Object thePoint1,
729 in GEOM_Object thePoint2);
732 * \brief Translate the given object along the vector, specified
733 * by its end points, creating its copy before the translation.
734 * \param theObject The object to be translated.
735 * \param thePoint1 Start point of translation vector.
736 * \param thePoint2 End point of translation vector.
737 * \return New GEOM_Object, containing the translated object.
739 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
740 in GEOM_Object thePoint1,
741 in GEOM_Object thePoint2);
744 * \brief Translate the given object along the vector, specified by its components.
745 * \param theObject The object to be translated.
746 * \param theDX,theDY,theDZ Components of translation vector.
749 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
750 in double theDX, in double theDY, in double theDZ);
753 * \brief Translate the given object along the vector, specified
754 * by its components, creating its copy before the translation.
755 * \param theObject The object to be translated.
756 * \param theDX,theDY,theDZ Components of translation vector.
757 * \return New GEOM_Object, containing the translated object.
759 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
760 in double theDX, in double theDY, in double theDZ);
764 * \brief Translate the given object along the given vector.
765 * \param theObject The object to be translated.
766 * \param theVector Translation vector, giving both direction and distance.
769 GEOM_Object TranslateVector (in GEOM_Object theObject,
770 in GEOM_Object theVector);
773 * \brief Translate the given object along the given vector,
774 * creating its copy before the translation.
775 * \param theObject The object to be translated.
776 * \param theVector Translation vector, giving both direction and distance.
777 * \return New GEOM_Object, containing the translated object.
779 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
780 in GEOM_Object theVector);
783 * \brief Translate the given object along the given vector on given distance,
784 * creating its copy before the translation.
785 * \param theObject The object to be translated.
786 * \param theVector Translation vector, giving a direction.
787 * \param theDistance Translation distance, giving a distance.
788 * \param theCopy Translation copy, creating its copy if true.
789 * \return New GEOM_Object, containing the translated object.
791 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
792 in GEOM_Object theVector,
793 in double theDistance,
797 * \brief Translate the given object along the given vector a given number times
798 * \param theObject The object to be translated.
799 * \param theVector Direction of the translation.
800 * \param theStep Distance to translate on.
801 * \param theNbTimes Quantity of translations to be done.
802 * \return New GEOM_Object, containing compound of all
803 * the shapes, obtained after each translation.
805 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
806 in GEOM_Object theVector,
811 * \brief Conseqently apply two specified translations to theObject specified number of times.
812 * \param theObject The object to be translated.
813 * \param theVector1 Direction of the first translation.
814 * \param theStep1 Step of the first translation.
815 * \param theNbTimes1 Quantity of translations to be done along theVector1.
816 * \param theVector2 Direction of the second translation.
817 * \param theStep2 Step of the second translation.
818 * \param theNbTimes2 Quantity of translations to be done along theVector2.
819 * \return New GEOM_Object, containing compound of all
820 * the shapes, obtained after each translation.
822 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
823 in GEOM_Object theVector1,
826 in GEOM_Object theVector2,
828 in long theNbTimes2);
831 * \brief Rotate given object around vector perpendicular to plane containing three points.
832 * \param theObject The object to be rotated.
833 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
834 * containing the three points.
835 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
838 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
839 in GEOM_Object theCentPoint,
840 in GEOM_Object thePoint1,
841 in GEOM_Object thePoint2);
845 * \brief Rotate given object around vector perpendicular to plane containing three points.
847 * Creating its copy before the rotatation.
848 * \param theObject The object to be rotated.
849 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
850 * containing the three points.
851 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
852 * \return New GEOM_Object, containing the rotated object.
854 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
855 in GEOM_Object theCentPoint,
856 in GEOM_Object thePoint1,
857 in GEOM_Object thePoint2);
860 * \brief Rotate the given object around the given axis on the given angle.
861 * \param theObject The object to be rotated.
862 * \param theAxis Rotation axis.
863 * \param theAngle Rotation angle in radians.
866 GEOM_Object Rotate (in GEOM_Object theObject,
867 in GEOM_Object theAxis,
872 * Rotate the given object around the given axis
873 * on the given angle, creating its copy before the rotatation.
874 * \param theObject The object to be rotated.
875 * \param theAxis Rotation axis.
876 * \param theAngle Rotation angle in radians.
877 * \return New GEOM_Object, containing the rotated object.
879 GEOM_Object RotateCopy (in GEOM_Object theObject,
880 in GEOM_Object theAxis,
885 * \brief Rotate the given object around the given axis a given number times.
887 * Rotation angle will be 2*PI/theNbTimes.
888 * \param theObject The object to be rotated.
889 * \param theAxis The rotation axis.
890 * \param theNbTimes Quantity of rotations to be done.
891 * \return New GEOM_Object, containing compound of all the
892 * shapes, obtained after each rotation.
894 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
895 in GEOM_Object theAxis,
899 * \brief Rotate the given object around the
900 * given axis on the given angle a given number
901 * times and multi-translate each rotation result.
903 * Translation direction passes through center of gravity
904 * of rotated shape and its projection on the rotation axis.
905 * \param theObject The object to be rotated.
906 * \param theAxis Rotation axis.
907 * \param theAngle Rotation angle in graduces.
908 * \param theNbTimes1 Quantity of rotations to be done.
909 * \param theStep Translation distance.
910 * \param theNbTimes2 Quantity of translations to be done.
911 * \return New GEOM_Object, containing compound of all the
912 * shapes, obtained after each transformation.
914 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
915 in GEOM_Object theAxis,
919 in long theNbTimes2);
922 * \brief Replace the given object by an object,
923 * symmetrical to it relatively the given plane.
924 * \param theObject The object to be mirrored.
925 * \param thePlane Plane of symmetry.
927 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
930 * \brief Create an object, symmetrical
931 * to the given one relatively the given plane.
932 * \param theObject The object to be mirrored.
933 * \param thePlane Plane of symmetry.
934 * \return New GEOM_Object, containing the mirrored shape.
936 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
939 * \brief Replace the given object by an object,
940 * symmetrical to it relatively the given axis.
941 * \param theObject The object to be mirrored.
942 * \param theAxis Axis of symmetry.
945 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
948 * \brief Create an object, symmetrical
949 * to the given one relatively the given axis.
950 * \param theObject The object to be mirrored.
951 * \param theAxis Axis of symmetry.
952 * \return New GEOM_Object, containing the mirrored object.
954 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
957 * \brief Replace the given object by an object, symmetrical to it relatively the given point.
958 * \param theObject The object to be mirrored.
959 * \param thePoint Point of symmetry.
962 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
965 * \brief Create an object, symmetrical to the given one relatively the given point.
966 * \param theObject The object to be mirrored.
967 * \param thePoint Point of symmetry.
968 * \return New GEOM_Object, containing the mirrored object.
970 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
973 * \brief Replace the given object by its offset.
974 * \param theObject The base object for the offset.
975 * \param theOffset Offset value.
978 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
981 * \brief Create new object as offset of the given one.
982 * \param theObject The base object for the offset.
983 * \param theOffset Offset value.
984 * \return New GEOM_Object, containing the offset object.
986 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
989 * \brief Create new object as projection of the given one on a 2D surface.
990 * \param theSource The source object for the projection. It can be a point, edge or wire.
991 * \param theTarget The target object. It can be planar or cylindrical face.
992 * \return New GEOM_Object, containing the projection.
994 GEOM_Object ProjectShapeCopy (in GEOM_Object theSource, in GEOM_Object theTarget);
997 * \brief Scale the given object by the factor.
998 * \param theObject The object to be scaled.
999 * \param thePoint Center point for scaling.
1000 * \param theFactor Scaling factor value.
1001 * \return theObject.
1003 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
1004 in double theFactor);
1007 * \brief Scale the given object by the factor, creating its copy before the scaling.
1008 * \param theObject The object to be scaled.
1009 * \param thePoint Center point for scaling.
1010 * \param theFactor Scaling factor value.
1011 * \return New GEOM_Object, containing the scaled shape.
1013 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
1014 in double theFactor);
1017 * \brief Scale the given object by different factors along coordinate axes.
1018 * \param theObject The object to be scaled.
1019 * \param thePoint Center point for scaling.
1020 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1021 * \return theObject.
1023 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
1024 in GEOM_Object thePoint,
1025 in double theFactorX,
1026 in double theFactorY,
1027 in double theFactorZ);
1030 * \brief Scale the given object by different factors along coordinate axes,
1031 * creating its copy before the scaling.
1032 * \param theObject The object to be scaled.
1033 * \param thePoint Center point for scaling.
1034 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1035 * \return New GEOM_Object, containing the scaled shape.
1037 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
1038 in GEOM_Object thePoint,
1039 in double theFactorX,
1040 in double theFactorY,
1041 in double theFactorZ);
1044 * \brief Modify the Location of the given object by LCS.
1045 * \param theObject The object to be displaced.
1046 * \param theStartLCS Coordinate system to perform displacement from it.
1047 * If \a theStartLCS is NULL, displacement
1048 * will be performed from global CS.
1049 * If \a theObject itself is used as \a theStartLCS,
1050 * its location will be changed to \a theEndLCS.
1051 * \param theEndLCS Coordinate system to perform displacement to it.
1052 * \return theObject.
1054 GEOM_Object PositionShape (in GEOM_Object theObject,
1055 in GEOM_Object theStartLCS,
1056 in GEOM_Object theEndLCS);
1059 * \brief Modify the Location of the given object by LCS,
1060 * creating its copy before the setting.
1061 * \param theObject The object to be displaced.
1062 * \param theStartLCS Coordinate system to perform displacement from it.
1063 * If \a theStartLCS is NULL, displacement
1064 * will be performed from global CS.
1065 * If \a theObject itself is used as \a theStartLCS,
1066 * its location will be changed to \a theEndLCS.
1067 * \param theEndLCS Coordinate system to perform displacement to it.
1068 * \return New GEOM_Object, containing the displaced shape.
1070 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
1071 in GEOM_Object theStartLCS,
1072 in GEOM_Object theEndLCS);
1075 * \brief Modify the Location of the given object by Path,
1076 * \param theObject The object to be displaced.
1077 * \param thePath Wire or Edge along that the object will be translated.
1078 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
1079 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
1080 * \param theReverse is a true or false parameter. true is to reverse direction, false is to move normal direction.
1081 * \return New GEOM_Object, containing the displaced shape.
1083 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
1084 in GEOM_Object thePath,
1085 in double theDistance,
1087 in boolean theReverse);
1090 * \brief Transform the shape in the same way what was used for the sample shape creation.
1091 * \param theObject The object to be transformed.
1092 * \param theSample The object containing information about required transformation.
1093 * \note Implementation of this method is limited by multi-transformations now.
1094 * \note Internal method.
1095 * \return New GEOM_Object, containing the transformed shape.
1097 GEOM_Object TransformLikeOtherCopy (in GEOM_Object theObject,
1098 in GEOM_Object theSample);
1101 * \brief Recompute the shape from its arguments.
1102 * \param theObject The object to be recomputed.
1103 * \return theObject.
1105 GEOM_Object RecomputeObject (in GEOM_Object theObject);
1108 // # GEOM_I3DPrimOperations:
1110 * \brief Interface for 3D primitives creation
1112 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
1113 * Pipe (extrusion along contour), Revolution, Solid (from shell).
1115 interface GEOM_I3DPrimOperations : GEOM_IOperations
1118 * \brief Create a box with specified dimensions along the coordinate axes
1119 * and with edges, parallel to the coordinate axes.
1121 * Center of the box will be at point (DX/2, DY/2, DZ/2).
1122 * \param theDX Length of Box edges, parallel to OX axis.
1123 * \param theDY Length of Box edges, parallel to OY axis.
1124 * \param theDZ Length of Box edges, parallel to OZ axis.
1125 * \return New GEOM_Object, containing the created box.
1127 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
1130 * \brief Create a box with two specified opposite vertices,
1131 * and with edges, parallel to the coordinate axes
1132 * \param thePnt1 First of two opposite vertices.
1133 * \param thePnt2 Second of two opposite vertices.
1134 * \return New GEOM_Object, containing the created box.
1136 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1139 * \brief Create a face specified dimensions along OX-OY coordinate axes,
1140 * with edges parallel to the coordinate axes.
1142 * Center of the face will be at point (0, 0, 0).
1143 * \param theH Height of the Face.
1144 * \param theW Width of the Face.
1145 * \param theOrientation Orientation belong axis OXY OYZ OZX
1146 * \return New GEOM_Object, containing the created face.
1148 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1150 * \brief Create a face by normale vector or edge and two specified sizes,
1151 * vertical (H) and horisontal (W).
1152 * \param theObj defines plane.
1153 * \param theH vertical size (height).
1154 * \param theW horisontal size (width).
1155 * \return New GEOM_Object, containing the created face.
1157 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1159 * \brief Create a Disk (circular face) with given center, normal vector and radius.
1160 * \param thePnt disk center.
1161 * \param theVec Vector, normal to the plane of the disk.
1162 * \param theR Disk radius.
1163 * \return New GEOM_Object, containing the created disk.
1165 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1166 in GEOM_Object theVec,
1169 * \brief Create a disk (circular face), passing through three given points
1170 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1171 * \return New GEOM_Object, containing the created disk.
1173 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1174 in GEOM_Object thePnt2,
1175 in GEOM_Object thePnt3);
1178 * \brief Create a disk specified dimensions along OX-OY coordinate axes.
1180 * Center of the disk at point (0, 0, 0).
1181 * \param theR of the Disk.
1182 * \param theOrientation Orientation belong axis OXY OYZ OZX
1183 * \return New GEOM_Object, containing the created disk.
1185 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1188 * \brief Create a cylinder with given radius and height at
1189 * the origin of coordinate system.
1191 * Axis of the cylinder will be collinear to the OZ axis of the coordinate system.
1192 * \param theR Cylinder radius.
1193 * \param theH Cylinder height.
1194 * \return New GEOM_Object, containing the created cylinder.
1196 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1199 * \brief Create a cylinder with given base point, axis, radius and height.
1200 * \param thePnt Central point of cylinder base.
1201 * \param theAxis Cylinder axis.
1202 * \param theR Cylinder radius.
1203 * \param theH Cylinder height.
1204 * \return New GEOM_Object, containing the created cylinder.
1206 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1207 in GEOM_Object theAxis,
1212 * \brief Create a cone with given height and radiuses at
1213 * the origin of coordinate system.
1215 * Axis of the cone will be collinear to the OZ axis of the coordinate system.
1216 * \param theR1 Radius of the first cone base.
1217 * \param theR2 Radius of the second cone base.
1218 * \note If both radiuses are non-zero, the cone will be truncated.
1219 * \note If the radiuses are equal, a cylinder will be created instead.
1220 * \param theH Cone height.
1221 * \return New GEOM_Object, containing the created cone.
1223 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1226 * \brief Create a cone with given base point, axis, height and radiuses.
1227 * \param thePnt Central point of the first cone base.
1228 * \param theAxis Cone axis.
1229 * \param theR1 Radius of the first cone base.
1230 * \param theR2 Radius of the second cone base.
1231 * \note If both radiuses are non-zero, the cone will be truncated.
1232 * \note If the radiuses are equal, a cylinder will be created instead.
1233 * \param theH Cone height.
1234 * \return New GEOM_Object, containing the created cone.
1236 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1237 in GEOM_Object theAxis,
1243 * \brief Create a torus with given radiuses at the origin of coordinate system.
1244 * \param theRMajor Torus major radius.
1245 * \param theRMinor Torus minor radius.
1246 * \return New GEOM_Object, containing the created torus.
1248 GEOM_Object MakeTorusRR (in double theRMajor,
1249 in double theRMinor);
1252 * \brief Create a torus with given center, normal vector and radiuses.
1253 * \param thePnt Torus central point.
1254 * \param theVec Torus axis of symmetry.
1255 * \param theRMajor Torus major radius.
1256 * \param theRMinor Torus minor radius.
1257 * \return New GEOM_Object, containing the created torus.
1259 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1260 in GEOM_Object theVec,
1261 in double theRMajor,
1262 in double theRMinor);
1265 * \brief Create a sphere with given radius at the origin of coordinate system.
1266 * \param theR Sphere radius.
1267 * \return New GEOM_Object, containing the created sphere.
1269 GEOM_Object MakeSphereR (in double theR);
1272 * \brief Create a sphere with given center and radius.
1273 * \param thePnt Sphere center.
1274 * \param theR Sphere radius.
1275 * \return New GEOM_Object, containing the created .
1277 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1280 * \brief Create a shape by extrusion of the base shape along the vector
1282 * All the space, transfixed by the base shape during its translation
1283 * along the vector on the given distance.
1284 * \param theBase Base shape to be extruded.
1285 * \param theVec Direction of extrusion.
1286 * \param theH Prism dimension along theVec.
1287 * \return New GEOM_Object, containing the created prism.
1289 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1290 in GEOM_Object theVec,
1292 /* \brief The Same Prism but in 2 directions (forward&backward) */
1293 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1294 in GEOM_Object theVec,
1296 /* \brief The Same as MakePrismVecH but with scaling */
1297 GEOM_Object MakePrismVecHWithScaling (in GEOM_Object theBase,
1298 in GEOM_Object theVec,
1300 in double theScaleFactor);
1303 * \brief Create a shape by extrusion of the base shape along a vector, defined by two points.
1304 * \param theBase Base shape to be extruded.
1305 * \param thePoint1 First end of extrusion vector.
1306 * \param thePoint2 Second end of extrusion vector.
1307 * \return New GEOM_Object, containing the created prism.
1309 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1310 in GEOM_Object thePoint1,
1311 in GEOM_Object thePoint2);
1312 /* \brief The same prism but in two directions forward&backward */
1313 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1314 in GEOM_Object thePoint1,
1315 in GEOM_Object thePoint2);
1316 /* \brief The Same as MakePrismTwoPnt but with scaling */
1317 GEOM_Object MakePrismTwoPntWithScaling (in GEOM_Object theBase,
1318 in GEOM_Object thePoint1,
1319 in GEOM_Object thePoint2,
1320 in double theScaleFactor);
1323 * \brief Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1324 * \param theBase Base shape to be extruded.
1325 * \param theDX, theDY, theDZ end of extrusion vector.
1326 * \return New GEOM_Object, containing the created prism.
1328 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1329 in double theDX, in double theDY, in double theDZ);
1330 /* \brief The same prism but in two directions forward&backward */
1331 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1332 in double theDX, in double theDY, in double theDZ);
1333 /* \brief The Same as MakePrismDXDYDZ but with scaling */
1334 GEOM_Object MakePrismDXDYDZWithScaling (in GEOM_Object theBase,
1335 in double theDX, in double theDY, in double theDZ,
1336 in double theScaleFactor);
1340 * \brief Add / Remove material to / from a solid by extrusion of the base shape on the given distance.
1341 * \param theInitShape Initial shape on which to perform the feature.It has to be a solid or
1342 * a compound made of a single solid
1343 * \param theBase Edge or wire defining the base shape to be extruded.
1344 * \param theHeight Prism dimension along the normal of the face.
1345 * \param theAngle Draft angel in degrees
1346 * \param theFuse If true material is added else material is removed
1347 * \return New GEOM_Object, containing the modified shape
1349 GEOM_Object MakeDraftPrism (in GEOM_Object theInitShape,
1350 in GEOM_Object theBase,
1351 in double theHeight,
1353 in boolean theFuse);
1356 * \brief Create a shape by extrusion of the base shape along
1357 * the path shape. The path shape can be a wire or an edge.
1358 * \param theBase Base shape to be extruded.
1359 * \param thePath Path shape to extrude the base shape along it.
1360 * \return New GEOM_Object, containing the created pipe.
1362 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1365 * \brief Create a shape by revolution of the base shape around the axis
1366 * on the given angle.
1368 * All the space, transfixed by the base
1369 * shape during its rotation around the axis on the given angle.
1370 * \param theBase Base shape to be rotated.
1371 * \param theAxis Rotation axis.
1372 * \param theAngle Rotation angle in radians.
1373 * \return New GEOM_Object, containing the created revolution.
1375 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1376 in GEOM_Object theAxis,
1377 in double theAngle);
1378 /* The Same Revolution but in both ways forward&backward */
1379 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1380 in GEOM_Object theAxis,
1381 in double theAngle);
1384 * \brief Create a filling from the given compound of contours.
1385 * \param theShape Initial shape on which to perform the feature.
1386 * \param theMinDeg a minimal degree of BSpline surface to create
1387 * \param theMaxDeg a maximal degree of BSpline surface to create
1388 * \param theTol2D a 2d tolerance to be reached
1389 * \param theTol3D a 3d tolerance to be reached
1390 * \param theNbIter a number of iteration of approximation algorithm
1391 * \param theMethod Kind of method to perform filling operation.
1392 * \param theApprox Boolean indicating if result should be approximated
1393 * \return New GEOM_Object, containing the created filling surface.
1395 GEOM_Object MakeFilling (in GEOM_Object theShape,
1396 in long theMinDeg, in long theMaxDeg,
1397 in double theTol2D, in double theTol3D,
1399 in filling_oper_method theMethod,
1400 in boolean theApprox);
1403 * \brief Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1404 * \param theSeqSections - set of specified sections.
1405 * \param theModeSolid - mode defining building solid or shell
1406 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1407 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1408 * \return New GEOM_Object, containing the created shell or solid.
1410 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1411 in boolean theModeSolid,
1413 in boolean theRuled);
1416 * \brief Create a shape by extrusion of the profile shape along
1419 * The path shape can be a wire or an edge.
1420 * the several profiles can be specified in the several locations of path.
1421 * \param theSeqBases - list of Bases shape to be extruded.
1422 * \param theLocations - list of locations on the path corresponding
1423 * specified list of the Bases shapes. Number of locations
1424 * should be equal to number of bases or list of locations can be empty.
1425 * \param thePath - Path shape to extrude the base shape along it.
1426 * \param theWithContact - the mode defining that the section is translated to be in
1427 * contact with the spine.
1428 * \param theWithCorrection - defining that the section is rotated to be
1429 * orthogonal to the spine tangent in the correspondent point
1430 * \return New GEOM_Object, containing the created pipe.
1432 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1433 in ListOfGO theLocations,
1434 in GEOM_Object thePath,
1435 in boolean theWithContact ,
1436 in boolean theWithCorrection );
1439 * \brief Create a shape by extrusion of the profile shape along
1442 * The path shape can be a shell or a face.
1443 * the several profiles can be specified in the several locations of path.
1444 * \param theSeqBases - list of Bases shape to be extruded.
1445 * \param theSeqSubBases - list of corresponding sub-shapes of section shapes.
1446 * \param theLocations - list of locations on the path corresponding
1447 * specified list of the Bases shapes. Number of locations
1448 * should be equal to number of bases.
1449 * \param thePath - Path shape to extrude the base shape along it.
1450 * \param theWithContact - the mode defining that the section is translated to be in
1451 * contact with the spine.
1452 * \param theWithCorrection - defining that the section is rotated to be
1453 * orthogonal to the spine tangent in the correspondent point
1454 * \return New GEOM_Object, containing the created pipe.
1456 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1457 in ListOfGO theSeqSubBases,
1458 in ListOfGO theLocations,
1459 in GEOM_Object thePath,
1460 in boolean theWithContact ,
1461 in boolean theWithCorrection );
1464 * \brief Create solids between given sections
1465 * \param theSeqBases - list of sections (shell or face).
1466 * \param theLocations - list of corresponding vertexes
1467 * \return New GEOM_Object, containing the created solids.
1469 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1470 in ListOfGO theLocations);
1473 * \brief Create a shape by extrusion of the base shape along
1474 * the path shape with constant bi-normal direction along the given vector.
1476 * The path shape can be a wire or an edge.
1477 * \param theBase Base shape to be extruded.
1478 * \param thePath Path shape to extrude the base shape along it.
1479 * \param theVec Vector defines a constant binormal direction to keep the
1480 * same angle beetween the Direction and the sections
1481 * along the sweep surface.
1482 * \return New GEOM_Object, containing the created pipe.
1484 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1485 in GEOM_Object thePath,
1486 in GEOM_Object theVec);
1490 // # GEOM_IShapesOperations
1492 * \brief Interface for Shapes creation:
1494 * Edge from two points, Wire from edges, Face from wire,
1495 * Shell from faces, Solid from shells, Compound from shapes
1497 interface GEOM_IShapesOperations : GEOM_IOperations
1500 * \brief Create a linear edge with specified ends.
1501 * \param thePnt1 Point for the first end of edge.
1502 * \param thePnt2 Point for the second end of edge.
1503 * \return New GEOM_Object, containing the created edge.
1505 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1508 * \brief Create an edge on another edge, corresponding to the given length on the given edge.
1509 * \param theRefCurve The referenced edge.
1510 * \param theLength Length on the referenced edge. It can be
1511 * negative for extrapolation on base curve.
1512 * \param theStartPoint Any vertex close to one of edge's
1513 * ends to select start point among them.
1514 * If NULL, fist vertex is used.
1515 * \return New GEOM_Object, containing the created edge.
1517 GEOM_Object MakeEdgeOnCurveByLength (in GEOM_Object theRefCurve,
1518 in double theLength,
1519 in GEOM_Object theStartPoint);
1522 * \brief Create an edge from specified wire.
1523 * \param theWire source Wire.
1524 * \param theLinearTolerance linear tolerance value
1525 * \param theAngularTolerance angular tolerance value
1526 * \return New GEOM_Object, containing the created edge.
1528 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1529 in double theLinearTolerance,
1530 in double theAngularTolerance);
1533 * \brief Create a wire from the set of edges and wires.
1534 * \param theEdgesAndWires List of edge and/or wires.
1535 * \param theTolerance Maximum distance between vertices, that will be merged.
1536 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1537 * \return New GEOM_Object, containing the created wire.
1539 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1540 in double theTolerance);
1543 * \brief Create a face on the given wire.
1544 * \param theWire closed Wire or Edge to build the face on.
1545 * \param isPlanarWanted If TRUE, only planar face will be built.
1546 * If impossible, NULL object will be returned.
1547 * \return New GEOM_Object, containing the created face.
1549 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1552 * \brief Create a face on the given wires set.
1553 * \param theWires List of closed wires or edges to build the face on.
1554 * \param isPlanarWanted If TRUE, only planar face will be built.
1555 * If impossible, NULL object will be returned.
1556 * \return New GEOM_Object, containing the created face.
1558 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1561 * \brief Create a shell from the set of faces and shells.
1562 * \param theFacesAndShells List of faces and/or shells.
1563 * \return New GEOM_Object, containing the created shell.
1565 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1568 * \brief Create a solid, bounded by the given shell.
1569 * \param theShell Bounding shell.
1570 * \return New GEOM_Object, containing the created solid.
1572 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1575 * \brief Create a solid, bounded by the given shells.
1576 * \param theShells Bounding shells.
1577 * \return New GEOM_Object, containing the created solid.
1579 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1582 * \brief Create a compound of the given shapes.
1583 * \param theShapes List of shapes to put in compound.
1584 * \return New GEOM_Object, containing the created compound.
1586 GEOM_Object MakeCompound (in ListOfGO theShapes);
1589 * \brief Replace coincident faces in theShape by one face.
1590 * \param theShape Initial shape.
1591 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1592 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1593 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1595 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1598 * Find coincident faces in theShape for possible gluing.
1599 * \param theShape Initial shape.
1600 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1603 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1606 * \brief Replace coincident faces in theShape by one face
1607 * in compliance with given list of faces
1608 * \param theShape Initial shape.
1609 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1610 * \param theFaces List of faces for gluing.
1611 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1612 * \param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
1613 * will be glued, otherwise only the edges,
1614 * belonging to <VAR>theFaces</VAR>.
1615 * \return New GEOM_Object, containing a copy of theShape without some faces.
1617 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1618 in ListOfGO theFaces, in boolean doKeepNonSolids,
1619 in boolean doGlueAllEdges);
1622 * \brief Replace coincident edges in theShape by one edge.
1623 * \param theShape Initial shape.
1624 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1625 * \return New GEOM_Object, containing a copy of theShape without coincident edges.
1627 GEOM_Object MakeGlueEdges (in GEOM_Object theShape, in double theTolerance);
1630 * Find coincident edges in theShape for possible gluing.
1631 * \param theShape Initial shape.
1632 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1635 ListOfGO GetGlueEdges (in GEOM_Object theShape, in double theTolerance);
1638 * \brief Replace coincident edges in theShape by one edge
1639 * in compliance with given list of edges
1640 * \param theShape Initial shape.
1641 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1642 * \param theEdges List of edges for gluing.
1643 * \return New GEOM_Object, containing a copy of theShape without some edges.
1645 GEOM_Object MakeGlueEdgesByList (in GEOM_Object theShape,
1646 in double theTolerance,
1647 in ListOfGO theEdges);
1650 * \brief Get all sub-shapes and groups of \a theShape,
1651 * that were created already by any other methods.
1652 * \param theShape Any shape.
1653 * \param theGroupsOnly If this parameter is TRUE, only groups will be
1654 * returned, else all found sub-shapes and groups.
1655 * \return List of existing sub-objects of \a theShape.
1657 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
1658 in boolean theGroupsOnly);
1661 * \brief Deprecated method.
1663 * Use MakeAllSubShapes() instead.
1665 ListOfGO MakeExplode (in GEOM_Object theShape,
1666 in long theShapeType,
1667 in boolean isSorted);
1670 * \brief Explode a shape on sub-shapes of a given type.
1672 * If the shape itself has the given type, it is also returned.
1673 * \param theShape Shape to be exploded.
1674 * \param theShapeType Type of sub-shapes to be retrieved.
1675 * \param isSorted If this parameter is TRUE, sub-shapes will be
1676 * sorted by coordinates of their gravity centers.
1677 * \return List of sub-shapes of type theShapeType, contained in theShape.
1679 ListOfGO MakeAllSubShapes (in GEOM_Object theShape,
1680 in long theShapeType,
1681 in boolean isSorted);
1684 * \brief Extract all sub-shapes of the given type from
1685 * the given shape, excluding the shape itself.
1686 * \param theShape Shape to be exploded.
1687 * \param theShapeType Type of sub-shapes to be retrieved.
1688 * \param isSorted If this parameter is TRUE, sub-shapes will be
1689 * sorted by coordinates of their gravity centers.
1690 * \return List of sub-shapes of type theShapeType, contained in theShape.
1692 ListOfGO ExtractSubShapes (in GEOM_Object theShape,
1693 in long theShapeType,
1694 in boolean isSorted);
1697 * \brief Deprecated method. Use GetAllSubShapesIDs() instead.
1699 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1700 in long theShapeType,
1701 in boolean isSorted);
1704 * \brief Explode a shape on sub-shapes of a given type.
1706 * Does the same, as MakeAllSubShapes, but returns IDs of
1707 * sub-shapes, not GEOM_Object. It works faster.
1708 * \param theShape Shape to be exploded.
1709 * \param theShapeType Type of sub-shapes to be retrieved.
1710 * \param isSorted If this parameter is TRUE, sub-shapes will be
1711 * sorted by coordinates of their gravity centers.
1712 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1714 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
1715 in long theShapeType,
1716 in boolean isSorted);
1719 * \brief Get a sub-shape defined by its unique ID inside \a theMainShape
1720 * \param theMainShape Main shape.
1721 * \param theID Unique ID of sub-shape inside \a theMainShape.
1722 * \return GEOM_Object, corresponding to found sub-shape.
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 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1730 * \brief Get a set of sub-shapes defined by their unique IDs inside \a theMainShape
1731 * \param theMainShape Main shape.
1732 * \param theIndices List of unique IDs of sub-shapes inside \a theMainShape.
1733 * \return List of GEOM_Object, corresponding to found sub-shapes.
1734 * \note The sub-shape GEOM_Object can has ONLY ONE function.
1735 * Don't try to apply modification operations (without copy) on them.
1737 ListOfGO MakeSubShapes (in GEOM_Object theMainShape,
1738 in ListOfLong theIndices);
1741 * Get global index of \a theSubShape in \a theMainShape.
1742 * \param theMainShape Main shape.
1743 * \param theSubShape Sub-shape of the main shape.
1744 * \return global index of \a theSubShape in \a theMainShape.
1746 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1749 * \brief Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1751 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1752 * to generate automatic names for sub-shapes, when publishing them in a study.
1753 * \param theMainShape Main shape.
1754 * \param theSubShape Sub-shape of the main shape.
1755 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1757 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1760 * \brief Get name of type of \a theShape.
1762 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1763 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1764 * to generate automatic names for sub-shapes, when publishing them in a study.
1765 * \param theShape The shape to get a type of.
1766 * \return String, containing a type name of \a theShape.
1768 string GetShapeTypeString (in GEOM_Object theShape);
1771 * \brief Count number of faces in the given shape.
1772 * \param theShape Shape to count faces in.
1773 * \return Number of faces in the given shape.
1775 long NumberOfFaces (in GEOM_Object theShape);
1778 * \brief Count number of edges in the given shape.
1779 * \param theShape Shape to count edges in.
1780 * \return Number of edges in theShape.
1782 long NumberOfEdges (in GEOM_Object theShape);
1785 * \brief Count number of sub-shapes of type \a theShapeType in the given shape.
1786 * \param theShape Shape to count sub-shapes in.
1787 * \param theShapeType The type of sub-shapes to count.
1788 * \return Number of sub-shapes of type \a theShapeType in \a theShape.
1790 long NumberOfSubShapes (in GEOM_Object theShape,
1791 in long theShapeType);
1794 * Reverses an orientation the given shape.
1795 * \param theShape Shape to be reversed.
1796 * \return The reversed copy of theShape.
1798 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1801 * \brief Retrieve all free faces from the given shape.
1803 * Free face is a face, which is not shared between two shells of the shape.
1804 * \param theShape Shape to find free faces in.
1805 * \return List of IDs of all free faces, contained in theShape.
1807 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1810 * \brief Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1811 * \param theShape1 Shape to find sub-shapes in.
1812 * \param theShape2 Shape to find shared sub-shapes with.
1813 * \param theShapeType Type of sub-shapes to be retrieved.
1814 * \return List of sub-shapes of theShape1, shared with theShape2.
1816 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1817 in GEOM_Object theShape2,
1818 in long theShapeType);
1821 * \brief Get all sub-shapes, shared by all shapes in the list \a theShapes.
1822 * \param theShapes Shapes to find common sub-shapes of.
1823 * \param theShapeType Type of sub-shapes to be retrieved.
1824 * \return List of objects, that are sub-shapes of all given shapes.
1826 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
1827 in long theShapeType);
1830 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1831 * the specified plane by the certain way, defined through \a theState parameter.
1832 * \param theShape Shape to find sub-shapes of.
1833 * \param theShapeType Type of sub-shapes to be retrieved.
1834 * \param theAx1 Vector (or line, or linear edge), specifying normal
1835 * direction and location of the plane to find shapes on.
1836 * \param theState The state of the sub-shapes to find.
1837 * \return List of all found sub-shapes.
1839 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1840 in long theShapeType,
1841 in GEOM_Object theAx1,
1842 in shape_state theState);
1844 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1845 * the specified plane by the certain way, defined through \a theState parameter.
1846 * \param theShape Shape to find sub-shapes of.
1847 * \param theShapeType Type of sub-shapes to be retrieved.
1848 * \param theAx1 Vector (or line, or linear edge), specifying normal
1849 * direction of the plane to find shapes on.
1850 * \param thePnt Point specifying location of the plane to find shapes on.
1851 * \param theState The state of the sub-shapes to find.
1852 * \return List of all found sub-shapes.
1854 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1855 in long theShapeType,
1856 in GEOM_Object theAx1,
1857 in GEOM_Object thePnt,
1858 in shape_state theState);
1863 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1864 * the specified cylinder by the certain way, defined through \a theState parameter.
1865 * \param theShape Shape to find sub-shapes of.
1866 * \param theShapeType Type of sub-shapes to be retrieved.
1867 * \param theAxis Vector (or line, or linear edge), specifying
1868 * axis of the cylinder to find shapes on.
1869 * \param theRadius Radius of the cylinder to find shapes on.
1870 * \param theState The state of the sub-shapes to find.
1871 * \return List of all found sub-shapes.
1873 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1874 in long theShapeType,
1875 in GEOM_Object theAxis,
1876 in double theRadius,
1877 in shape_state theState);
1880 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1881 * the specified cylinder by the certain way, defined through \a theState parameter.
1882 * \param theShape Shape to find sub-shapes of.
1883 * \param theShapeType Type of sub-shapes to be retrieved.
1884 * \param theAxis Vector (or line, or linear edge), specifying
1885 * axis of the cylinder to find shapes on.
1886 * \param thePnt Point specifying location of the bottom of the cylinder.
1887 * \param theRadius Radius of the cylinder to find shapes on.
1888 * \param theState The state of the sub-shapes to find.
1889 * \return List of all found sub-shapes.
1891 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1892 in long theShapeType,
1893 in GEOM_Object theAxis,
1894 in GEOM_Object thePnt,
1895 in double theRadius,
1896 in shape_state theState);
1899 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1900 * the specified sphere by the certain way, defined through \a theState parameter.
1901 * \param theShape Shape to find sub-shapes of.
1902 * \param theShapeType Type of sub-shapes to be retrieved.
1903 * \param theCenter Point, specifying center of the sphere to find shapes on.
1904 * \param theRadius Radius of the sphere to find shapes on.
1905 * \param theState The state of the sub-shapes to find.
1906 * \return List of all found sub-shapes.
1908 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1909 in long theShapeType,
1910 in GEOM_Object theCenter,
1911 in double theRadius,
1912 in shape_state theState);
1915 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1916 * the specified quadrangle by the certain way, defined through \a theState parameter.
1917 * \param theShape Shape to find sub-shapes of.
1918 * \param theShapeType Type of sub-shapes to be retrieved.
1919 * \param theTopLeftPoint Top left quadrangle corner
1920 * \param theTopRigthPoint Top right quadrangle corner
1921 * \param theBottomLeftPoint Bottom left quadrangle corner
1922 * \param theBottomRigthPoint Bottom right quadrangle corner
1923 * \param theState The state of the sub-shapes to find.
1924 * \return List of all found sub-shapes.
1926 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1927 in long theShapeType,
1928 in GEOM_Object theTopLeftPoint,
1929 in GEOM_Object theTopRigthPoint,
1930 in GEOM_Object theBottomLeftPoint,
1931 in GEOM_Object theBottomRigthPoint,
1932 in shape_state theState);
1935 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1936 * the specified plane by the certain way, defined through \a theState parameter.
1937 * \param theShape Shape to find sub-shapes of.
1938 * \param theShapeType Type of sub-shapes to be retrieved.
1939 * \param theAx1 Vector (or line, or linear edge), specifying normal
1940 * direction and location of the plane to find shapes on.
1941 * \param theState The state of the sub-shapes to find.
1942 * \return List of IDs of all found sub-shapes.
1944 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1945 in long theShapeType,
1946 in GEOM_Object theAx1,
1947 in shape_state theState);
1950 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1951 * the specified plane by the certain way, defined through \a theState parameter.
1952 * \param theShape Shape to find sub-shapes of.
1953 * \param theShapeType Type of sub-shapes to be retrieved.
1954 * \param theAx1 Vector (or line, or linear edge), specifying normal
1955 * direction of the plane to find shapes on.
1956 * \param thePnt Point specifying location of the plane to find shapes on.
1957 * \param theState The state of the sub-shapes to find.
1958 * \return List of IDs of all found sub-shapes.
1960 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1961 in long theShapeType,
1962 in GEOM_Object theAx1,
1963 in GEOM_Object thePnt,
1964 in shape_state theState);
1967 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1968 * the specified cylinder by the certain way, defined through \a theState parameter.
1969 * \param theShape Shape to find sub-shapes of.
1970 * \param theShapeType Type of sub-shapes to be retrieved.
1971 * \param theAxis Vector (or line, or linear edge), specifying
1972 * axis of the cylinder to find shapes on.
1973 * \param theRadius Radius of the cylinder to find shapes on.
1974 * \param theState The state of the sub-shapes to find.
1975 * \return List of IDs of all found sub-shapes.
1977 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1978 in long theShapeType,
1979 in GEOM_Object theAxis,
1980 in double theRadius,
1981 in shape_state theState);
1984 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1985 * the specified cylinder by the certain way, defined through \a theState parameter.
1986 * \param theShape Shape to find sub-shapes of.
1987 * \param theShapeType Type of sub-shapes to be retrieved.
1988 * \param theAxis Vector (or line, or linear edge), specifying
1989 * axis of the cylinder to find shapes on.
1990 * \param thePnt Point specifying location of the bottom of the cylinder.
1991 * \param theRadius Radius of the cylinder to find shapes on.
1992 * \param theState The state of the sub-shapes to find.
1993 * \return List of IDs all found sub-shapes.
1995 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1996 in long theShapeType,
1997 in GEOM_Object theAxis,
1998 in GEOM_Object thePnt,
1999 in double theRadius,
2000 in shape_state theState);
2003 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2004 * the specified sphere by the certain way, defined through \a theState parameter.
2005 * \param theShape Shape to find sub-shapes of.
2006 * \param theShapeType Type of sub-shapes to be retrieved.
2007 * \param theCenter Point, specifying center of the sphere to find shapes on.
2008 * \param theRadius Radius of the sphere to find shapes on.
2009 * \param theState The state of the sub-shapes to find.
2010 * \return List of IDs of all found sub-shapes.
2012 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
2013 in long theShapeType,
2014 in GEOM_Object theCenter,
2015 in double theRadius,
2016 in shape_state theState);
2019 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2020 * the specified quadrangle by the certain way, defined through \a theState parameter.
2021 * \param theShape Shape to find sub-shapes of.
2022 * \param theShapeType Type of sub-shapes to be retrieved.
2023 * \param theTopLeftPoint Top left quadrangle corner
2024 * \param theTopRigthPoint Top right quadrangle corner
2025 * \param theBottomLeftPoint Bottom left quadrangle corner
2026 * \param theBottomRigthPoint Bottom right quadrangle corner
2027 * \param theState The state of the sub-shapes to find.
2028 * \return List of IDs of all found sub-shapes.
2030 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
2031 in long theShapeType,
2032 in GEOM_Object theTopLeftPoint,
2033 in GEOM_Object theTopRigthPoint,
2034 in GEOM_Object theBottomLeftPoint,
2035 in GEOM_Object theBottomRigthPoint,
2036 in shape_state theState);
2039 * \brief Find sub-shapes complying with given status
2040 * \param theBox - the box to check state of sub-shapes against
2041 * \param theShape - the shape to explore
2042 * \param theShapeType - type of sub-shape of theShape
2043 * \param theState - required state
2044 * \return List of IDs of all found sub-shapes.
2046 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
2047 in GEOM_Object theShape,
2048 in long theShapeType,
2049 in shape_state theState);
2052 * \brief Find sub-shapes complying with given status
2053 * \param theBox - the box to check state of sub-shapes against
2054 * \param theShape - the shape to explore
2055 * \param theShapeType - type of sub-shape of theShape
2056 * \param theState - required state
2057 * \return List of all found sub-shapes.
2059 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
2060 in GEOM_Object theShape,
2061 in long theShapeType,
2062 in shape_state theState);
2065 * \brief Find sub-shapes complying with given status
2066 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2067 * \param theShape - the shape to explore
2068 * \param theShapeType - type of sub-shape of theShape
2069 * \param theState - required state
2070 * \return List of IDs of all found sub-shapes.
2072 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
2073 in GEOM_Object theShape,
2074 in short theShapeType,
2075 in shape_state theState);
2078 * \brief Find sub-shapes complying with given status
2079 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2080 * \param theShape - the shape to explore
2081 * \param theShapeType - type of sub-shape of theShape
2082 * \param theState - required state
2083 * \return List of all found sub-shapes.
2085 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
2086 in GEOM_Object theShape,
2087 in short theShapeType,
2088 in shape_state theState);
2091 * \brief Find sub-shapes complying with given status
2092 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2093 * \param theShape - the shape to explore
2094 * \param theShapeType - type of sub-shape of theShape
2095 * \param theState - required state
2096 * \return compound includes all found sub-shapes.
2098 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
2099 in GEOM_Object theShape,
2100 in short theShapeType,
2101 in shape_state theState);
2104 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2105 * coincident with \a theShapeWhat or could be a part of it.
2106 * \param theShapeWhere Shape to find sub-shapes of.
2107 * \param theShapeWhat Shape, specifying what to find.
2108 * \return Group of all found sub-shapes or a single found sub-shape.
2110 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
2111 in GEOM_Object theShapeWhat);
2114 * Old implementation of GetInPlace functionality, based on shape properties.
2116 GEOM_Object GetInPlaceOld (in GEOM_Object theShapeWhere,
2117 in GEOM_Object theShapeWhat);
2120 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2121 * coincident with \a theShapeWhat or could be a part of it.
2123 * Implementation of this method is based on a saved history of an operation,
2124 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
2125 * arguments (an argument shape or a sub-shape of an argument shape).
2126 * The operation could be the Partition or one of boolean operations,
2127 * performed on simple shapes (not on compounds).
2129 * \param theShapeWhere Shape to find sub-shapes of.
2130 * \param theShapeWhat Shape, specifying what to find.
2131 * \return Group of all found sub-shapes or a single found sub-shape.
2133 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
2134 in GEOM_Object theShapeWhat);
2137 * \brief Get sub-shape of theShapeWhere, which are
2138 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2139 * \param theShapeWhere Shape to find sub-shapes of.
2140 * \param theShapeWhat Shape, specifying what to find.
2141 * \return found sub-shape.
2143 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
2144 in GEOM_Object theShapeWhat);
2147 * \brief Get sub-shape Ids of theShapeWhere, which are
2148 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2149 * \param theShapeWhere Shape to find sub-shapes of.
2150 * \param theShapeWhat Shape, specifying what to find.
2151 * \return found sub-shape Ids.
2153 ListOfLong GetSameIDs (in GEOM_Object theShapeWhere,
2154 in GEOM_Object theShapeWhat);
2158 // # GEOM_IBlocksOperations:
2160 * \brief Interface for Blocks construction
2161 * Face from points or edges, Block from faces,
2162 * Blocks multi-translation and multi-rotation
2164 interface GEOM_IBlocksOperations : GEOM_IOperations
2167 // # Creation of blocks
2170 * \brief Create a quadrangle face from four edges. Order of Edges is not
2171 * important. It is not necessary that edges share the same vertex.
2172 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
2173 * \return New GEOM_Object, containing the created face.
2175 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
2176 in GEOM_Object theEdge2,
2177 in GEOM_Object theEdge3,
2178 in GEOM_Object theEdge4);
2181 * \brief Create a quadrangle face on two edges.
2183 * The missing edges will be built by creating the shortest ones.
2184 * \param theEdge1,theEdge2 Two opposite edges for the face.
2185 * \return New GEOM_Object, containing the created face.
2187 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
2188 in GEOM_Object theEdge2);
2191 * \brief Create a quadrangle face with specified corners.
2193 * The missing edges will be built by creating the shortest ones.
2194 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
2195 * \return New GEOM_Object, containing the created face.
2197 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
2198 in GEOM_Object thePnt2,
2199 in GEOM_Object thePnt3,
2200 in GEOM_Object thePnt4);
2203 * \brief Create a hexahedral solid, bounded by the six given faces. Order of
2204 * faces is not important.
2206 * It is not necessary that Faces share the same edge.
2207 * \param theFace1,theFace2,theFace3,theFace4,theFace5,theFace6 Faces for the hexahedral solid.
2208 * \return New GEOM_Object, containing the created solid.
2210 GEOM_Object MakeHexa (in GEOM_Object theFace1,
2211 in GEOM_Object theFace2,
2212 in GEOM_Object theFace3,
2213 in GEOM_Object theFace4,
2214 in GEOM_Object theFace5,
2215 in GEOM_Object theFace6);
2218 * \brief Create a hexahedral solid between two given faces.
2220 * The missing faces will be built by creating the smallest ones.
2221 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
2222 * \return New GEOM_Object, containing the created solid.
2224 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
2225 in GEOM_Object theFace2);
2228 // # Extract elements of blocks and blocks compounds
2232 * \brief Get a vertex, found in the given shape by its coordinates.
2233 * \param theShape Block or a compound of blocks.
2234 * \param theX,theY,theZ Coordinates of the sought vertex.
2235 * \param theEpsilon Maximum allowed distance between the resulting
2236 * vertex and point with the given coordinates.
2237 * \return New GEOM_Object, containing the found vertex.
2239 GEOM_Object GetPoint (in GEOM_Object theShape,
2243 in double theEpsilon);
2246 * \brief Find a vertex of the given shape, which has minimal distance to the given point.
2247 * \param theShape Any shape.
2248 * \param thePoint Point, close to the desired vertex.
2249 * \return New GEOM_Object, containing the found vertex.
2251 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
2252 in GEOM_Object thePoint);
2255 * \brief Get an edge, found in the given shape by two given vertices.
2256 * \param theShape Block or a compound of blocks.
2257 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2258 * \return New GEOM_Object, containing the found edge.
2260 GEOM_Object GetEdge (in GEOM_Object theShape,
2261 in GEOM_Object thePoint1,
2262 in GEOM_Object thePoint2);
2265 * \brief Find an edge of the given shape, which has minimal distance to the given point.
2266 * \param theShape Block or a compound of blocks.
2267 * \param thePoint Point, close to the desired edge.
2268 * \return New GEOM_Object, containing the found edge.
2270 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
2271 in GEOM_Object thePoint);
2274 * \brief Returns a face, found in the given shape by four given corner vertices.
2275 * \param theShape Block or a compound of blocks.
2276 * \param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
2277 * \return New GEOM_Object, containing the found face.
2279 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
2280 in GEOM_Object thePoint1,
2281 in GEOM_Object thePoint2,
2282 in GEOM_Object thePoint3,
2283 in GEOM_Object thePoint4);
2286 * \brief Get a face of block, found in the given shape by two given edges.
2287 * \param theShape Block or a compound of blocks.
2288 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2289 * \return New GEOM_Object, containing the found face.
2291 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2292 in GEOM_Object theEdge1,
2293 in GEOM_Object theEdge2);
2296 * \brief Find a face, opposite to the given one in the given block.
2297 * \param theBlock Must be a hexahedral solid.
2298 * \param theFace Face of \a theBlock, opposite to the desired face.
2299 * \return New GEOM_Object, containing the found face.
2301 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2302 in GEOM_Object theFace);
2305 * \brief Find a face of the given shape, which has minimal distance to the given point.
2306 * \param theShape Block or a compound of blocks.
2307 * \param thePoint Point, close to the desired face.
2308 * \return New GEOM_Object, containing the found face.
2310 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2311 in GEOM_Object thePoint);
2314 * \brief Find a face of block, whose outside normale has minimal angle with the given vector.
2315 * \param theBlock Block or a compound of blocks.
2316 * \param theVector Vector, close to the normale of the desired face.
2317 * \return New GEOM_Object, containing the found face.
2319 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2320 in GEOM_Object theVector);
2323 * \brief Find all sub-shapes of type \a theShapeType of the given shape,
2324 * which have minimal distance to the given point.
2325 * \param theShape Any shape.
2326 * \param thePoint Point, close to the desired shape.
2327 * \param theShapeType Defines what kind of sub-shapes is searched.
2328 * \param theTolerance The tolerance for distances comparison. All shapes
2329 * with distances to the given point in interval
2330 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2331 * \return New GEOM_Object, containing a group of all found shapes.
2333 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2334 in GEOM_Object thePoint,
2335 in long theShapeType,
2336 in double theTolerance);
2338 // # Extract blocks from blocks compounds
2342 * \brief Check, if the compound contains only specified blocks.
2343 * \param theCompound The compound to check.
2344 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2345 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2346 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2347 * \param theNbBlocks Number of specified blocks in theCompound.
2348 * \return TRUE, if the given compound contains only blocks.
2350 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2351 in long theMinNbFaces,
2352 in long theMaxNbFaces,
2353 out long theNbBlocks);
2356 * \brief Enumeration of Blocks Compound defects.
2360 /* Each element of the compound should be a Block */
2363 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2366 /* A connection between two Blocks should be an entire face or an entire edge */
2369 /* The compound should be connexe */
2372 /* The glue between two quadrangle faces should be applied */
2377 * \brief Description of Blocks Compound defect: type and incriminated sub-shapes.
2382 ListOfLong incriminated;
2386 * \brief Sequence of all Blocks Compound defects.
2388 typedef sequence<BCError> BCErrors;
2391 * \brief Check, if the compound of blocks is given.
2393 * To be considered as a compound of blocks, the
2394 * given shape must satisfy the following conditions:
2395 * - Each element of the compound should be a Block (6 faces and 12 edges).
2396 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2397 * - The compound should be connexe.
2398 * - The glue between two quadrangle faces should be applied.
2399 * \note Single block is also accepted as a valid compound of blocks.
2400 * \param theCompound The compound to check.
2401 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
2402 * \return TRUE, if the given shape is a compound of blocks.
2404 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2405 out BCErrors theErrors);
2408 * \brief Convert sequence of Blocks Compound errors, returned by
2409 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2410 * \param theCompound The bad compound.
2411 * \param theErrors The sequence of \a theCompound errors.
2412 * \return String, describing all the errors in form, suitable for printing.
2414 string PrintBCErrors (in GEOM_Object theCompound,
2415 in BCErrors theErrors);
2418 * \brief Retrieve all non blocks solids and faces from a shape.
2420 * \param theShape The shape to explore.
2421 * \param theNonQuads Output parameter. Group of all non quadrangular faces.
2423 * \return Group of all non block solids (= not 6 faces, or with 6
2424 * faces, but with the presence of non-quadrangular faces).
2426 GEOM_Object GetNonBlocks (in GEOM_Object theShape, out GEOM_Object theNonQuads);
2429 * \brief Remove all seam and degenerated edges from \a theShape.
2431 * Unite faces and edges, sharing one surface.
2432 * \param theShape The compound or single solid to remove irregular edges from.
2433 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2434 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2435 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2436 * For blocks repairing recommended value is 6.
2437 * \return Improved shape.
2439 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2440 in long theOptimumNbFaces);
2443 * \brief Check, if the given shape is a blocks compound.
2445 * Fix all detected errors.
2446 * \note Single block can be also fixed by this method.
2447 * \param theCompound The compound to check and improve.
2448 * \return Improved compound.
2450 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2453 * \brief Get all the blocks, contained in the given compound.
2455 * \param theCompound The compound to explode.
2456 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2457 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2458 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2459 * \return List of GEOM_Object, containing the retrieved blocks.
2461 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2462 in long theMinNbFaces,
2463 in long theMaxNbFaces);
2466 * \brief Find block, containing the given point inside its volume or on boundary.
2467 * \param theCompound Compound, to find block in.
2468 * \param thePoint Point, close to the desired block. If the point lays on
2469 * boundary between some blocks, we return block with nearest center.
2470 * \return New GEOM_Object, containing the found block.
2472 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2473 in GEOM_Object thePoint);
2476 * \brief Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2477 * \param theCompound Compound, to find block in.
2478 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2479 * \return New GEOM_Object, containing the found block.
2481 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2482 in ListOfGO theParts);
2485 * \brief Return all blocks, containing all the elements, passed as the parts.
2486 * \param theCompound Compound, to find blocks in.
2487 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2488 * \return List of GEOM_Object, containing the found blocks.
2490 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2491 in ListOfGO theParts);
2493 // # Operations on blocks with gluing of result
2496 * \brief Multi-transformate block and glue the result.
2498 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2499 * \param theBlock Hexahedral solid to be multi-transformed.
2500 * \param theDirFace1 First direction face global index.
2501 * \param theDirFace2 Second direction face global index.
2502 * \param theNbTimes Quantity of transformations to be done.
2503 * \note Global index of sub-shape can be obtained, using method
2504 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2505 * \return New GEOM_Object, containing the result shape.
2507 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2508 in long theDirFace1,
2509 in long theDirFace2,
2510 in long theNbTimes);
2513 * \brief Multi-transformate block and glue the result.
2514 * \param theBlock Hexahedral solid to be multi-transformed.
2515 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2516 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2517 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2518 * \return New GEOM_Object, containing the result shape.
2520 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2521 in long theDirFace1U,
2522 in long theDirFace2U,
2523 in long theNbTimesU,
2524 in long theDirFace1V,
2525 in long theDirFace2V,
2526 in long theNbTimesV);
2528 // # Special operation - propagation
2532 * \brief Build all possible propagation groups.
2534 * Propagation group is a set of all edges, opposite to one (main)
2535 * edge of this group directly or through other opposite edges.
2536 * Notion of Opposite Edge make sence only on quadrangle face.
2537 * \param theShape Shape to build propagation groups on.
2538 * \return List of GEOM_Object, each of them is a propagation group.
2540 ListOfGO Propagate (in GEOM_Object theShape);
2543 // # GEOM_IBooleanOperations
2545 * \brief Interface for boolean operations (Cut, Fuse, Common)
2547 interface GEOM_IBooleanOperations : GEOM_IOperations
2550 * \brief Perform one of boolean operations on two given shapes.
2551 * \param theShape1 First argument for boolean operation.
2552 * \param theShape2 Second argument for boolean operation.
2553 * \param theOperation Indicates the operation to be done:
2554 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2555 * \return New GEOM_Object, containing the result shape.
2557 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2558 in GEOM_Object theShape2,
2559 in long theOperation);
2562 * \brief Perform partition operation.
2564 * \param theShapes Shapes to be intersected.
2565 * \param theTools Shapes to intersect theShapes.
2566 * \note Each compound from ListShapes and ListTools will be exploded in order
2567 * to avoid possible intersection between shapes from this compound.
2568 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2569 * \param theKeepNonlimitShapes: if this parameter == 0, then only shapes of
2570 * target type (equal to Limit) are kept in the result,
2571 * else standalone shapes of lower dimension
2572 * are kept also (if they exist).
2574 * After implementation new version of PartitionAlgo (October 2006)
2575 * other parameters are ignored by current functionality. They are kept
2576 * in this function only for supporting old versions.
2577 * Ignored parameters:
2578 * \param theKeepInside Shapes, outside which the results will be deleted.
2579 * Each shape from theKeepInside must belong to theShapes also.
2580 * \param theRemoveInside Shapes, inside which the results will be deleted.
2581 * Each shape from theRemoveInside must belong to theShapes also.
2582 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2583 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2585 * \return New GEOM_Object, containing the result shapes.
2587 GEOM_Object MakePartition (in ListOfGO theShapes,
2588 in ListOfGO theTools,
2589 in ListOfGO theKeepInside,
2590 in ListOfGO theRemoveInside,
2592 in boolean theRemoveWebs,
2593 in ListOfLong theMaterials,
2594 in short theKeepNonlimitShapes);
2597 * \brief Perform partition operation.
2599 * This method may be usefull if it is needed to make a partition for
2600 * a compound containing nonintersected shapes. Performance will be better
2601 * since intersection between shapes from compound is not performed.
2603 * Description of all parameters as in previous method MakePartition()
2605 * \note Passed compounds (via ListShapes or via ListTools)
2606 * have to consist of nonintersecting shapes.
2608 * \return New GEOM_Object, containing the result shapes.
2610 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2611 in ListOfGO theTools,
2612 in ListOfGO theKeepInside,
2613 in ListOfGO theRemoveInside,
2615 in boolean theRemoveWebs,
2616 in ListOfLong theMaterials,
2617 in short theKeepNonlimitShapes);
2620 * \brief Perform partition of the Shape with the Plane
2621 * \param theShape Shape to be intersected.
2622 * \param thePlane Tool shape, to intersect theShape.
2623 * \return New GEOM_Object, containing the result shape.
2625 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2626 in GEOM_Object thePlane);
2629 // # GEOM_ICurvesOperations:
2631 * \brief Interface for curves creation.
2633 * Polyline, Circle, Spline (Bezier and Interpolation)
2635 interface GEOM_ICurvesOperations : GEOM_IOperations
2638 * \brief Create a circle with given center, normal vector and radius.
2639 * \param thePnt Circle center.
2640 * \param theVec Vector, normal to the plane of the circle.
2641 * \param theR Circle radius.
2642 * \return New GEOM_Object, containing the created circle.
2644 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2645 in GEOM_Object theVec,
2648 * \brief Create a circle, passing through three given points
2649 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2650 * \return New GEOM_Object, containing the created circle.
2652 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2653 in GEOM_Object thePnt2,
2654 in GEOM_Object thePnt3);
2656 * \brief Create a circle with given center, with a radius equals the distance from center to Point1
2657 * and on a plane defined by all of three points.
2658 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2659 * \return New GEOM_Object, containing the created circle.
2661 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2662 in GEOM_Object thePnt2,
2663 in GEOM_Object thePnt3);
2665 * \brief Create an ellipse with given center, normal vector and radiuses.
2666 * \param thePnt Ellipse center.
2667 * \param theVec Vector, normal to the plane of the ellipse.
2668 * \param theRMajor Major ellipse radius.
2669 * \param theRMinor Minor ellipse radius.
2670 * \return New GEOM_Object, containing the created ellipse.
2672 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2673 in GEOM_Object theVec,
2674 in double theRMajor,
2675 in double theRMinor);
2678 * \brief Create an ellipse with given center, normal vector, main axis vector and radiuses.
2679 * \param thePnt Ellipse center.
2680 * \param theVec Vector, normal to the plane of the ellipse.
2681 * \param theRMajor Major ellipse radius.
2682 * \param theRMinor Minor ellipse radius.
2683 * \param theVecMaj Vector, direction of the ellipse's main axis.
2684 * \return New GEOM_Object, containing the created ellipse.
2686 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2687 in GEOM_Object theVec,
2688 in double theRMajor,
2689 in double theRMinor,
2690 in GEOM_Object theVecMaj);
2693 * \brief Create an arc of circle, passing through three given points.
2694 * \param thePnt1 Start point of the arc.
2695 * \param thePnt2 Middle point of the arc.
2696 * \param thePnt3 End point of the arc.
2697 * \return New GEOM_Object, containing the created arc.
2699 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2700 in GEOM_Object thePnt2,
2701 in GEOM_Object thePnt3);
2704 * \brief Create an arc of circle of center C from one point to another
2705 * \param theCenter Center point of the arc.
2706 * \param thePnt1 Start point of the arc.
2707 * \param thePnt2 End point of the arc.
2708 * \param theSense Orientation of the arc
2709 * \return New GEOM_Object, containing the created arc.
2711 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2712 in GEOM_Object thePnt1,
2713 in GEOM_Object thePnt2,
2714 in boolean theSense);
2717 * \brief Create an arc of ellipse of center C and two points P1 P2.
2718 * \param theCenter Center point of the arc.
2719 * \param thePnt1 Major radius is distance from center to Pnt1.
2720 * \param thePnt2 define a plane and Minor radius as a shortest
2721 * distance from Pnt2 to vector Center->Pnt1.
2722 * \return New GEOM_Object, containing the created arc.
2724 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2725 in GEOM_Object thePnt1,
2726 in GEOM_Object thePnt2);
2730 * \brief Create a polyline on the set of points.
2731 * \param thePoints Sequence of points for the polyline.
2732 * \param theIsClosed If TRUE, build a closed wire.
2733 * \return New GEOM_Object, containing the created polyline.
2735 GEOM_Object MakePolyline (in ListOfGO thePoints,
2736 in boolean theIsClosed);
2739 * \brief Create bezier curve on the set of points.
2740 * \param thePoints Sequence of points for the bezier curve.
2741 * \param theIsClosed If TRUE, build a closed curve.
2742 * \return New GEOM_Object, containing the created bezier curve.
2744 GEOM_Object MakeSplineBezier (in ListOfGO thePoints,
2745 in boolean theIsClosed);
2748 * \brief Create B-Spline curve on the set of points.
2749 * \param thePoints Sequence of points for the B-Spline curve.
2750 * \param theIsClosed If TRUE, build a closed curve.
2751 * \param theDoReordering If TRUE, the algo does not follow the order of
2752 * \a thePoints but searches for the closest vertex.
2753 * \return New GEOM_Object, containing the created B-Spline curve.
2755 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2756 in boolean theIsClosed,
2757 in boolean theDoReordering);
2760 * \brief Creates a curve using the parametric definition of the basic points.
2761 * \param thexExpr parametric equation of the coordinates X.
2762 * \param theyExpr parametric equation of the coordinates Y.
2763 * \param thezExpr parametric equation of the coordinates Z.
2764 * \param theParamMin the minimal value of the parameter.
2765 * \param theParamMax the maximum value of the parameter.
2766 * \param theParamStep the step of the parameter.
2767 * \param theCurveType the type of the curve.
2768 * \return New GEOM_Object, containing the created curve.
2770 GEOM_Object MakeCurveParametric(in string thexExpr,
2773 in double theParamMin,
2774 in double theParamMax,
2775 in double theParamStep,
2776 in curve_type theCurveType);
2779 * \brief Creates a curve using the parametric definition of the basic points.
2780 * \param thexExpr parametric equation of the coordinates X.
2781 * \param theyExpr parametric equation of the coordinates Y.
2782 * \param thezExpr parametric equation of the coordinates Z.
2783 * \param theParamMin the minimal value of the parameter.
2784 * \param theParamMax the maximum value of the parameter.
2785 * \param theParamNbStep the number of steps of the parameter discretization.
2786 * \param theCurveType the type of the curve.
2787 * \return New GEOM_Object, containing the created curve.
2789 GEOM_Object MakeCurveParametricNew(in string thexExpr,
2792 in double theParamMin,
2793 in double theParamMax,
2794 in long theParamNbStep,
2795 in curve_type theCurveType);
2798 * \brief Create a sketcher (wire or face), following the textual description,
2799 * passed through \a theCommand argument.
2801 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2802 * Format of the description string has to be the following:
2804 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2807 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2809 * - "R angle" : Set the direction by angle
2810 * - "D dx dy" : Set the direction by DX & DY
2813 * - "TT x y" : Create segment by point at X & Y
2814 * - "T dx dy" : Create segment by point with DX & DY
2815 * - "L length" : Create segment by direction & Length
2816 * - "IX x" : Create segment by direction & Intersect. X
2817 * - "IY y" : Create segment by direction & Intersect. Y
2820 * - "C radius length" : Create arc by direction, radius and length(in degree)
2823 * - "WW" : Close Wire (to finish)
2824 * - "WF" : Close Wire and build face (to finish)
2826 * \param theCommand String, defining the sketcher in local
2827 * coordinates of the working plane.
2828 * \param theWorkingPlane Nine double values, defining origin,
2829 * OZ and OX directions of the working plane.
2830 * \return New GEOM_Object, containing the created wire or face.
2832 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2835 * \brief Create a sketcher (wire or face), following the textual description,
2836 * passed through \a theCommand argument.
2838 * For format of the description string see the previous method.\n
2840 * \param theCommand String, defining the sketcher in local
2841 * coordinates of the working plane.
2842 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2843 * \return New GEOM_Object, containing the created wire or face.
2845 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2848 * \brief Create a 3D sketcher, following the textual description,
2849 * passed through \a theCommand argument.
2851 * Format of the description string has to be the following:
2853 * "3DSketcher:CMD[:CMD[:CMD...]]"
2855 * Where CMD is one of
2856 * - "TT x y z" : Create segment by point at X & Y or set the first point
2857 * - "T dx dy dz" : Create segment by point with DX & DY
2860 * - "OXY angleX angle2 length" : Create segment by two angles and length
2861 * - "OYZ angleY angle2 length" : Create segment by two angles and length
2862 * - "OXZ angleX angle2 length" : Create segment by two angles and length
2865 * - "WW" : Close Wire (to finish)
2867 * \param theCommand String, defining the sketcher in local
2868 * coordinates of the working plane.
2869 * \return New GEOM_Object, containing the created wire.
2871 GEOM_Object Make3DSketcherCommand (in string theCommand);
2874 * \brief Create a 3D sketcher, made of a straight segments, joining points
2875 * with coordinates passed through \a theCoordinates argument.
2877 * Order of coordinates has to be the following:
2878 * x1, y1, z1, x2, y2, z2, ..., xN, yN, zN
2880 * \param theCoordinates List of double values.
2881 * \return New GEOM_Object, containing the created wire.
2883 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2886 // # GEOM_ILocalOperations:
2888 * \brief Interface for fillet and chamfer creation.
2890 interface GEOM_ILocalOperations : GEOM_IOperations
2893 * \brief Perform a fillet on all edges of the given shape.
2894 * \param theShape Shape, to perform fillet on.
2895 * \param theR Fillet radius.
2896 * \return New GEOM_Object, containing the result shape.
2898 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2902 * \brief Perform a fillet on the specified edges of the given shape
2903 * \param theShape Shape, to perform fillet on.
2904 * \param theR Fillet radius.
2905 * \param theEdges Global indices of edges to perform fillet on.
2906 * \note Global index of sub-shape can be obtained, using method
2907 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2908 * \return New GEOM_Object, containing the result shape.
2910 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2912 in ListOfLong theEdges);
2913 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2916 in ListOfLong theEdges);
2919 * \brief Perform a fillet on all edges of the specified faces of the given shape.
2920 * \param theShape Shape, to perform fillet on.
2921 * \param theR Fillet radius.
2922 * \param theFaces Global indices of faces to perform fillet on.
2923 * \note Global index of sub-shape can be obtained, using method
2924 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2925 * \return New GEOM_Object, containing the result shape.
2927 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2929 in ListOfLong theFaces);
2931 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2934 in ListOfLong theFaces);
2937 * \brief Perform a fillet on a face or a shell at the specified vertexes.
2938 * \param theShape Shape, to perform fillet on.
2939 * \param theR Fillet radius.
2940 * \param theVertexes Global indices of vertexes to perform fillet on.
2941 * \note Global index of sub-shape can be obtained, using method
2942 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2943 * \return New GEOM_Object, containing the result shape.
2945 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2947 in ListOfLong theVertexes);
2950 * \brief Perform a fillet on edges of the specified vertexes of the given wire.
2951 * \param theShape Shape, to perform fillet on.
2952 * \param theR Fillet radius.
2953 * \param theVertexes Global indices of vertexes to perform fillet on.
2954 * \note Global index of sub-shape can be obtained, using method
2955 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2956 * \note The list of vertices coudl be empty, in this case fillet fill be done
2957 * at all vertices in given wire
2958 * \param doIgnoreSecantVertices If FALSE, fillet radius is always limited
2959 * by the length of the edges, nearest to the fillet vertex.
2960 * But sometimes the next edge is C1 continuous with the one, nearest to
2961 * the fillet point, and such two (or more) edges can be united to allow
2962 * bigger radius. Set this flag to TRUE to allow collinear edges union,
2963 * thus ignoring the secant vertex (vertices).
2964 * \return New GEOM_Object, containing the result shape.
2966 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2968 in ListOfLong theVertexes,
2969 in boolean doIgnoreSecantVertices);
2972 * \brief Perform a symmetric chamfer on all edges of the given shape.
2973 * \param theShape Shape, to perform chamfer on.
2974 * \param theD Chamfer size along each face.
2975 * \return New GEOM_Object, containing the result shape.
2977 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2981 * \brief Perform a chamfer on edges, common to the specified faces.
2982 * with distance D1 on the Face1
2983 * \param theShape Shape, to perform chamfer on.
2984 * \param theD1 Chamfer size along \a theFace1.
2985 * \param theD2 Chamfer size along \a theFace2.
2986 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2987 * \note Global index of sub-shape can be obtained, using method
2988 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2989 * \return New GEOM_Object, containing the result shape.
2991 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2992 in double theD1, in double theD2,
2993 in long theFace1, in long theFace2);
2995 * \brief The Same but with params theD = Chamfer Lenght
2996 * and theAngle = Chamfer Angle (Angle in radians)
2998 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2999 in double theD, in double theAngle,
3000 in long theFace1, in long theFace2);
3003 * \brief Perform a chamfer on all edges of the specified faces.
3004 * with distance D1 on the first specified face (if several for one edge)
3005 * \param theShape Shape, to perform chamfer on.
3006 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
3007 * connected to the edge, are in \a theFaces, \a theD1
3008 * will be get along face, which is nearer to \a theFaces beginning.
3009 * \param theD2 Chamfer size along another of two faces, connected to the edge.
3010 * \param theFaces Sequence of global indices of faces of \a theShape.
3011 * \note Global index of sub-shape can be obtained, using method
3012 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3013 * \return New GEOM_Object, containing the result shape.
3015 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
3016 in double theD1, in double theD2,
3017 in ListOfLong theFaces);
3019 * The Same but with params theD = Chamfer Lenght
3020 * and theAngle = Chamfer Angle (Angle in radians)
3022 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
3023 in double theD, in double theAngle,
3024 in ListOfLong theFaces);
3027 * \brief Perform a chamfer on edges,
3028 * with distance D1 on the first specified face (if several for one edge)
3029 * \param theShape Shape, to perform chamfer on.
3030 * \param theD1,theD2 Chamfer size
3031 * \param theEdges Sequence of edges of \a theShape.
3032 * \return New GEOM_Object, containing the result shape.
3034 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
3035 in double theD1, in double theD2,
3036 in ListOfLong theEdges);
3038 * The Same but with params theD = Chamfer Lenght
3039 * and theAngle = Chamfer Angle (Angle in radians)
3041 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
3042 in double theD, in double theAngle,
3043 in ListOfLong theEdges);
3046 * \brief Perform an Archimde operation on the given shape with given parameters.
3047 * The object presenting the resulting face is returned
3048 * \param theShape Shape to be put in water.
3049 * \param theWeight Weight og the shape.
3050 * \param theWaterDensity Density of the water.
3051 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
3052 * \return New GEOM_Object, containing a section of \a theShape
3053 * by a plane, corresponding to water level.
3055 GEOM_Object MakeArchimede (in GEOM_Object theShape,
3056 in double theWeight,
3057 in double theWaterDensity,
3058 in double theMeshDeflection);
3061 * \brief Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3063 * Present here only for compatibility.
3065 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
3068 // # GEOM_IHealingOperations:
3070 * \brief Interface for shape healing operations
3072 * Shape Processing, SuppressFaces, etc.
3074 interface GEOM_IHealingOperations : GEOM_IOperations
3077 * \brief Apply a sequence of Shape Healing operators to the given object.
3078 * \param theShapes Shape to be processed.
3079 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
3080 * \param theParameters List of names of parameters
3081 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
3082 * \param theValues List of values of parameters, in the same order
3083 * as parameters are listed in \a theParameters list.
3084 * \return New GEOM_Object, containing processed shape.
3086 GEOM_Object ProcessShape (in GEOM_Object theShapes,
3087 in string_array theOperators,
3088 in string_array theParameters,
3089 in string_array theValues);
3092 * \brief Get default sequence of operators, their parameters and parameters' values
3093 * of Shape Process operation.
3095 * In the current implementation the defaults are
3096 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3097 * \param theOperators Output. Default list of names of operators.
3098 * \param theParameters Output. Default list of names of parameters.
3099 * \param theValues Output. List of default values of parameters, in the same order
3100 * as parameters are listed in \a theParameters list.
3102 void GetShapeProcessParameters (out string_array theOperators,
3103 out string_array theParameters,
3104 out string_array theValues);
3106 * \brief Get parameters and parameters' values for the given Shape Process operation.
3108 * In the current implementation the defaults are
3109 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3110 * \param theOperator Input. The operator's name.
3111 * \param theParameters Output. Default list of names of parameters.
3112 * \param theValues Output. List of default values of parameters, in the same order
3113 * as parameters are listed in \a theParameters list.
3115 void GetOperatorParameters (in string theOperator,
3116 out string_array theParameters,
3117 out string_array theValues);
3120 * \brief Remove faces from the given object (shape).
3121 * \param theObject Shape to be processed.
3122 * \param theFaces Indices of faces to be removed, if EMPTY then the method
3123 * removes ALL faces of the given object.
3124 * \return New GEOM_Object, containing processed shape.
3126 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
3129 * \brief Close an open wire.
3130 * \param theObject Shape to be processed.
3131 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
3132 * if -1, then theObject itself is a wire.
3133 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
3134 * If FALS : closure by creation of an edge between ends.
3135 * \return New GEOM_Object, containing processed shape.
3137 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
3138 in boolean isCommonVertex);
3141 * \brief Remove internal wires and edges from the given object (face).
3142 * \param theObject Shape to be processed.
3143 * \param theWires Indices of wires to be removed, if EMPTY then the method
3144 * removes ALL internal wires of the given object.
3145 * \return New GEOM_Object, containing processed shape.
3147 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
3150 * \brief Remove internal closed contours (holes) from the given object.
3151 * \param theObject Shape to be processed.
3152 * \param theWires Indices of wires to be removed, if EMPTY then the method
3153 * removes ALL internal holes of the given object
3154 * \return New GEOM_Object, containing processed shape.
3156 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
3159 * Sewing of the given object.
3160 * \param theObject Shape to be processed.
3161 * \param theTolerance Required tolerance value.
3162 * \return New GEOM_Object, containing processed shape.
3164 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
3167 * \brief Addition of a point to a given edge object.
3168 * \param theObject Shape to be processed.
3169 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
3170 * if -1, then theObject itself is the edge.
3171 * \param theValue Value of parameter on edge or length parameter,
3172 * depending on \a isByParameter.
3173 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
3174 * if FALSE : \a theValue is treated as a length parameter [0..1]
3175 * \return New GEOM_Object, containing processed shape.
3177 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
3178 in double theValue, in boolean isByParameter);
3181 * \brief Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
3182 * \param theWire Wire to minimize the number of C1 continuous edges in.
3183 * \param theVertices A list of vertices to suppress. If the list
3184 * is empty, all vertices in a wire will be assumed.
3185 * \return New GEOM_Object with modified wire.
3187 GEOM_Object FuseCollinearEdgesWithinWire (in GEOM_Object theWire,
3188 in ListOfGO theVertices);
3191 * \brief Get a list of wires (wrapped in GEOM_Object-s),
3192 * that constitute a free boundary of the given shape.
3193 * \param theObject Shape to get free boundary of.
3194 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
3195 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
3196 * \return FALSE, if an error(s) occured during the method execution.
3198 boolean GetFreeBoundary (in GEOM_Object theObject,
3199 out ListOfGO theClosedWires,
3200 out ListOfGO theOpenWires);
3203 * \brief Change orientation of the given object.
3204 * \param theObject Shape to be processed.
3205 * \return New GEOM_Object, containing processed shape.
3207 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
3208 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
3211 * \brief Try to limit tolerance of the given object by value \a theTolerance.
3212 * \param theObject Shape to be processed.
3213 * \param theTolerance Required tolerance value.
3214 * \return New GEOM_Object, containing processed shape.
3216 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
3220 // # GEOM_IInsertOperations:
3222 * \brief Interface for shape insert operations (like copy, import).
3225 interface GEOM_IInsertOperations : GEOM_IOperations
3228 * \brief Create a copy of the given object
3230 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
3233 * \brief Export the given shape into a file with given name.
3234 * \param theObject Shape to be stored in the file.
3235 * \param theFileName Name of the file to store the given shape in.
3236 * \param theFormatName Specify format for the shape storage.
3237 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3239 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
3242 * \brief Import a shape from the BRep or IGES or STEP file
3243 * (depends on given format) with given name.
3244 * \param theFileName The file, containing the shape.
3245 * \param theFormatName Specify format for the file reading.
3246 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3247 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
3248 * set to 'meter' and result model will be scaled.
3249 * \return New GEOM_Object, containing the imported shape.
3251 GEOM_Object ImportFile (in string theFileName, in string theFormatName);
3254 * \brief Read a value of parameter from a file, containing a shape.
3255 * \param theFileName The file, containing the shape.
3256 * \param theFormatName Specify format for the file reading.
3257 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3258 * \param theParameterName Specify the parameter. For example, pass "LEN_UNITS"
3259 * to obtain length units, in which the file is written.
3260 * \return Value of requested parameter in form of text string.
3262 string ReadValue (in string theFileName, in string theFormatName, in string theParameterName);
3265 * \brief Get the supported import formats and corresponding patterns for File dialog.
3266 * \param theFormats Output. List of formats, available for import.
3267 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3268 * \return Returns available formats and patterns through the arguments.
3270 void ImportTranslators (out string_array theFormats,
3271 out string_array thePatterns);
3274 * \brief Get the supported export formats and corresponding patterns for File dialog.
3275 * \param theFormats Output. List of formats, available for export.
3276 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3277 * \return Returns available formats and patterns through the arguments.
3279 void ExportTranslators (out string_array theFormats,
3280 out string_array thePatterns);
3283 * \brief Read a shape from the binary stream, containing its bounding representation (BRep).
3284 * \note GEOM_Object::GetShapeStream() method can be used to obtain the shape's BRep stream.
3285 * \param theStream The BRep binary stream.
3286 * \return New GEOM_Object, containing the shape, read from theStream.
3288 GEOM_Object RestoreShape (in SALOMEDS::TMPFile theStream);
3291 * \brief Load texture from file
3292 * \param theTextureFile texture file name
3293 * \return unique texture identifier
3295 long LoadTexture(in string theTextureFile);
3298 * \brief Add texture to the study
3299 * \param theWidth texture width in pixels
3300 * \param theHeight texture height in pixels
3301 * \param theTexture texture byte array
3302 * \return unique texture identifier
3304 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
3307 * \brief Get previously loaded texture data
3308 * \param theID texture identifier
3309 * \param theWidth texture width in pixels
3310 * \param theHeight texture height in pixels
3311 * \return texture byte array
3313 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
3316 * \brief Get list of all avaiable texture IDs
3317 * \return list of all texture IDs avaiable for the current study
3319 ListOfLong GetAllTextures();
3322 // # GEOM_IKindOfShape:
3324 * \brief Interface for shape_kind enumeration.
3326 interface GEOM_IKindOfShape
3340 /*! box with faces, parallel to global coordinate planes */
3348 /*! solid, bounded by polygons */
3353 /*! spherical face (closed) */
3355 /*! cylindrical face with defined height */
3357 /*! toroidal face (closed) */
3359 /*! conical face with defined height */
3361 /*! planar, bounded by circle */
3363 /*! planar, bounded by ellipse */
3365 /*! planar, bounded by segments */
3367 /*! infinite planar */
3376 /*! arc of circle */
3380 /*! arc of ellipse */
3382 /*! infinite segment */
3391 /*! all advanced shapes (temporary implementation) */
3396 // # GEOM_IMeasureOperations:
3398 * \brief Interface for measurement (distance, whatis) and
3399 * properties calculation (like Centre of Mass, Inertia, etc.).
3402 interface GEOM_IMeasureOperations : GEOM_IOperations
3405 * \brief Get kind of theShape.
3406 * \param theShape Shape to get a kind of.
3407 * \param theIntegers Output. Integer and enumerated shape's parameters
3408 * (kind of surface, closed/unclosed, number of edges, etc.)
3409 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
3410 * \note Concrete meaning of each value, returned via \a theIntegers
3411 * or \a theDoubles list depends on the kind of the shape.
3412 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
3414 //short KindOfShape (in GEOM_Object theShape,
3415 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
3416 out ListOfLong theIntegers,
3417 out ListOfDouble theDoubles);
3420 * \brief Get position (LCS) of theShape.
3421 * \param theShape Shape to calculate position of.
3422 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
3423 * Origin of the LCS is situated at the shape's center of mass.
3424 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
3425 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
3426 * Axes of the LCS are obtained from shape's location or,
3427 * if the shape is a planar face, from position of its plane.
3428 * \return Returns position of the shape through the last nine arguments.
3430 void GetPosition (in GEOM_Object theShape,
3431 out double Ox, out double Oy, out double Oz,
3432 out double Zx, out double Zy, out double Zz,
3433 out double Xx, out double Xy, out double Xz);
3436 * \brief Get summarized length of all wires,
3437 * area of surface and volume of the given shape.
3438 * \param theShape Shape to define properties of.
3439 * \param theLength Output. Summarized length of all wires of the given shape.
3440 * \param theSurfArea Output. Area of surface of the given shape.
3441 * \param theVolume Output. Volume of the given shape.
3442 * \return Returns shape properties through the last three arguments.
3444 void GetBasicProperties (in GEOM_Object theShape,
3445 out double theLength,
3446 out double theSurfArea,
3447 out double theVolume);
3450 * \brief Get a point, situated at the centre of mass of theShape.
3451 * \param theShape Shape to define centre of mass of.
3452 * \return New GEOM_Object, containing the created point.
3454 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
3457 * Get the vertex by index for 1D objects depends the edge/wire orientation
3458 * \param theShape Shape (wire or edge) to find the vertex on it
3459 * \param theIndex Index of vertex sub-shape
3460 * \return New GEOM_Object, vertex.
3462 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
3465 * \brief Get a vector, representing the normal of theFace.
3466 * If the face is not planar, theOptionalPoint is obligatory.
3467 * \param theFace Shape (face) to define the normal of.
3468 * \param theOptionalPoint Shape (point) to define the normal at.
3469 * Can be NULL in case of planar face.
3470 * \return New GEOM_Object, containing the created normal vector.
3472 GEOM_Object GetNormal (in GEOM_Object theFace,
3473 in GEOM_Object theOptionalPoint);
3476 * \brief Get inertia matrix and moments of inertia of theShape.
3477 * \param theShape Shape to calculate inertia of.
3478 * \param I11,I12,I13,I21,I22,I23,I31,I32,I33 Output. Components of the inertia matrix of the given shape.
3479 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
3480 * \return Returns inertia through the last twelve arguments.
3482 void GetInertia (in GEOM_Object theShape,
3483 out double I11, out double I12, out double I13,
3484 out double I21, out double I22, out double I23,
3485 out double I31, out double I32, out double I33,
3486 out double Ix , out double Iy , out double Iz);
3489 * \brief Get parameters of bounding box of the given shape
3490 * \param theShape Shape to obtain bounding box of.
3491 * \param Xmin,Xmax Output. Limits of shape along OX axis.
3492 * \param Ymin,Ymax Output. Limits of shape along OY axis.
3493 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
3494 * \return Returns parameters of bounding box through the last six arguments.
3496 void GetBoundingBox (in GEOM_Object theShape,
3497 out double Xmin, out double Xmax,
3498 out double Ymin, out double Ymax,
3499 out double Zmin, out double Zmax);
3502 * \brief Get min and max tolerances of sub-shapes of theShape
3503 * \param theShape Shape, to get tolerances of.
3504 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3505 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
3506 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
3507 * \return Returns shape tolerances through the last six arguments.
3509 void GetTolerance (in GEOM_Object theShape,
3510 out double FaceMin, out double FaceMax,
3511 out double EdgeMin, out double EdgeMax,
3512 out double VertMin, out double VertMax);
3515 * \brief Check a topology of the given shape.
3516 * \param theShape Shape to check validity of.
3517 * \param theDescription Output. Description of problems in the shape, if they are.
3518 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
3520 boolean CheckShape (in GEOM_Object theShape,
3521 out string theDescription);
3524 * \brief Check a topology and a geometry of the given shape.
3525 * \param theShape Shape to check validity of.
3526 * \param theDescription Output. Description of problems in the shape, if they are.
3527 * \return TRUE, if the shape "seems to be valid".
3529 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
3530 out string theDescription);
3533 * \brief Check a topology of the given shape on self-intersections presence.
3534 * \param theShape Shape to check validity of.
3535 * \param theIntersections Output. List of intersected sub-shapes IDs, it contains pairs of IDs.
3536 * \return TRUE, if the shape does not have any self-intersections.
3538 boolean CheckSelfIntersections (in GEOM_Object theShape,
3539 out ListOfLong theIntersections);
3542 * \brief Check if the given shape can be an argument for MakeSolid operation
3543 * \param theShape Shape to be described.
3544 * \return Empty string if a solid can be made on this shape, error code otherwise.
3546 string IsGoodForSolid (in GEOM_Object theShape);
3549 * O\brief btain description of the given shape
3550 * \param theShape Shape to be described.
3551 * \return Description of the given shape.
3553 string WhatIs (in GEOM_Object theShape);
3556 * \brief Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on
3557 * the shape theShape.
3558 * \param theShape Shape to check.
3559 * \param coords list of coordinates.
3560 * \param tolerance tolerance.
3561 * \return list of boolean.
3563 ListOfBool AreCoordsInside(in GEOM_Object theShape, in ListOfDouble coords, in double tolerance);
3566 * \brief Get minimal distance between the given shapes.
3567 * \param theShape1,theShape2 Shapes to find minimal distance between.
3568 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
3569 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
3570 * \return Value of the minimal distance between the given shapes.
3572 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
3573 out double X1, out double Y1, out double Z1,
3574 out double X2, out double Y2, out double Z2);
3577 * \brief Get angle between the given lines or linear edges.
3578 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
3579 * \return Value of the angle between the given shapes.
3581 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
3584 * \brief Get angle between the given vectors.
3585 * \param theShape1,theShape2 Vectors to find angle between.
3586 * \return Value of the angle between the given vectors.
3588 double GetAngleBtwVectors (in GEOM_Object theShape1, in GEOM_Object theShape2);
3591 * \brief Get point coordinates
3593 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
3596 * \brief Get radius of curvature of curve in the point determinated by param
3597 * \param theShape - curve.
3598 * \param theParam - parameter on curve
3599 * \return Value of curvature.
3601 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3604 * \brief Get radius of curvature of curve in the given point
3605 * \param theShape - curve.
3606 * \param thePoint - point
3607 * \return Value of curvature.
3609 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3612 * \brief Get max radius of curvature of surface in the point determinated by params
3613 * \param theShape - surface.
3614 * \param theUParam - U-parameter on surface
3615 * \param theVParam - V-parameter on surface
3616 * \return Value of curvature.
3618 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3619 in double theVParam);
3622 * \brief Get max radius of curvature of surface in the given point
3623 * \param theShape - surface.
3624 * \param thePoint - point
3625 * \return Value of curvature.
3627 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3630 * \brief Get min radius of curvature of surface in the point determinated by params
3631 * \param theShape - surface.
3632 * \param theUParam - U-parameter on surface
3633 * \param theVParam - V-parameter on surface
3634 * \return Value of curvature.
3636 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3637 in double theVParam);
3640 * \brief Get min radius of curvature of surface in the given point
3641 * \param theShape - surface.
3642 * \param thePoint - point
3643 * \return Value of curvature.
3645 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3649 // # GEOM_IGroupOperations:
3651 * \brief Interface for groups creation.
3653 interface GEOM_IGroupOperations : GEOM_IOperations
3656 * \brief Creates a new group which will store sub-shapes of theMainShape
3657 * \param theMainShape is a GEOM_Object on which the group is selected
3658 * \param theShapeType defines a shape type of the group
3659 * \return a newly created GEOM group
3661 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3664 * \brief Adds a sub-object with ID theSubShapeId to the group
3665 * \param theGroup is a GEOM group to which the new sub-shape is added
3666 * \param theSubShapeId is a sub-shape ID in the main object.
3667 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
3669 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3672 * \brief Removes a sub-object with ID \a theSubShapeId from the group
3673 * \param theGroup is a GEOM group from which the sub-shape is removed.
3674 * \param theSubShapeId is a sub-shape ID in the main object.
3675 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
3677 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3680 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3681 * \param theGroup is a GEOM group to which the new sub-shapes are added.
3682 * \param theSubShapes is a list of sub-shapes to be added.
3684 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3687 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
3688 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3689 * \param theSubShapes is a list of sub-shapes to be removed.
3691 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3694 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3695 * \param theGroup is a GEOM group to which the new sub-shapes are added.
3696 * \param theSubShapes is a list of IDs of sub-shapes to be added.
3698 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3701 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
3702 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3703 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3705 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3708 * \brief Union of two groups.
3709 * New group is created. It will contain all entities
3710 * which are present in groups theGroup1 and theGroup2.
3711 * \param theGroup1, theGroup2 are the initial GEOM groups
3712 * to create the united group from.
3713 * \return a newly created GEOM group.
3715 GEOM_Object UnionGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
3718 * \brief Intersection of two groups.
3719 * New group is created. It will contain only those entities
3720 * which are present in both groups theGroup1 and theGroup2.
3721 * \param theGroup1, theGroup2 are the initial GEOM groups to get common part of.
3722 * \return a newly created GEOM group.
3724 GEOM_Object IntersectGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
3727 * \brief Cut of two groups.
3728 * New group is created. It will contain entities which are
3729 * present in group theGroup1 but are not present in group theGroup2.
3730 * \param theGroup1 is a GEOM group to include elements of.
3731 * \param theGroup2 is a GEOM group to exclude elements of.
3732 * \return a newly created GEOM group.
3734 GEOM_Object CutGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
3737 * \brief Union of list of groups.
3738 * New group is created. It will contain all entities that are
3739 * present in groups listed in theGList.
3740 * \param theGList is a list of GEOM groups to create the united group from.
3741 * \return a newly created GEOM group.
3743 GEOM_Object UnionListOfGroups (in ListOfGO theGList);
3746 * \brief Intersection of list of groups.
3747 * New group is created. It will contain only entities
3748 * which are simultaneously present in the groups listed in theGList.
3749 * \param theGList is a list of GEOM groups to get common part of.
3750 * \return a newly created GEOM group.
3752 GEOM_Object IntersectListOfGroups (in ListOfGO theGList);
3755 * \brief Cut of lists of groups.
3756 * New group is created. It will contain only entities
3757 * which are present in groups listed in theGList1 but
3758 * are not present in groups from theGList2.
3759 * \param theGList1 is a list of GEOM groups to include elements of.
3760 * \param theGList2 is a list of GEOM groups to exclude elements of.
3761 * \return a newly created GEOM group.
3763 GEOM_Object CutListOfGroups (in ListOfGO theGList1,
3764 in ListOfGO theGList2);
3767 * \brief Returns a type of sub-objects stored in the group
3768 * \param theGroup is a GEOM group which type is returned.
3770 long GetType (in GEOM_Object theGroup);
3773 * \brief Returns a main shape associated with the group
3774 * \param theGroup is a GEOM group for which a main shape object is requested
3775 * \return a GEOM_Object which is a main shape for theGroup
3777 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3780 * \brief Returns a list of sub-objects ID stored in the group
3781 * \param theGroup is a GEOM group for which a list of IDs is requested
3783 ListOfLong GetObjects (in GEOM_Object theGroup);
3786 // # GEOM_IAdvancedOperations:
3788 * \brief Interface for advanced modeling functions.
3790 interface GEOM_IAdvancedOperations : GEOM_IOperations
3793 * \brief Create a T-shape object with specified caracteristics for the main and
3794 * the incident pipes (radius, width, half-length).
3796 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3797 * \param theR1 Internal radius of main pipe
3798 * \param theW1 Width of main pipe
3799 * \param theL1 Half-length of main pipe
3800 * \param theR2 Internal radius of incident pipe (R2 < R1)
3801 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3802 * \param theL2 Half-length of incident pipe
3803 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3804 * \return List of GEOM_Object, containing the created shape and propagation groups.
3806 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
3807 in double theR2, in double theW2, in double theL2,
3808 in boolean theHexMesh);
3810 * \brief Create a T-shape object with specified caracteristics for the main and
3811 * the incident pipes (radius, width, half-length).
3813 * The extremities of the main pipe are located on junctions points P1 and P2.
3814 * The extremity of the incident pipe is located on junction point P3.
3815 * \param theR1 Internal radius of main pipe
3816 * \param theW1 Width of main pipe
3817 * \param theL1 Half-length of main pipe
3818 * \param theR2 Internal radius of incident pipe (R2 < R1)
3819 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3820 * \param theL2 Half-length of incident pipe
3821 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3822 * \param theP1 1st junction point of main pipe
3823 * \param theP2 2nd junction point of main pipe
3824 * \param theP3 Junction point of incident pipe
3825 * \return List of GEOM_Object, containing the created shape and propagation groups.
3827 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
3828 in double theR2, in double theW2, in double theL2,
3829 in boolean theHexMesh,
3830 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3832 * \brief Create a T-shape object with specified caracteristics for the main and
3833 * the incident pipes (radius, width, half-length). A chamfer is created
3834 * on the junction of the pipes.
3836 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3837 * \param theR1 Internal radius of main pipe
3838 * \param theW1 Width of main pipe
3839 * \param theL1 Half-length of main pipe
3840 * \param theR2 Internal radius of incident pipe (R2 < R1)
3841 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3842 * \param theL2 Half-length of incident pipe
3843 * \param theH Height of the chamfer.
3844 * \param theW Width of the chamfer.
3845 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3846 * \return List of GEOM_Object, containing the created shape and propagation groups.
3848 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
3849 in double theR2, in double theW2, in double theL2,
3850 in double theH, in double theW, in boolean theHexMesh);
3852 * \brief Create a T-shape object with specified caracteristics for the main and
3853 * the incident pipes (radius, width, half-length).
3855 * A chamfer is created on the junction of the pipes.
3856 * The extremities of the main pipe are located on junctions points P1 and P2.
3857 * The extremity of the incident pipe is located on junction point P3.
3858 * \param theR1 Internal radius of main pipe
3859 * \param theW1 Width of main pipe
3860 * \param theL1 Half-length of main pipe
3861 * \param theR2 Internal radius of incident pipe (R2 < R1)
3862 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3863 * \param theL2 Half-length of incident pipe
3864 * \param theH Height of the chamfer.
3865 * \param theW Width of the chamfer.
3866 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3867 * \param theP1 1st junction point of main pipe
3868 * \param theP2 2nd junction point of main pipe
3869 * \param theP3 Junction point of incident pipe
3870 * \return List of GEOM_Object, containing the created shape and propagation groups.
3872 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
3873 in double theR2, in double theW2, in double theL2,
3874 in double theH, in double theW, in boolean theHexMesh,
3875 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3877 * \brief Create a T-shape object with specified caracteristics for the main and
3878 * the incident pipes (radius, width, half-length).
3880 * A fillet is created on the junction of the pipes.
3881 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3882 * \param theR1 Internal radius of main pipe
3883 * \param theW1 Width of main pipe
3884 * \param theL1 Half-length of main pipe
3885 * \param theR2 Internal radius of incident pipe (R2 < R1)
3886 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3887 * \param theL2 Half-length of incident pipe
3888 * \param theRF Radius of curvature of fillet.
3889 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3890 * \return List of GEOM_Object, containing the created shape and propagation groups.
3892 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
3893 in double theR2, in double theW2, in double theL2,
3894 in double theRF, in boolean theHexMesh);
3896 * \brief Create a T-shape object with specified caracteristics for the main and
3897 * the incident pipes (radius, width, half-length).
3899 * A fillet is created on the junction of the pipes.
3900 * The extremities of the main pipe are located on junctions points P1 and P2.
3901 * The extremity of the incident pipe is located on junction point P3.
3902 * \param theR1 Internal radius of main pipe
3903 * \param theW1 Width of main pipe
3904 * \param theL1 Half-length of main pipe
3905 * \param theR2 Internal radius of incident pipe (R2 < R1)
3906 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3907 * \param theL2 Half-length of incident pipe
3908 * \param theRF Radius of curvature of fillet.
3909 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3910 * \param theP1 1st junction point of main pipe
3911 * \param theP2 2nd junction point of main pipe
3912 * \param theP3 Junction point of incident pipe
3913 * \return List of GEOM_Object, containing the created shape and propagation groups.
3915 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
3916 in double theR2, in double theW2, in double theL2,
3917 in double theRF, in boolean theHexMesh,
3918 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3920 * This function allows to create a disk already divided into blocks. It
3921 * can be use to create divided pipes for later meshing in hexaedra.
3922 * \param theR Radius of the disk
3923 * \param theRatio Relative size of the central square diagonal against the disk diameter
3924 * \param theOrientation Plane on which the disk will be built
3925 * \return New GEOM_Object, containing the created shape.
3927 GEOM_Object MakeDividedDisk (in double theR,
3929 in short theOrientation,
3930 in pattern thePattern);
3933 * \brief Create a Disk prepared for hexa meshing with given center, normal vector and radius.
3934 * \param thePnt disk center.
3935 * \param theVec Vector, normal to the plane of the disk.
3936 * \param theR Disk radius.
3937 * \param theRatio Relative size of the central square diagonal against the disk diameter
3938 * \return New GEOM_Object, containing the created disk.
3940 GEOM_Object MakeDividedDiskPntVecR ( in GEOM_Object thePnt,
3941 in GEOM_Object theVec,
3944 in pattern thePattern);
3947 * Builds a cylinder prepared for hexa meshes
3948 * \param theR Radius of the cylinder
3949 * \param theH Height of the cylinder
3950 * \return New GEOM_Object, containing the created shape.
3952 GEOM_Object MakeDividedCylinder (in double theR,
3954 in pattern thePattern );
3956 /*@@ insert new functions before this line @@ do not remove this line @@*/
3961 * \brief Interface to access other GEOM interfaces.
3963 * Also contains some methods to access and manage GEOM_Object.
3965 interface GEOM_Gen : Engines::EngineComponent,SALOMEDS::Driver
3968 * \brief Undo/Redo Management
3971 void Undo (in long theStudyID);
3973 void Redo (in long theStudyID);
3976 * \brief Publishing management
3978 * Adds in theStudy a object theObject under with a name theName,
3979 * if theFather is not NULL the object is placed under thFather's SObject.
3980 * Returns a SObject where theObject is placed
3982 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3983 in GEOM_Object theObject,
3985 in GEOM_Object theFather);
3988 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
3990 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3991 * \param theStudy the study, in which theObject is published already,
3992 * and in which the arguments will be published
3993 * \param theObject published GEOM_Object, arguments of which will be published
3994 * \param theArgs list of GEOM_Object, operation arguments to be published.
3995 * If this list is empty, all operation arguments will be published
3996 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
3997 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
3998 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3999 * Do not publish sub-shapes in place of arguments, but only
4000 * in place of sub-shapes of the first argument,
4001 * because the whole shape corresponds to the first argument.
4002 * Mainly to be used after transformations, but it also can be
4003 * usefull after partition with one object shape, and some other
4004 * operations, where only the first argument has to be considered.
4005 * If theObject has only one argument shape, this flag is automatically
4006 * considered as True, not regarding really passed value.
4007 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4008 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4009 * \return list of published sub-shapes
4011 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
4012 in GEOM_Object theObject,
4013 in ListOfGO theArgs,
4014 in find_shape_method theFindMethod,
4015 in boolean theInheritFirstArg,
4016 in boolean theAddPrefix);
4019 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4021 * To be used from python scripts out of geompy.addToStudy (non-default usage)
4022 * \param theStudy the study, in which theObject is published already,
4023 * and in which the arguments will be published
4024 * \param theObject published GEOM_Object, arguments of which will be published
4025 * \param theArgs list of GEOM_Object, operation arguments to be published.
4026 * If this list is empty, all operation arguments will be published
4027 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4028 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4029 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4030 * Do not publish sub-shapes in place of arguments, but only
4031 * in place of sub-shapes of the first argument,
4032 * because the whole shape corresponds to the first argument.
4033 * Mainly to be used after transformations, but it also can be
4034 * usefull after partition with one object shape, and some other
4035 * operations, where only the first argument has to be considered.
4036 * If theObject has only one argument shape, this flag is automatically
4037 * considered as True, not regarding really passed value.
4038 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4039 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4040 * \return list of published sub-shapes
4042 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
4043 in GEOM_Object theObject,
4044 in ListOfGO theArgs,
4045 in find_shape_method theFindMethod,
4046 in boolean theInheritFirstArg,
4047 in boolean theAddPrefix);
4050 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4052 * To be used from GUI and from geompy.addToStudy.
4053 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
4054 * \param theStudy the study, in which theObject is published already,
4055 * and in which the arguments will be published
4056 * \param theSObject study object, referencing GEOM_Object, arguments of which will be published
4057 * \param theArgs list of GEOM_Object, operation arguments to be published.
4058 * If this list is empty, all operation arguments will be published
4059 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4060 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4061 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4062 * Do not publish sub-shapes in place of arguments, but only
4063 * in place of sub-shapes of the first argument,
4064 * because the whole shape corresponds to the first argument.
4065 * Mainly to be used after transformations, but it also can be
4066 * usefull after partition with one object shape, and some other
4067 * operations, where only the first argument has to be considered.
4068 * If theObject has only one argument shape, this flag is automatically
4069 * considered as True, not regarding really passed value.
4070 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4071 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4073 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
4074 in SALOMEDS::SObject theSObject,
4075 in ListOfGO theArgs,
4076 in find_shape_method theFindMethod,
4077 in boolean theInheritFirstArg,
4078 in boolean theAddPrefix);
4080 // # Methods to access interfaces for objects creation and transformation
4082 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4083 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
4084 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4085 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4086 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4087 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4088 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4089 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4090 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4091 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4092 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4093 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4094 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4096 // # Objects Management
4100 * \brief Removes the object from the GEOM component
4101 * \param theObject is a GEOM_Object to be removed
4103 void RemoveObject (in GEOM_Object theObject);
4106 * \brief Returns an object defined by the study and its entry in the GEOM component
4107 * \param theStudyID is a SALOMEDS Study ID
4108 * \param theEntry is an entry of the requested GEOM_Object in the GEOM component
4109 * \note if the object has not previously been created a NULL GEOM_Object is returned
4111 GEOM_Object GetObject (in long theStudyID, in string theEntry);
4114 * \brief Add a sub-shape defined by indices in \a theIndices
4115 * (contains unique IDs of sub-shapes inside \a theMainShape)
4116 * \note The sub-shape GEOM_Object can has ONLY ONE function.
4117 * Don't try to apply modification operations on them.
4118 * \note Internal method
4120 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
4122 // # GEOM_Objects IOR Management
4125 * \brief Returns a GEOM_Object defined by its IOR
4126 * \param theIOR a string containg an IOR of the requested GEOM_Object
4128 GEOM_Object GetIORFromString (in string theIOR);
4131 * \brief Returns a string which contains an IOR of the GEOM_Object
4132 * \param theObject is a GEOM_Object which IOR is requested
4134 string GetStringFromIOR (in GEOM_Object theObject);
4137 * \brief Returns a name with which a GEOM_Object was dumped into python script
4138 * \param theStudyEntry is an entry of the GEOM_Object in the study
4140 string GetDumpName (in string theStudyEntry);
4143 * \brief Returns all names with which a GEOM_Object was dumped
4144 * into python script to avoid the same names in SMESH script
4146 string_array GetAllDumpNames();
4149 * \brief Publishes the named sub-shapes of given object in the study.
4150 * \param theStudy The study in which the object is published
4151 * \param theObject The object which named sub-shapes are published
4153 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
4154 //in SObject theSObject,
4155 in Object theObject);