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
23 // File : GEOM_Gen.idl
24 // Author : Sergey RUIN
29 #include "SALOME_Exception.idl"
30 #include "SALOME_Component.idl"
31 #include "SALOMEDS.idl"
32 #include "SALOMEDS_Attributes.idl"
34 #include "SALOME_GenericObj.idl"
39 * Topological types of shapes (like Open Cascade types)
41 enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
42 FACE, WIRE, EDGE, VERTEX, SHAPE };
47 enum marker_type { MT_NONE, MT_POINT, MT_PLUS, MT_STAR, MT_O, MT_X, MT_O_POINT, MT_O_PLUS,
48 MT_O_STAR, MT_O_X, MT_BALL, MT_RING1, MT_RING2, MT_RING3, MT_USER };
53 enum marker_size { MS_NONE, MS_10, MS_15, MS_20, MS_25, MS_30, MS_35,
54 MS_40, MS_45, MS_50, MS_55, MS_60, MS_65, MS_70 };
57 * State of shape relatively geometrical surface like plane, sphere or cylinder.
58 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
62 /*! Shape is on surface */
66 * Shape is in the direction defined by the normal and not on surface.
67 * For plane it means above the plane,
68 * For sphere and cylinder it means outside of volume, bounded by the surface.
73 * Shape is in the direction defined by the normal and on surface.
79 * Complementary to ONOUT.
80 * For plane it means below the plane,
81 * For sphere and cylinder it means inside the volume, bounded by the surface
82 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
87 * Complementary to OUT.
94 * Kind of method to find inside one main shape some subshapes,
95 * corresponding to other given shape (its argument)
96 * Is used in functions GEOM_Gen.RestoreSubShapes<xxx>()
98 enum find_shape_method
100 /*! Use GetInPlace functionality. Suits all cases, except transformations */
103 /*! To be used only for transformation result, to find subshapes of argument.
104 * Only this method can be used after transformation.
108 /*! To find only shared subshapes, not modified by the operation */
111 /*! Use GetShapesOnShape method (can work only on solids) */
112 FSM_GetShapesOnShape,
114 /*! Use GetInPlaceByHistory method (can work only after Partition) */
115 FSM_GetInPlaceByHistory
119 * Kind of method to perform filling operation
120 * Is used in functions GEOM_Gen.MakeFilling<xxx>()
122 enum filling_oper_method
124 /*! Default (standard behaviour) */
127 /*! Use edges orientation */
130 /*! Auto-correct edges orientation */
135 typedef sequence<string> string_array;
136 typedef sequence<short> short_array;
137 typedef sequence<long> ListOfLong;
138 typedef sequence<double> ListOfDouble;
140 interface GEOM_Object;
142 typedef sequence<GEOM_Object> ListOfGO;
145 * GEOM_Object: interface of geometric object
147 interface GEOM_Object : SALOME::GenericObj
151 * Get an entry of the object in GEOM component.
156 * Get ID of study, where the object is created.
161 * Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
166 * Get a <VAR>shape_type</VAR> of the object value.
168 shape_type GetShapeType();
171 * Get the topology type of the object value.
172 * In contrast to the shape type, this function returns type of the most
173 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
177 shape_type GetTopologyType();
180 * Set name of the object.
181 * \param theName is a name which will be associated with this object.
183 void SetName (in string theName);
186 * Get name of the object associated with this object.
191 * Set color of the object.
192 * \param theColor is a color of the object.
194 void SetColor(in SALOMEDS::Color theColor);
197 * Get color of the object.
199 SALOMEDS::Color GetColor();
202 * Toggle auto color mode on the object.
203 * \param theAtoColor is a flag which toggles auto color mode.
205 void SetAutoColor(in boolean theAutoColor);
208 * Get flag of object's auto color mode.
210 boolean GetAutoColor();
213 * Set standard point marker for the object
214 * \param theType standard marker type
215 * \param theSize marker relative size
217 void SetMarkerStd(in marker_type theType, in marker_size theSize );
220 * Set custom point marker for the object. The texture can be added
221 * by LoadTexture() or AddTexture() functions.
222 * \param theTextureId texture ID
224 void SetMarkerTexture(in long theTextureId);
227 * Get type of the point marker assigned to the object
228 * \return current marker type (MT_NONE if no marker is set)
230 marker_type GetMarkerType();
233 * Get size of the point marker assigned to the object
234 * \return current marker relative size (MS_NONE if no marker is set)
236 marker_size GetMarkerSize();
239 * Get texture idenifier of the point marker assigned to the object
240 * \return marker texture ID (0 if no marker set)
242 long GetMarkerTexture();
245 * Set a Study entry where this object was published.
247 void SetStudyEntry (in string theEntry);
250 * Get a Study entry where this object was published.
252 string GetStudyEntry();
255 * Get a list of all GEOM objects on which were the arguments
256 * when this object was constructed and modified.
257 * \note This method is supposed to be used by GUI only.
259 ListOfGO GetDependency();
262 * Get a list of GEOM objects on which the last function that created or modified the object depends.
263 * \note This method is supposed to be used by GUI only.
265 ListOfGO GetLastDependency();
268 * Get the TopoDS_Shape, for colocated case only.
270 long long getShape();
273 ######################################################################
274 * Internal methods (For sub shape identification)
275 ######################################################################
279 * Get geometric shape of the object as a byte stream
281 SALOMEDS::TMPFile GetShapeStream();
284 * Returns True if this object is not a sub shape of another object.
286 boolean IsMainShape();
289 * Get a list of ID's of sub shapes in the main shape.
290 * \note Internal method, suppopsed to be used only by GEOM_Client
292 ListOfLong GetSubShapeIndices();
295 * Get a main shape object to which this object is a sub shape
296 * \note Internal method, suppopsed to be used only by GEOM_Client
298 GEOM_Object GetMainShape();
301 * Return true if geom object representes a shape.
302 * For example, method return false for GEOM_MARKER
307 * Set list of parameters
308 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
309 * used for object creation
311 void SetParameters (in string theParameters);
314 * Return list of notebook variables used for object creation separated by ":" symbol
316 string GetParameters();
321 * GEOM_IOperations: basic methods of all geometric operations
323 interface GEOM_IOperations : SALOME::GenericObj
326 * To know, if the operation was successfully performed
331 * Set the operation error code
332 * \param theErrorID is a string describing the error occured
333 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
335 void SetErrorCode (in string theErrorID);
338 * Get the operation error code
340 string GetErrorCode();
343 * Get ID of study, where the operation is defined
348 * Opens a new transaction
350 void StartOperation();
353 * Closes the previously opened trasaction
355 void FinishOperation();
358 * Aborts the previously opened transaction
360 void AbortOperation();
364 * GEOM_IBasicOperations: interface for basic geometry creation
365 * (Point, Vector, Plane, Marker)
367 interface GEOM_IBasicOperations : GEOM_IOperations
370 * Create point by three coordinates.
371 * \param theX The X coordinate of the point.
372 * \param theY The Y coordinate of the point.
373 * \param theZ The Z coordinate of the point.
374 * \return New GEOM_Object, containing the created point.
376 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
379 * Create a point, distant from the referenced point
380 * on the given distances along the coordinate axes.
381 * \param theReference The referenced point.
382 * \param theX Displacement from the referenced point along OX axis.
383 * \param theY Displacement from the referenced point along OY axis.
384 * \param theZ Displacement from the referenced point along OZ axis.
385 * \return New GEOM_Object, containing the created point.
387 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
388 in double theX, in double theY, in double theZ);
391 * Create a point, corresponding to the given parameter on the given curve.
392 * \param theRefCurve The referenced curve.
393 * \param theParameter Value of parameter on the referenced curve.
394 * \return New GEOM_Object, containing the created point.
396 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
397 in double theParameter);
400 * Create a point on the given curve, projecting given point
401 * \param theRefCurve The referenced curve.
402 * \param theXParameter X co-ordinate of point to project on curve
403 * \param theYParameter Y co-ordinate of point to project on curve
404 * \param theZParameter Z co-ordinate of point to project on curve
405 * \return New GEOM_Object, containing the created point.
407 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
408 in double theXParameter,
409 in double theYarameter,
410 in double theZPameter);
413 * Create a point, corresponding to the given parameters on the
415 * \param theRefSurf The referenced surface.
416 * \param theUParameter Value of U-parameter on the referenced surface.
417 * \param theVParameter Value of V-parameter on the referenced surface.
418 * \return New GEOM_Object, containing the created point.
420 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
421 in double theUParameter,
422 in double theVParameter);
425 * Create a point on the given surface, projecting given point
426 * \param theRefSurf The referenced surface.
427 * \param theXParameter X co-ordinate of point to project on curve
428 * \param theYParameter Y co-ordinate of point to project on curve
429 * \param theZParameter Z co-ordinate of point to project on curve
430 * \return New GEOM_Object, containing the created point.
432 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
433 in double theXParameter,
434 in double theYarameter,
435 in double theZPameter);
439 * Create a point, on two lines intersection.
440 * \param theRefLine1, theRefLine2 The referenced lines.
441 * \return New GEOM_Object, containing the created point.
443 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
444 in GEOM_Object theRefLine2);
447 * Create a vector, corresponding to tangent to the given parameter on the given curve.
448 * \param theRefCurve The referenced curve.
449 * \param theParameter Value of parameter on the referenced curve.This value should be have value
450 * \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
451 * \last parameter of curve.
452 * \return New GEOM_Object, containing the created point.
454 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
455 in double theParameter);
458 * Create a vector with the given components.
459 * \param theDX X component of the vector.
460 * \param theDY Y component of the vector.
461 * \param theDZ Z component of the vector.
462 * \return New GEOM_Object, containing the created vector.
464 GEOM_Object MakeVectorDXDYDZ (in double theDX,
469 * Create a vector between two points.
470 * \param thePnt1 Start point for the vector.
471 * \param thePnt2 End point for the vector.
472 * \return New GEOM_Object, containing the created vector.
474 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
477 * Create a line, passing through the given point
478 * and parrallel to the given direction
479 * \param thePnt Point. The resulting line will pass through it.
480 * \param theDir Direction. The resulting line will be parallel to it.
481 * \return New GEOM_Object, containing the created line.
483 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
486 * Create a line, passing through the given points
487 * \param thePnt1 First of two points, defining the line.
488 * \param thePnt2 Second of two points, defining the line.
489 * \return New GEOM_Object, containing the created line.
491 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
494 * Create a line, given by two faces intersection.
495 * \param theFace1 First of two faces, defining the line.
496 * \param theFace2 Second of two faces, defining the line.
497 * \return New GEOM_Object, containing the created line.
499 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
502 * Create a plane, passing through the three given points
503 * \param thePnt1 First of three points, defining the plane.
504 * \param thePnt2 Second of three points, defining the plane.
505 * \param thePnt3 Fird of three points, defining the plane.
506 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
507 * \return New GEOM_Object, containing the created plane.
509 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
510 in GEOM_Object thePnt2,
511 in GEOM_Object thePnt3,
512 in double theTrimSize);
515 * Create a plane, passing through the given point
516 * and normal to the given vector.
517 * \param thePnt Point, the plane has to pass through.
518 * \param theVec Vector, defining the plane normal direction.
519 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
520 * \return New GEOM_Object, containing the created plane.
522 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
523 in GEOM_Object theVec,
524 in double theTrimSize);
527 * Create a plane, similar to the existing one, but with another size of representing face.
528 * \param theFace Referenced plane or LCS(Marker).
529 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
530 * \return New GEOM_Object, containing the created plane.
532 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
533 in double theTrimSize);
536 * Create a plane, by two vectors.
537 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
538 * \param theVec Vector2, defining the plane normal direction.
539 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
540 * \return New GEOM_Object, containing the created plane.
542 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
543 in GEOM_Object theVec2,
544 in double theTrimSize);
547 * Create a plane, defined by local coordinate system.
548 * \param theLCS Referenced LCS(Marker).
549 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
550 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
551 * \return New GEOM_Object, containing the created plane.
553 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
554 in double theTrimSize,
555 in double theOrientation);
558 * Create a local coordinate system.
559 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
560 * \param theXDX,theXDY,theXDZ Three components of OX direction
561 * \param theYDX,theYDY,theYDZ Three components of OY direction
562 * \return New GEOM_Object, containing the created coordinate system.
564 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
565 in double theXDX, in double theXDY, in double theXDZ,
566 in double theYDX, in double theYDY, in double theYDZ);
569 * Create a local coordinate system from shape.
570 * \param theShape The initial shape to detect the coordinate system.
571 * \return New GEOM_Object, containing the created coordinate system.
573 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
576 * Create a local coordinate system from point and two vectors (DX, DY).
577 * \param theOrigin Point of coordinate system origin.
578 * \param theXVec Vector of X direction.
579 * \param theYVec Vector of Y direction.
580 * \return New GEOM_Object, containing the created coordinate system.
582 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin, in GEOM_Object theXVec, in GEOM_Object theYVec);
585 * Create a tangent plane to specified face in the point with specified parameters.
586 * Values of parameters should be between 0. and 1.0
587 * \param theFace - face for which tangent plane shuold be built.
588 * \param theParameterU - value of parameter by U
589 * \param theParameterV - value of parameter Vthe
590 * \param theTrimSize - defines sizes of created face
591 * \return New GEOM_Object, containing the face built on tangent plane.
593 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
594 in double theParameterU,
595 in double theParameterV,
596 in double theTrimSize);
599 interface GEOM_ITransformOperations : GEOM_IOperations
602 * Translate the given object along the vector, specified by its end points.
603 * \param theObject The object to be translated.
604 * \param thePoint1 Start point of translation vector.
605 * \param thePoint2 End point of translation vector.
608 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
609 in GEOM_Object thePoint1,
610 in GEOM_Object thePoint2);
613 * Translate the given object along the vector, specified
614 * by its end points, creating its copy before the translation.
615 * \param theObject The object to be translated.
616 * \param thePoint1 Start point of translation vector.
617 * \param thePoint2 End point of translation vector.
618 * \return New GEOM_Object, containing the translated object.
620 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
621 in GEOM_Object thePoint1,
622 in GEOM_Object thePoint2);
625 * Translate the given object along the vector, specified by its components.
626 * \param theObject The object to be translated.
627 * \param theDX,theDY,theDZ Components of translation vector.
630 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
631 in double theDX, in double theDY, in double theDZ);
634 * Translate the given object along the vector, specified
635 * by its components, creating its copy before the translation.
636 * \param theObject The object to be translated.
637 * \param theDX,theDY,theDZ Components of translation vector.
638 * \return New GEOM_Object, containing the translated object.
640 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
641 in double theDX, in double theDY, in double theDZ);
645 * Translate the given object along the given vector.
646 * \param theObject The object to be translated.
647 * \param theVector Translation vector, giving both direction and distance.
650 GEOM_Object TranslateVector (in GEOM_Object theObject,
651 in GEOM_Object theVector);
654 * Translate the given object along the given vector,
655 * creating its copy before the translation.
656 * \param theObject The object to be translated.
657 * \param theVector Translation vector, giving both direction and distance.
658 * \return New GEOM_Object, containing the translated object.
660 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
661 in GEOM_Object theVector);
664 * Translate the given object along the given vector on given distance,
665 * creating its copy before the translation.
666 * \param theObject The object to be translated.
667 * \param theVector Translation vector, giving a direction.
668 * \param theDistance Translation distance, giving a distance.
669 * \param theCope Translation copy, creating its copy if true.
670 * \return New GEOM_Object, containing the translated object.
672 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
673 in GEOM_Object theVector,
674 in double theDistance,
678 * Translate the given object along the given vector a given number times
679 * \param theObject The object to be translated.
680 * \param theVector Direction of the translation.
681 * \param theStep Distance to translate on.
682 * \param theNbTimes Quantity of translations to be done.
683 * \return New GEOM_Object, containing compound of all
684 * the shapes, obtained after each translation.
686 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
687 in GEOM_Object theVector,
692 * Conseqently apply two specified translations to theObject specified number of times.
693 * \param theObject The object to be translated.
694 * \param theVector1 Direction of the first translation.
695 * \param theStep1 Step of the first translation.
696 * \param theNbTimes1 Quantity of translations to be done along theVector1.
697 * \param theVector2 Direction of the second translation.
698 * \param theStep2 Step of the second translation.
699 * \param theNbTimes2 Quantity of translations to be done along theVector2.
700 * \return New GEOM_Object, containing compound of all
701 * the shapes, obtained after each translation.
703 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
704 in GEOM_Object theVector1,
707 in GEOM_Object theVector2,
709 in long theNbTimes2);
712 * Rotate given object around vector perpendicular to plane containing three points.
713 * \param theObject The object to be rotated.
714 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
715 * containing the three points.
716 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
719 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
720 in GEOM_Object theCentPoint,
721 in GEOM_Object thePoint1,
722 in GEOM_Object thePoint2);
726 * Rotate given object around vector perpendicular to plane containing three points.
727 * Creating its copy before the rotatation.
728 * \param theObject The object to be rotated.
729 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
730 * containing the three points.
731 * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
732 * \return New GEOM_Object, containing the rotated object.
734 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
735 in GEOM_Object theCentPoint,
736 in GEOM_Object thePoint1,
737 in GEOM_Object thePoint2);
740 * Rotate the given object around the given axis on the given angle.
741 * \param theObject The object to be rotated.
742 * \param theAxis Rotation axis.
743 * \param theAngle Rotation angle in radians.
746 GEOM_Object Rotate (in GEOM_Object theObject,
747 in GEOM_Object theAxis,
752 * Rotate the given object around the given axis
753 * on the given angle, creating its copy before the rotatation.
754 * \param theObject The object to be rotated.
755 * \param theAxis Rotation axis.
756 * \param theAngle Rotation angle in radians.
757 * \return New GEOM_Object, containing the rotated object.
759 GEOM_Object RotateCopy (in GEOM_Object theObject,
760 in GEOM_Object theAxis,
765 * Rotate the given object around the given axis a given number times.
766 * Rotation angle will be 2*PI/theNbTimes.
767 * \param theObject The object to be rotated.
768 * \param theAxis The rotation axis.
769 * \param theNbTimes Quantity of rotations to be done.
770 * \return New GEOM_Object, containing compound of all the
771 * shapes, obtained after each rotation.
773 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
774 in GEOM_Object theAxis,
778 * Rotate the given object around the
779 * given axis on the given angle a given number
780 * times and multi-translate each rotation result.
781 * Translation direction passes through center of gravity
782 * of rotated shape and its projection on the rotation axis.
783 * \param theObject The object to be rotated.
784 * \param theAxis Rotation axis.
785 * \param theAngle Rotation angle in graduces.
786 * \param theNbTimes1 Quantity of rotations to be done.
787 * \param theStep Translation distance.
788 * \param theNbTimes2 Quantity of translations to be done.
789 * \return New GEOM_Object, containing compound of all the
790 * shapes, obtained after each transformation.
792 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
793 in GEOM_Object theAxis,
797 in long theNbTimes2);
800 * Replace the given object by an object,
801 * symmetrical to it relatively the given plane.
802 * \param theObject The object to be mirrored.
803 * \param thePlane Plane of symmetry.
805 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
808 * Create an object, symmetrical
809 * to the given one relatively the given plane.
810 * \param theObject The object to be mirrored.
811 * \param thePlane Plane of symmetry.
812 * \return New GEOM_Object, containing the mirrored shape.
814 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
817 * Replace the given object by an object,
818 * symmetrical to it relatively the given axis.
819 * \param theObject The object to be mirrored.
820 * \param theAxis Axis of symmetry.
823 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
826 * Create an object, symmetrical
827 * to the given one relatively the given axis.
828 * \param theObject The object to be mirrored.
829 * \param theAxis Axis of symmetry.
830 * \return New GEOM_Object, containing the mirrored object.
832 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
835 * Replace the given object by an object, symmetrical to it relatively the given point.
836 * \param theObject The object to be mirrored.
837 * \param thePoint Point of symmetry.
840 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
843 * Create an object, symmetrical to the given one relatively the given point.
844 * \param theObject The object to be mirrored.
845 * \param thePoint Point of symmetry.
846 * \return New GEOM_Object, containing the mirrored object.
848 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
851 * Replace the given object by its offset.
852 * \param theObject The base object for the offset.
853 * \param theOffset Offset value.
856 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
859 * Create new object as offset of the given one.
860 * \param theObject The base object for the offset.
861 * \param theOffset Offset value.
862 * \return New GEOM_Object, containing the offset object.
864 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
867 * Scale the given object by the factor.
868 * \param theObject The object to be scaled.
869 * \param thePoint Center point for scaling.
870 * \param theFactor Scaling factor value.
873 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
874 in double theFactor);
877 * Scale the given object by the factor, creating its copy before the scaling.
878 * \param theObject The object to be scaled.
879 * \param thePoint Center point for scaling.
880 * \param theFactor Scaling factor value.
881 * \return New GEOM_Object, containing the scaled shape.
883 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
884 in double theFactor);
887 * Scale the given object by different factors along coordinate axes.
888 * \param theObject The object to be scaled.
889 * \param thePoint Center point for scaling.
890 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
893 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
894 in GEOM_Object thePoint,
895 in double theFactorX,
896 in double theFactorY,
897 in double theFactorZ);
900 * Scale the given object by different factors along coordinate axes,
901 * creating its copy before the scaling.
902 * \param theObject The object to be scaled.
903 * \param thePoint Center point for scaling.
904 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
905 * \return New GEOM_Object, containing the scaled shape.
907 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
908 in GEOM_Object thePoint,
909 in double theFactorX,
910 in double theFactorY,
911 in double theFactorZ);
914 * Modify the Location of the given object by LCS.
915 * \param theObject The object to be displaced.
916 * \param theStartLCS Coordinate system to perform displacement from it.
917 * If \a theStartLCS is NULL, displacement
918 * will be performed from global CS.
919 * If \a theObject itself is used as \a theStartLCS,
920 * its location will be changed to \a theEndLCS.
921 * \param theEndLCS Coordinate system to perform displacement to it.
924 GEOM_Object PositionShape (in GEOM_Object theObject,
925 in GEOM_Object theStartLCS,
926 in GEOM_Object theEndLCS);
929 * Modify the Location of the given object by LCS,
930 * creating its copy before the setting.
931 * \param theObject The object to be displaced.
932 * \param theStartLCS Coordinate system to perform displacement from it.
933 * If \a theStartLCS is NULL, displacement
934 * will be performed from global CS.
935 * If \a theObject itself is used as \a theStartLCS,
936 * its location will be changed to \a theEndLCS.
937 * \param theEndLCS Coordinate system to perform displacement to it.
938 * \return New GEOM_Object, containing the displaced shape.
940 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
941 in GEOM_Object theStartLCS,
942 in GEOM_Object theEndLCS);
945 * Modify the Location of the given object by Path,
946 * \param theObject The object to be displaced.
947 * \param thePath Wire or Edge along that the object will be translated.
948 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
949 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
950 * \param theCopy is a true or false parameter. true is to reverse direction, false is to move normal direction.
951 * \return New GEOM_Object, containing the displaced shape.
954 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
955 in GEOM_Object thePath,
956 in double theDistance,
958 in boolean theReverse);
961 * Recompute the shape from its arguments.
962 * \param theObject The object to be recomputed.
965 GEOM_Object RecomputeObject (in GEOM_Object theObject);
969 * GEOM_I3DPrimOperations: Interface for 3D primitives creation
970 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
971 * Pipe (extrusion along contour), Revolution, Solid (from shell).
973 interface GEOM_I3DPrimOperations : GEOM_IOperations
976 * Create a box with specified dimensions along the coordinate axes
977 * and with edges, parallel to the coordinate axes.
978 * Center of the box will be at point (DX/2, DY/2, DZ/2).
979 * \param theDX Length of Box edges, parallel to OX axis.
980 * \param theDY Length of Box edges, parallel to OY axis.
981 * \param theDZ Length of Box edges, parallel to OZ axis.
982 * \return New GEOM_Object, containing the created box.
984 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
987 * Create a box with two specified opposite vertices,
988 * and with edges, parallel to the coordinate axes
989 * \param thePnt1 First of two opposite vertices.
990 * \param thePnt2 Second of two opposite vertices.
991 * \return New GEOM_Object, containing the created box.
993 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
996 * Create a face specified dimensions along OX-OY coordinate axes,
997 * with edges parallel to the coordinate axes.
998 * Center of the face will be at point (0, 0, 0).
999 * \param theH Height of the Face.
1000 * \param theW Width of the Face.
1001 * \param theOrientation Orientation belong axis OXY OYZ OZX
1002 * \return New GEOM_Object, containing the created face.
1004 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1006 * Create a face by normale vector or edge and two specified sizes,
1007 * vertical (H) and horisontal (W).
1008 * \param theVec defines plane.
1009 * \param theH vertical size (height).
1010 * \param theW horisontal size (width).
1011 * \return New GEOM_Object, containing the created face.
1013 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1015 * Create a Disk (circular face) with given center, normal vector and radius.
1016 * \param thePnt disk center.
1017 * \param theVec Vector, normal to the plane of the disk.
1018 * \param theR Disk radius.
1019 * \return New GEOM_Object, containing the created disk.
1021 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1022 in GEOM_Object theVec,
1025 * Create a disk (circular face), passing through three given points
1026 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1027 * \return New GEOM_Object, containing the created disk.
1029 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1030 in GEOM_Object thePnt2,
1031 in GEOM_Object thePnt3);
1034 * Create a disk specified dimensions along OX-OY coordinate axes,
1035 * Center of the disk at point (0, 0, 0).
1036 * \param theR of the Disk.
1037 * \param theOrientation Orientation belong axis OXY OYZ OZX
1038 * \return New GEOM_Object, containing the created disk.
1040 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1043 * Create a cylinder with given radius and height at
1044 * the origin of coordinate system. Axis of the cylinder
1045 * will be collinear to the OZ axis of the coordinate system.
1046 * \param theR Cylinder radius.
1047 * \param theH Cylinder height.
1048 * \return New GEOM_Object, containing the created cylinder.
1050 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1053 * Create a cylinder with given base point, axis, radius and height.
1054 * \param thePnt Central point of cylinder base.
1055 * \param theAxis Cylinder axis.
1056 * \param theR Cylinder radius.
1057 * \param theH Cylinder height.
1058 * \return New GEOM_Object, containing the created cylinder.
1060 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1061 in GEOM_Object theAxis,
1066 * Create a cone with given height and radiuses at
1067 * the origin of coordinate system. Axis of the cone will
1068 * be collinear to the OZ axis of the coordinate system.
1069 * \param theR1 Radius of the first cone base.
1070 * \param theR2 Radius of the second cone base.
1071 * \note If both radiuses are non-zero, the cone will be truncated.
1072 * \note If the radiuses are equal, a cylinder will be created instead.
1073 * \param theH Cone height.
1074 * \return New GEOM_Object, containing the created cone.
1076 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1079 * Create a cone with given base point, axis, height and radiuses.
1080 * \param thePnt Central point of the first cone base.
1081 * \param theAxis Cone axis.
1082 * \param theR1 Radius of the first cone base.
1083 * \param theR2 Radius of the second cone base.
1084 * \note If both radiuses are non-zero, the cone will be truncated.
1085 * \note If the radiuses are equal, a cylinder will be created instead.
1086 * \param theH Cone height.
1087 * \return New GEOM_Object, containing the created cone.
1089 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1090 in GEOM_Object theAxis,
1096 * Create a torus with given radiuses at the origin of coordinate system.
1097 * \param theRMajor Torus major radius.
1098 * \param theRMinor Torus minor radius.
1099 * \return New GEOM_Object, containing the created torus.
1101 GEOM_Object MakeTorusRR (in double theRMajor,
1102 in double theRMinor);
1105 * Create a torus with given center, normal vector and radiuses.
1106 * \param thePnt Torus central point.
1107 * \param theVec Torus axis of symmetry.
1108 * \param theRMajor Torus major radius.
1109 * \param theRMinor Torus minor radius.
1110 * \return New GEOM_Object, containing the created torus.
1112 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1113 in GEOM_Object theVec,
1114 in double theRMajor,
1115 in double theRMinor);
1118 * Create a sphere with given radius at the origin of coordinate system.
1119 * \param theR Sphere radius.
1120 * \return New GEOM_Object, containing the created sphere.
1122 GEOM_Object MakeSphereR (in double theR);
1125 * Create a sphere with given center and radius.
1126 * \param thePnt Sphere center.
1127 * \param theR Sphere radius.
1128 * \return New GEOM_Object, containing the created .
1130 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1133 * Create a shape by extrusion of the base shape along the vector,
1134 * i.e. all the space, transfixed by the base shape during its translation
1135 * along the vector on the given distance.
1136 * \param theBase Base shape to be extruded.
1137 * \param theVec Direction of extrusion.
1138 * \param theH Prism dimension along theVec.
1139 * \return New GEOM_Object, containing the created prism.
1141 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1142 in GEOM_Object theVec,
1144 /* The Same Prism but in 2 directions (forward&backward) */
1145 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1146 in GEOM_Object theVec,
1150 * Create a shape by extrusion of the base shape along a vector, defined by two points.
1151 * \param theBase Base shape to be extruded.
1152 * \param thePoint1 First end of extrusion vector.
1153 * \param thePoint2 Second end of extrusion vector.
1154 * \return New GEOM_Object, containing the created prism.
1156 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1157 in GEOM_Object thePoint1,
1158 in GEOM_Object thePoint2);
1159 /* The same prism but in two directions forward&backward */
1160 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1161 in GEOM_Object thePoint1,
1162 in GEOM_Object thePoint2);
1165 * Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1166 * \param theBase Base shape to be extruded.
1167 * \param DX, DY, DZ end of extrusion vector.
1168 * \return New GEOM_Object, containing the created prism.
1170 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1171 in double theDX, in double theDY, in double theDZ);
1172 /* The same prism but in two directions forward&backward */
1173 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1174 in double theDX, in double theDY, in double theDZ);
1177 * Create a shape by extrusion of the base shape along
1178 * the path shape. The path shape can be a wire or an edge.
1179 * \param theBase Base shape to be extruded.
1180 * \param thePath Path shape to extrude the base shape along it.
1181 * \return New GEOM_Object, containing the created pipe.
1183 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1186 * Create a shape by revolution of the base shape around the axis
1187 * on the given angle, i.e. all the space, transfixed by the base
1188 * shape during its rotation around the axis on the given angle.
1189 * \param theBase Base shape to be rotated.
1190 * \param theAxis Rotation axis.
1191 * \param theAngle Rotation angle in radians.
1192 * \return New GEOM_Object, containing the created revolution.
1194 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1195 in GEOM_Object theAxis,
1196 in double theAngle);
1197 /* The Same Revolution but in both ways forward&backward */
1198 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1199 in GEOM_Object theAxis,
1200 in double theAngle);
1203 * Create a filling from the given compound of contours.
1204 * \param theMinDeg a minimal degree of BSpline surface to create
1205 * \param theMaxDeg a maximal degree of BSpline surface to create
1206 * \param theTol2D a 2d tolerance to be reached
1207 * \param theTol3D a 3d tolerance to be reached
1208 * \param theNbIter a number of iteration of approximation algorithm
1209 * \param theMethod Kind of method to perform filling operation.
1210 * \return New GEOM_Object, containing the created filling surface.
1212 GEOM_Object MakeFilling (in GEOM_Object theShape,
1213 in long theMinDeg, in long theMaxDeg,
1214 in double theTol2D, in double theTol3D,
1216 in filling_oper_method theMethod,
1217 in boolean theApprox);
1220 * Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1221 * \param theSeqSections - set of specified sections.
1222 * \param theModeSolid - mode defining building solid or shell
1223 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1224 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1225 * \return New GEOM_Object, containing the created shell or solid.
1227 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1228 in boolean theModeSolid,
1230 in boolean theRuled);
1233 * Create a shape by extrusion of the profile shape along
1234 * the path shape. The path shape can be a wire or an edge.
1235 * the several profiles can be specified in the several locations of path.
1236 * \param theSeqBases - list of Bases shape to be extruded.
1237 * \param theLocations - list of locations on the path corresponding
1238 * specified list of the Bases shapes. Number of locations
1239 * should be equal to number of bases or list of locations can be empty.
1240 * \param thePath - Path shape to extrude the base shape along it.
1241 * \param theWithContact - the mode defining that the section is translated to be in
1242 * contact with the spine.
1243 * \param - WithCorrection - defining that the section is rotated to be
1244 * orthogonal to the spine tangent in the correspondent point
1245 * \return New GEOM_Object, containing the created pipe.
1247 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1248 in ListOfGO theLocations,
1249 in GEOM_Object thePath,
1250 in boolean theWithContact ,
1251 in boolean theWithCorrection );
1254 * Create a shape by extrusion of the profile shape along
1255 * the path shape. The path shape can be a shell or a face.
1256 * the several profiles can be specified in the several locations of path.
1257 * \param theSeqBases - list of Bases shape to be extruded.
1258 * \param theSeqSubBases - list of corresponding subshapes of section shapes.
1259 * \param theLocations - list of locations on the path corresponding
1260 * specified list of the Bases shapes. Number of locations
1261 * should be equal to number of bases.
1262 * \param thePath - Path shape to extrude the base shape along it.
1263 * \param theWithContact - the mode defining that the section is translated to be in
1264 * contact with the spine.
1265 * \param - WithCorrection - defining that the section is rotated to be
1266 * orthogonal to the spine tangent in the correspondent point
1267 * \return New GEOM_Object, containing the created pipe.
1269 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1270 in ListOfGO theSeqSubBases,
1271 in ListOfGO theLocations,
1272 in GEOM_Object thePath,
1273 in boolean theWithContact ,
1274 in boolean theWithCorrection );
1277 * Create solids between given sections
1278 * \param theSeqBases - list of sections (shell or face).
1279 * \param theLocations - list of corresponding vertexes
1280 * \return New GEOM_Object, containing the created solids.
1282 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1283 in ListOfGO theLocations);
1286 * Create a shape by extrusion of the base shape along
1287 * the path shape with constant bi-normal direction along the given vector.
1288 * The path shape can be a wire or an edge.
1289 * \param theBase Base shape to be extruded.
1290 * \param thePath Path shape to extrude the base shape along it.
1291 * \param theVec Vector defines a constant binormal direction to keep the
1292 * same angle beetween the Direction and the sections
1293 * along the sweep surface.
1294 * \return New GEOM_Object, containing the created pipe.
1296 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1297 in GEOM_Object thePath,
1298 in GEOM_Object theVec);
1303 * GEOM_IShapesOperations: Interface for Shapes creation:
1304 * Edge from two points, Wire from edges, Face from wire,
1305 * Shell from faces, Solid from shells, Compound from shapes
1307 interface GEOM_IShapesOperations : GEOM_IOperations
1310 * Create a linear edge with specified ends.
1311 * \param thePnt1 Point for the first end of edge.
1312 * \param thePnt2 Point for the second end of edge.
1313 * \return New GEOM_Object, containing the created edge.
1315 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1318 * Create a wire from the set of edges and wires.
1319 * \param theEdgesAndWires List of edge and/or wires.
1320 * \param theTolerance Maximum distance between vertices, that will be merged.
1321 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1322 * \return New GEOM_Object, containing the created wire.
1324 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1325 in double theTolerance);
1328 * Create a face on the given wire.
1329 * \param theWire closed Wire or Edge to build the face on.
1330 * \param isPlanarWanted If TRUE, only planar face will be built.
1331 * If impossible, NULL object will be returned.
1332 * \return New GEOM_Object, containing the created face.
1334 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1337 * Create a face on the given wires set.
1338 * \param theWires List of closed wires or edges to build the face on.
1339 * \param isPlanarWanted If TRUE, only planar face will be built.
1340 * If impossible, NULL object will be returned.
1341 * \return New GEOM_Object, containing the created face.
1343 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1346 * Create a shell from the set of faces and shells.
1347 * \param theFacesAndShells List of faces and/or shells.
1348 * \return New GEOM_Object, containing the created shell.
1350 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1353 * Create a solid, bounded by the given shell.
1354 * \param theShell Bounding shell.
1355 * \return New GEOM_Object, containing the created solid.
1357 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1360 * Create a solid, bounded by the given shells.
1361 * \param theShells Bounding shells.
1362 * \return New GEOM_Object, containing the created solid.
1364 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1367 * Create a compound of the given shapes.
1368 * \param theShapes List of shapes to put in compound.
1369 * \return New GEOM_Object, containing the created compound.
1371 GEOM_Object MakeCompound (in ListOfGO theShapes);
1374 * Replace coincident faces in theShape by one face.
1375 * \param theShape Initial shape.
1376 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1377 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1378 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1380 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1383 * Find coincident faces in theShape for possible gluing.
1384 * \param theShape Initial shape.
1385 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1388 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1391 * Replace coincident faces in theShape by one face
1392 * in compliance with given list of faces
1393 * \param theShape Initial shape.
1394 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1395 * \param theFaces List of faces for gluing.
1396 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1397 * \return New GEOM_Object, containing a copy of theShape without some faces.
1399 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1400 in ListOfGO theFaces, in boolean doKeepNonSolids);
1403 * Explode a shape on subshapes of a given type.
1404 * \param theShape Shape to be exploded.
1405 * \param theShapeType Type of sub-shapes to be retrieved.
1406 * \param isSorted If this parameter is TRUE, sub-shapes will be
1407 * sorted by coordinates of their gravity centers.
1408 * \return List of sub-shapes of type theShapeType, contained in theShape.
1410 ListOfGO MakeExplode (in GEOM_Object theShape,
1411 in long theShapeType,
1412 in boolean isSorted);
1415 * Explode a shape on subshapes of a given type.
1416 * Does the same, as the above method, but returns IDs of sub-shapes,
1417 * not GEOM_Objects. It works faster.
1418 * \param theShape Shape to be exploded.
1419 * \param theShapeType Type of sub-shapes to be retrieved.
1420 * \param isSorted If this parameter is TRUE, sub-shapes will be
1421 * sorted by coordinates of their gravity centers.
1422 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
1424 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
1425 in long theShapeType,
1426 in boolean isSorted);
1429 * Get a sub shape defined by its unique ID inside \a theMainShape
1430 * \note The sub shape GEOM_Objects can has ONLY ONE function.
1431 * Don't try to apply modification operations on them.
1433 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
1437 * Get global index of \a theSubShape in \a theMainShape.
1438 * \param theMainShape Main shape.
1439 * \param theSubShape Sub-shape of the main shape.
1440 * \return global index of \a theSubShape in \a theMainShape.
1442 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1445 * Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
1446 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
1447 * to generate automatic names for sub-shapes, when publishing them in a study.
1448 * \param theMainShape Main shape.
1449 * \param theSubShape Sub-shape of the main shape.
1450 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
1452 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
1455 * \brief Get name of type of \a theShape.
1457 * Use wide type notation, taking into consideration both topology and geometry of the shape.
1458 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
1459 * to generate automatic names for sub-shapes, when publishing them in a study.
1460 * \param theShape The shape to get a type of.
1461 * \return String, containing a type name of \a theShape.
1463 string GetShapeTypeString (in GEOM_Object theShape);
1466 * Count number of faces in the given shape.
1467 * \param theShape Shape to count faces in.
1468 * \return Number of faces in the given shape.
1470 long NumberOfFaces (in GEOM_Object theShape);
1473 * Count number of edges in the given shape.
1474 * \param theShape Shape to count edges in.
1475 * \return Number of edges in theShape.
1477 long NumberOfEdges (in GEOM_Object theShape);
1480 * Count number of subshapes of type \a theShapeType in the given shape.
1481 * \param theShape Shape to count subshapes in.
1482 * \param theShapeType The type of subshapes to count.
1483 * \return Number of subshapes of type \a theShapeType in \a theShape.
1485 long NumberOfSubShapes (in GEOM_Object theShape,
1486 in long theShapeType);
1489 * Reverses an orientation the given shape.
1490 * \param theShape Shape to be reversed.
1491 * \return The reversed copy of theShape.
1493 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
1496 * Retrieve all free faces from the given shape.
1497 * Free face is a face, which is not shared between two shells of the shape.
1498 * \param theShape Shape to find free faces in.
1499 * \return List of IDs of all free faces, contained in theShape.
1501 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
1504 * Get all sub-shapes of theShape1 of the given type, shared with theShape2.
1505 * \param theShape1 Shape to find sub-shapes in.
1506 * \param theShape2 Shape to find shared sub-shapes with.
1507 * \param theShapeType Type of sub-shapes to be retrieved.
1508 * \return List of sub-shapes of theShape1, shared with theShape2.
1510 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
1511 in GEOM_Object theShape2,
1512 in long theShapeType);
1515 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1516 * the specified plane by the certain way, defined through \a theState parameter.
1517 * \param theShape Shape to find sub-shapes of.
1518 * \param theShapeType Type of sub-shapes to be retrieved.
1519 * \param theAx1 Vector (or line, or linear edge), specifying normal
1520 * direction and location of the plane to find shapes on.
1521 * \param theState The state of the subshapes to find.
1522 * \return List of all found sub-shapes.
1524 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
1525 in long theShapeType,
1526 in GEOM_Object theAx1,
1527 in shape_state theState);
1529 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1530 * the specified plane by the certain way, defined through \a theState parameter.
1531 * \param theShape Shape to find sub-shapes of.
1532 * \param theShapeType Type of sub-shapes to be retrieved.
1533 * \param theAx1 Vector (or line, or linear edge), specifying normal
1534 * direction of the plane to find shapes on.
1535 * \param thePnt Point specifying location of the plane to find shapes on.
1536 * \param theState The state of the subshapes to find.
1537 * \return List of all found sub-shapes.
1539 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
1540 in long theShapeType,
1541 in GEOM_Object theAx1,
1542 in GEOM_Object thePnt,
1543 in shape_state theState);
1548 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1549 * the specified cylinder by the certain way, defined through \a theState parameter.
1550 * \param theShape Shape to find sub-shapes of.
1551 * \param theShapeType Type of sub-shapes to be retrieved.
1552 * \param theAxis Vector (or line, or linear edge), specifying
1553 * axis of the cylinder to find shapes on.
1554 * \param theRadius Radius of the cylinder to find shapes on.
1555 * \param theState The state of the subshapes to find.
1556 * \return List of all found sub-shapes.
1558 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
1559 in long theShapeType,
1560 in GEOM_Object theAxis,
1561 in double theRadius,
1562 in shape_state theState);
1565 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1566 * the specified cylinder by the certain way, defined through \a theState parameter.
1567 * \param theShape Shape to find sub-shapes of.
1568 * \param theShapeType Type of sub-shapes to be retrieved.
1569 * \param theAxis Vector (or line, or linear edge), specifying
1570 * axis of the cylinder to find shapes on.
1571 * \param thePnt Point specifying location of the bottom of the cylinder.
1572 * \param theRadius Radius of the cylinder to find shapes on.
1573 * \param theState The state of the subshapes to find.
1574 * \return List of all found sub-shapes.
1576 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
1577 in long theShapeType,
1578 in GEOM_Object theAxis,
1579 in GEOM_Object thePnt,
1580 in double theRadius,
1581 in shape_state theState);
1584 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1585 * the specified sphere by the certain way, defined through \a theState parameter.
1586 * \param theShape Shape to find sub-shapes of.
1587 * \param theShapeType Type of sub-shapes to be retrieved.
1588 * \param theCenter Point, specifying center of the sphere to find shapes on.
1589 * \param theRadius Radius of the sphere to find shapes on.
1590 * \param theState The state of the subshapes to find.
1591 * \return List of all found sub-shapes.
1593 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
1594 in long theShapeType,
1595 in GEOM_Object theCenter,
1596 in double theRadius,
1597 in shape_state theState);
1600 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1601 * the specified quadrangle by the certain way, defined through \a theState parameter.
1602 * \param theShape Shape to find sub-shapes of.
1603 * \param theShapeType Type of sub-shapes to be retrieved.
1604 * \param theTopLeftPoint Top left quadrangle corner
1605 * \param theTopRigthPoint Top right quadrangle corner
1606 * \param theBottomLeftPoint Bottom left quadrangle corner
1607 * \param theBottomRigthPoint Bottom right quadrangle corner
1608 * \param theState The state of the subshapes to find.
1609 * \return List of all found sub-shapes.
1611 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
1612 in long theShapeType,
1613 in GEOM_Object theTopLeftPoint,
1614 in GEOM_Object theTopRigthPoint,
1615 in GEOM_Object theBottomLeftPoint,
1616 in GEOM_Object theBottomRigthPoint,
1617 in shape_state theState);
1620 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1621 * the specified plane by the certain way, defined through \a theState parameter.
1622 * \param theShape Shape to find sub-shapes of.
1623 * \param theShapeType Type of sub-shapes to be retrieved.
1624 * \param theAx1 Vector (or line, or linear edge), specifying normal
1625 * direction and location of the plane to find shapes on.
1626 * \param theState The state of the subshapes to find.
1627 * \return List of IDs of all found sub-shapes.
1629 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
1630 in long theShapeType,
1631 in GEOM_Object theAx1,
1632 in shape_state theState);
1635 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1636 * the specified plane by the certain way, defined through \a theState parameter.
1637 * \param theShape Shape to find sub-shapes of.
1638 * \param theShapeType Type of sub-shapes to be retrieved.
1639 * \param theAx1 Vector (or line, or linear edge), specifying normal
1640 * direction of the plane to find shapes on.
1641 * \param thePnt Point specifying location of the plane to find shapes on.
1642 * \param theState The state of the subshapes to find.
1643 * \return List of IDs of all found sub-shapes.
1645 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
1646 in long theShapeType,
1647 in GEOM_Object theAx1,
1648 in GEOM_Object thePnt,
1649 in shape_state theState);
1652 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1653 * the specified cylinder by the certain way, defined through \a theState parameter.
1654 * \param theShape Shape to find sub-shapes of.
1655 * \param theShapeType Type of sub-shapes to be retrieved.
1656 * \param theAxis Vector (or line, or linear edge), specifying
1657 * axis of the cylinder to find shapes on.
1658 * \param theRadius Radius of the cylinder to find shapes on.
1659 * \param theState The state of the subshapes to find.
1660 * \return List of IDs of all found sub-shapes.
1662 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
1663 in long theShapeType,
1664 in GEOM_Object theAxis,
1665 in double theRadius,
1666 in shape_state theState);
1669 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1670 * the specified cylinder by the certain way, defined through \a theState parameter.
1671 * \param theShape Shape to find sub-shapes of.
1672 * \param theShapeType Type of sub-shapes to be retrieved.
1673 * \param theAxis Vector (or line, or linear edge), specifying
1674 * axis of the cylinder to find shapes on.
1675 * \param thePnt Point specifying location of the bottom of the cylinder.
1676 * \param theRadius Radius of the cylinder to find shapes on.
1677 * \param theState The state of the subshapes to find.
1678 * \return List of IDs all found sub-shapes.
1680 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
1681 in long theShapeType,
1682 in GEOM_Object theAxis,
1683 in GEOM_Object thePnt,
1684 in double theRadius,
1685 in shape_state theState);
1688 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1689 * the specified sphere by the certain way, defined through \a theState parameter.
1690 * \param theShape Shape to find sub-shapes of.
1691 * \param theShapeType Type of sub-shapes to be retrieved.
1692 * \param theCenter Point, specifying center of the sphere to find shapes on.
1693 * \param theRadius Radius of the sphere to find shapes on.
1694 * \param theState The state of the subshapes to find.
1695 * \return List of IDs of all found sub-shapes.
1697 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
1698 in long theShapeType,
1699 in GEOM_Object theCenter,
1700 in double theRadius,
1701 in shape_state theState);
1704 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
1705 * the specified quadrangle by the certain way, defined through \a theState parameter.
1706 * \param theShape Shape to find sub-shapes of.
1707 * \param theShapeType Type of sub-shapes to be retrieved.
1708 * \param theTopLeftPoint Top left quadrangle corner
1709 * \param theTopRigthPoint Top right quadrangle corner
1710 * \param theBottomLeftPoint Bottom left quadrangle corner
1711 * \param theBottomRigthPoint Bottom right quadrangle corner
1712 * \param theState The state of the subshapes to find.
1713 * \return List of IDs of all found sub-shapes.
1715 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
1716 in long theShapeType,
1717 in GEOM_Object theTopLeftPoint,
1718 in GEOM_Object theTopRigthPoint,
1719 in GEOM_Object theBottomLeftPoint,
1720 in GEOM_Object theBottomRigthPoint,
1721 in shape_state theState);
1724 * \brief Find subshapes complying with given status
1725 * \param theBox - the box to check state of subshapes against
1726 * \param theShape - the shape to explore
1727 * \param theShapeType - type of subshape of theShape
1728 * \param theState - required state
1729 * \return List of IDs of all found sub-shapes.
1731 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
1732 in GEOM_Object theShape,
1733 in long theShapeType,
1734 in shape_state theState);
1737 * \brief Find subshapes complying with given status
1738 * \param theBox - the box to check state of subshapes against
1739 * \param theShape - the shape to explore
1740 * \param theShapeType - type of subshape of theShape
1741 * \param theState - required state
1742 * \return List of all found sub-shapes.
1744 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
1745 in GEOM_Object theShape,
1746 in long theShapeType,
1747 in shape_state theState);
1750 * \brief Find subshapes complying with given status
1751 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1752 * \param theShape - the shape to explore
1753 * \param theShapeType - type of subshape of theShape
1754 * \param theState - required state
1755 * \return List of IDs of all found sub-shapes.
1757 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
1758 in GEOM_Object theShape,
1759 in short theShapeType,
1760 in shape_state theState);
1763 * \brief Find subshapes complying with given status
1764 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1765 * \param theShape - the shape to explore
1766 * \param theShapeType - type of subshape of theShape
1767 * \param theState - required state
1768 * \return List of all found sub-shapes.
1770 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
1771 in GEOM_Object theShape,
1772 in short theShapeType,
1773 in shape_state theState);
1776 * \brief Find subshapes complying with given status
1777 * \param theCheckShape - the shape to check state of subshapes against. It must be a solid.
1778 * \param theShape - the shape to explore
1779 * \param theShapeType - type of subshape of theShape
1780 * \param theState - required state
1781 * \return compound includes all found sub-shapes.
1783 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
1784 in GEOM_Object theShape,
1785 in short theShapeType,
1786 in shape_state theState);
1789 * Get sub-shape(s) of \a theShapeWhere, which are
1790 * coincident with \a theShapeWhat or could be a part of it.
1791 * \param theShapeWhere Shape to find sub-shapes of.
1792 * \param theShapeWhat Shape, specifying what to find.
1793 * \return Group of all found sub-shapes or a single found sub-shape.
1795 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
1796 in GEOM_Object theShapeWhat);
1799 * Get sub-shape(s) of \a theShapeWhere, which are
1800 * coincident with \a theShapeWhat or could be a part of it.
1802 * Implementation of this method is based on a saved history of an operation,
1803 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
1804 * arguments (an argument shape or a sub-shape of an argument shape).
1805 * The operation could be the Partition or one of boolean operations,
1806 * performed on simple shapes (not on compounds).
1808 * \param theShapeWhere Shape to find sub-shapes of.
1809 * \param theShapeWhat Shape, specifying what to find.
1810 * \return Group of all found sub-shapes or a single found sub-shape.
1812 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
1813 in GEOM_Object theShapeWhat);
1816 * Get sub-shape of theShapeWhere, which are
1817 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
1818 * \param theShapeWhere Shape to find sub-shapes of.
1819 * \param theShapeWhat Shape, specifying what to find.
1820 * \return found sub-shape.
1822 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
1823 in GEOM_Object theShapeWhat);
1827 * GEOM_IBlocksOperations: Interface for Blocks construction
1828 * Face from points or edges, Block from faces,
1829 * Blocks multi-translation and multi-rotation
1831 interface GEOM_IBlocksOperations : GEOM_IOperations
1834 * Creation of blocks
1838 * Create a quadrangle face from four edges. Order of Edges is not
1839 * important. It is not necessary that edges share the same vertex.
1840 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
1841 * \return New GEOM_Object, containing the created face.
1843 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
1844 in GEOM_Object theEdge2,
1845 in GEOM_Object theEdge3,
1846 in GEOM_Object theEdge4);
1849 * Create a quadrangle face on two edges.
1850 * The missing edges will be built by creating the shortest ones.
1851 * \param theEdge1,theEdge2 Two opposite edges for the face.
1852 * \return New GEOM_Object, containing the created face.
1854 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1855 in GEOM_Object theEdge2);
1858 * Create a quadrangle face with specified corners.
1859 * The missing edges will be built by creating the shortest ones.
1860 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1861 * \return New GEOM_Object, containing the created face.
1863 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1864 in GEOM_Object thePnt2,
1865 in GEOM_Object thePnt3,
1866 in GEOM_Object thePnt4);
1869 * Create a hexahedral solid, bounded by the six given faces. Order of
1870 * faces is not important. It is not necessary that Faces share the same edge.
1871 * \param theFace1-theFace6 Faces for the hexahedral solid.
1872 * \return New GEOM_Object, containing the created solid.
1874 GEOM_Object MakeHexa (in GEOM_Object theFace1,
1875 in GEOM_Object theFace2,
1876 in GEOM_Object theFace3,
1877 in GEOM_Object theFace4,
1878 in GEOM_Object theFace5,
1879 in GEOM_Object theFace6);
1882 * Create a hexahedral solid between two given faces.
1883 * The missing faces will be built by creating the smallest ones.
1884 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1885 * \return New GEOM_Object, containing the created solid.
1887 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1888 in GEOM_Object theFace2);
1891 * Extract elements of blocks and blocks compounds
1895 * Get a vertex, found in the given shape by its coordinates.
1896 * \param theShape Block or a compound of blocks.
1897 * \param theX,theY,theZ Coordinates of the sought vertex.
1898 * \param theEpsilon Maximum allowed distance between the resulting
1899 * vertex and point with the given coordinates.
1900 * \return New GEOM_Object, containing the found vertex.
1902 GEOM_Object GetPoint (in GEOM_Object theShape,
1906 in double theEpsilon);
1909 * Find a vertex of the given shape, which has minimal distance to the given point.
1910 * \param theShape Any shape.
1911 * \param thePoint Point, close to the desired vertex.
1912 * \return New GEOM_Object, containing the found vertex.
1914 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
1915 in GEOM_Object thePoint);
1918 * Get an edge, found in the given shape by two given vertices.
1919 * \param theShape Block or a compound of blocks.
1920 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1921 * \return New GEOM_Object, containing the found edge.
1923 GEOM_Object GetEdge (in GEOM_Object theShape,
1924 in GEOM_Object thePoint1,
1925 in GEOM_Object thePoint2);
1928 * Find an edge of the given shape, which has minimal distance to the given point.
1929 * \param theShape Block or a compound of blocks.
1930 * \param thePoint Point, close to the desired edge.
1931 * \return New GEOM_Object, containing the found edge.
1933 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1934 in GEOM_Object thePoint);
1937 * Returns a face, found in the given shape by four given corner vertices.
1938 * \param theShape Block or a compound of blocks.
1939 * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1940 * \return New GEOM_Object, containing the found face.
1942 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1943 in GEOM_Object thePoint1,
1944 in GEOM_Object thePoint2,
1945 in GEOM_Object thePoint3,
1946 in GEOM_Object thePoint4);
1949 * Get a face of block, found in the given shape by two given edges.
1950 * \param theShape Block or a compound of blocks.
1951 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
1952 * \return New GEOM_Object, containing the found face.
1954 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
1955 in GEOM_Object theEdge1,
1956 in GEOM_Object theEdge2);
1959 * Find a face, opposite to the given one in the given block.
1960 * \param theBlock Must be a hexahedral solid.
1961 * \param theFace Face of \a theBlock, opposite to the desired face.
1962 * \return New GEOM_Object, containing the found face.
1964 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
1965 in GEOM_Object theFace);
1968 * Find a face of the given shape, which has minimal distance to the given point.
1969 * \param theShape Block or a compound of blocks.
1970 * \param thePoint Point, close to the desired face.
1971 * \return New GEOM_Object, containing the found face.
1973 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
1974 in GEOM_Object thePoint);
1977 * Find a face of block, whose outside normale has minimal angle with the given vector.
1978 * \param theShape Block or a compound of blocks.
1979 * \param theVector Vector, close to the normale of the desired face.
1980 * \return New GEOM_Object, containing the found face.
1982 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
1983 in GEOM_Object theVector);
1986 * Find all subshapes of type \a theShapeType of the given shape,
1987 * which have minimal distance to the given point.
1988 * \param theShape Any shape.
1989 * \param thePoint Point, close to the desired shape.
1990 * \param theShapeType Defines what kind of subshapes is searched.
1991 * \param theTolerance The tolerance for distances comparison. All shapes
1992 * with distances to the given point in interval
1993 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
1994 * \return New GEOM_Object, containing a group of all found shapes.
1996 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
1997 in GEOM_Object thePoint,
1998 in long theShapeType,
1999 in double theTolerance);
2002 * Extract blocks from blocks compounds
2006 * Check, if the compound contains only specified blocks.
2007 * \param theCompound The compound to check.
2008 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2009 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2010 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2011 * \return TRUE, if the given compound contains only blocks.
2012 * \return theNbBlocks Number of specified blocks in theCompound.
2014 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2015 in long theMinNbFaces,
2016 in long theMaxNbFaces,
2017 out long theNbBlocks);
2020 * Enumeration of Blocks Compound defects.
2024 /* Each element of the compound should be a Block */
2027 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2030 /* A connection between two Blocks should be an entire face or an entire edge */
2033 /* The compound should be connexe */
2036 /* The glue between two quadrangle faces should be applied */
2041 * Description of Blocks Compound defect: type and incriminated sub-shapes.
2046 ListOfLong incriminated;
2050 * Sequence of all Blocks Compound defects.
2052 typedef sequence<BCError> BCErrors;
2055 * Check, if the compound of blocks is given.
2056 * To be considered as a compound of blocks, the
2057 * given shape must satisfy the following conditions:
2058 * - Each element of the compound should be a Block (6 faces and 12 edges).
2059 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2060 * - The compound should be connexe.
2061 * - The glue between two quadrangle faces should be applied.
2062 * \note Single block is also accepted as a valid compound of blocks.
2063 * \param theCompound The compound to check.
2064 * \return TRUE, if the given shape is a compound of blocks.
2065 * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
2067 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2068 out BCErrors theErrors);
2071 * Convert sequence of Blocks Compound errors, returned by
2072 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2073 * \param theCompound The bad compound.
2074 * \param theErrors The sequence of \a theCompound errors.
2075 * \return String, describing all the errors in form, suitable for printing.
2077 string PrintBCErrors (in GEOM_Object theCompound,
2078 in BCErrors theErrors);
2081 * Remove all seam and degenerated edges from \a theShape.
2082 * Unite faces and edges, sharing one surface.
2083 * \param theShape The compound or single solid to remove irregular edges from.
2084 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2085 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2086 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2087 * For blocks repairing recommended value is 6.
2088 * \return Improved shape.
2090 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2091 in long theOptimumNbFaces);
2094 * Check, if the given shape is a blocks compound.
2095 * Fix all detected errors.
2096 * \note Single block can be also fixed by this method.
2097 * \param theCompound The compound to check and improve.
2098 * \return Improved compound.
2100 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2103 * Get all the blocks, contained in the given compound.
2104 * \param theCompound The compound to explode.
2105 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2106 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2107 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2108 * \return List of GEOM_Objects, containing the retrieved blocks.
2110 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2111 in long theMinNbFaces,
2112 in long theMaxNbFaces);
2115 * Find block, containing the given point inside its volume or on boundary.
2116 * \param theCompound Compound, to find block in.
2117 * \param thePoint Point, close to the desired block. If the point lays on
2118 * boundary between some blocks, we return block with nearest center.
2119 * \return New GEOM_Object, containing the found block.
2121 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2122 in GEOM_Object thePoint);
2125 * Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2126 * \param theCompound Compound, to find block in.
2127 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2128 * \return New GEOM_Object, containing the found block.
2130 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2131 in ListOfGO theParts);
2134 * Return all blocks, containing all the elements, passed as the parts.
2135 * \param theCompound Compound, to find blocks in.
2136 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2137 * \return List of GEOM_Objects, containing the found blocks.
2139 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2140 in ListOfGO theParts);
2143 * Operations on blocks with gluing of result
2147 * Multi-transformate block and glue the result.
2148 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2149 * \param theBlock Hexahedral solid to be multi-transformed.
2150 * \param theDirFace1 First direction face global index.
2151 * \param theDirFace2 Second direction face global index.
2152 * \param theNbTimes Quantity of transformations to be done.
2153 * \note Global index of sub-shape can be obtained, using method
2154 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2155 * \return New GEOM_Object, containing the result shape.
2157 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2158 in long theDirFace1,
2159 in long theDirFace2,
2160 in long theNbTimes);
2163 * Multi-transformate block and glue the result.
2164 * \param theBlock Hexahedral solid to be multi-transformed.
2165 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2166 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2167 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2168 * \return New GEOM_Object, containing the result shape.
2170 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2171 in long theDirFace1U,
2172 in long theDirFace2U,
2173 in long theNbTimesU,
2174 in long theDirFace1V,
2175 in long theDirFace2V,
2176 in long theNbTimesV);
2179 * Special operation - propagation
2183 * Build all possible propagation groups.
2184 * Propagation group is a set of all edges, opposite to one (main)
2185 * edge of this group directly or through other opposite edges.
2186 * Notion of Opposite Edge make sence only on quadrangle face.
2187 * \param theShape Shape to build propagation groups on.
2188 * \return List of GEOM_Objects, each of them is a propagation group.
2190 ListOfGO Propagate (in GEOM_Object theShape);
2194 * GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
2196 interface GEOM_IBooleanOperations : GEOM_IOperations
2199 * Perform one of boolean operations on two given shapes.
2200 * \param theShape1 First argument for boolean operation.
2201 * \param theShape2 Second argument for boolean operation.
2202 * \param theOperation Indicates the operation to be done:
2203 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2204 * \return New GEOM_Object, containing the result shape.
2206 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2207 in GEOM_Object theShape2,
2208 in long theOperation);
2211 * Perform partition operation.
2212 * \param theShapes Shapes to be intersected.
2213 * \param theTools Shapes to intersect theShapes.
2214 * \note Each compound from ListShapes and ListTools will be exploded in order
2215 * to avoid possible intersection between shapes from this compound.
2216 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2217 * \param KeepNonlimitShapes: if this parameter == 0, then only shapes of
2218 * target type (equal to Limit) are kept in the result,
2219 * else standalone shapes of lower dimension
2220 * are kept also (if they exist).
2222 * After implementation new version of PartitionAlgo (October 2006)
2223 * other parameters are ignored by current functionality. They are kept
2224 * in this function only for supporting old versions.
2225 * Ignored parameters:
2226 * \param theKeepInside Shapes, outside which the results will be deleted.
2227 * Each shape from theKeepInside must belong to theShapes also.
2228 * \param theRemoveInside Shapes, inside which the results will be deleted.
2229 * Each shape from theRemoveInside must belong to theShapes also.
2230 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2231 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2233 * \return New GEOM_Object, containing the result shapes.
2235 GEOM_Object MakePartition (in ListOfGO theShapes,
2236 in ListOfGO theTools,
2237 in ListOfGO theKeepInside,
2238 in ListOfGO theRemoveInside,
2240 in boolean theRemoveWebs,
2241 in ListOfLong theMaterials,
2242 in short theKeepNonlimitShapes);
2245 * Perform partition operation.
2246 * This method may be usefull if it is needed to make a partition for
2247 * a compound containing nonintersected shapes. Performance will be better
2248 * since intersection between shapes from compound is not performed.
2250 * Description of all parameters as in previous method MakePartition()
2252 * \note Passed compounds (via ListShapes or via ListTools)
2253 * have to consist of nonintersecting shapes.
2255 * \return New GEOM_Object, containing the result shapes.
2257 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
2258 in ListOfGO theTools,
2259 in ListOfGO theKeepInside,
2260 in ListOfGO theRemoveInside,
2262 in boolean theRemoveWebs,
2263 in ListOfLong theMaterials,
2264 in short theKeepNonlimitShapes);
2267 * Perform partition of the Shape with the Plane
2268 * \param theShape Shape to be intersected.
2269 * \param thePlane Tool shape, to intersect theShape.
2270 * \return New GEOM_Object, containing the result shape.
2272 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
2273 in GEOM_Object thePlane);
2277 * GEOM_ICurvesOperations: Interface for curves creation.
2278 * Polyline, Circle, Spline (Bezier and Interpolation)
2280 interface GEOM_ICurvesOperations : GEOM_IOperations
2283 * Create a circle with given center, normal vector and radius.
2284 * \param thePnt Circle center.
2285 * \param theVec Vector, normal to the plane of the circle.
2286 * \param theR Circle radius.
2287 * \return New GEOM_Object, containing the created circle.
2289 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
2290 in GEOM_Object theVec,
2293 * Create a circle, passing through three given points
2294 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2295 * \return New GEOM_Object, containing the created circle.
2297 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
2298 in GEOM_Object thePnt2,
2299 in GEOM_Object thePnt3);
2301 * Create a circle with given center, with a radius equals the distance from center to Point1
2302 * and on a plane defined by all of three points.
2303 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
2304 * \return New GEOM_Object, containing the created circle.
2306 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
2307 in GEOM_Object thePnt2,
2308 in GEOM_Object thePnt3);
2310 * Create an ellipse with given center, normal vector and radiuses.
2311 * \param thePnt Ellipse center.
2312 * \param theVec Vector, normal to the plane of the ellipse.
2313 * \param theRMajor Major ellipse radius.
2314 * \param theRMinor Minor ellipse radius.
2315 * \return New GEOM_Object, containing the created ellipse.
2317 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
2318 in GEOM_Object theVec,
2319 in double theRMajor,
2320 in double theRMinor);
2323 * Create an ellipse with given center, normal vector, main axis vector and radiuses.
2324 * \param thePnt Ellipse center.
2325 * \param theVec Vector, normal to the plane of the ellipse.
2326 * \param theRMajor Major ellipse radius.
2327 * \param theRMinor Minor ellipse radius.
2328 * \param theVecMaj Vector, direction of the ellipse's main axis.
2329 * \return New GEOM_Object, containing the created ellipse.
2331 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
2332 in GEOM_Object theVec,
2333 in double theRMajor,
2334 in double theRMinor,
2335 in GEOM_Object theVecMaj);
2338 * Create an arc of circle, passing through three given points.
2339 * \param thePnt1 Start point of the arc.
2340 * \param thePnt2 Middle point of the arc.
2341 * \param thePnt3 End point of the arc.
2342 * \return New GEOM_Object, containing the created arc.
2344 GEOM_Object MakeArc (in GEOM_Object thePnt1,
2345 in GEOM_Object thePnt2,
2346 in GEOM_Object thePnt3);
2349 * Create an arc of circle of center C from one point to another
2350 * \param theCenter Center point of the arc.
2351 * \param thePnt1 Start point of the arc.
2352 * \param thePnt2 End point of the arc.
2353 * \param theSense Orientation of the arc
2354 * \return New GEOM_Object, containing the created arc.
2356 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
2357 in GEOM_Object thePnt1,
2358 in GEOM_Object thePnt2,
2359 in boolean theSense);
2362 * Create an arc of ellipse of center C and two points P1 P2.
2363 * \param theCenter Center point of the arc.
2364 * \param thePnt1 Major radius is distance from center to Pnt1.
2365 * \param thePnt2 define a plane and Minor radius as a shortest distance from Pnt2 to vector Center->Pnt1.
2366 * \return New GEOM_Object, containing the created arc.
2368 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
2369 in GEOM_Object thePnt1,
2370 in GEOM_Object thePnt2);
2374 * Create a polyline on the set of points.
2375 * \param thePoints Sequence of points for the polyline.
2376 * \return New GEOM_Object, containing the created polyline.
2378 GEOM_Object MakePolyline (in ListOfGO thePoints);
2381 * Create bezier curve on the set of points.
2382 * \param thePoints Sequence of points for the bezier curve.
2383 * \return New GEOM_Object, containing the created bezier curve.
2385 GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
2388 * Create B-Spline curve on the set of points.
2389 * \param thePoints Sequence of points for the B-Spline curve.
2390 * \param theIsClosed If TRUE, build a closed curve.
2391 * \return New GEOM_Object, containing the created B-Spline curve.
2393 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
2394 in boolean theIsClosed);
2397 * Create a sketcher (wire or face), following the textual description,
2398 * passed through \a theCommand argument. \n
2399 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
2400 * Format of the description string have to be the following:
2402 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
2405 * - x1, y1 are coordinates of the first sketcher point (zero by default),
2407 * - "R angle" : Set the direction by angle
2408 * - "D dx dy" : Set the direction by DX & DY
2411 * - "TT x y" : Create segment by point at X & Y
2412 * - "T dx dy" : Create segment by point with DX & DY
2413 * - "L length" : Create segment by direction & Length
2414 * - "IX x" : Create segment by direction & Intersect. X
2415 * - "IY y" : Create segment by direction & Intersect. Y
2418 * - "C radius length" : Create arc by direction, radius and length(in degree)
2421 * - "WW" : Close Wire (to finish)
2422 * - "WF" : Close Wire and build face (to finish)
2424 * \param theCommand String, defining the sketcher in local
2425 * coordinates of the working plane.
2426 * \param theWorkingPlane Nine double values, defining origin,
2427 * OZ and OX directions of the working plane.
2428 * \return New GEOM_Object, containing the created wire.
2430 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
2433 * Create a 3D sketcher, following the numerical description,
2434 * passed through points created by \a theCoordinates argument. \n
2435 * Format of the description string have to be the following:
2437 * "Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"
2440 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
2443 * Create a sketcher (wire or face), following the textual description,
2444 * passed through \a theCommand argument. \n
2445 * For format of the description string see the previous method.\n
2446 * \param theCommand String, defining the sketcher in local
2447 * coordinates of the working plane.
2448 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
2449 * \return New GEOM_Object, containing the created wire.
2451 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
2455 * GEOM_ILocalOperations: Interface for fillet and chamfer creation.
2457 interface GEOM_ILocalOperations : GEOM_IOperations
2460 * Perform a fillet on all edges of the given shape.
2461 * \param theShape Shape, to perform fillet on.
2462 * \param theR Fillet radius.
2463 * \return New GEOM_Object, containing the result shape.
2465 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
2469 * Perform a fillet on the specified edges of the given shape
2470 * \param theShape Shape, to perform fillet on.
2471 * \param theR Fillet radius.
2472 * \param theEdges Global indices of edges to perform fillet on.
2473 * \note Global index of sub-shape can be obtained, using method
2474 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2475 * \return New GEOM_Object, containing the result shape.
2477 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
2479 in ListOfLong theEdges);
2480 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
2483 in ListOfLong theEdges);
2486 * Perform a fillet on all edges of the specified faces of the given shape.
2487 * \param theShape Shape, to perform fillet on.
2488 * \param theR Fillet radius.
2489 * \param theFaces Global indices of faces to perform fillet on.
2490 * \note Global index of sub-shape can be obtained, using method
2491 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2492 * \return New GEOM_Object, containing the result shape.
2494 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
2496 in ListOfLong theFaces);
2498 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
2501 in ListOfLong theFaces);
2504 * Perform a fillet on face of the specified vertexes of the given shape.
2505 * \param theShape Shape, to perform fillet on.
2506 * \param theR Fillet radius.
2507 * \param theVertexes Global indices of vertexes to perform fillet on.
2508 * \note Global index of sub-shape can be obtained, using method
2509 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2510 * \return New GEOM_Object, containing the result shape.
2512 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
2514 in ListOfLong theVertexes);
2517 * Perform a fillet on edges of the specified vertexes of the given wire.
2518 * \param theShape Shape, to perform fillet on.
2519 * \param theR Fillet radius.
2520 * \param theVertexes Global indices of vertexes to perform fillet on.
2521 * \note Global index of sub-shape can be obtained, using method
2522 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2523 * \note The list of vertices coudl be empty, in this case fillet fill be done
2524 * at all vertices in given wire
2525 * \return New GEOM_Object, containing the result shape.
2527 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
2529 in ListOfLong theVertexes);
2532 * Perform a symmetric chamfer on all edges of the given shape.
2533 * \param theShape Shape, to perform chamfer on.
2534 * \param theD Chamfer size along each face.
2535 * \return New GEOM_Object, containing the result shape.
2537 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
2541 * Perform a chamfer on edges, common to the specified faces.
2542 * with distance D1 on the Face1
2543 * \param theShape Shape, to perform chamfer on.
2544 * \param theD1 Chamfer size along \a theFace1.
2545 * \param theD2 Chamfer size along \a theFace2.
2546 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
2547 * \note Global index of sub-shape can be obtained, using method
2548 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2549 * \return New GEOM_Object, containing the result shape.
2551 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
2552 in double theD1, in double theD2,
2553 in long theFace1, in long theFace2);
2555 * The Same but with params theD = Chamfer Lenght
2556 * and theAngle = Chamfer Angle (Angle in radians)
2558 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
2559 in double theD, in double theAngle,
2560 in long theFace1, in long theFace2);
2563 * Perform a chamfer on all edges of the specified faces.
2564 * with distance D1 on the first specified face (if several for one edge)
2565 * \param theShape Shape, to perform chamfer on.
2566 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
2567 * connected to the edge, are in \a theFaces, \a theD1
2568 * will be get along face, which is nearer to \a theFaces beginning.
2569 * \param theD2 Chamfer size along another of two faces, connected to the edge.
2570 * \param theFaces Sequence of global indices of faces of \a theShape.
2571 * \note Global index of sub-shape can be obtained, using method
2572 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2573 * \return New GEOM_Object, containing the result shape.
2575 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
2576 in double theD1, in double theD2,
2577 in ListOfLong theFaces);
2579 * The Same but with params theD = Chamfer Lenght
2580 * and theAngle = Chamfer Angle (Angle in radians)
2582 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
2583 in double theD, in double theAngle,
2584 in ListOfLong theFaces);
2587 * Perform a chamfer on edges,
2588 * with distance D1 on the first specified face (if several for one edge)
2589 * \param theShape Shape, to perform chamfer on.
2590 * \param theD1 theD2 Chamfer size
2591 * \param theEdges Sequence of edges of \a theShape.
2592 * \return New GEOM_Object, containing the result shape.
2594 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
2595 in double theD1, in double theD2,
2596 in ListOfLong theEdges);
2598 * The Same but with params theD = Chamfer Lenght
2599 * and theAngle = Chamfer Angle (Angle in radians)
2601 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
2602 in double theD, in double theAngle,
2603 in ListOfLong theEdges);
2606 * Perform an Archimde operation on the given shape with given parameters.
2607 * The object presenting the resulting face is returned
2608 * \param theShape Shape to be put in water.
2609 * \param theWeight Weight og the shape.
2610 * \param theWaterDensity Density of the water.
2611 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
2612 * \return New GEOM_Object, containing a section of \a theShape
2613 * by a plane, corresponding to water level.
2615 GEOM_Object MakeArchimede (in GEOM_Object theShape,
2616 in double theWeight,
2617 in double theWaterDensity,
2618 in double theMeshDeflection);
2621 * Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2622 * Present here only for compatibility.
2624 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
2628 * GEOM_IHealingOperations: Interface for shape healing operations.
2629 * Shape Processing, SuppressFaces, etc.
2631 interface GEOM_IHealingOperations : GEOM_IOperations
2634 * Apply a sequence of Shape Healing operators to the given object.
2635 * \param theShapes Shape to be processed.
2636 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
2637 * \param theParameters List of names of parameters
2638 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
2639 * \param theValues List of values of parameters, in the same order
2640 * as parameters are listed in \a theParameters list.
2641 * \return New GEOM_Object, containing processed shape.
2643 GEOM_Object ProcessShape (in GEOM_Object theShapes,
2644 in string_array theOperators,
2645 in string_array theParameters,
2646 in string_array theValues);
2649 * Get default sequence of operators, their parameters and parameters' values
2650 * of Shape Process operation. In the current implementation the defaults are
2651 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2652 * \param theOperators Output. Default list of names of operators.
2653 * \param theParameters Output. Default list of names of parameters.
2654 * \param theValues Output. List of default values of parameters, in the same order
2655 * as parameters are listed in \a theParameters list.
2657 void GetShapeProcessParameters (out string_array theOperators,
2658 out string_array theParameters,
2659 out string_array theValues);
2661 * Get parameters and parameters' values for the given Shape Process operation.
2662 * In the current implementation the defaults are
2663 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
2664 * \param theOperator Input. The operator's name.
2665 * \param theParameters Output. Default list of names of parameters.
2666 * \param theValues Output. List of default values of parameters, in the same order
2667 * as parameters are listed in \a theParameters list.
2669 void GetOperatorParameters (in string theOperator,
2670 out string_array theParameters,
2671 out string_array theValues);
2674 * Remove faces from the given object (shape).
2675 * \param theObject Shape to be processed.
2676 * \param theFaces Indices of faces to be removed, if EMPTY then the method
2677 * removes ALL faces of the given object.
2678 * \return New GEOM_Object, containing processed shape.
2680 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
2683 * Close an open wire.
2684 * \param theObject Shape to be processed.
2685 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
2686 * if -1, then theObject itself is a wire.
2687 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
2688 * If FALS : closure by creation of an edge between ends.
2689 * \return New GEOM_Object, containing processed shape.
2691 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
2692 in boolean isCommonVertex);
2695 * Remove internal wires and edges from the given object (face).
2696 * \param theObject Shape to be processed.
2697 * \param theWires Indices of wires to be removed, if EMPTY then the method
2698 * removes ALL internal wires of the given object.
2699 * \return New GEOM_Object, containing processed shape.
2701 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
2704 * Remove internal closed contours (holes) from the given object.
2705 * \param theObject Shape to be processed.
2706 * \param theWires Indices of wires to be removed, if EMPTY then the method
2707 * removes ALL internal holes of the given object
2708 * \return New GEOM_Object, containing processed shape.
2710 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
2713 * Sewing of the given object.
2714 * \param theObject Shape to be processed.
2715 * \param theTolerance Required tolerance value.
2716 * \return New GEOM_Object, containing processed shape.
2718 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
2721 * Addition of a point to a given edge object.
2722 * \param theObject Shape to be processed.
2723 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
2724 * if -1, then theObject itself is the edge.
2725 * \param theValue Value of parameter on edge or length parameter,
2726 * depending on \a isByParameter.
2727 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
2728 * if FALSE : \a theValue is treated as a length parameter [0..1]
2729 * \return New GEOM_Object, containing processed shape.
2731 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
2732 in double theValue, in boolean isByParameter);
2735 * Get a list of wires (wrapped in GEOM_Object-s),
2736 * that constitute a free boundary of the given shape.
2737 * \param theObject Shape to get free boundary of.
2738 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
2739 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
2740 * \return FALSE, if an error(s) occured during the method execution.
2742 boolean GetFreeBoundary (in GEOM_Object theObject,
2743 out ListOfGO theClosedWires,
2744 out ListOfGO theOpenWires);
2747 * Change orientation of the given object.
2748 * \param theObject Shape to be processed.
2749 * \return New GEOM_Object, containing processed shape.
2751 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
2752 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
2755 * Try to limit tolerance of the given object by value \a theTolerance.
2756 * \param theObject Shape to be processed.
2757 * \param theTolerance Required tolerance value.
2758 * \return New GEOM_Object, containing processed shape.
2760 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
2765 * GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
2768 interface GEOM_IInsertOperations : GEOM_IOperations
2771 * Create a copy of the given object
2773 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
2776 * Export the given shape into a file with given name.
2777 * \param theObject Shape to be stored in the file.
2778 * \param theFileName Name of the file to store the given shape in.
2779 * \param theFormatName Specify format for the shape storage.
2780 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2782 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
2785 * Import a shape from the BRep or IGES or STEP file
2786 * (depends on given format) with given name.
2787 * \param theFileName The file, containing the shape.
2788 * \param theFormatName Specify format for the file reading.
2789 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
2790 * If format 'IGES_SCALE' is used instead 'IGES' length unit will be
2791 * set to 'meter' and result model will be scaled.
2792 * \return New GEOM_Object, containing the imported shape.
2794 GEOM_Object Import (in string theFileName, in string theFormatName);
2797 * Get the supported import formats and corresponding patterns for File dialog.
2798 * \param theFormats Output. List of formats, available for import.
2799 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2800 * \return Returns available formats and patterns through the arguments.
2802 void ImportTranslators (out string_array theFormats,
2803 out string_array thePatterns);
2806 * Get the supported export formats and corresponding patterns for File dialog.
2807 * \param theFormats Output. List of formats, available for export.
2808 * \param thePatterns Output. List of file patterns, corresponding to available formats.
2809 * \return Returns available formats and patterns through the arguments.
2811 void ExportTranslators (out string_array theFormats,
2812 out string_array thePatterns);
2815 * Load texture from file
2816 * \param theTextureFile texture file name
2817 * \return unique texture identifier
2819 long LoadTexture(in string theTextureFile);
2822 * Add texture to the study
2823 * \param theWidth texture width in pixels
2824 * \param theHeight texture height in pixels
2825 * \param theTexture texture byte array
2826 * \return unique texture identifier
2828 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
2831 * Get previously loaded texture data
2832 * \param theID texture identifier
2833 * \param theWidth texture width in pixels
2834 * \param theHeight texture height in pixels
2835 * \return texture byte array
2837 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
2840 * Get list of all avaiable texture IDs
2841 * \return list of all texture IDs avaiable for the current study
2843 ListOfLong GetAllTextures();
2847 * GEOM_IKindOfShape: namespace for shape_kind enumeration.
2849 interface GEOM_IKindOfShape
2859 SPHERE, // full sphere
2860 CYLINDER, // cylinder
2861 BOX, // box with faces, parallel to global coordinate planes
2862 ROTATED_BOX, // other box
2863 TORUS, // full torus
2865 POLYHEDRON, // solid, bounded by polygons
2866 SOLID, // other solid
2868 SPHERE2D, // spherical face (closed)
2869 CYLINDER2D, // cylindrical face with defined height
2870 TORUS2D, // toroidal face (closed)
2871 CONE2D, // conical face with defined height
2872 DISK_CIRCLE, // planar, bounded by circle
2873 DISK_ELLIPSE, // planar, bounded by ellipse
2874 POLYGON, // planar, bounded by segments
2875 PLANE, // infinite planar
2876 PLANAR, // other planar
2879 CIRCLE, // full circle
2880 ARC_CIRCLE, // arc of circle
2881 ELLIPSE, // full ellipse
2882 ARC_ELLIPSE, // arc of ellipse
2883 LINE, // infinite segment
2889 ADVANCED // all advanced shapes (temporary implementation)
2895 * GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
2896 * properties calculation (like Centre of Mass, Inertia, etc.).
2899 interface GEOM_IMeasureOperations : GEOM_IOperations
2902 * Get kind of theShape.
2903 * \param theShape Shape to get a kind of.
2904 * \param theIntegers Output. Integer and enumerated shape's parameters
2905 * (kind of surface, closed/unclosed, number of edges, etc.)
2906 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
2907 * \note Concrete meaning of each value, returned via \a theIntegers
2908 * or \a theDoubles list depends on the kind of the shape.
2909 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
2911 //short KindOfShape (in GEOM_Object theShape,
2912 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
2913 out ListOfLong theIntegers,
2914 out ListOfDouble theDoubles);
2917 * Get position (LCS) of theShape.
2918 * \param theShape Shape to calculate position of.
2919 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
2920 * Origin of the LCS is situated at the shape's center of mass.
2921 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
2922 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
2923 * Axes of the LCS are obtained from shape's location or,
2924 * if the shape is a planar face, from position of its plane.
2925 * \return Returns position of the shape through the last nine arguments.
2927 void GetPosition (in GEOM_Object theShape,
2928 out double Ox, out double Oy, out double Oz,
2929 out double Zx, out double Zy, out double Zz,
2930 out double Xx, out double Xy, out double Xz);
2933 * Get summarized length of all wires,
2934 * area of surface and volume of the given shape.
2935 * \param theShape Shape to define properties of.
2936 * \param theLength Output. Summarized length of all wires of the given shape.
2937 * \param theSurfArea Output. Area of surface of the given shape.
2938 * \param theVolume Output. Volume of the given shape.
2939 * \return Returns shape properties through the last three arguments.
2941 void GetBasicProperties (in GEOM_Object theShape,
2942 out double theLength,
2943 out double theSurfArea,
2944 out double theVolume);
2947 * Get a point, situated at the centre of mass of theShape.
2948 * \param theShape Shape to define centre of mass of.
2949 * \return New GEOM_Object, containing the created point.
2951 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
2955 * Get the vertex by index for 1D objects depends the edge/wire orientation
2956 * \param theShape Shape (wire or edge) to find the vertex on it
2957 * \param theIndex Index of vertex subshape
2958 * \return New GEOM_Object, vertex.
2960 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
2963 * Get a vector, representing the normal of theFace.
2964 * If the face is not planar, theOptionalPoint is obligatory.
2965 * \param theFace Shape (face) to define the normal of.
2966 * \param theOptionalPoint Shape (point) to define the normal at.
2967 * Can be NULL in case of planar face.
2968 * \return New GEOM_Object, containing the created normal vector.
2970 GEOM_Object GetNormal (in GEOM_Object theFace,
2971 in GEOM_Object theOptionalPoint);
2974 * Get inertia matrix and moments of inertia of theShape.
2975 * \param theShape Shape to calculate inertia of.
2976 * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
2977 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
2978 * \return Returns inertia through the last twelve arguments.
2980 void GetInertia (in GEOM_Object theShape,
2981 out double I11, out double I12, out double I13,
2982 out double I21, out double I22, out double I23,
2983 out double I31, out double I32, out double I33,
2984 out double Ix , out double Iy , out double Iz);
2987 * Get parameters of bounding box of the given shape
2988 * \param theShape Shape to obtain bounding box of.
2989 * \param Xmin,Xmax Output. Limits of shape along OX axis.
2990 * \param Ymin,Ymax Output. Limits of shape along OY axis.
2991 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
2992 * \return Returns parameters of bounding box through the last six arguments.
2994 void GetBoundingBox (in GEOM_Object theShape,
2995 out double Xmin, out double Xmax,
2996 out double Ymin, out double Ymax,
2997 out double Zmin, out double Zmax);
3000 * Get min and max tolerances of sub-shapes of theShape
3001 * \param theShape Shape, to get tolerances of.
3002 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3003 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
3004 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
3005 * \return Returns shape tolerances through the last six arguments.
3007 void GetTolerance (in GEOM_Object theShape,
3008 out double FaceMin, out double FaceMax,
3009 out double EdgeMin, out double EdgeMax,
3010 out double VertMin, out double VertMax);
3013 * Check a topology of the given shape.
3014 * \param theShape Shape to check validity of.
3015 * \param theDescription Output. Description of problems in the shape, if they are.
3016 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
3018 boolean CheckShape (in GEOM_Object theShape,
3019 out string theDescription);
3022 * Check a topology and a geometry of the given shape.
3023 * \param theShape Shape to check validity of.
3024 * \param theDescription Output. Description of problems in the shape, if they are.
3025 * \return TRUE, if the shape "seems to be valid".
3027 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
3028 out string theDescription);
3031 * Obtain description of the given shape
3032 * \param theShape Shape to be described.
3033 * \return Description of the given shape.
3035 string WhatIs (in GEOM_Object theShape);
3038 * Get minimal distance between the given shapes.
3039 * \param theShape1,theShape2 Shapes to find minimal distance between.
3040 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
3041 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
3042 * \return Value of the minimal distance between the given shapes.
3044 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
3045 out double X1, out double Y1, out double Z1,
3046 out double X2, out double Y2, out double Z2);
3049 * Get angle between the given lines or linear edges.
3050 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
3051 * \return Value of the angle between the given shapes.
3053 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
3056 * Get point coordinates
3058 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
3061 * Get radius of curvature of curve in the point determinated by param
3062 * \param theShape - curve.
3063 * \param theParam - parameter on curve
3064 * \return Value of curvature.
3066 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
3069 * Get radius of curvature of curve in the given point
3070 * \param theShape - curve.
3071 * \param thePoint - point
3072 * \return Value of curvature.
3074 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3077 * Get max radius of curvature of surface in the point determinated by params
3078 * \param theShape - surface.
3079 * \param theUParam - U-parameter on surface
3080 * \param theVParam - V-parameter on surface
3081 * \return Value of curvature.
3083 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3084 in double theVParam);
3087 * Get max radius of curvature of surface in the given point
3088 * \param theShape - surface.
3089 * \param thePoint - point
3090 * \return Value of curvature.
3092 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3095 * Get min radius of curvature of surface in the point determinated by params
3096 * \param theShape - surface.
3097 * \param theUParam - U-parameter on surface
3098 * \param theVParam - V-parameter on surface
3099 * \return Value of curvature.
3101 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
3102 in double theVParam);
3105 * Get min radius of curvature of surface in the given point
3106 * \param theShape - surface.
3107 * \param thePoint - point
3108 * \return Value of curvature.
3110 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
3116 * GEOM_IGroupOperations: Interface for groups creation.
3118 interface GEOM_IGroupOperations : GEOM_IOperations
3121 * Creates a new group which will store sub shapes of theMainShape
3122 * \param theMainShape is a GEOM object on which the group is selected
3123 * \param theShapeType defines a shape type of the group
3124 * \return a newly created GEOM group
3126 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
3129 * Adds a sub object with ID theSubShapeId to the group
3130 * \param theGroup is a GEOM group to which the new sub shape is added
3131 * \param theSubShapeId is a sub shape ID in the main object.
3132 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3134 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
3137 * Removes a sub object with ID \a theSubShapeId from the group
3138 * \param theGroup is a GEOM group from which the sub shape is removed.
3139 * \param theSubShapeId is a sub shape ID in the main object.
3140 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
3142 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
3145 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3146 * \param theGroup is a GEOM group to which the new sub shapes are added.
3147 * \param theSubShapes is a list of sub shapes to be added.
3149 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3152 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3153 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3154 * \param theSubShapes is a list of sub-shapes to be removed.
3156 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
3159 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
3160 * \param theGroup is a GEOM group to which the new sub shapes are added.
3161 * \param theSubShapes is a list of IDs of sub shapes to be added.
3163 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3166 * Removes from the group all the given shapes. No errors, if some shapes are not included.
3167 * \param theGroup is a GEOM group from which the sub-shapes are removed.
3168 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
3170 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
3173 * Returns a type of sub objects stored in the group
3174 * \param theGroup is a GEOM group which type is returned.
3176 long GetType (in GEOM_Object theGroup);
3179 * Returns a main shape associated with the group
3180 * \param theGroup is a GEOM group for which a main shape object is requested
3181 * \return a GEOM object which is a main shape for theGroup
3183 GEOM_Object GetMainShape (in GEOM_Object theGroup);
3186 * Returns a list of sub objects ID stored in the group
3187 * \param theGroup is a GEOM group for which a list of IDs is requested
3189 ListOfLong GetObjects (in GEOM_Object theGroup);
3194 * GEOM_IAdvancedOperations: Interface for advanced modeling functions.
3196 interface GEOM_IAdvancedOperations : GEOM_IOperations
3199 * Create a T-shape object with specified caracteristics for the main and
3200 * the incident pipes (radius, width, half-length).
3201 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3202 * \param theR1 Internal radius of main pipe
3203 * \param theW1 Width of main pipe
3204 * \param theL1 Half-length of main pipe
3205 * \param theR2 Internal radius of incident pipe (R2 < R1)
3206 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3207 * \param theL2 Half-length of incident pipe
3208 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3209 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3211 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
3212 in double theR2, in double theW2, in double theL2,
3213 in boolean theHexMesh);
3215 * Create a T-shape object with specified caracteristics for the main and
3216 * the incident pipes (radius, width, half-length).
3217 * The extremities of the main pipe are located on junctions points P1 and P2.
3218 * The extremity of the incident pipe is located on junction point P3.
3219 * \param theR1 Internal radius of main pipe
3220 * \param theW1 Width of main pipe
3221 * \param theL1 Half-length of main pipe
3222 * \param theR2 Internal radius of incident pipe (R2 < R1)
3223 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3224 * \param theL2 Half-length of incident pipe
3225 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3226 * \param theP1 1st junction point of main pipe
3227 * \param theP2 2nd junction point of main pipe
3228 * \param theP3 Junction point of incident pipe
3229 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3231 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
3232 in double theR2, in double theW2, in double theL2,
3233 in boolean theHexMesh,
3234 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3236 * Create a T-shape object with specified caracteristics for the main and
3237 * the incident pipes (radius, width, half-length). A chamfer is created
3238 * on the junction of the pipes.
3239 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3240 * \param theR1 Internal radius of main pipe
3241 * \param theW1 Width of main pipe
3242 * \param theL1 Half-length of main pipe
3243 * \param theR2 Internal radius of incident pipe (R2 < R1)
3244 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3245 * \param theL2 Half-length of incident pipe
3246 * \param theH Height of the chamfer.
3247 * \param theW Width of the chamfer.
3248 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3249 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3251 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
3252 in double theR2, in double theW2, in double theL2,
3253 in double theH, in double theW, in boolean theHexMesh);
3255 * Create a T-shape object with specified caracteristics for the main and
3256 * the incident pipes (radius, width, half-length). A chamfer is created
3257 * on the junction of the pipes.
3258 * The extremities of the main pipe are located on junctions points P1 and P2.
3259 * The extremity of the incident pipe is located on junction point P3.
3260 * \param theR1 Internal radius of main pipe
3261 * \param theW1 Width of main pipe
3262 * \param theL1 Half-length of main pipe
3263 * \param theR2 Internal radius of incident pipe (R2 < R1)
3264 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3265 * \param theL2 Half-length of incident pipe
3266 * \param theH Height of the chamfer.
3267 * \param theW Width of the chamfer.
3268 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3269 * \param theP1 1st junction point of main pipe
3270 * \param theP2 2nd junction point of main pipe
3271 * \param theP3 Junction point of incident pipe
3272 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3274 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
3275 in double theR2, in double theW2, in double theL2,
3276 in double theH, in double theW, in boolean theHexMesh,
3277 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3279 * Create a T-shape object with specified caracteristics for the main and
3280 * the incident pipes (radius, width, half-length). A fillet is created
3281 * on the junction of the pipes.
3282 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
3283 * \param theR1 Internal radius of main pipe
3284 * \param theW1 Width of main pipe
3285 * \param theL1 Half-length of main pipe
3286 * \param theR2 Internal radius of incident pipe (R2 < R1)
3287 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3288 * \param theL2 Half-length of incident pipe
3289 * \param theRF Radius of curvature of fillet.
3290 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3291 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3293 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
3294 in double theR2, in double theW2, in double theL2,
3295 in double theRF, in boolean theHexMesh);
3297 * Create a T-shape object with specified caracteristics for the main and
3298 * the incident pipes (radius, width, half-length). A fillet is created
3299 * on the junction of the pipes.
3300 * The extremities of the main pipe are located on junctions points P1 and P2.
3301 * The extremity of the incident pipe is located on junction point P3.
3302 * \param theR1 Internal radius of main pipe
3303 * \param theW1 Width of main pipe
3304 * \param theL1 Half-length of main pipe
3305 * \param theR2 Internal radius of incident pipe (R2 < R1)
3306 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
3307 * \param theL2 Half-length of incident pipe
3308 * \param theRF Radius of curvature of fillet.
3309 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
3310 * \param theP1 1st junction point of main pipe
3311 * \param theP2 2nd junction point of main pipe
3312 * \param theP3 Junction point of incident pipe
3313 * \return List of GEOM_Objects, containing the created shape and propagation groups.
3315 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
3316 in double theR2, in double theW2, in double theL2,
3317 in double theRF, in boolean theHexMesh,
3318 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
3319 /*@@ insert new functions before this line @@ do not remove this line @@*/
3323 * GEOM_Gen: Interface to access other GEOM interfaces.
3324 * Also contains some methods to access and manage GEOM objects.
3326 interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
3329 * Undo/Redo Management
3332 void Undo (in long theStudyID);
3334 void Redo (in long theStudyID);
3337 * Publishing management
3338 * Adds in theStudy a object theObject under with a name theName,
3339 * if theFather is not NULL the object is placed under thFather's SObject.
3340 * Returns a SObject where theObject is placed
3342 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
3343 in GEOM_Object theObject,
3345 in GEOM_Object theFather);
3348 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3349 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3350 * \param theStudy the study, in which theObject is published already,
3351 * and in which the arguments will be published
3352 * \param theObject published GEOM object, arguments of which will be published
3353 * \param theArgs list of GEOM_Object, operation arguments to be published.
3354 * If this list is empty, all operation arguments will be published
3355 * \param theFindMethod method to search subshapes, corresponding to arguments and
3356 * their subshapes. Value from enumeration GEOM::find_shape_method.
3357 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3358 * Do not publish subshapes in place of arguments, but only
3359 * in place of subshapes of the first argument,
3360 * because the whole shape corresponds to the first argument.
3361 * Mainly to be used after transformations, but it also can be
3362 * usefull after partition with one object shape, and some other
3363 * operations, where only the first argument has to be considered.
3364 * If theObject has only one argument shape, this flag is automatically
3365 * considered as True, not regarding really passed value.
3366 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3367 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3368 * \return list of published sub-shapes
3370 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
3371 in GEOM_Object theObject,
3372 in ListOfGO theArgs,
3373 in find_shape_method theFindMethod,
3374 in boolean theInheritFirstArg,
3375 in boolean theAddPrefix);
3378 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3379 * To be used from python scripts out of geompy.addToStudy (non-default usage)
3380 * \param theStudy the study, in which theObject is published already,
3381 * and in which the arguments will be published
3382 * \param theObject published GEOM object, arguments of which will be published
3383 * \param theArgs list of GEOM_Object, operation arguments to be published.
3384 * If this list is empty, all operation arguments will be published
3385 * \param theFindMethod method to search subshapes, corresponding to arguments and
3386 * their subshapes. Value from enumeration GEOM::find_shape_method.
3387 * \param theInheritFirstArg set properties of the first argument for \a theObject.
3388 * Do not publish subshapes in place of arguments, but only
3389 * in place of subshapes of the first argument,
3390 * because the whole shape corresponds to the first argument.
3391 * Mainly to be used after transformations, but it also can be
3392 * usefull after partition with one object shape, and some other
3393 * operations, where only the first argument has to be considered.
3394 * If theObject has only one argument shape, this flag is automatically
3395 * considered as True, not regarding really passed value.
3396 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
3397 * and prefix "from_subshapes_of_" to names of partially restored subshapes.
3398 * \return list of published sub-shapes
3400 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
3401 in GEOM_Object theObject,
3402 in ListOfGO theArgs,
3403 in find_shape_method theFindMethod,
3404 in boolean theInheritFirstArg,
3405 in boolean theAddPrefix);
3408 * Publish sub-shapes, standing for arguments and sub-shapes of arguments
3409 * To be used from GUI and from geompy.addToStudy.
3410 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
3411 * \param theSObject study object, referencing GEOM object, arguments of which will be published
3413 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
3414 in SALOMEDS::SObject theSObject,
3415 in ListOfGO theArgs,
3416 in find_shape_method theFindMethod,
3417 in boolean theInheritFirstArg,
3418 in boolean theAddPrefix);
3421 * Methods to access interfaces for objects creation and transformation
3423 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3424 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
3425 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3426 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3427 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3428 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3429 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3430 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3431 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3432 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3433 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3434 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3435 GEOM_IAdvancedOperations GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
3438 * Objects Management
3442 * Removes the object from the GEOM component
3443 * \param theObject is a GEOM object to be removed
3445 void RemoveObject (in GEOM_Object theObject);
3448 * Returns an object defined by the study and its entry in the GEOM component
3449 * \param theStudyID is a SALOMEDS Study ID
3450 * \param theEntry is an entry of the requested GEOM object in the GEOM component
3451 * \note if the object has not previously been created a NULL GEOM object is returned
3453 GEOM_Object GetObject (in long theStudyID, in string theEntry);
3456 * Add a sub shape defined by indices in \a theIndices
3457 * (contains unique IDs of sub shapes inside theMainShape)
3458 * \note The sub shape GEOM_Objects can has ONLY ONE function.
3459 * Don't try to apply modification operations on them.
3460 * \note Internal method
3462 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
3465 * GEOM object's IOR Management
3469 * Returns a GEOM Object defined by its IOR
3470 * \param theIOR a string containg an IOR of the requested GEOM object
3472 GEOM_Object GetIORFromString (in string theIOR);
3475 * Returns a string which contains an IOR of the GEOM object
3476 * \param theObject is a GEOM object which IOR is requested
3478 string GetStringFromIOR (in GEOM_Object theObject);
3481 * Returns a name with which a GEOM object was dumped into python script
3482 * \param theStudyEntry is an entry of the GEOM object in the study
3484 string GetDumpName (in string theStudyEntry);
3487 * Returns all names with which a GEOM objects was dumped
3488 * into python script to avoid the same names in SMESH script
3490 string_array GetAllDumpNames();
3493 * Publishes the named subshapes of given object in the study.
3494 * \param theStudy The study in which the object is published
3495 * \param theObject The object which named subshapes are published
3497 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
3498 //in SObject theSObject,
3499 in Object theObject);
