1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : GEOM_Gen.idl
23 // Author : Sergey RUIN
28 #include "SALOME_Exception.idl"
29 #include "SALOME_Component.idl"
30 #include "SALOMEDS.idl"
31 #include "SALOMEDS_Attributes.idl"
33 #include "SALOME_GenericObj.idl"
38 * Topological types of shapes (like Open Cascade types)
40 enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
41 FACE, WIRE, EDGE, VERTEX, SHAPE };
46 enum marker_type { MT_NONE, MT_POINT, MT_PLUS, MT_STAR, MT_O, MT_X, MT_O_POINT, MT_O_PLUS,
47 MT_O_STAR, MT_O_X, MT_BALL, MT_RING1, MT_RING2, MT_RING3, MT_USER };
52 enum marker_size { MS_NONE, MS_10, MS_15, MS_20, MS_25, MS_30, MS_35,
53 MS_40, MS_45, MS_50, MS_55, MS_60, MS_65, MS_70 };
56 * State of shape relatively geometrical surface like plane, sphere or cylinder.
57 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
61 /*! Shape is on surface */
65 * Shape is in the direction defined by the normal and not on surface.
66 * For plane it means above the plane,
67 * For sphere and cylinder it means outside of volume, bounded by the surface.
72 * Shape is in the direction defined by the normal and on surface.
78 * Complementary to ONOUT.
79 * For plane it means below the plane,
80 * For sphere and cylinder it means inside the volume, bounded by the surface
81 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
86 * Complementary to OUT.
93 * Kind of method to find inside one main shape some subshapes,
94 * corresponding to other given shape (its argument)
95 * Is used in functions GEOM_Gen.RestoreSubShapes<xxx>()
97 enum find_shape_method
99 /*! Use GetInPlace functionality. Suits all cases, except transformations */
102 /*! To be used only for transformation result, to find subshapes of argument.
103 * Only this method can be used after transformation.
107 /*! To find only shared subshapes, not modified by the operation */
110 /*! Use GetShapesOnShape method (can work only on solids) */
111 FSM_GetShapesOnShape,
113 /*! Use GetInPlaceByHistory method (can work only after Partition) */
114 FSM_GetInPlaceByHistory,
116 /*! To be used only for multi-transformation result.
117 * Only this method can be used after multi-transformation.
123 * Kind of method to perform filling operation
124 * Is used in functions GEOM_Gen.MakeFilling<xxx>()
126 enum filling_oper_method
128 /*! Default (standard behaviour) */
131 /*! Use edges orientation */
134 /*! Auto-correct edges orientation */
139 typedef sequence<string> string_array;
140 typedef sequence<short> short_array;
141 typedef sequence<boolean> ListOfBool;
142 typedef sequence<long> ListOfLong;
143 typedef sequence<double> ListOfDouble;
145 interface GEOM_Object;
147 typedef sequence<GEOM_Object> ListOfGO;
150 * GEOM_Object: interface of geometric object
152 interface GEOM_Object : SALOME::GenericObj
156 * Get an entry of the object in GEOM component.
161 * Get ID of study, where the object is created.
166 * Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
171 * Get a <VAR>shape_type</VAR> of the object value.
173 shape_type GetShapeType();
176 * Get the topology type of the object value.
177 * In contrast to the shape type, this function returns type of the most
178 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
182 shape_type GetTopologyType();
185 * Get a minimal type of the top-level shapes contained in the object.
186 * This function is useful for the compounds only; for simple shapes it
187 * exactly the same value as GetShapeType().
188 * Note, that compounds are procesed recursively.
189 * \sa GetShapeType(), GetTopologyType(), GetMaxShapeType()
191 shape_type GetMinShapeType();
194 * Get a maximal type of the top-level shapes contained in the object.
195 * This function is useful for the compounds only; for simple shapes it
196 * exactly the same value as GetShapeType().
197 * Note, that compounds are procesed recursively.
198 * \sa GetShapeType(), GetTopologyType(), GetMinShapeType()
200 shape_type GetMaxShapeType();
203 * Set name of the object.
204 * \param theName is a name which will be associated with this object.
206 void SetName (in string theName);
209 * Get name of the object associated with this object.
214 * Set color of the object.
215 * \param theColor is a color of the object.
217 void SetColor(in SALOMEDS::Color theColor);
220 * Get color of the object.
222 SALOMEDS::Color GetColor();
225 * Toggle auto color mode on the object.
226 * \param theAtoColor is a flag which toggles auto color mode.
228 void SetAutoColor(in boolean theAutoColor);
231 * Get flag of object's auto color mode.
233 boolean GetAutoColor();
236 * Set standard point marker for the object
237 * \param theType standard marker type
238 * \param theSize marker relative size
240 void SetMarkerStd(in marker_type theType, in marker_size theSize );
243 * Set custom point marker for the object. The texture can be added
244 * by LoadTexture() or AddTexture() functions.
245 * \param theTextureId texture ID
247 void SetMarkerTexture(in long theTextureId);
250 * Get type of the point marker assigned to the object
251 * \return current marker type (MT_NONE if no marker is set)
253 marker_type GetMarkerType();
256 * Get size of the point marker assigned to the object
257 * \return current marker relative size (MS_NONE if no marker is set)
259 marker_size GetMarkerSize();
262 * Get texture idenifier of the point marker assigned to the object
263 * \return marker texture ID (0 if no marker set)
265 long GetMarkerTexture();
268 * Set a Study entry where this object was published.
270 void SetStudyEntry (in string theEntry);
273 * Get a Study entry where this object was published.
275 string GetStudyEntry();
278 * Get a list of all GEOM objects on which were the arguments
279 * when this object was constructed and modified.
280 * \note This method is supposed to be used by GUI only.
282 ListOfGO GetDependency();
285 * Get a list of GEOM objects on which the last function that created or modified the object depends.
286 * \note This method is supposed to be used by GUI only.
288 ListOfGO GetLastDependency();
291 * Get the TopoDS_Shape, for colocated case only.
293 long long getShape();
296 ######################################################################
297 * Internal methods (For sub shape identification)
298 ######################################################################
302 * Get geometric shape of the object as a byte stream
304 SALOMEDS::TMPFile GetShapeStream();
307 * Returns True if this object is not a sub shape of another object.
309 boolean IsMainShape();
312 * Get a list of ID's of sub shapes in the main shape.
313 * \note Internal method, suppopsed to be used only by GEOM_Client
315 ListOfLong GetSubShapeIndices();
318 * Get a main shape object to which this object is a sub shape
319 * \note Internal method, suppopsed to be used only by GEOM_Client
321 GEOM_Object GetMainShape();
324 * Return true if geom object representes a shape.
325 * For example, method return false for GEOM_MARKER
330 * Return true if passed object is identical to this object
331 * \param other object being compared with this one
333 boolean IsSame(in GEOM_Object other);
336 * Set list of parameters
337 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
338 * used for object creation
340 void SetParameters (in string theParameters);
343 * Return list of notebook variables used for object creation separated by ":" symbol
345 string GetParameters();
350 * GEOM_IOperations: basic methods of all geometric operations
352 interface GEOM_IOperations : SALOME::GenericObj
355 * To know, if the operation was successfully performed
360 * Set the operation error code
361 * \param theErrorID is a string describing the error occured
362 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
364 void SetErrorCode (in string theErrorID);
367 * Get the operation error code
369 string GetErrorCode();
372 * Get ID of study, where the operation is defined
377 * Opens a new transaction
379 void StartOperation();
382 * Closes the previously opened trasaction
384 void FinishOperation();
387 * Aborts the previously opened transaction
389 void AbortOperation();
393 * GEOM_IBasicOperations: interface for basic geometry creation
394 * (Point, Vector, Plane, Marker)
396 interface GEOM_IBasicOperations : GEOM_IOperations
399 * Create point by three coordinates.
400 * \param theX The X coordinate of the point.
401 * \param theY The Y coordinate of the point.
402 * \param theZ The Z coordinate of the point.
403 * \return New GEOM_Object, containing the created point.
405 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
408 * Create a point, distant from the referenced point
409 * on the given distances along the coordinate axes.
410 * \param theReference The referenced point.
411 * \param theX Displacement from the referenced point along OX axis.
412 * \param theY Displacement from the referenced point along OY axis.
413 * \param theZ Displacement from the referenced point along OZ axis.
414 * \return New GEOM_Object, containing the created point.
416 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
417 in double theX, in double theY, in double theZ);
420 * Create a point, corresponding to the given parameter on the given curve.
421 * \param theRefCurve The referenced curve.
422 * \param theParameter Value of parameter on the referenced curve.
423 * \return New GEOM_Object, containing the created point.
425 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
426 in double theParameter);
429 * Create a point, corresponding to the given length on the given curve.
430 * \param theRefCurve The referenced curve.
431 * \param theLength Length on the referenced curve.
432 * \param theReverse Direction for the calculation of the length (false = forward or true = reversed).
433 * \return New GEOM_Object, containing the created point.
435 GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve,
437 in boolean theReverse);
440 * Create a point on the given curve, projecting given point
441 * \param theRefCurve The referenced curve.
442 * \param theXParameter X co-ordinate of point to project on curve
443 * \param theYParameter Y co-ordinate of point to project on curve
444 * \param theZParameter Z co-ordinate of point to project on curve
445 * \return New GEOM_Object, containing the created point.
447 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
448 in double theXParameter,
449 in double theYarameter,
450 in double theZPameter);
453 * Create a point, corresponding to the given parameters on the
455 * \param theRefSurf The referenced surface.
456 * \param theUParameter Value of U-parameter on the referenced surface.
457 * \param theVParameter Value of V-parameter on the referenced surface.
458 * \return New GEOM_Object, containing the created point.
460 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
461 in double theUParameter,
462 in double theVParameter);
465 * Create a point on the given surface, projecting given point
466 * \param theRefSurf The referenced surface.
467 * \param theXParameter X co-ordinate of point to project on curve
468 * \param theYParameter Y co-ordinate of point to project on curve
469 * \param theZParameter Z co-ordinate of point to project on curve
470 * \return New GEOM_Object, containing the created point.
472 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
473 in double theXParameter,
474 in double theYarameter,
475 in double theZPameter);
479 * Create a point, on two lines intersection.
480 * \param theRefLine1, theRefLine2 The referenced lines.
481 * \return New GEOM_Object, containing the created point.
483 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
484 in GEOM_Object theRefLine2);
487 * Create a vector, corresponding to tangent to the given parameter on the given curve.
488 * \param theRefCurve The referenced curve.
489 * \param theParameter Value of parameter on the referenced curve.This value should be have value
490 * \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
491 * \last parameter of curve.
492 * \return New GEOM_Object, containing the created point.
494 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
495 in double theParameter);
498 * Create a vector with the given components.
499 * \param theDX X component of the vector.
500 * \param theDY Y component of the vector.
501 * \param theDZ Z component of the vector.
502 * \return New GEOM_Object, containing the created vector.
504 GEOM_Object MakeVectorDXDYDZ (in double theDX,
509 * Create a vector between two points.
510 * \param thePnt1 Start point for the vector.
511 * \param thePnt2 End point for the vector.
512 * \return New GEOM_Object, containing the created vector.
514 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
517 * Create a line, passing through the given point
518 * and parrallel to the given direction
519 * \param thePnt Point. The resulting line will pass through it.
520 * \param theDir Direction. The resulting line will be parallel to it.
521 * \return New GEOM_Object, containing the created line.
523 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
526 * Create a line, passing through the given points
527 * \param thePnt1 First of two points, defining the line.
528 * \param thePnt2 Second of two points, defining the line.
529 * \return New GEOM_Object, containing the created line.
531 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
534 * Create a line, given by two faces intersection.
535 * \param theFace1 First of two faces, defining the line.
536 * \param theFace2 Second of two faces, defining the line.
537 * \return New GEOM_Object, containing the created line.
539 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
542 * Create a plane, passing through the three given points
543 * \param thePnt1 First of three points, defining the plane.
544 * \param thePnt2 Second of three points, defining the plane.
545 * \param thePnt3 Fird of three points, defining the plane.
546 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
547 * \return New GEOM_Object, containing the created plane.
549 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
550 in GEOM_Object thePnt2,
551 in GEOM_Object thePnt3,
552 in double theTrimSize);
555 * Create a plane, passing through the given point
556 * and normal to the given vector.
557 * \param thePnt Point, the plane has to pass through.
558 * \param theVec Vector, defining the plane normal direction.
559 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
560 * \return New GEOM_Object, containing the created plane.
562 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
563 in GEOM_Object theVec,
564 in double theTrimSize);
567 * Create a plane, similar to the existing one, but with another size of representing face.
568 * \param theFace Referenced plane or LCS(Marker).
569 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
570 * \return New GEOM_Object, containing the created plane.
572 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
573 in double theTrimSize);
576 * Create a plane, by two vectors.
577 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
578 * \param theVec Vector2, defining the plane normal direction.
579 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
580 * \return New GEOM_Object, containing the created plane.
582 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
583 in GEOM_Object theVec2,
584 in double theTrimSize);
587 * Create a plane, defined by local coordinate system.
588 * \param theLCS Referenced LCS(Marker).
589 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
590 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
591 * \return New GEOM_Object, containing the created plane.
593 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
594 in double theTrimSize,
595 in double theOrientation);
598 * Create a local coordinate system.
599 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
600 * \param theXDX,theXDY,theXDZ Three components of OX direction
601 * \param theYDX,theYDY,theYDZ Three components of OY direction
602 * \return New GEOM_Object, containing the created coordinate system.
604 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
605 in double theXDX, in double theXDY, in double theXDZ,
606 in double theYDX, in double theYDY, in double theYDZ);
609 * Create a local coordinate system from shape.
610 * \param theShape The initial shape to detect the coordinate system.
611 * \return New GEOM_Object, containing the created coordinate system.
613 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
616 * Create a local coordinate system from point and two vectors (DX, DY).
617 * \param theOrigin Point of coordinate system origin.
618 * \param theXVec Vector of X direction.
619 * \param theYVec Vector of Y direction.
620 * \return New GEOM_Object, containing the created coordinate system.
622 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin,
623 in GEOM_Object theXVec, in GEOM_Object theYVec);
626 * Create a tangent plane to specified face in the point with specified parameters.
627 * Values of parameters should be between 0. and 1.0
628 * \param theFace - face for which tangent plane shuold be built.
629 * \param theParameterU - value of parameter by U
630 * \param theParameterV - value of parameter Vthe
631 * \param theTrimSize - defines sizes of created face
632 * \return New GEOM_Object, containing the face built on tangent plane.
634 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
635 in double theParameterU,
636 in double theParameterV,
637 in double theTrimSize);
640 interface GEOM_ITransformOperations : GEOM_IOperations
643 * Translate the given object along the vector, specified by its end points.
644 * \param theObject The object to be translated.
645 * \param thePoint1 Start point of translation vector.
646 * \param thePoint2 End point of translation vector.
649 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
650 in GEOM_Object thePoint1,
651 in GEOM_Object thePoint2);
654 * Translate the given object along the vector, specified
655 * by its end points, creating its copy before the translation.
656 * \param theObject The object to be translated.
657 * \param thePoint1 Start point of translation vector.
658 * \param thePoint2 End point of translation vector.
659 * \return New GEOM_Object, containing the translated object.
661 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
662 in GEOM_Object thePoint1,
663 in GEOM_Object thePoint2);
666 * Translate the given object along the vector, specified by its components.
667 * \param theObject The object to be translated.
668 * \param theDX,theDY,theDZ Components of translation vector.
671 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
672 in double theDX, in double theDY, in double theDZ);
675 * Translate the given object along the vector, specified
676 * by its components, creating its copy before the translation.
677 * \param theObject The object to be translated.
678 * \param theDX,theDY,theDZ Components of translation vector.
679 * \return New GEOM_Object, containing the translated object.
681 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
682 in double theDX, in double theDY, in double theDZ);
686 * Translate the given object along the given vector.
687 * \param theObject The object to be translated.
688 * \param theVector Translation vector, giving both direction and distance.
691 GEOM_Object TranslateVector (in GEOM_Object theObject,
692 in GEOM_Object theVector);
695 * Translate the given object along the given vector,
696 * creating its copy before the translation.
697 * \param theObject The object to be translated.
698 * \param theVector Translation vector, giving both direction and distance.
699 * \return New GEOM_Object, containing the translated object.
701 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
702 in GEOM_Object theVector);
705 * Translate the given object along the given vector on given distance,
706 * creating its copy before the translation.
707 * \param theObject The object to be translated.
708 * \param theVector Translation vector, giving a direction.
709 * \param theDistance Translation distance, giving a distance.
710 * \param theCope Translation copy, creating its copy if true.
711 * \return New GEOM_Object, containing the translated object.
713 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
714 in GEOM_Object theVector,
715 in double theDistance,
719 * Translate the given object along the given vector a given number times
720 * \param theObject The object to be translated.
721 * \param theVector Direction of the translation.
722 * \param theStep Distance to translate on.
723 * \param theNbTimes Quantity of translations to be done.
724 * \return New GEOM_Object, containing compound of all
725 * the shapes, obtained after each translation.
727 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
728 in GEOM_Object theVector,
733 * Conseqently apply two specified translations to theObject specified number of times.
734 * \param theObject The object to be translated.
735 * \param theVector1 Direction of the first translation.
736 * \param theStep1 Step of the first translation.
737 * \param theNbTimes1 Quantity of translations to be done along theVector1.
738 * \param theVector2 Direction of the second translation.
739 * \param theStep2 Step of the second translation.
740 * \param theNbTimes2 Quantity of translations to be done along theVector2.
741 * \return New GEOM_Object, containing compound of all
742 * the shapes, obtained after each translation.
744 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
745 in GEOM_Object theVector1,
748 in GEOM_Object theVector2,
750 in long theNbTimes2);
753 * Rotate given object around vector perpendicular to plane containing three points.
754 * \param theObject The object to be rotated.
755 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
756 * containing the three points.
757 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
760 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
761 in GEOM_Object theCentPoint,
762 in GEOM_Object thePoint1,
763 in GEOM_Object thePoint2);
767 * Rotate given object around vector perpendicular to plane containing three points.
768 * Creating its copy before the rotatation.
769 * \param theObject The object to be rotated.
770 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
771 * containing the three points.
772 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
773 * \return New GEOM_Object, containing the rotated object.
775 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
776 in GEOM_Object theCentPoint,
777 in GEOM_Object thePoint1,
778 in GEOM_Object thePoint2);
781 * Rotate the given object around the given axis on the given angle.
782 * \param theObject The object to be rotated.
783 * \param theAxis Rotation axis.
784 * \param theAngle Rotation angle in radians.
787 GEOM_Object Rotate (in GEOM_Object theObject,
788 in GEOM_Object theAxis,
793 * Rotate the given object around the given axis
794 * on the given angle, creating its copy before the rotatation.
795 * \param theObject The object to be rotated.
796 * \param theAxis Rotation axis.
797 * \param theAngle Rotation angle in radians.
798 * \return New GEOM_Object, containing the rotated object.
800 GEOM_Object RotateCopy (in GEOM_Object theObject,
801 in GEOM_Object theAxis,
806 * Rotate the given object around the given axis a given number times.
807 * Rotation angle will be 2*PI/theNbTimes.
808 * \param theObject The object to be rotated.
809 * \param theAxis The rotation axis.
810 * \param theNbTimes Quantity of rotations to be done.
811 * \return New GEOM_Object, containing compound of all the
812 * shapes, obtained after each rotation.
814 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
815 in GEOM_Object theAxis,
819 * Rotate the given object around the
820 * given axis on the given angle a given number
821 * times and multi-translate each rotation result.
822 * Translation direction passes through center of gravity
823 * of rotated shape and its projection on the rotation axis.
824 * \param theObject The object to be rotated.
825 * \param theAxis Rotation axis.
826 * \param theAngle Rotation angle in graduces.
827 * \param theNbTimes1 Quantity of rotations to be done.
828 * \param theStep Translation distance.
829 * \param theNbTimes2 Quantity of translations to be done.
830 * \return New GEOM_Object, containing compound of all the
831 * shapes, obtained after each transformation.
833 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
834 in GEOM_Object theAxis,
838 in long theNbTimes2);
841 * Replace the given object by an object,
842 * symmetrical to it relatively the given plane.
843 * \param theObject The object to be mirrored.
844 * \param thePlane Plane of symmetry.
846 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
849 * Create an object, symmetrical
850 * to the given one relatively the given plane.
851 * \param theObject The object to be mirrored.
852 * \param thePlane Plane of symmetry.
853 * \return New GEOM_Object, containing the mirrored shape.
855 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
858 * Replace the given object by an object,
859 * symmetrical to it relatively the given axis.
860 * \param theObject The object to be mirrored.
861 * \param theAxis Axis of symmetry.
864 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
867 * Create an object, symmetrical
868 * to the given one relatively the given axis.
869 * \param theObject The object to be mirrored.
870 * \param theAxis Axis of symmetry.
871 * \return New GEOM_Object, containing the mirrored object.
873 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
876 * Replace the given object by an object, symmetrical to it relatively the given point.
877 * \param theObject The object to be mirrored.
878 * \param thePoint Point of symmetry.
881 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
884 * Create an object, symmetrical to the given one relatively the given point.
885 * \param theObject The object to be mirrored.
886 * \param thePoint Point of symmetry.
887 * \return New GEOM_Object, containing the mirrored object.
889 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
892 * Replace the given object by its offset.
893 * \param theObject The base object for the offset.
894 * \param theOffset Offset value.
897 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
900 * Create new object as offset of the given one.
901 * \param theObject The base object for the offset.
902 * \param theOffset Offset value.
903 * \return New GEOM_Object, containing the offset object.
905 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
908 * Scale the given object by the factor.
909 * \param theObject The object to be scaled.
910 * \param thePoint Center point for scaling.
911 * \param theFactor Scaling factor value.
914 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
915 in double theFactor);
918 * Scale the given object by the factor, creating its copy before the scaling.
919 * \param theObject The object to be scaled.
920 * \param thePoint Center point for scaling.
921 * \param theFactor Scaling factor value.
922 * \return New GEOM_Object, containing the scaled shape.
924 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
925 in double theFactor);
928 * Scale the given object by different factors along coordinate axes.
929 * \param theObject The object to be scaled.
930 * \param thePoint Center point for scaling.
931 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
934 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
935 in GEOM_Object thePoint,
936 in double theFactorX,
937 in double theFactorY,
938 in double theFactorZ);
941 * Scale the given object by different factors along coordinate axes,
942 * creating its copy before the scaling.
943 * \param theObject The object to be scaled.
944 * \param thePoint Center point for scaling.
945 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
946 * \return New GEOM_Object, containing the scaled shape.
948 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
949 in GEOM_Object thePoint,
950 in double theFactorX,
951 in double theFactorY,
952 in double theFactorZ);
955 * Modify the Location of the given object by LCS.
956 * \param theObject The object to be displaced.
957 * \param theStartLCS Coordinate system to perform displacement from it.
958 * If \a theStartLCS is NULL, displacement
959 * will be performed from global CS.
960 * If \a theObject itself is used as \a theStartLCS,
961 * its location will be changed to \a theEndLCS.
962 * \param theEndLCS Coordinate system to perform displacement to it.
965 GEOM_Object PositionShape (in GEOM_Object theObject,
966 in GEOM_Object theStartLCS,
967 in GEOM_Object theEndLCS);
970 * Modify the Location of the given object by LCS,
971 * creating its copy before the setting.
972 * \param theObject The object to be displaced.
973 * \param theStartLCS Coordinate system to perform displacement from it.
974 * If \a theStartLCS is NULL, displacement
975 * will be performed from global CS.
976 * If \a theObject itself is used as \a theStartLCS,
977 * its location will be changed to \a theEndLCS.
978 * \param theEndLCS Coordinate system to perform displacement to it.
979 * \return New GEOM_Object, containing the displaced shape.
981 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
982 in GEOM_Object theStartLCS,
983 in GEOM_Object theEndLCS);
986 * Modify the Location of the given object by Path,
987 * \param theObject The object to be displaced.
988 * \param thePath Wire or Edge along that the object will be translated.
989 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
990 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
991 * \param theCopy is a true or false parameter. true is to reverse direction, false is to move normal direction.
992 * \return New GEOM_Object, containing the displaced shape.
994 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
995 in GEOM_Object thePath,
996 in double theDistance,
998 in boolean theReverse);
1001 * Transform the shape in the same way what was used for the sample shape creation.
1002 * \param theObject The object to be transformed.
1003 * \param theSample The object containing information about required transformation.
1004 * \note Implementation of this method is limited by multi-transformations now.
1005 * \note Internal method.
1006 * \return New GEOM_Object, containing the transformed shape.
1008 GEOM_Object TransformLikeOtherCopy (in GEOM_Object theObject,
1009 in GEOM_Object theSample);
1012 * Recompute the shape from its arguments.
1013 * \param theObject The object to be recomputed.
1014 * \return theObject.
1016 GEOM_Object RecomputeObject (in GEOM_Object theObject);
1020 * GEOM_I3DPrimOperations: Interface for 3D primitives creation
1021 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
1022 * Pipe (extrusion along contour), Revolution, Solid (from shell).
1024 interface GEOM_I3DPrimOperations : GEOM_IOperations
1027 * Create a box with specified dimensions along the coordinate axes
1028 * and with edges, parallel to the coordinate axes.
1029 * Center of the box will be at point (DX/2, DY/2, DZ/2).
1030 * \param theDX Length of Box edges, parallel to OX axis.
1031 * \param theDY Length of Box edges, parallel to OY axis.
1032 * \param theDZ Length of Box edges, parallel to OZ axis.
1033 * \return New GEOM_Object, containing the created box.
1035 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
1038 * Create a box with two specified opposite vertices,
1039 * and with edges, parallel to the coordinate axes
1040 * \param thePnt1 First of two opposite vertices.
1041 * \param thePnt2 Second of two opposite vertices.
1042 * \return New GEOM_Object, containing the created box.
1044 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1047 * Create a face specified dimensions along OX-OY coordinate axes,
1048 * with edges parallel to the coordinate axes.
1049 * Center of the face will be at point (0, 0, 0).
1050 * \param theH Height of the Face.
1051 * \param theW Width of the Face.
1052 * \param theOrientation Orientation belong axis OXY OYZ OZX
1053 * \return New GEOM_Object, containing the created face.
1055 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1057 * Create a face by normale vector or edge and two specified sizes,
1058 * vertical (H) and horisontal (W).
1059 * \param theVec defines plane.
1060 * \param theH vertical size (height).
1061 * \param theW horisontal size (width).
1062 * \return New GEOM_Object, containing the created face.
1064 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1066 * Create a Disk (circular face) with given center, normal vector and radius.
1067 * \param thePnt disk center.
1068 * \param theVec Vector, normal to the plane of the disk.
1069 * \param theR Disk radius.
1070 * \return New GEOM_Object, containing the created disk.
1072 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1073 in GEOM_Object theVec,
1076 * Create a disk (circular face), passing through three given points
1077 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1078 * \return New GEOM_Object, containing the created disk.
1080 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1081 in GEOM_Object thePnt2,
1082 in GEOM_Object thePnt3);
1085 * Create a disk specified dimensions along OX-OY coordinate axes,
1086 * Center of the disk at point (0, 0, 0).
1087 * \param theR of the Disk.
1088 * \param theOrientation Orientation belong axis OXY OYZ OZX
1089 * \return New GEOM_Object, containing the created disk.
1091 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1094 * Create a cylinder with given radius and height at
1095 * the origin of coordinate system. Axis of the cylinder
1096 * will be collinear to the OZ axis of the coordinate system.
1097 * \param theR Cylinder radius.
1098 * \param theH Cylinder height.
1099 * \return New GEOM_Object, containing the created cylinder.
1101 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1104 * Create a cylinder with given base point, axis, radius and height.
1105 * \param thePnt Central point of cylinder base.
1106 * \param theAxis Cylinder axis.
1107 * \param theR Cylinder radius.
1108 * \param theH Cylinder height.
1109 * \return New GEOM_Object, containing the created cylinder.
1111 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1112 in GEOM_Object theAxis,
1117 * Create a cone with given height and radiuses at
1118 * the origin of coordinate system. Axis of the cone will
1119 * be collinear to the OZ axis of the coordinate system.
1120 * \param theR1 Radius of the first cone base.
1121 * \param theR2 Radius of the second cone base.
1122 * \note If both radiuses are non-zero, the cone will be truncated.
1123 * \note If the radiuses are equal, a cylinder will be created instead.
1124 * \param theH Cone height.
1125 * \return New GEOM_Object, containing the created cone.
1127 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1130 * Create a cone with given base point, axis, height and radiuses.
1131 * \param thePnt Central point of the first cone base.
1132 * \param theAxis Cone axis.
1133 * \param theR1 Radius of the first cone base.
1134 * \param theR2 Radius of the second cone base.
1135 * \note If both radiuses are non-zero, the cone will be truncated.
1136 * \note If the radiuses are equal, a cylinder will be created instead.
1137 * \param theH Cone height.
1138 * \return New GEOM_Object, containing the created cone.
1140 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1141 in GEOM_Object theAxis,
1147 * Create a torus with given radiuses at the origin of coordinate system.
1148 * \param theRMajor Torus major radius.
1149 * \param theRMinor Torus minor radius.
1150 * \return New GEOM_Object, containing the created torus.
1152 GEOM_Object MakeTorusRR (in double theRMajor,
1153 in double theRMinor);
1156 * Create a torus with given center, normal vector and radiuses.
1157 * \param thePnt Torus central point.
1158 * \param theVec Torus axis of symmetry.
1159 * \param theRMajor Torus major radius.
1160 * \param theRMinor Torus minor radius.
1161 * \return New GEOM_Object, containing the created torus.
1163 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1164 in GEOM_Object theVec,
1165 in double theRMajor,
1166 in double theRMinor);
1169 * Create a sphere with given radius at the origin of coordinate system.
1170 * \param theR Sphere radius.
1171 * \return New GEOM_Object, containing the created sphere.
1173 GEOM_Object MakeSphereR (in double theR);
1176 * Create a sphere with given center and radius.
1177 * \param thePnt Sphere center.
1178 * \param theR Sphere radius.
1179 * \return New GEOM_Object, containing the created .
1181 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1184 * Create a shape by extrusion of the base shape along the vector,
1185 * i.e. all the space, transfixed by the base shape during its translation
1186 * along the vector on the given distance.
1187 * \param theBase Base shape to be extruded.
1188 * \param theVec Direction of extrusion.
1189 * \param theH Prism dimension along theVec.
1190 * \return New GEOM_Object, containing the created prism.
1192 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1193 in GEOM_Object theVec,
1195 /* The Same Prism but in 2 directions (forward&backward) */
1196 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1197 in GEOM_Object theVec,
1201 * Create a shape by extrusion of the base shape along a vector, defined by two points.
1202 * \param theBase Base shape to be extruded.
1203 * \param thePoint1 First end of extrusion vector.
1204 * \param thePoint2 Second end of extrusion vector.
1205 * \return New GEOM_Object, containing the created prism.
1207 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1208 in GEOM_Object thePoint1,
1209 in GEOM_Object thePoint2);
1210 /* The same prism but in two directions forward&backward */
1211 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1212 in GEOM_Object thePoint1,
1213 in GEOM_Object thePoint2);
1216 * Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1217 * \param theBase Base shape to be extruded.
1218 * \param DX, DY, DZ end of extrusion vector.
1219 * \return New GEOM_Object, containing the created prism.
1221 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1222 in double theDX, in double theDY, in double theDZ);
1223 /* The same prism but in two directions forward&backward */
1224 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1225 in double theDX, in double theDY, in double theDZ);
1228 * Create a shape by extrusion of the base shape along
1229 * the path shape. The path shape can be a wire or an edge.
1230 * \param theBase Base shape to be extruded.
1231 * \param thePath Path shape to extrude the base shape along it.
1232 * \return New GEOM_Object, containing the created pipe.
1234 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1237 * Create a shape by revolution of the base shape around the axis
1238 * on the given angle, i.e. all the space, transfixed by the base
1239 * shape during its rotation around the axis on the given angle.
1240 * \param theBase Base shape to be rotated.
1241 * \param theAxis Rotation axis.
1242 * \param theAngle Rotation angle in radians.
1243 * \return New GEOM_Object, containing the created revolution.
1245 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1246 in GEOM_Object theAxis,
1247 in double theAngle);
1248 /* The Same Revolution but in both ways forward&backward */
1249 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1250 in GEOM_Object theAxis,
1251 in double theAngle);
1254 * Create a filling from the given compound of contours.
1255 * \param theMinDeg a minimal degree of BSpline surface to create
1256 * \param theMaxDeg a maximal degree of BSpline surface to create
1257 * \param theTol2D a 2d tolerance to be reached
1258 * \param theTol3D a 3d tolerance to be reached
1259 * \param theNbIter a number of iteration of approximation algorithm
1260 * \param theMethod Kind of method to perform filling operation.
1261 * \return New GEOM_Object, containing the created filling surface.
1263 GEOM_Object MakeFilling (in GEOM_Object theShape,
1264 in long theMinDeg, in long theMaxDeg,
1265 in double theTol2D, in double theTol3D,
1267 in filling_oper_method theMethod,
1268 in boolean theApprox);
1271 * Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1272 * \param theSeqSections - set of specified sections.
1273 * \param theModeSolid - mode defining building solid or shell
1274 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1275 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1276 * \return New GEOM_Object, containing the created shell or solid.
1278 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1279 in boolean theModeSolid,
1281 in boolean theRuled);
1284 * Create a shape by extrusion of the profile shape along
1285 * the path shape. The path shape can be a wire or an edge.
1286 * the several profiles can be specified in the several locations of path.
1287 * \param theSeqBases - list of Bases shape to be extruded.
1288 * \param theLocations - list of locations on the path corresponding
1289 * specified list of the Bases shapes. Number of locations
1290 * should be equal to number of bases or list of locations can be empty.
1291 * \param thePath - Path shape to extrude the base shape along it.
1292 * \param theWithContact - the mode defining that the section is translated to be in
1293 * contact with the spine.
1294 * \param - WithCorrection - defining that the section is rotated to be
1295 * orthogonal to the spine tangent in the correspondent point
1296 * \return New GEOM_Object, containing the created pipe.
1298 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1299 in ListOfGO theLocations,
1300 in GEOM_Object thePath,
1301 in boolean theWithContact ,
1302 in boolean theWithCorrection );
1305 * Create a shape by extrusion of the profile shape along
1306 * the path shape. The path shape can be a shell or a face.
1307 * the several profiles can be specified in the several locations of path.
1308 * \param theSeqBases - list of Bases shape to be extruded.
1309 * \param theSeqSubBases - list of corresponding subshapes of section shapes.
1310 * \param theLocations - list of locations on the path corresponding
1311 * specified list of the Bases shapes. Number of locations
1312 * should be equal to number of bases.
1313 * \param thePath - Path shape to extrude the base shape along it.
1314 * \param theWithContact - the mode defining that the section is translated to be in
1315 * contact with the spine.
1316 * \param - WithCorrection - defining that the section is rotated to be
1317 * orthogonal to the spine tangent in the correspondent point
1318 * \return New GEOM_Object, containing the created pipe.
1320 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1321 in ListOfGO theSeqSubBases,
1322 in ListOfGO theLocations,
1323 in GEOM_Object thePath,
1324 in boolean theWithContact ,
1325 in boolean theWithCorrection );
1328 * Create solids between given sections
1329 * \param theSeqBases - list of sections (shell or face).
1330 * \param theLocations - list of corresponding vertexes
1331 * \return New GEOM_Object, containing the created solids.
1333 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1334 in ListOfGO theLocations);
1337 * Create a shape by extrusion of the base shape along
1338 * the path shape with constant bi-normal direction along the given vector.
1339 * The path shape can be a wire or an edge.
1340 * \param theBase Base shape to be extruded.
1341 * \param thePath Path shape to extrude the base shape along it.
1342 * \param theVec Vector defines a constant binormal direction to keep the
1343 * same angle beetween the Direction and the sections
1344 * along the sweep surface.
1345 * \return New GEOM_Object, containing the created pipe.
1347 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1348 in GEOM_Object thePath,
1349 in GEOM_Object theVec);
1354 * GEOM_IShapesOperations: Interface for Shapes creation:
1355 * Edge from two points, Wire from edges, Face from wire,
1356 * Shell from faces, Solid from shells, Compound from shapes
1358 interface GEOM_IShapesOperations : GEOM_IOperations
1361 * Create a linear edge with specified ends.
1362 * \param thePnt1 Point for the first end of edge.
1363 * \param thePnt2 Point for the second end of edge.
1364 * \return New GEOM_Object, containing the created edge.
1366 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1369 * Create an edge from specified wire.
1370 * \param theWire source Wire.
1371 * \param theLinearTolerance linear tolerance value
1372 * \param theAngularTolerance angular tolerance value
1373 * \return New GEOM_Object, containing the created edge.
1375 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1376 in double theLinearTolerance,
1377 in double theAngularTolerance);
1380 * Create a wire from the set of edges and wires.
1381 * \param theEdgesAndWires List of edge and/or wires.
1382 * \param theTolerance Maximum distance between vertices, that will be merged.
1383 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1384 * \return New GEOM_Object, containing the created wire.
1386 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1387 in double theTolerance);
1390 * Create a face on the given wire.
1391 * \param theWire closed Wire or Edge to build the face on.
1392 * \param isPlanarWanted If TRUE, only planar face will be built.
1393 * If impossible, NULL object will be returned.
1394 * \return New GEOM_Object, containing the created face.
1396 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1399 * Create a face on the given wires set.
1400 * \param theWires List of closed wires or edges to build the face on.
1401 * \param isPlanarWanted If TRUE, only planar face will be built.
1402 * If impossible, NULL object will be returned.
1403 * \return New GEOM_Object, containing the created face.
1405 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1408 * Create a shell from the set of faces and shells.
1409 * \param theFacesAndShells List of faces and/or shells.
1410 * \return New GEOM_Object, containing the created shell.
1412 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1415 * Create a solid, bounded by the given shell.
1416 * \param theShell Bounding shell.
1417 * \return New GEOM_Object, containing the created solid.
1419 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1422 * Create a solid, bounded by the given shells.
1423 * \param theShells Bounding shells.
1424 * \return New GEOM_Object, containing the created solid.
1426 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1429 * Create a compound of the given shapes.
1430 * \param theShapes List of shapes to put in compound.
1431 * \return New GEOM_Object, containing the created compound.
1433 GEOM_Object MakeCompound (in ListOfGO theShapes);
1436 * Replace coincident faces in theShape by one face.
1437 * \param theShape Initial shape.
1438 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1439 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1440 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1442 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1445 * Find coincident faces in theShape for possible gluing.
1446 * \param theShape Initial shape.
1447 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1450 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1453 * Replace coincident faces in theShape by one face
1454 * in compliance with given list of faces
1455 * \param theShape Initial shape.
1456 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1457 * \param theFaces List of faces for gluing.
1458 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1459 * \return New GEOM_Object, containing a copy of theShape without some faces.
1461 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1462 in ListOfGO theFaces, in boolean doKeepNonSolids);
1465 * Get all sub-shapes and groups of \a theShape,
1466 * that were created already by any other methods.
1467 * \param theShape Any shape.
1468 * \param theGroupsOnly If this parameter is TRUE, only groups will be
1469 * returned, else all found sub-shapes and groups.
1470 * \return List of existing sub-objects of \a theShape.
1472 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
1473 in boolean theGroupsOnly);
1476 * Deprecated method. Use MakeAllSubShapes() instead.
1478 ListOfGO MakeExplode (in GEOM_Object theShape,
1479 in long theShapeType,
1480 in boolean isSorted);
1483 * Explode a shape on subshapes of a given type. If the
1484 * shape itself has the given type, it is also returned.
1485 * \param theShape Shape to be exploded.
1486 * \param theShapeType Type of sub-shapes to be retrieved.
1487 * \param isSorted If this parameter is TRUE, sub-shapes will be
1488 * sorted by coordinates of their gravity centers.
1489 * \return List of sub-shapes of type theShapeType, contained in theShape.
1491 ListOfGO MakeAllSubShapes (in GEOM_Object theShape,
1492 in long theShapeType,
1493 in boolean isSorted);
1496 * Extract all subshapes of the given type from
1497 * the given shape, excluding the shape itself.
1498 * \param theShape Shape to be exploded.
1499 * \param theShapeType Type of sub-shapes to be retrieved.
1500 * \param isSorted If this parameter is TRUE, sub-shapes will be
1501 * sorted by coordinates of their gravity centers.
1502 * \return List of sub-shapes of type theShapeType, contained in theShape.
1504 ListOfGO ExtractSubShapes (in GEOM_Object theShape,
1505 in long theShapeType,
1506 in boolean isSorted);
1509 * Deprecated method. Use GetAllSubShapesIDs() instead.
1511 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1512 in long theShapeType,
1513 in boolean isSorted);
1516 * Explode a shape on subshapes of a given type.
1517 * Does the same, as MakeAllSubShapes, but returns IDs of
1518 * sub-shapes, not GEOM_Objects. It works faster.
1519 * \param theShape Shape to be exploded.
1520 * \param theShapeType Type of sub-shapes to be retrieved.
1521 * \param isSorted If this parameter is TRUE, sub-shapes will be
1522 * sorted by coordinates of their gravity centers.
1523 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1525 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
1526 in long theShapeType,
1527 in boolean isSorted);
1530 * Get a sub shape defined by its unique ID inside \a theMainShape
1531 * \note The sub shape GEOM_Objects can has ONLY ONE function.
1532 * Don't try to apply modification operations on them.
1534 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1538 * Get global index of \a theSubShape in \a theMainShape.
1539 * \param theMainShape Main shape.
1540 * \param theSubShape Sub-shape of the main shape.
1541 * \return global index of \a theSubShape in \a theMainShape.
1543 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1546 * Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1547 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1548 * to generate automatic names for sub-shapes, when publishing them in a study.
1549 * \param theMainShape Main shape.
1550 * \param theSubShape Sub-shape of the main shape.
1551 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1553 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1556 * \brief Get name of type of \a theShape.
1558 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1559 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1560 * to generate automatic names for sub-shapes, when publishing them in a study.
1561 * \param theShape The shape to get a type of.
1562 * \return String, containing a type name of \a theShape.
1564 string GetShapeTypeString (in GEOM_Object theShape);
1567 * Count number of faces in the given shape.
1568 * \param theShape Shape to count faces in.
1569 * \return Number of faces in the given shape.
1571 long NumberOfFaces (in GEOM_Object theShape);
1574 * Count number of edges in the given shape.
1575 * \param theShape Shape to count edges in.
1576 * \return Number of edges in theShape.
1578 long NumberOfEdges (in GEOM_Object theShape);
1581 * Count number of subshapes of type \a theShapeType in the given shape.
1582 * \param theShape Shape to count subshapes in.
1583 * \param theShapeType The type of subshapes to count.
1584 * \return Number of subshapes of type \a theShapeType in \a theShape.
1586 long NumberOfSubShapes (in GEOM_Object theShape,
1587 in long theShapeType);
1590 * Reverses an orientation the given shape.
1591 * \param theShape Shape to be reversed.
1592 * \return The reversed copy of theShape.
1594 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1597 * Retrieve all free faces from the given shape.
1598 * Free face is a face, which is not shared between two shells of the shape.
1599 * \param theShape Shape to find free faces in.
1600 * \return List of IDs of all free faces, contained in theShape.
1602 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1605 * Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1606 * \param theShape1 Shape to find sub-shapes in.
1607 * \param theShape2 Shape to find shared sub-shapes with.
1608 * \param theShapeType Type of sub-shapes to be retrieved.
1609 * \return List of sub-shapes of theShape1, shared with theShape2.
1611 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1612 in GEOM_Object theShape2,
1613 in long theShapeType);
1616 * Get all sub-shapes, shared by all shapes in the list \a theShapes.
1617 * \param theShapes Shapes to find common sub-shapes of.
1618 * \param theShapeType Type of sub-shapes to be retrieved.
1619 * \return List of objects, that are sub-shapes of all given shapes.
1621 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
1622 in long theShapeType);
1625 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1626 * the specified plane by the certain way, defined through \a theState parameter.
1627 * \param theShape Shape to find sub-shapes of.
1628 * \param theShapeType Type of sub-shapes to be retrieved.
1629 * \param theAx1 Vector (or line, or linear edge), specifying normal
1630 * direction and location of the plane to find shapes on.
1631 * \param theState The state of the subshapes to find.
1632 * \return List of all found sub-shapes.
1634 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1635 in long theShapeType,
1636 in GEOM_Object theAx1,
1637 in shape_state theState);
1639 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1640 * the specified plane by the certain way, defined through \a theState parameter.
1641 * \param theShape Shape to find sub-shapes of.
1642 * \param theShapeType Type of sub-shapes to be retrieved.
1643 * \param theAx1 Vector (or line, or linear edge), specifying normal
1644 * direction of the plane to find shapes on.
1645 * \param thePnt Point specifying location of the plane to find shapes on.
1646 * \param theState The state of the subshapes to find.
1647 * \return List of all found sub-shapes.
1649 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1650 in long theShapeType,
1651 in GEOM_Object theAx1,
1652 in GEOM_Object thePnt,
1653 in shape_state theState);
1658 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1659 * the specified cylinder by the certain way, defined through \a theState parameter.
1660 * \param theShape Shape to find sub-shapes of.
1661 * \param theShapeType Type of sub-shapes to be retrieved.
1662 * \param theAxis Vector (or line, or linear edge), specifying
1663 * axis of the cylinder to find shapes on.
1664 * \param theRadius Radius of the cylinder to find shapes on.
1665 * \param theState The state of the subshapes to find.
1666 * \return List of all found sub-shapes.
1668 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1669 in long theShapeType,
1670 in GEOM_Object theAxis,
1671 in double theRadius,
1672 in shape_state theState);
1675 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1676 * the specified cylinder by the certain way, defined through \a theState parameter.
1677 * \param theShape Shape to find sub-shapes of.
1678 * \param theShapeType Type of sub-shapes to be retrieved.
1679 * \param theAxis Vector (or line, or linear edge), specifying
1680 * axis of the cylinder to find shapes on.
1681 * \param thePnt Point specifying location of the bottom of the cylinder.
1682 * \param theRadius Radius of the cylinder to find shapes on.
1683 * \param theState The state of the subshapes to find.
1684 * \return List of all found sub-shapes.
1686 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1687 in long theShapeType,
1688 in GEOM_Object theAxis,
1689 in GEOM_Object thePnt,
1690 in double theRadius,
1691 in shape_state theState);
1694 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1695 * the specified sphere by the certain way, defined through \a theState parameter.
1696 * \param theShape Shape to find sub-shapes of.
1697 * \param theShapeType Type of sub-shapes to be retrieved.
1698 * \param theCenter Point, specifying center of the sphere to find shapes on.
1699 * \param theRadius Radius of the sphere to find shapes on.
1700 * \param theState The state of the subshapes to find.
1701 * \return List of all found sub-shapes.
1703 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1704 in long theShapeType,
1705 in GEOM_Object theCenter,
1706 in double theRadius,
1707 in shape_state theState);
1710 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1711 * the specified quadrangle by the certain way, defined through \a theState parameter.
1712 * \param theShape Shape to find sub-shapes of.
1713 * \param theShapeType Type of sub-shapes to be retrieved.
1714 * \param theTopLeftPoint Top left quadrangle corner
1715 * \param theTopRigthPoint Top right quadrangle corner
1716 * \param theBottomLeftPoint Bottom left quadrangle corner
1717 * \param theBottomRigthPoint Bottom right quadrangle corner
1718 * \param theState The state of the subshapes to find.
1719 * \return List of all found sub-shapes.
1721 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1722 in long theShapeType,
1723 in GEOM_Object theTopLeftPoint,
1724 in GEOM_Object theTopRigthPoint,
1725 in GEOM_Object theBottomLeftPoint,
1726 in GEOM_Object theBottomRigthPoint,
1727 in shape_state theState);
1730 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1731 * the specified plane by the certain way, defined through \a theState parameter.
1732 * \param theShape Shape to find sub-shapes of.
1733 * \param theShapeType Type of sub-shapes to be retrieved.
1734 * \param theAx1 Vector (or line, or linear edge), specifying normal
1735 * direction and location of the plane to find shapes on.
1736 * \param theState The state of the subshapes to find.
1737 * \return List of IDs of all found sub-shapes.
1739 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1740 in long theShapeType,
1741 in GEOM_Object theAx1,
1742 in shape_state theState);
1745 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1746 * the specified plane by the certain way, defined through \a theState parameter.
1747 * \param theShape Shape to find sub-shapes of.
1748 * \param theShapeType Type of sub-shapes to be retrieved.
1749 * \param theAx1 Vector (or line, or linear edge), specifying normal
1750 * direction of the plane to find shapes on.
1751 * \param thePnt Point specifying location of the plane to find shapes on.
1752 * \param theState The state of the subshapes to find.
1753 * \return List of IDs of all found sub-shapes.
1755 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1756 in long theShapeType,
1757 in GEOM_Object theAx1,
1758 in GEOM_Object thePnt,
1759 in shape_state theState);
1762 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1763 * the specified cylinder by the certain way, defined through \a theState parameter.
1764 * \param theShape Shape to find sub-shapes of.
1765 * \param theShapeType Type of sub-shapes to be retrieved.
1766 * \param theAxis Vector (or line, or linear edge), specifying
1767 * axis of the cylinder to find shapes on.
1768 * \param theRadius Radius of the cylinder to find shapes on.
1769 * \param theState The state of the subshapes to find.
1770 * \return List of IDs of all found sub-shapes.
1772 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1773 in long theShapeType,
1774 in GEOM_Object theAxis,
1775 in double theRadius,
1776 in shape_state theState);
1779 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1780 * the specified cylinder by the certain way, defined through \a theState parameter.
1781 * \param theShape Shape to find sub-shapes of.
1782 * \param theShapeType Type of sub-shapes to be retrieved.
1783 * \param theAxis Vector (or line, or linear edge), specifying
1784 * axis of the cylinder to find shapes on.
1785 * \param thePnt Point specifying location of the bottom of the cylinder.
1786 * \param theRadius Radius of the cylinder to find shapes on.
1787 * \param theState The state of the subshapes to find.
1788 * \return List of IDs all found sub-shapes.
1790 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1791 in long theShapeType,
1792 in GEOM_Object theAxis,
1793 in GEOM_Object thePnt,
1794 in double theRadius,
1795 in shape_state theState);
1798 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1799 * the specified sphere by the certain way, defined through \a theState parameter.
1800 * \param theShape Shape to find sub-shapes of.
1801 * \param theShapeType Type of sub-shapes to be retrieved.
1802 * \param theCenter Point, specifying center of the sphere to find shapes on.
1803 * \param theRadius Radius of the sphere to find shapes on.
1804 * \param theState The state of the subshapes to find.
1805 * \return List of IDs of all found sub-shapes.
1807 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1808 in long theShapeType,
1809 in GEOM_Object theCenter,
1810 in double theRadius,
1811 in shape_state theState);
1814 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1815 * the specified quadrangle by the certain way, defined through \a theState parameter.
1816 * \param theShape Shape to find sub-shapes of.
1817 * \param theShapeType Type of sub-shapes to be retrieved.
1818 * \param theTopLeftPoint Top left quadrangle corner
1819 * \param theTopRigthPoint Top right quadrangle corner
1820 * \param theBottomLeftPoint Bottom left quadrangle corner
1821 * \param theBottomRigthPoint Bottom right quadrangle corner
1822 * \param theState The state of the subshapes to find.
1823 * \return List of IDs of all found sub-shapes.
1825 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1826 in long theShapeType,
1827 in GEOM_Object theTopLeftPoint,
1828 in GEOM_Object theTopRigthPoint,
1829 in GEOM_Object theBottomLeftPoint,
1830 in GEOM_Object theBottomRigthPoint,
1831 in shape_state theState);
1834 * \brief Find subshapes complying with given status
1835 * \param theBox - the box to check state of subshapes against
1836 * \param theShape - the shape to explore
1837 * \param theShapeType - type of subshape of theShape
1838 * \param theState - required state
1839 * \return List of IDs of all found sub-shapes.
1841 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1842 in GEOM_Object theShape,
1843 in long theShapeType,
1844 in shape_state theState);
1847 * \brief Find subshapes complying with given status
1848 * \param theBox - the box to check state of subshapes against
1849 * \param theShape - the shape to explore
1850 * \param theShapeType - type of subshape of theShape
1851 * \param theState - required state
1852 * \return List of all found sub-shapes.
1854 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1855 in GEOM_Object theShape,
1856 in long theShapeType,
1857 in shape_state theState);
1860 * \brief Find subshapes complying with given status
1861 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1862 * \param theShape - the shape to explore
1863 * \param theShapeType - type of subshape of theShape
1864 * \param theState - required state
1865 * \return List of IDs of all found sub-shapes.
1867 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
1868 in GEOM_Object theShape,
1869 in short theShapeType,
1870 in shape_state theState);
1873 * \brief Find subshapes complying with given status
1874 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1875 * \param theShape - the shape to explore
1876 * \param theShapeType - type of subshape of theShape
1877 * \param theState - required state
1878 * \return List of all found sub-shapes.
1880 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
1881 in GEOM_Object theShape,
1882 in short theShapeType,
1883 in shape_state theState);
1886 * \brief Find subshapes complying with given status
1887 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1888 * \param theShape - the shape to explore
1889 * \param theShapeType - type of subshape of theShape
1890 * \param theState - required state
1891 * \return compound includes all found sub-shapes.
1893 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
1894 in GEOM_Object theShape,
1895 in short theShapeType,
1896 in shape_state theState);
1899 * Get sub-shape(s) of \a theShapeWhere, which are
1900 * coincident with \a theShapeWhat or could be a part of it.
1901 * \param theShapeWhere Shape to find sub-shapes of.
1902 * \param theShapeWhat Shape, specifying what to find.
1903 * \return Group of all found sub-shapes or a single found sub-shape.
1905 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1906 in GEOM_Object theShapeWhat);
1909 * Get sub-shape(s) of \a theShapeWhere, which are
1910 * coincident with \a theShapeWhat or could be a part of it.
1912 * Implementation of this method is based on a saved history of an operation,
1913 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1914 * arguments (an argument shape or a sub-shape of an argument shape).
1915 * The operation could be the Partition or one of boolean operations,
1916 * performed on simple shapes (not on compounds).
1918 * \param theShapeWhere Shape to find sub-shapes of.
1919 * \param theShapeWhat Shape, specifying what to find.
1920 * \return Group of all found sub-shapes or a single found sub-shape.
1922 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
1923 in GEOM_Object theShapeWhat);
1926 * Get sub-shape of theShapeWhere, which are
1927 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1928 * \param theShapeWhere Shape to find sub-shapes of.
1929 * \param theShapeWhat Shape, specifying what to find.
1930 * \return found sub-shape.
1932 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1933 in GEOM_Object theShapeWhat);
1937 * GEOM_IBlocksOperations: Interface for Blocks construction
1938 * Face from points or edges, Block from faces,
1939 * Blocks multi-translation and multi-rotation
1941 interface GEOM_IBlocksOperations : GEOM_IOperations
1944 * Creation of blocks
1948 * Create a quadrangle face from four edges. Order of Edges is not
1949 * important. It is not necessary that edges share the same vertex.
1950 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1951 * \return New GEOM_Object, containing the created face.
1953 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1954 in GEOM_Object theEdge2,
1955 in GEOM_Object theEdge3,
1956 in GEOM_Object theEdge4);
1959 * Create a quadrangle face on two edges.
1960 * The missing edges will be built by creating the shortest ones.
1961 * \param theEdge1,theEdge2 Two opposite edges for the face.
1962 * \return New GEOM_Object, containing the created face.
1964 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1965 in GEOM_Object theEdge2);
1968 * Create a quadrangle face with specified corners.
1969 * The missing edges will be built by creating the shortest ones.
1970 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1971 * \return New GEOM_Object, containing the created face.
1973 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1974 in GEOM_Object thePnt2,
1975 in GEOM_Object thePnt3,
1976 in GEOM_Object thePnt4);
1979 * Create a hexahedral solid, bounded by the six given faces. Order of
1980 * faces is not important. It is not necessary that Faces share the same edge.
1981 * \param theFace1-theFace6 Faces for the hexahedral solid.
1982 * \return New GEOM_Object, containing the created solid.
1984 GEOM_Object MakeHexa (in GEOM_Object theFace1,
1985 in GEOM_Object theFace2,
1986 in GEOM_Object theFace3,
1987 in GEOM_Object theFace4,
1988 in GEOM_Object theFace5,
1989 in GEOM_Object theFace6);
1992 * Create a hexahedral solid between two given faces.
1993 * The missing faces will be built by creating the smallest ones.
1994 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1995 * \return New GEOM_Object, containing the created solid.
1997 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1998 in GEOM_Object theFace2);
2001 * Extract elements of blocks and blocks compounds
2005 * Get a vertex, found in the given shape by its coordinates.
2006 * \param theShape Block or a compound of blocks.
2007 * \param theX,theY,theZ Coordinates of the sought vertex.
2008 * \param theEpsilon Maximum allowed distance between the resulting
2009 * vertex and point with the given coordinates.
2010 * \return New GEOM_Object, containing the found vertex.
2012 GEOM_Object GetPoint (in GEOM_Object theShape,
2016 in double theEpsilon);
2019 * Find a vertex of the given shape, which has minimal distance to the given point.
2020 * \param theShape Any shape.
2021 * \param thePoint Point, close to the desired vertex.
2022 * \return New GEOM_Object, containing the found vertex.
2024 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
2025 in GEOM_Object thePoint);
2028 * Get an edge, found in the given shape by two given vertices.
2029 * \param theShape Block or a compound of blocks.
2030 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2031 * \return New GEOM_Object, containing the found edge.
2033 GEOM_Object GetEdge (in GEOM_Object theShape,
2034 in GEOM_Object thePoint1,
2035 in GEOM_Object thePoint2);
2038 * Find an edge of the given shape, which has minimal distance to the given point.
2039 * \param theShape Block or a compound of blocks.
2040 * \param thePoint Point, close to the desired edge.
2041 * \return New GEOM_Object, containing the found edge.
2043 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
2044 in GEOM_Object thePoint);
2047 * Returns a face, found in the given shape by four given corner vertices.
2048 * \param theShape Block or a compound of blocks.
2049 * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
2050 * \return New GEOM_Object, containing the found face.
2052 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
2053 in GEOM_Object thePoint1,
2054 in GEOM_Object thePoint2,
2055 in GEOM_Object thePoint3,
2056 in GEOM_Object thePoint4);
2059 * Get a face of block, found in the given shape by two given edges.
2060 * \param theShape Block or a compound of blocks.
2061 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2062 * \return New GEOM_Object, containing the found face.
2064 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2065 in GEOM_Object theEdge1,
2066 in GEOM_Object theEdge2);
2069 * Find a face, opposite to the given one in the given block.
2070 * \param theBlock Must be a hexahedral solid.
2071 * \param theFace Face of \a theBlock, opposite to the desired face.
2072 * \return New GEOM_Object, containing the found face.
2074 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2075 in GEOM_Object theFace);
2078 * Find a face of the given shape, which has minimal distance to the given point.
2079 * \param theShape Block or a compound of blocks.
2080 * \param thePoint Point, close to the desired face.
2081 * \return New GEOM_Object, containing the found face.
2083 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2084 in GEOM_Object thePoint);
2087 * Find a face of block, whose outside normale has minimal angle with the given vector.
2088 * \param theShape Block or a compound of blocks.
2089 * \param theVector Vector, close to the normale of the desired face.
2090 * \return New GEOM_Object, containing the found face.
2092 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2093 in GEOM_Object theVector);
2096 * Find all subshapes of type \a theShapeType of the given shape,
2097 * which have minimal distance to the given point.
2098 * \param theShape Any shape.
2099 * \param thePoint Point, close to the desired shape.
2100 * \param theShapeType Defines what kind of subshapes is searched.
2101 * \param theTolerance The tolerance for distances comparison. All shapes
2102 * with distances to the given point in interval
2103 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2104 * \return New GEOM_Object, containing a group of all found shapes.
2106 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2107 in GEOM_Object thePoint,
2108 in long theShapeType,
2109 in double theTolerance);
2112 * Extract blocks from blocks compounds
2116 * Check, if the compound contains only specified blocks.
2117 * \param theCompound The compound to check.
2118 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2119 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2120 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2121 * \return TRUE, if the given compound contains only blocks.
2122 * \return theNbBlocks Number of specified blocks in theCompound.
2124 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2125 in long theMinNbFaces,
2126 in long theMaxNbFaces,
2127 out long theNbBlocks);
2130 * Enumeration of Blocks Compound defects.
2134 /* Each element of the compound should be a Block */
2137 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2140 /* A connection between two Blocks should be an entire face or an entire edge */
2143 /* The compound should be connexe */
2146 /* The glue between two quadrangle faces should be applied */
2151 * Description of Blocks Compound defect: type and incriminated sub-shapes.
2156 ListOfLong incriminated;
2160 * Sequence of all Blocks Compound defects.
2162 typedef sequence<BCError> BCErrors;
2165 * Check, if the compound of blocks is given.
2166 * To be considered as a compound of blocks, the
2167 * given shape must satisfy the following conditions:
2168 * - Each element of the compound should be a Block (6 faces and 12 edges).
2169 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2170 * - The compound should be connexe.
2171 * - The glue between two quadrangle faces should be applied.
2172 * \note Single block is also accepted as a valid compound of blocks.
2173 * \param theCompound The compound to check.
2174 * \return TRUE, if the given shape is a compound of blocks.
2175 * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
2177 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2178 out BCErrors theErrors);
2181 * Convert sequence of Blocks Compound errors, returned by
2182 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2183 * \param theCompound The bad compound.
2184 * \param theErrors The sequence of \a theCompound errors.
2185 * \return String, describing all the errors in form, suitable for printing.
2187 string PrintBCErrors (in GEOM_Object theCompound,
2188 in BCErrors theErrors);
2191 * Remove all seam and degenerated edges from \a theShape.
2192 * Unite faces and edges, sharing one surface.
2193 * \param theShape The compound or single solid to remove irregular edges from.
2194 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2195 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2196 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2197 * For blocks repairing recommended value is 6.
2198 * \return Improved shape.
2200 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2201 in long theOptimumNbFaces);
2204 * Check, if the given shape is a blocks compound.
2205 * Fix all detected errors.
2206 * \note Single block can be also fixed by this method.
2207 * \param theCompound The compound to check and improve.
2208 * \return Improved compound.
2210 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2213 * Get all the blocks, contained in the given compound.
2214 * \param theCompound The compound to explode.
2215 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2216 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2217 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2218 * \return List of GEOM_Objects, containing the retrieved blocks.
2220 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2221 in long theMinNbFaces,
2222 in long theMaxNbFaces);
2225 * Find block, containing the given point inside its volume or on boundary.
2226 * \param theCompound Compound, to find block in.
2227 * \param thePoint Point, close to the desired block. If the point lays on
2228 * boundary between some blocks, we return block with nearest center.
2229 * \return New GEOM_Object, containing the found block.
2231 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2232 in GEOM_Object thePoint);
2235 * Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2236 * \param theCompound Compound, to find block in.
2237 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2238 * \return New GEOM_Object, containing the found block.
2240 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2241 in ListOfGO theParts);
2244 * Return all blocks, containing all the elements, passed as the parts.
2245 * \param theCompound Compound, to find blocks in.
2246 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2247 * \return List of GEOM_Objects, containing the found blocks.
2249 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2250 in ListOfGO theParts);
2253 * Operations on blocks with gluing of result
2257 * Multi-transformate block and glue the result.
2258 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2259 * \param theBlock Hexahedral solid to be multi-transformed.
2260 * \param theDirFace1 First direction face global index.
2261 * \param theDirFace2 Second direction face global index.
2262 * \param theNbTimes Quantity of transformations to be done.
2263 * \note Global index of sub-shape can be obtained, using method
2264 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2265 * \return New GEOM_Object, containing the result shape.
2267 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2268 in long theDirFace1,
2269 in long theDirFace2,
2270 in long theNbTimes);
2273 * Multi-transformate block and glue the result.
2274 * \param theBlock Hexahedral solid to be multi-transformed.
2275 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2276 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2277 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2278 * \return New GEOM_Object, containing the result shape.
2280 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2281 in long theDirFace1U,
2282 in long theDirFace2U,
2283 in long theNbTimesU,
2284 in long theDirFace1V,
2285 in long theDirFace2V,
2286 in long theNbTimesV);
2289 * Special operation - propagation
2293 * Build all possible propagation groups.
2294 * Propagation group is a set of all edges, opposite to one (main)
2295 * edge of this group directly or through other opposite edges.
2296 * Notion of Opposite Edge make sence only on quadrangle face.
2297 * \param theShape Shape to build propagation groups on.
2298 * \return List of GEOM_Objects, each of them is a propagation group.
2300 ListOfGO Propagate (in GEOM_Object theShape);
2304 * GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
2306 interface GEOM_IBooleanOperations : GEOM_IOperations
2309 * Perform one of boolean operations on two given shapes.
2310 * \param theShape1 First argument for boolean operation.
2311 * \param theShape2 Second argument for boolean operation.
2312 * \param theOperation Indicates the operation to be done:
2313 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2314 * \return New GEOM_Object, containing the result shape.
2316 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2317 in GEOM_Object theShape2,
2318 in long theOperation);
2321 * Perform partition operation.
2322 * \param theShapes Shapes to be intersected.
2323 * \param theTools Shapes to intersect theShapes.
2324 * \note Each compound from ListShapes and ListTools will be exploded in order
2325 * to avoid possible intersection between shapes from this compound.
2326 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2327 * \param KeepNonlimitShapes: if this parameter == 0, then only shapes of
2328 * target type (equal to Limit) are kept in the result,
2329 * else standalone shapes of lower dimension
2330 * are kept also (if they exist).
2332 * After implementation new version of PartitionAlgo (October 2006)
2333 * other parameters are ignored by current functionality. They are kept
2334 * in this function only for supporting old versions.
2335 * Ignored parameters:
2336 * \param theKeepInside Shapes, outside which the results will be deleted.
2337 * Each shape from theKeepInside must belong to theShapes also.
2338 * \param theRemoveInside Shapes, inside which the results will be deleted.
2339 * Each shape from theRemoveInside must belong to theShapes also.
2340 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2341 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2343 * \return New GEOM_Object, containing the result shapes.
2345 GEOM_Object MakePartition (in ListOfGO theShapes,
2346 in ListOfGO theTools,
2347 in ListOfGO theKeepInside,
2348 in ListOfGO theRemoveInside,
2350 in boolean theRemoveWebs,
2351 in ListOfLong theMaterials,
2352 in short theKeepNonlimitShapes);
2355 * Perform partition operation.
2356 * This method may be usefull if it is needed to make a partition for
2357 * a compound containing nonintersected shapes. Performance will be better
2358 * since intersection between shapes from compound is not performed.
2360 * Description of all parameters as in previous method MakePartition()
2362 * \note Passed compounds (via ListShapes or via ListTools)
2363 * have to consist of nonintersecting shapes.
2365 * \return New GEOM_Object, containing the result shapes.
2367 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2368 in ListOfGO theTools,
2369 in ListOfGO theKeepInside,
2370 in ListOfGO theRemoveInside,
2372 in boolean theRemoveWebs,
2373 in ListOfLong theMaterials,
2374 in short theKeepNonlimitShapes);
2377 * Perform partition of the Shape with the Plane
2378 * \param theShape Shape to be intersected.
2379 * \param thePlane Tool shape, to intersect theShape.
2380 * \return New GEOM_Object, containing the result shape.
2382 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2383 in GEOM_Object thePlane);
2387 * GEOM_ICurvesOperations: Interface for curves creation.
2388 * Polyline, Circle, Spline (Bezier and Interpolation)
2390 interface GEOM_ICurvesOperations : GEOM_IOperations
2393 * Create a circle with given center, normal vector and radius.
2394 * \param thePnt Circle center.
2395 * \param theVec Vector, normal to the plane of the circle.
2396 * \param theR Circle radius.
2397 * \return New GEOM_Object, containing the created circle.
2399 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2400 in GEOM_Object theVec,
2403 * Create a circle, passing through three given points
2404 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2405 * \return New GEOM_Object, containing the created circle.
2407 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2408 in GEOM_Object thePnt2,
2409 in GEOM_Object thePnt3);
2411 * Create a circle with given center, with a radius equals the distance from center to Point1
2412 * and on a plane defined by all of three points.
2413 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2414 * \return New GEOM_Object, containing the created circle.
2416 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2417 in GEOM_Object thePnt2,
2418 in GEOM_Object thePnt3);
2420 * Create an ellipse with given center, normal vector and radiuses.
2421 * \param thePnt Ellipse center.
2422 * \param theVec Vector, normal to the plane of the ellipse.
2423 * \param theRMajor Major ellipse radius.
2424 * \param theRMinor Minor ellipse radius.
2425 * \return New GEOM_Object, containing the created ellipse.
2427 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2428 in GEOM_Object theVec,
2429 in double theRMajor,
2430 in double theRMinor);
2433 * Create an ellipse with given center, normal vector, main axis vector and radiuses.
2434 * \param thePnt Ellipse center.
2435 * \param theVec Vector, normal to the plane of the ellipse.
2436 * \param theRMajor Major ellipse radius.
2437 * \param theRMinor Minor ellipse radius.
2438 * \param theVecMaj Vector, direction of the ellipse's main axis.
2439 * \return New GEOM_Object, containing the created ellipse.
2441 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2442 in GEOM_Object theVec,
2443 in double theRMajor,
2444 in double theRMinor,
2445 in GEOM_Object theVecMaj);
2448 * Create an arc of circle, passing through three given points.
2449 * \param thePnt1 Start point of the arc.
2450 * \param thePnt2 Middle point of the arc.
2451 * \param thePnt3 End point of the arc.
2452 * \return New GEOM_Object, containing the created arc.
2454 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2455 in GEOM_Object thePnt2,
2456 in GEOM_Object thePnt3);
2459 * Create an arc of circle of center C from one point to another
2460 * \param theCenter Center point of the arc.
2461 * \param thePnt1 Start point of the arc.
2462 * \param thePnt2 End point of the arc.
2463 * \param theSense Orientation of the arc
2464 * \return New GEOM_Object, containing the created arc.
2466 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2467 in GEOM_Object thePnt1,
2468 in GEOM_Object thePnt2,
2469 in boolean theSense);
2472 * Create an arc of ellipse of center C and two points P1 P2.
2473 * \param theCenter Center point of the arc.
2474 * \param thePnt1 Major radius is distance from center to Pnt1.
2475 * \param thePnt2 define a plane and Minor radius as a shortest
2476 * distance from Pnt2 to vector Center->Pnt1.
2477 * \return New GEOM_Object, containing the created arc.
2479 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2480 in GEOM_Object thePnt1,
2481 in GEOM_Object thePnt2);
2485 * Create a polyline on the set of points.
2486 * \param thePoints Sequence of points for the polyline.
2487 * \return New GEOM_Object, containing the created polyline.
2489 GEOM_Object MakePolyline (in ListOfGO thePoints);
2492 * Create bezier curve on the set of points.
2493 * \param thePoints Sequence of points for the bezier curve.
2494 * \return New GEOM_Object, containing the created bezier curve.
2496 GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
2499 * Create B-Spline curve on the set of points.
2500 * \param thePoints Sequence of points for the B-Spline curve.
2501 * \param theIsClosed If TRUE, build a closed curve.
2502 * \return New GEOM_Object, containing the created B-Spline curve.
2504 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2505 in boolean theIsClosed);
2508 * Create a sketcher (wire or face), following the textual description,
2509 * passed through \a theCommand argument. \n
2510 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2511 * Format of the description string have to be the following:
2513 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2516 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2518 * - "R angle" : Set the direction by angle
2519 * - "D dx dy" : Set the direction by DX & DY
2522 * - "TT x y" : Create segment by point at X & Y
2523 * - "T dx dy" : Create segment by point with DX & DY
2524 * - "L length" : Create segment by direction & Length
2525 * - "IX x" : Create segment by direction & Intersect. X
2526 * - "IY y" : Create segment by direction & Intersect. Y
2529 * - "C radius length" : Create arc by direction, radius and length(in degree)
2532 * - "WW" : Close Wire (to finish)
2533 * - "WF" : Close Wire and build face (to finish)
2535 * \param theCommand String, defining the sketcher in local
2536 * coordinates of the working plane.
2537 * \param theWorkingPlane Nine double values, defining origin,
2538 * OZ and OX directions of the working plane.
2539 * \return New GEOM_Object, containing the created wire.
2541 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2544 * Create a 3D sketcher, following the numerical description,
2545 * passed through points created by \a theCoordinates argument. \n
2546 * Format of the description string have to be the following:
2548 * "Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"
2551 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2554 * Create a sketcher (wire or face), following the textual description,
2555 * passed through \a theCommand argument. \n
2556 * For format of the description string see the previous method.\n
2557 * \param theCommand String, defining the sketcher in local
2558 * coordinates of the working plane.
2559 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2560 * \return New GEOM_Object, containing the created wire.
2562 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2566 * GEOM_ILocalOperations: Interface for fillet and chamfer creation.
2568 interface GEOM_ILocalOperations : GEOM_IOperations
2571 * Perform a fillet on all edges of the given shape.
2572 * \param theShape Shape, to perform fillet on.
2573 * \param theR Fillet radius.
2574 * \return New GEOM_Object, containing the result shape.
2576 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2580 * Perform a fillet on the specified edges of the given shape
2581 * \param theShape Shape, to perform fillet on.
2582 * \param theR Fillet radius.
2583 * \param theEdges Global indices of edges to perform fillet on.
2584 * \note Global index of sub-shape can be obtained, using method
2585 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2586 * \return New GEOM_Object, containing the result shape.
2588 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2590 in ListOfLong theEdges);
2591 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2594 in ListOfLong theEdges);
2597 * Perform a fillet on all edges of the specified faces of the given shape.
2598 * \param theShape Shape, to perform fillet on.
2599 * \param theR Fillet radius.
2600 * \param theFaces Global indices of faces to perform fillet on.
2601 * \note Global index of sub-shape can be obtained, using method
2602 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2603 * \return New GEOM_Object, containing the result shape.
2605 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2607 in ListOfLong theFaces);
2609 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2612 in ListOfLong theFaces);
2615 * Perform a fillet on face of the specified vertexes of the given shape.
2616 * \param theShape Shape, to perform fillet on.
2617 * \param theR Fillet radius.
2618 * \param theVertexes Global indices of vertexes to perform fillet on.
2619 * \note Global index of sub-shape can be obtained, using method
2620 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2621 * \return New GEOM_Object, containing the result shape.
2623 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2625 in ListOfLong theVertexes);
2628 * Perform a fillet on edges of the specified vertexes of the given wire.
2629 * \param theShape Shape, to perform fillet on.
2630 * \param theR Fillet radius.
2631 * \param theVertexes Global indices of vertexes to perform fillet on.
2632 * \note Global index of sub-shape can be obtained, using method
2633 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2634 * \note The list of vertices coudl be empty, in this case fillet fill be done
2635 * at all vertices in given wire
2636 * \return New GEOM_Object, containing the result shape.
2638 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2640 in ListOfLong theVertexes);
2643 * Perform a symmetric chamfer on all edges of the given shape.
2644 * \param theShape Shape, to perform chamfer on.
2645 * \param theD Chamfer size along each face.
2646 * \return New GEOM_Object, containing the result shape.
2648 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2652 * Perform a chamfer on edges, common to the specified faces.
2653 * with distance D1 on the Face1
2654 * \param theShape Shape, to perform chamfer on.
2655 * \param theD1 Chamfer size along \a theFace1.
2656 * \param theD2 Chamfer size along \a theFace2.
2657 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2658 * \note Global index of sub-shape can be obtained, using method
2659 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2660 * \return New GEOM_Object, containing the result shape.
2662 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2663 in double theD1, in double theD2,
2664 in long theFace1, in long theFace2);
2666 * The Same but with params theD = Chamfer Lenght
2667 * and theAngle = Chamfer Angle (Angle in radians)
2669 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2670 in double theD, in double theAngle,
2671 in long theFace1, in long theFace2);
2674 * Perform a chamfer on all edges of the specified faces.
2675 * with distance D1 on the first specified face (if several for one edge)
2676 * \param theShape Shape, to perform chamfer on.
2677 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2678 * connected to the edge, are in \a theFaces, \a theD1
2679 * will be get along face, which is nearer to \a theFaces beginning.
2680 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2681 * \param theFaces Sequence of global indices of faces of \a theShape.
2682 * \note Global index of sub-shape can be obtained, using method
2683 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2684 * \return New GEOM_Object, containing the result shape.
2686 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2687 in double theD1, in double theD2,
2688 in ListOfLong theFaces);
2690 * The Same but with params theD = Chamfer Lenght
2691 * and theAngle = Chamfer Angle (Angle in radians)
2693 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2694 in double theD, in double theAngle,
2695 in ListOfLong theFaces);
2698 * Perform a chamfer on edges,
2699 * with distance D1 on the first specified face (if several for one edge)
2700 * \param theShape Shape, to perform chamfer on.
2701 * \param theD1 theD2 Chamfer size
2702 * \param theEdges Sequence of edges of \a theShape.
2703 * \return New GEOM_Object, containing the result shape.
2705 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2706 in double theD1, in double theD2,
2707 in ListOfLong theEdges);
2709 * The Same but with params theD = Chamfer Lenght
2710 * and theAngle = Chamfer Angle (Angle in radians)
2712 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2713 in double theD, in double theAngle,
2714 in ListOfLong theEdges);
2717 * Perform an Archimde operation on the given shape with given parameters.
2718 * The object presenting the resulting face is returned
2719 * \param theShape Shape to be put in water.
2720 * \param theWeight Weight og the shape.
2721 * \param theWaterDensity Density of the water.
2722 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
2723 * \return New GEOM_Object, containing a section of \a theShape
2724 * by a plane, corresponding to water level.
2726 GEOM_Object MakeArchimede (in GEOM_Object theShape,
2727 in double theWeight,
2728 in double theWaterDensity,
2729 in double theMeshDeflection);
2732 * Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2733 * Present here only for compatibility.
2735 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2739 * GEOM_IHealingOperations: Interface for shape healing operations.
2740 * Shape Processing, SuppressFaces, etc.
2742 interface GEOM_IHealingOperations : GEOM_IOperations
2745 * Apply a sequence of Shape Healing operators to the given object.
2746 * \param theShapes Shape to be processed.
2747 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2748 * \param theParameters List of names of parameters
2749 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2750 * \param theValues List of values of parameters, in the same order
2751 * as parameters are listed in \a theParameters list.
2752 * \return New GEOM_Object, containing processed shape.
2754 GEOM_Object ProcessShape (in GEOM_Object theShapes,
2755 in string_array theOperators,
2756 in string_array theParameters,
2757 in string_array theValues);
2760 * Get default sequence of operators, their parameters and parameters' values
2761 * of Shape Process operation. In the current implementation the defaults are
2762 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2763 * \param theOperators Output. Default list of names of operators.
2764 * \param theParameters Output. Default list of names of parameters.
2765 * \param theValues Output. List of default values of parameters, in the same order
2766 * as parameters are listed in \a theParameters list.
2768 void GetShapeProcessParameters (out string_array theOperators,
2769 out string_array theParameters,
2770 out string_array theValues);
2772 * Get parameters and parameters' values for the given Shape Process operation.
2773 * In the current implementation the defaults are
2774 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2775 * \param theOperator Input. The operator's name.
2776 * \param theParameters Output. Default list of names of parameters.
2777 * \param theValues Output. List of default values of parameters, in the same order
2778 * as parameters are listed in \a theParameters list.
2780 void GetOperatorParameters (in string theOperator,
2781 out string_array theParameters,
2782 out string_array theValues);
2785 * Remove faces from the given object (shape).
2786 * \param theObject Shape to be processed.
2787 * \param theFaces Indices of faces to be removed, if EMPTY then the method
2788 * removes ALL faces of the given object.
2789 * \return New GEOM_Object, containing processed shape.
2791 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
2794 * Close an open wire.
2795 * \param theObject Shape to be processed.
2796 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2797 * if -1, then theObject itself is a wire.
2798 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
2799 * If FALS : closure by creation of an edge between ends.
2800 * \return New GEOM_Object, containing processed shape.
2802 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2803 in boolean isCommonVertex);
2806 * Remove internal wires and edges from the given object (face).
2807 * \param theObject Shape to be processed.
2808 * \param theWires Indices of wires to be removed, if EMPTY then the method
2809 * removes ALL internal wires of the given object.
2810 * \return New GEOM_Object, containing processed shape.
2812 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2815 * Remove internal closed contours (holes) from the given object.
2816 * \param theObject Shape to be processed.
2817 * \param theWires Indices of wires to be removed, if EMPTY then the method
2818 * removes ALL internal holes of the given object
2819 * \return New GEOM_Object, containing processed shape.
2821 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2824 * Sewing of the given object.
2825 * \param theObject Shape to be processed.
2826 * \param theTolerance Required tolerance value.
2827 * \return New GEOM_Object, containing processed shape.
2829 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2832 * Addition of a point to a given edge object.
2833 * \param theObject Shape to be processed.
2834 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
2835 * if -1, then theObject itself is the edge.
2836 * \param theValue Value of parameter on edge or length parameter,
2837 * depending on \a isByParameter.
2838 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2839 * if FALSE : \a theValue is treated as a length parameter [0..1]
2840 * \return New GEOM_Object, containing processed shape.
2842 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2843 in double theValue, in boolean isByParameter);
2846 * Get a list of wires (wrapped in GEOM_Object-s),
2847 * that constitute a free boundary of the given shape.
2848 * \param theObject Shape to get free boundary of.
2849 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2850 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
2851 * \return FALSE, if an error(s) occured during the method execution.
2853 boolean GetFreeBoundary (in GEOM_Object theObject,
2854 out ListOfGO theClosedWires,
2855 out ListOfGO theOpenWires);
2858 * Change orientation of the given object.
2859 * \param theObject Shape to be processed.
2860 * \return New GEOM_Object, containing processed shape.
2862 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2863 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2866 * Try to limit tolerance of the given object by value \a theTolerance.
2867 * \param theObject Shape to be processed.
2868 * \param theTolerance Required tolerance value.
2869 * \return New GEOM_Object, containing processed shape.
2871 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
2876 * GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2879 interface GEOM_IInsertOperations : GEOM_IOperations
2882 * Create a copy of the given object
2884 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2887 * Export the given shape into a file with given name.
2888 * \param theObject Shape to be stored in the file.
2889 * \param theFileName Name of the file to store the given shape in.
2890 * \param theFormatName Specify format for the shape storage.
2891 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2893 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2896 * Import a shape from the BRep or IGES or STEP file
2897 * (depends on given format) with given name.
2898 * \param theFileName The file, containing the shape.
2899 * \param theFormatName Specify format for the file reading.
2900 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2901 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
2902 * set to 'meter' and result model will be scaled.
2903 * \return New GEOM_Object, containing the imported shape.
2905 GEOM_Object Import (in string theFileName, in string theFormatName);
2908 * Get the supported import formats and corresponding patterns for File dialog.
2909 * \param theFormats Output. List of formats, available for import.
2910 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2911 * \return Returns available formats and patterns through the arguments.
2913 void ImportTranslators (out string_array theFormats,
2914 out string_array thePatterns);
2917 * Get the supported export formats and corresponding patterns for File dialog.
2918 * \param theFormats Output. List of formats, available for export.
2919 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2920 * \return Returns available formats and patterns through the arguments.
2922 void ExportTranslators (out string_array theFormats,
2923 out string_array thePatterns);
2926 * Load texture from file
2927 * \param theTextureFile texture file name
2928 * \return unique texture identifier
2930 long LoadTexture(in string theTextureFile);
2933 * Add texture to the study
2934 * \param theWidth texture width in pixels
2935 * \param theHeight texture height in pixels
2936 * \param theTexture texture byte array
2937 * \return unique texture identifier
2939 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
2942 * Get previously loaded texture data
2943 * \param theID texture identifier
2944 * \param theWidth texture width in pixels
2945 * \param theHeight texture height in pixels
2946 * \return texture byte array
2948 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
2951 * Get list of all avaiable texture IDs
2952 * \return list of all texture IDs avaiable for the current study
2954 ListOfLong GetAllTextures();
2958 * GEOM_IKindOfShape: namespace for shape_kind enumeration.
2960 interface GEOM_IKindOfShape
2970 SPHERE, // full sphere
2971 CYLINDER, // cylinder
2972 BOX, // box with faces, parallel to global coordinate planes
2973 ROTATED_BOX, // other box
2974 TORUS, // full torus
2976 POLYHEDRON, // solid, bounded by polygons
2977 SOLID, // other solid
2979 SPHERE2D, // spherical face (closed)
2980 CYLINDER2D, // cylindrical face with defined height
2981 TORUS2D, // toroidal face (closed)
2982 CONE2D, // conical face with defined height
2983 DISK_CIRCLE, // planar, bounded by circle
2984 DISK_ELLIPSE, // planar, bounded by ellipse
2985 POLYGON, // planar, bounded by segments
2986 PLANE, // infinite planar
2987 PLANAR, // other planar
2990 CIRCLE, // full circle
2991 ARC_CIRCLE, // arc of circle
2992 ELLIPSE, // full ellipse
2993 ARC_ELLIPSE, // arc of ellipse
2994 LINE, // infinite segment
3000 ADVANCED // all advanced shapes (temporary implementation)
3006 * GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
3007 * properties calculation (like Centre of Mass, Inertia, etc.).
3010 interface GEOM_IMeasureOperations : GEOM_IOperations
3013 * Get kind of theShape.
3014 * \param theShape Shape to get a kind of.
3015 * \param theIntegers Output. Integer and enumerated shape's parameters
3016 * (kind of surface, closed/unclosed, number of edges, etc.)
3017 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
3018 * \note Concrete meaning of each value, returned via \a theIntegers
3019 * or \a theDoubles list depends on the kind of the shape.
3020 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
3022 //short KindOfShape (in GEOM_Object theShape,
3023 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
3024 out ListOfLong theIntegers,
3025 out ListOfDouble theDoubles);
3028 * Get position (LCS) of theShape.
3029 * \param theShape Shape to calculate position of.
3030 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
3031 * Origin of the LCS is situated at the shape's center of mass.
3032 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
3033 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
3034 * Axes of the LCS are obtained from shape's location or,
3035 * if the shape is a planar face, from position of its plane.
3036 * \return Returns position of the shape through the last nine arguments.
3038 void GetPosition (in GEOM_Object theShape,
3039 out double Ox, out double Oy, out double Oz,
3040 out double Zx, out double Zy, out double Zz,
3041 out double Xx, out double Xy, out double Xz);
3044 * Get summarized length of all wires,
3045 * area of surface and volume of the given shape.
3046 * \param theShape Shape to define properties of.
3047 * \param theLength Output. Summarized length of all wires of the given shape.
3048 * \param theSurfArea Output. Area of surface of the given shape.
3049 * \param theVolume Output. Volume of the given shape.
3050 * \return Returns shape properties through the last three arguments.
3052 void GetBasicProperties (in GEOM_Object theShape,
3053 out double theLength,
3054 out double theSurfArea,
3055 out double theVolume);
3058 * Get a point, situated at the centre of mass of theShape.
3059 * \param theShape Shape to define centre of mass of.
3060 * \return New GEOM_Object, containing the created point.
3062 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
3065 * Get the vertex by index for 1D objects depends the edge/wire orientation
3066 * \param theShape Shape (wire or edge) to find the vertex on it
3067 * \param theIndex Index of vertex subshape
3068 * \return New GEOM_Object, vertex.
3070 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
3073 * Get a vector, representing the normal of theFace.
3074 * If the face is not planar, theOptionalPoint is obligatory.
3075 * \param theFace Shape (face) to define the normal of.
3076 * \param theOptionalPoint Shape (point) to define the normal at.
3077 * Can be NULL in case of planar face.
3078 * \return New GEOM_Object, containing the created normal vector.
3080 GEOM_Object GetNormal (in GEOM_Object theFace,
3081 in GEOM_Object theOptionalPoint);
3084 * Get inertia matrix and moments of inertia of theShape.
3085 * \param theShape Shape to calculate inertia of.
3086 * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
3087 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
3088 * \return Returns inertia through the last twelve arguments.
3090 void GetInertia (in GEOM_Object theShape,
3091 out double I11, out double I12, out double I13,
3092 out double I21, out double I22, out double I23,
3093 out double I31, out double I32, out double I33,
3094 out double Ix , out double Iy , out double Iz);
3097 * Get parameters of bounding box of the given shape
3098 * \param theShape Shape to obtain bounding box of.
3099 * \param Xmin,Xmax Output. Limits of shape along OX axis.
3100 * \param Ymin,Ymax Output. Limits of shape along OY axis.
3101 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
3102 * \return Returns parameters of bounding box through the last six arguments.
3104 void GetBoundingBox (in GEOM_Object theShape,
3105 out double Xmin, out double Xmax,
3106 out double Ymin, out double Ymax,
3107 out double Zmin, out double Zmax);
3110 * Get min and max tolerances of sub-shapes of theShape
3111 * \param theShape Shape, to get tolerances of.
3112 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3113 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
3114 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
3115 * \return Returns shape tolerances through the last six arguments.
3117 void GetTolerance (in GEOM_Object theShape,
3118 out double FaceMin, out double FaceMax,
3119 out double EdgeMin, out double EdgeMax,
3120 out double VertMin, out double VertMax);
3123 * Check a topology of the given shape.
3124 * \param theShape Shape to check validity of.
3125 * \param theDescription Output. Description of problems in the shape, if they are.
3126 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
3128 boolean CheckShape (in GEOM_Object theShape,
3129 out string theDescription);
3132 * Check a topology and a geometry of the given shape.
3133 * \param theShape Shape to check validity of.
3134 * \param theDescription Output. Description of problems in the shape, if they are.
3135 * \return TRUE, if the shape "seems to be valid".
3137 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
3138 out string theDescription);
3141 * Obtain description of the given shape
3142 * \param theShape Shape to be described.
3143 * \return Description of the given shape.
3145 string WhatIs (in GEOM_Object theShape);
3148 * Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on
3149 * the shape theShape.
3150 * \param theShape Shape to check.
3151 * \param coords list of coordinates.
3152 * \param tolerance tolerance.
3153 * \return list of boolean.
3155 ListOfBool AreCoordsInside(in GEOM_Object theShape, in ListOfDouble coords, in double tolerance);
3158 * Get minimal distance between the given shapes.
3159 * \param theShape1,theShape2 Shapes to find minimal distance between.
3160 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
3161 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
3162 * \return Value of the minimal distance between the given shapes.
3164 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
3165 out double X1, out double Y1, out double Z1,
3166 out double X2, out double Y2, out double Z2);
3169 * Get angle between the given lines or linear edges.
3170 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
3171 * \return Value of the angle between the given shapes.
3173 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
3176 * Get point coordinates
3178 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
3181 * Get radius of curvature of curve in the point determinated by param
3182 * \param theShape - curve.
3183 * \param theParam - parameter on curve
3184 * \return Value of curvature.
3186 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3189 * Get radius of curvature of curve in the given point
3190 * \param theShape - curve.
3191 * \param thePoint - point
3192 * \return Value of curvature.
3194 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3197 * Get max radius of curvature of surface in the point determinated by params
3198 * \param theShape - surface.
3199 * \param theUParam - U-parameter on surface
3200 * \param theVParam - V-parameter on surface
3201 * \return Value of curvature.
3203 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3204 in double theVParam);
3207 * Get max radius of curvature of surface in the given point
3208 * \param theShape - surface.
3209 * \param thePoint - point
3210 * \return Value of curvature.
3212 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3215 * Get min radius of curvature of surface in the point determinated by params
3216 * \param theShape - surface.
3217 * \param theUParam - U-parameter on surface
3218 * \param theVParam - V-parameter on surface
3219 * \return Value of curvature.
3221 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3222 in double theVParam);
3225 * Get min radius of curvature of surface in the given point
3226 * \param theShape - surface.
3227 * \param thePoint - point
3228 * \return Value of curvature.
3230 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3236 * GEOM_IGroupOperations: Interface for groups creation.
3238 interface GEOM_IGroupOperations : GEOM_IOperations
3241 * Creates a new group which will store sub shapes of theMainShape
3242 * \param theMainShape is a GEOM object on which the group is selected
3243 * \param theShapeType defines a shape type of the group
3244 * \return a newly created GEOM group
3246 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3249 * Adds a sub object with ID theSubShapeId to the group
3250 * \param theGroup is a GEOM group to which the new sub shape is added
3251 * \param theSubShapeId is a sub shape ID in the main object.
3252 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3254 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3257 * Removes a sub object with ID \a theSubShapeId from the group
3258 * \param theGroup is a GEOM group from which the sub shape is removed.
3259 * \param theSubShapeId is a sub shape ID in the main object.
3260 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3262 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3265 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3266 * \param theGroup is a GEOM group to which the new sub shapes are added.
3267 * \param theSubShapes is a list of sub shapes to be added.
3269 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3272 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3273 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3274 * \param theSubShapes is a list of sub-shapes to be removed.
3276 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3279 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3280 * \param theGroup is a GEOM group to which the new sub shapes are added.
3281 * \param theSubShapes is a list of IDs of sub shapes to be added.
3283 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3286 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3287 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3288 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3290 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3293 * Returns a type of sub objects stored in the group
3294 * \param theGroup is a GEOM group which type is returned.
3296 long GetType (in GEOM_Object theGroup);
3299 * Returns a main shape associated with the group
3300 * \param theGroup is a GEOM group for which a main shape object is requested
3301 * \return a GEOM object which is a main shape for theGroup
3303 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3306 * Returns a list of sub objects ID stored in the group
3307 * \param theGroup is a GEOM group for which a list of IDs is requested
3309 ListOfLong GetObjects (in GEOM_Object theGroup);
3314 * GEOM_IAdvancedOperations: Interface for advanced modeling functions.
3316 interface GEOM_IAdvancedOperations : GEOM_IOperations
3319 * Create a T-shape object with specified caracteristics for the main and
3320 * the incident pipes (radius, width, half-length).
3321 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3322 * \param theR1 Internal radius of main pipe
3323 * \param theW1 Width of main pipe
3324 * \param theL1 Half-length of main pipe
3325 * \param theR2 Internal radius of incident pipe (R2 < R1)
3326 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3327 * \param theL2 Half-length of incident pipe
3328 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3329 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3331 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
3332 in double theR2, in double theW2, in double theL2,
3333 in boolean theHexMesh);
3335 * Create a T-shape object with specified caracteristics for the main and
3336 * the incident pipes (radius, width, half-length).
3337 * The extremities of the main pipe are located on junctions points P1 and P2.
3338 * The extremity of the incident pipe is located on junction point P3.
3339 * \param theR1 Internal radius of main pipe
3340 * \param theW1 Width of main pipe
3341 * \param theL1 Half-length of main pipe
3342 * \param theR2 Internal radius of incident pipe (R2 < R1)
3343 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3344 * \param theL2 Half-length of incident pipe
3345 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3346 * \param theP1 1st junction point of main pipe
3347 * \param theP2 2nd junction point of main pipe
3348 * \param theP3 Junction point of incident pipe
3349 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3351 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
3352 in double theR2, in double theW2, in double theL2,
3353 in boolean theHexMesh,
3354 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3356 * Create a T-shape object with specified caracteristics for the main and
3357 * the incident pipes (radius, width, half-length). A chamfer is created
3358 * on the junction of the pipes.
3359 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3360 * \param theR1 Internal radius of main pipe
3361 * \param theW1 Width of main pipe
3362 * \param theL1 Half-length of main pipe
3363 * \param theR2 Internal radius of incident pipe (R2 < R1)
3364 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3365 * \param theL2 Half-length of incident pipe
3366 * \param theH Height of the chamfer.
3367 * \param theW Width of the chamfer.
3368 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3369 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3371 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
3372 in double theR2, in double theW2, in double theL2,
3373 in double theH, in double theW, in boolean theHexMesh);
3375 * Create a T-shape object with specified caracteristics for the main and
3376 * the incident pipes (radius, width, half-length). A chamfer is created
3377 * on the junction of the pipes.
3378 * The extremities of the main pipe are located on junctions points P1 and P2.
3379 * The extremity of the incident pipe is located on junction point P3.
3380 * \param theR1 Internal radius of main pipe
3381 * \param theW1 Width of main pipe
3382 * \param theL1 Half-length of main pipe
3383 * \param theR2 Internal radius of incident pipe (R2 < R1)
3384 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3385 * \param theL2 Half-length of incident pipe
3386 * \param theH Height of the chamfer.
3387 * \param theW Width of the chamfer.
3388 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3389 * \param theP1 1st junction point of main pipe
3390 * \param theP2 2nd junction point of main pipe
3391 * \param theP3 Junction point of incident pipe
3392 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3394 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
3395 in double theR2, in double theW2, in double theL2,
3396 in double theH, in double theW, in boolean theHexMesh,
3397 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3399 * Create a T-shape object with specified caracteristics for the main and
3400 * the incident pipes (radius, width, half-length). A fillet is created
3401 * on the junction of the pipes.
3402 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3403 * \param theR1 Internal radius of main pipe
3404 * \param theW1 Width of main pipe
3405 * \param theL1 Half-length of main pipe
3406 * \param theR2 Internal radius of incident pipe (R2 < R1)
3407 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3408 * \param theL2 Half-length of incident pipe
3409 * \param theRF Radius of curvature of fillet.
3410 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3411 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3413 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
3414 in double theR2, in double theW2, in double theL2,
3415 in double theRF, in boolean theHexMesh);
3417 * Create a T-shape object with specified caracteristics for the main and
3418 * the incident pipes (radius, width, half-length). A fillet is created
3419 * on the junction of the pipes.
3420 * The extremities of the main pipe are located on junctions points P1 and P2.
3421 * The extremity of the incident pipe is located on junction point P3.
3422 * \param theR1 Internal radius of main pipe
3423 * \param theW1 Width of main pipe
3424 * \param theL1 Half-length of main pipe
3425 * \param theR2 Internal radius of incident pipe (R2 < R1)
3426 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3427 * \param theL2 Half-length of incident pipe
3428 * \param theRF Radius of curvature of fillet.
3429 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3430 * \param theP1 1st junction point of main pipe
3431 * \param theP2 2nd junction point of main pipe
3432 * \param theP3 Junction point of incident pipe
3433 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3435 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
3436 in double theR2, in double theW2, in double theL2,
3437 in double theRF, in boolean theHexMesh,
3438 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3439 /*@@ insert new functions before this line @@ do not remove this line @@*/
3443 * GEOM_Gen: Interface to access other GEOM interfaces.
3444 * Also contains some methods to access and manage GEOM objects.
3446 interface GEOM_Gen : Engines::EngineComponent,SALOMEDS::Driver
3449 * Undo/Redo Management
3452 void Undo (in long theStudyID);
3454 void Redo (in long theStudyID);
3457 * Publishing management
3458 * Adds in theStudy a object theObject under with a name theName,
3459 * if theFather is not NULL the object is placed under thFather's SObject.
3460 * Returns a SObject where theObject is placed
3462 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3463 in GEOM_Object theObject,
3465 in GEOM_Object theFather);
3468 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3469 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3470 * \param theStudy the study, in which theObject is published already,
3471 * and in which the arguments will be published
3472 * \param theObject published GEOM object, arguments of which will be published
3473 * \param theArgs list of GEOM_Object, operation arguments to be published.
3474 * If this list is empty, all operation arguments will be published
3475 * \param theFindMethod method to search subshapes, corresponding to arguments and
3476 * their subshapes. Value from enumeration GEOM::find_shape_method.
3477 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3478 * Do not publish subshapes in place of arguments, but only
3479 * in place of subshapes of the first argument,
3480 * because the whole shape corresponds to the first argument.
3481 * Mainly to be used after transformations, but it also can be
3482 * usefull after partition with one object shape, and some other
3483 * operations, where only the first argument has to be considered.
3484 * If theObject has only one argument shape, this flag is automatically
3485 * considered as True, not regarding really passed value.
3486 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3487 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3488 * \return list of published sub-shapes
3490 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
3491 in GEOM_Object theObject,
3492 in ListOfGO theArgs,
3493 in find_shape_method theFindMethod,
3494 in boolean theInheritFirstArg,
3495 in boolean theAddPrefix);
3498 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3499 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3500 * \param theStudy the study, in which theObject is published already,
3501 * and in which the arguments will be published
3502 * \param theObject published GEOM object, arguments of which will be published
3503 * \param theArgs list of GEOM_Object, operation arguments to be published.
3504 * If this list is empty, all operation arguments will be published
3505 * \param theFindMethod method to search subshapes, corresponding to arguments and
3506 * their subshapes. Value from enumeration GEOM::find_shape_method.
3507 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3508 * Do not publish subshapes in place of arguments, but only
3509 * in place of subshapes of the first argument,
3510 * because the whole shape corresponds to the first argument.
3511 * Mainly to be used after transformations, but it also can be
3512 * usefull after partition with one object shape, and some other
3513 * operations, where only the first argument has to be considered.
3514 * If theObject has only one argument shape, this flag is automatically
3515 * considered as True, not regarding really passed value.
3516 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3517 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3518 * \return list of published sub-shapes
3520 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
3521 in GEOM_Object theObject,
3522 in ListOfGO theArgs,
3523 in find_shape_method theFindMethod,
3524 in boolean theInheritFirstArg,
3525 in boolean theAddPrefix);
3528 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3529 * To be used from GUI and from geompy.addToStudy.
3530 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
3531 * \param theSObject study object, referencing GEOM object, arguments of which will be published
3533 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
3534 in SALOMEDS::SObject theSObject,
3535 in ListOfGO theArgs,
3536 in find_shape_method theFindMethod,
3537 in boolean theInheritFirstArg,
3538 in boolean theAddPrefix);
3541 * Methods to access interfaces for objects creation and transformation
3543 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3544 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
3545 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3546 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3547 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3548 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3549 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3550 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3551 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3552 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3553 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3554 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3555 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3558 * Objects Management
3562 * Removes the object from the GEOM component
3563 * \param theObject is a GEOM object to be removed
3565 void RemoveObject (in GEOM_Object theObject);
3568 * Returns an object defined by the study and its entry in the GEOM component
3569 * \param theStudyID is a SALOMEDS Study ID
3570 * \param theEntry is an entry of the requested GEOM object in the GEOM component
3571 * \note if the object has not previously been created a NULL GEOM object is returned
3573 GEOM_Object GetObject (in long theStudyID, in string theEntry);
3576 * Add a sub shape defined by indices in \a theIndices
3577 * (contains unique IDs of sub shapes inside theMainShape)
3578 * \note The sub shape GEOM_Objects can has ONLY ONE function.
3579 * Don't try to apply modification operations on them.
3580 * \note Internal method
3582 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
3585 * GEOM object's IOR Management
3589 * Returns a GEOM Object defined by its IOR
3590 * \param theIOR a string containg an IOR of the requested GEOM object
3592 GEOM_Object GetIORFromString (in string theIOR);
3595 * Returns a string which contains an IOR of the GEOM object
3596 * \param theObject is a GEOM object which IOR is requested
3598 string GetStringFromIOR (in GEOM_Object theObject);
3601 * Returns a name with which a GEOM object was dumped into python script
3602 * \param theStudyEntry is an entry of the GEOM object in the study
3604 string GetDumpName (in string theStudyEntry);
3607 * Returns all names with which a GEOM objects was dumped
3608 * into python script to avoid the same names in SMESH script
3610 string_array GetAllDumpNames();
3613 * Publishes the named subshapes of given object in the study.
3614 * \param theStudy The study in which the object is published
3615 * \param theObject The object which named subshapes are published
3617 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
3618 //in SObject theSObject,
3619 in Object theObject);