2 // Author : Sergey RUIN
7 #include "SALOME_Exception.idl"
8 #include "SALOME_Component.idl"
9 #include "SALOMEDS.idl"
11 #include "SALOME_GenericObj.idl"
16 * Topological types of shapes (like Open Cascade types)
18 enum shape_type { COMPOUND, COMPSOLID, SOLID, SHELL,
19 FACE, WIRE, EDGE, VERTEX, SHAPE };
23 * State of shape relatively geometrical surface like plane, sphere or cylinder.
24 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
28 /*! Shape is on surface */
32 * Shape is in the direction defined by the normal and not on surface.
33 * For plane it means above the plane,
34 * For sphere and cylinder it means outside of volume, bounded by the surface.
39 * Shape is in the direction defined by the normal and on surface.
45 * Complementary to ONOUT.
46 * For plane it means below the plane,
47 * For sphere and cylinder it means inside the volume, bounded by the surface
48 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
53 * Complementary to OUT.
59 typedef sequence<string> string_array;
60 typedef sequence<short> short_array;
61 typedef sequence<long> ListOfLong;
62 typedef sequence<double> ListOfDouble;
64 interface GEOM_Object;
66 typedef sequence<GEOM_Object> ListOfGO;
69 * GEOM_Object: interface of geometric object
71 interface GEOM_Object : SALOME::GenericObj
75 * Get an entry of the object in GEOM component.
80 * Get ID of study, where the object is created.
85 * Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
90 * Get a <VAR>shape_type</VAR> of the object value.
92 shape_type GetShapeType();
95 * Set name of the object.
96 * \param theName is a name which will be associated with this object.
98 void SetName (in string theName);
101 * Get name of the object associated with this object.
106 * Set a Study entry where this object was published.
108 void SetStudyEntry (in string theEntry);
111 * Get a Study entry where this object was published.
113 string GetStudyEntry();
116 * Get a list of all GEOM objects on which were the arguments
117 * when this object was constructed and modified.
118 * \note This method is supposed to be used by GUI only.
120 ListOfGO GetDependency();
123 * Get a list of GEOM objects on which the last function that created or modified the object depends.
124 * \note This method is supposed to be used by GUI only.
126 ListOfGO GetLastDependency();
129 * Get the TopoDS_Shape, for colocated case only.
134 ######################################################################
135 * Internal methods (For sub shape identification)
136 ######################################################################
140 * Get geometric shape of the object as a byte stream
142 SALOMEDS::TMPFile GetShapeStream();
145 * Returns True if this object is not a sub shape of another object.
147 boolean IsMainShape();
150 * Get a list of ID's of sub shapes in the main shape.
151 * \note Internal method, suppopsed to be used only by GEOM_Client
153 ListOfLong GetSubShapeIndices();
156 * Get a main shape object to which this object is a sub shape
157 * \note Internal method, suppopsed to be used only by GEOM_Client
159 GEOM_Object GetMainShape();
162 * Return true if geom object representes a shape.
163 * For example, method return false for GEOM_MARKER
170 * GEOM_IOperations: basic methods of all geometric operations
172 interface GEOM_IOperations : SALOME::GenericObj
175 * To know, if the operation was successfully performed
180 * Set the operation error code
181 * \param theErrorID is a string describing the error occured
182 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
184 void SetErrorCode (in string theErrorID);
187 * Get the operation error code
189 string GetErrorCode();
192 * Get ID of study, where the operation is defined
197 * Opens a new transaction
199 void StartOperation();
202 * Closes the previously opened trasaction
204 void FinishOperation();
207 * Aborts the previously opened transaction
209 void AbortOperation();
213 * GEOM_IBasicOperations: interface for basic geometry creation
214 * (Point, Vector, Plane, Marker)
216 interface GEOM_IBasicOperations : GEOM_IOperations
219 * Create point by three coordinates.
220 * \param theX The X coordinate of the point.
221 * \param theY The Y coordinate of the point.
222 * \param theZ The Z coordinate of the point.
223 * \return New GEOM_Object, containing the created point.
225 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
228 * Create a point, distant from the referenced point
229 * on the given distances along the coordinate axes.
230 * \param theReference The referenced point.
231 * \param theX Displacement from the referenced point along OX axis.
232 * \param theY Displacement from the referenced point along OY axis.
233 * \param theZ Displacement from the referenced point along OZ axis.
234 * \return New GEOM_Object, containing the created point.
236 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
237 in double theX, in double theY, in double theZ);
240 * Create a point, corresponding to the given parameter on the given curve.
241 * \param theRefCurve The referenced curve.
242 * \param theParameter Value of parameter on the referenced curve.
243 * \return New GEOM_Object, containing the created point.
245 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
246 in double theParameter);
249 * Create a vector with the given components.
250 * \param theDX X component of the vector.
251 * \param theDY Y component of the vector.
252 * \param theDZ Z component of the vector.
253 * \return New GEOM_Object, containing the created vector.
255 GEOM_Object MakeVectorDXDYDZ (in double theDX,
260 * Create a vector between two points.
261 * \param thePnt1 Start point for the vector.
262 * \param thePnt2 End point for the vector.
263 * \return New GEOM_Object, containing the created vector.
265 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
268 * Create a line, passing through the given point
269 * and parrallel to the given direction
270 * \param thePnt Point. The resulting line will pass through it.
271 * \param theDir Direction. The resulting line will be parallel to it.
272 * \return New GEOM_Object, containing the created line.
274 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
277 * Create a line, passing through the given points
278 * \param thePnt1 First of two points, defining the line.
279 * \param thePnt2 Second of two points, defining the line.
280 * \return New GEOM_Object, containing the created line.
282 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
285 * Create a plane, passing through the three given points
286 * \param thePnt1 First of three points, defining the plane.
287 * \param thePnt2 Second of three points, defining the plane.
288 * \param thePnt3 Fird of three points, defining the plane.
289 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
290 * \return New GEOM_Object, containing the created plane.
292 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
293 in GEOM_Object thePnt2,
294 in GEOM_Object thePnt3,
295 in double theTrimSize);
298 * Create a plane, passing through the given point
299 * and normal to the given vector.
300 * \param thePnt Point, the plane has to pass through.
301 * \param theVec Vector, defining the plane normal direction.
302 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
303 * \return New GEOM_Object, containing the created plane.
305 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
306 in GEOM_Object theVec,
307 in double theTrimSize);
310 * Create a plane, similar to the existing one, but with another size of representing face.
311 * \param theFace Referenced plane.
312 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
313 * \return New GEOM_Object, containing the created plane.
315 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
316 in double theTrimSize);
319 * Create a local coordinate system.
320 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
321 * \param theXDX,theXDY,theXDZ Three components of OX direction
322 * \param theYDX,theYDY,theYDZ Three components of OY direction
323 * \return New GEOM_Object, containing the created coordinate system.
325 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
326 in double theXDX, in double theXDY, in double theXDZ,
327 in double theYDX, in double theYDY, in double theYDZ);
330 interface GEOM_ITransformOperations : GEOM_IOperations
333 * Translate the given object along the vector, specified by its end points.
334 * \param theObject The object to be translated.
335 * \param thePoint1 Start point of translation vector.
336 * \param thePoint2 End point of translation vector.
339 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
340 in GEOM_Object thePoint1,
341 in GEOM_Object thePoint2);
344 * Translate the given object along the vector, specified
345 * by its end points, creating its copy before the translation.
346 * \param theObject The object to be translated.
347 * \param thePoint1 Start point of translation vector.
348 * \param thePoint2 End point of translation vector.
349 * \return New GEOM_Object, containing the translated object.
351 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
352 in GEOM_Object thePoint1,
353 in GEOM_Object thePoint2);
356 * Translate the given object along the vector, specified by its components.
357 * \param theObject The object to be translated.
358 * \param theDX,theDY,theDZ Components of translation vector.
361 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
362 in double theDX, in double theDY, in double theDZ);
365 * Translate the given object along the vector, specified
366 * by its components, creating its copy before the translation.
367 * \param theObject The object to be translated.
368 * \param theDX,theDY,theDZ Components of translation vector.
369 * \return New GEOM_Object, containing the translated object.
371 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
372 in double theDX, in double theDY, in double theDZ);
376 * Translate the given object along the given vector.
377 * \param theObject The object to be translated.
378 * \param theVector Translation vector, giving both direction and distance.
381 GEOM_Object TranslateVector (in GEOM_Object theObject,
382 in GEOM_Object theVector);
385 * Translate the given object along the given vector,
386 * creating its copy before the translation.
387 * \param theObject The object to be translated.
388 * \param theVector Translation vector, giving both direction and distance.
389 * \return New GEOM_Object, containing the translated object.
391 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
392 in GEOM_Object theVector);
395 * Translate the given object along the given vector a given number times
396 * \param theObject The object to be translated.
397 * \param theVector Direction of the translation.
398 * \param theStep Distance to translate on.
399 * \param theNbTimes Quantity of translations to be done.
400 * \return New GEOM_Object, containing compound of all
401 * the shapes, obtained after each translation.
403 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
404 in GEOM_Object theVector,
409 * Conseqently apply two specified translations to theObject specified number of times.
410 * \param theObject The object to be translated.
411 * \param theVector1 Direction of the first translation.
412 * \param theStep1 Step of the first translation.
413 * \param theNbTimes1 Quantity of translations to be done along theVector1.
414 * \param theVector2 Direction of the second translation.
415 * \param theStep2 Step of the second translation.
416 * \param theNbTimes2 Quantity of translations to be done along theVector2.
417 * \return New GEOM_Object, containing compound of all
418 * the shapes, obtained after each translation.
420 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
421 in GEOM_Object theVector1,
424 in GEOM_Object theVector2,
426 in long theNbTimes2);
429 * Rotate the given object around the given axis on the given angle.
430 * \param theObject The object to be rotated.
431 * \param theAxis Rotation axis.
432 * \param theAngle Rotation angle in radians.
435 GEOM_Object Rotate (in GEOM_Object theObject,
436 in GEOM_Object theAxis,
440 * Rotate the given object around the given axis
441 * on the given angle, creating its copy before the rotatation.
442 * \param theObject The object to be rotated.
443 * \param theAxis Rotation axis.
444 * \param theAngle Rotation angle in radians.
445 * \return New GEOM_Object, containing the rotated object.
447 GEOM_Object RotateCopy (in GEOM_Object theObject,
448 in GEOM_Object theAxis,
452 * Rotate the given object around the given axis a given number times.
453 * Rotation angle will be 2*PI/theNbTimes.
454 * \param theObject The object to be rotated.
455 * \param theAxis The rotation axis.
456 * \param theNbTimes Quantity of rotations to be done.
457 * \return New GEOM_Object, containing compound of all the
458 * shapes, obtained after each rotation.
460 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
461 in GEOM_Object theAxis,
465 * Rotate the given object around the
466 * given axis on the given angle a given number
467 * times and multi-translate each rotation result.
468 * Translation direction passes through center of gravity
469 * of rotated shape and its projection on the rotation axis.
470 * \param theObject The object to be rotated.
471 * \param theAxis Rotation axis.
472 * \param theAngle Rotation angle in graduces.
473 * \param theNbTimes1 Quantity of rotations to be done.
474 * \param theStep Translation distance.
475 * \param theNbTimes2 Quantity of translations to be done.
476 * \return New GEOM_Object, containing compound of all the
477 * shapes, obtained after each transformation.
479 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
480 in GEOM_Object theAxis,
484 in long theNbTimes2);
487 * Replace the given object by an object,
488 * symmetrical to it relatively the given plane.
489 * \param theObject The object to be mirrored.
490 * \param thePlane Plane of symmetry.
492 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
495 * Create an object, symmetrical
496 * to the given one relatively the given plane.
497 * \param theObject The object to be mirrored.
498 * \param thePlane Plane of symmetry.
499 * \return New GEOM_Object, containing the mirrored shape.
501 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
504 * Replace the given object by an object,
505 * symmetrical to it relatively the given axis.
506 * \param theObject The object to be mirrored.
507 * \param theAxis Axis of symmetry.
510 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
513 * Create an object, symmetrical
514 * to the given one relatively the given axis.
515 * \param theObject The object to be mirrored.
516 * \param theAxis Axis of symmetry.
517 * \return New GEOM_Object, containing the mirrored object.
519 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
522 * Replace the given object by an object, symmetrical to it relatively the given point.
523 * \param theObject The object to be mirrored.
524 * \param thePoint Point of symmetry.
527 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
530 * Create an object, symmetrical to the given one relatively the given point.
531 * \param theObject The object to be mirrored.
532 * \param thePoint Point of symmetry.
533 * \return New GEOM_Object, containing the mirrored object.
535 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
538 * Replace the given object by its offset.
539 * \param theObject The base object for the offset.
540 * \param theOffset Offset value.
543 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
546 * Create new object as offset of the given one.
547 * \param theObject The base object for the offset.
548 * \param theOffset Offset value.
549 * \return New GEOM_Object, containing the offset object.
551 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
554 * Scale the given object by the factor.
555 * \param theObject The object to be scaled.
556 * \param thePoint Center point for scaling.
557 * \param theFactor Scaling factor value.
560 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
561 in double theFactor);
564 * Scale the given object by the factor, creating its copy before the scaling.
565 * \param theObject The object to be scaled.
566 * \param thePoint Center point for scaling.
567 * \param theFactor Scaling factor value.
568 * \return New GEOM_Object, containing the scaled shape.
570 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
571 in double theFactor);
574 * Modify the Location of the given object by LCS
576 GEOM_Object PositionShape (in GEOM_Object theObject,
577 in GEOM_Object theStartLCS,
578 in GEOM_Object theEndLCS);
581 * Modify the Location of the given object by LCS
582 * creating its copy before the setting
584 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
585 in GEOM_Object theStartLCS,
586 in GEOM_Object theEndLCS);
590 * GEOM_I3DPrimOperations: Interface for 3D primitives creation
591 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
592 * Pipe (extrusion along contour), Revolution, Solid (from shell).
594 interface GEOM_I3DPrimOperations : GEOM_IOperations
597 * Create a box with specified dimensions along the coordinate axes
598 * and with edges, parallel to the coordinate axes.
599 * Center of the box will be at point (DX/2, DY/2, DZ/2).
600 * \param theDX Length of Box edges, parallel to OX axis.
601 * \param theDY Length of Box edges, parallel to OY axis.
602 * \param theDZ Length of Box edges, parallel to OZ axis.
603 * \return New GEOM_Object, containing the created box.
605 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
608 * Create a box with two specified opposite vertices,
609 * and with edges, parallel to the coordinate axes
610 * \param thePnt1 First of two opposite vertices.
611 * \param thePnt2 Second of two opposite vertices.
612 * \return New GEOM_Object, containing the created box.
614 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
617 * Create a cylinder with given radius and height at
618 * the origin of coordinate system. Axis of the cylinder
619 * will be collinear to the OZ axis of the coordinate system.
620 * \param theR Cylinder radius.
621 * \param theH Cylinder height.
622 * \return New GEOM_Object, containing the created cylinder.
624 GEOM_Object MakeCylinderRH (in double theR, in double theH);
627 * Create a cylinder with given base point, axis, radius and height.
628 * \param thePnt Central point of cylinder base.
629 * \param theAxis Cylinder axis.
630 * \param theR Cylinder radius.
631 * \param theH Cylinder height.
632 * \return New GEOM_Object, containing the created cylinder.
634 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
635 in GEOM_Object theAxis,
640 * Create a cone with given height and radiuses at
641 * the origin of coordinate system. Axis of the cone will
642 * be collinear to the OZ axis of the coordinate system.
643 * \param theR1 Radius of the first cone base.
644 * \param theR2 Radius of the second cone base.
645 * \note If both radiuses are non-zero, the cone will be truncated.
646 * \note If the radiuses are equal, a cylinder will be created instead.
647 * \param theH Cone height.
648 * \return New GEOM_Object, containing the created cone.
650 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
653 * Create a cone with given base point, axis, height and radiuses.
654 * \param thePnt Central point of the first cone base.
655 * \param theAxis Cone axis.
656 * \param theR1 Radius of the first cone base.
657 * \param theR2 Radius of the second cone base.
658 * \note If both radiuses are non-zero, the cone will be truncated.
659 * \note If the radiuses are equal, a cylinder will be created instead.
660 * \param theH Cone height.
661 * \return New GEOM_Object, containing the created cone.
663 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
664 in GEOM_Object theAxis,
670 * Create a torus with given radiuses at the origin of coordinate system.
671 * \param theRMajor Torus major radius.
672 * \param theRMinor Torus minor radius.
673 * \return New GEOM_Object, containing the created torus.
675 GEOM_Object MakeTorusRR (in double theRMajor,
676 in double theRMinor);
679 * Create a torus with given center, normal vector and radiuses.
680 * \param thePnt Torus central point.
681 * \param theVec Torus axis of symmetry.
682 * \param theRMajor Torus major radius.
683 * \param theRMinor Torus minor radius.
684 * \return New GEOM_Object, containing the created torus.
686 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
687 in GEOM_Object theVec,
689 in double theRMinor);
692 * Create a sphere with given radius at the origin of coordinate system.
693 * \param theR Sphere radius.
694 * \return New GEOM_Object, containing the created sphere.
696 GEOM_Object MakeSphereR (in double theR);
699 * Create a sphere with given center and radius.
700 * \param thePnt Sphere center.
701 * \param theR Sphere radius.
702 * \return New GEOM_Object, containing the created .
704 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
707 * Create a shape by extrusion of the base shape along the vector,
708 * i.e. all the space, transfixed by the base shape during its translation
709 * along the vector on the given distance.
710 * \param theBase Base shape to be extruded.
711 * \param theVec Direction of extrusion.
712 * \param theH Prism dimension along theVec.
713 * \return New GEOM_Object, containing the created prism.
715 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
716 in GEOM_Object theVec,
720 * Create a shape by extrusion of the base shape along a vector, defined by two points.
721 * \param theBase Base shape to be extruded.
722 * \param thePoint1 First end of extrusion vector.
723 * \param thePoint2 Second end of extrusion vector.
724 * \return New GEOM_Object, containing the created prism.
726 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
727 in GEOM_Object thePoint1,
728 in GEOM_Object thePoint2);
731 * Create a shape by extrusion of the base shape along
732 * the path shape. The path shape can be a wire or an edge.
733 * \param theBase Base shape to be extruded.
734 * \param thePath Path shape to extrude the base shape along it.
735 * \return New GEOM_Object, containing the created pipe.
737 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
740 * Create a shape by revolution of the base shape around the axis
741 * on the given angle, i.e. all the space, transfixed by the base
742 * shape during its rotation around the axis on the given angle.
743 * \param theBase Base shape to be rotated.
744 * \param theAxis Rotation axis.
745 * \param theAngle Rotation angle in radians.
746 * \return New GEOM_Object, containing the created revolution.
748 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
749 in GEOM_Object theAxis,
753 * Create a filling from the given compound of contours.
754 * \param theMinDeg a minimal degree
755 * \param theMaxDeg a maximal degree
756 * \param theTol2D a 2d tolerance
757 * \param theTol3D a 3d tolerance
758 * \param theNbIter a number of iteration
759 * \return New GEOM_Object, containing the created filling surface.
761 GEOM_Object MakeFilling (in GEOM_Object theShape,
762 in long theMinDeg, in long theMaxDeg,
763 in double theTol2D, in double theTol3D,
768 * GEOM_IShapesOperations: Interface for Shapes creation:
769 * Edge from two points, Wire from edges, Face from wire,
770 * Shell from faces, Solid from shells, Compound from shapes
772 interface GEOM_IShapesOperations : GEOM_IOperations
775 * Create a linear edge with specified ends.
776 * \param thePnt1 Point for the first end of edge.
777 * \param thePnt2 Point for the second end of edge.
778 * \return New GEOM_Object, containing the created edge.
780 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
783 * Create a wire from the set of edges and wires.
784 * \param theEdgesAndWires List of edge and/or wires.
785 * \return New GEOM_Object, containing the created wire.
787 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires);
790 * Create a face on the given wire.
791 * \param theWire Wire to build the face on.
792 * \param isPlanarWanted If TRUE, only planar face will be built.
793 * If impossible, NULL object will be returned.
794 * \return New GEOM_Object, containing the created face.
796 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
799 * Create a face on the given wires set.
800 * \param theWires List of wires to build the face on.
801 * \param isPlanarWanted If TRUE, only planar face will be built.
802 * If impossible, NULL object will be returned.
803 * \return New GEOM_Object, containing the created face.
805 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
808 * Create a shell from the set of faces and shells.
809 * \param theFacesAndShells List of faces and/or shells.
810 * \return New GEOM_Object, containing the created shell.
812 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
815 * Create a solid, bounded by the given shell.
816 * \param theShell Bounding shell.
817 * \return New GEOM_Object, containing the created solid.
819 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
822 * Create a solid, bounded by the given shells.
823 * \param theShells Bounding shells.
824 * \return New GEOM_Object, containing the created solid.
826 GEOM_Object MakeSolidShells (in ListOfGO theShells);
829 * Create a compound of the given shapes.
830 * \param theShapes List of shapes to put in compound.
831 * \return New GEOM_Object, containing the created compound.
833 GEOM_Object MakeCompound (in ListOfGO theShapes);
836 * Replace coincident faces in theShape by one face.
837 * \param theShape Initial shape.
838 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
839 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
841 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance);
844 * Explode a shape on subshapes of a given type.
845 * \param theShape Shape to be exploded.
846 * \param theShapeType Type of sub-shapes to be retrieved.
847 * \param isSorted If this parameter is TRUE, sub-shapes will be
848 * sorted by coordinates of their gravity centers.
849 * \return List of sub-shapes of type theShapeType, contained in theShape.
851 ListOfGO MakeExplode (in GEOM_Object theShape,
852 in long theShapeType,
853 in boolean isSorted);
856 * Explode a shape on subshapes of a given type.
857 * Does the same, as the above method, but returns IDs of sub-shapes,
858 * not GEOM_Objects. It works faster.
859 * \param theShape Shape to be exploded.
860 * \param theShapeType Type of sub-shapes to be retrieved.
861 * \param isSorted If this parameter is TRUE, sub-shapes will be
862 * sorted by coordinates of their gravity centers.
863 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
865 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
866 in long theShapeType,
867 in boolean isSorted);
870 * Get a sub shape defined by its unique ID inside \a theMainShape
871 * \note The sub shape GEOM_Objects can has ONLY ONE function.
872 * Don't try to apply modification operations on them.
874 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
878 * Count number of faces in the given shape.
879 * \param theShape Shape to count faces in.
880 * \return Number of faces in the given shape.
882 long NumberOfFaces (in GEOM_Object theShape);
885 * Count number of edges in the given shape.
886 * \param theShape Shape to count edges in.
887 * \return Number of edges in theShape.
889 long NumberOfEdges (in GEOM_Object theShape);
892 * Reverses an orientation the given shape.
893 * \param theShape Shape to be reversed.
894 * \return The reversed copy of theShape.
896 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
899 * Retrieve all free faces from the given shape.
900 * Free face is a face, which is not shared between two shells of the shape.
901 * \param theShape Shape to find free faces in.
902 * \return List of IDs of all free faces, contained in theShape.
904 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
907 * Get all sub-shapes of theShape1 of the given type, shared with theShape2.
908 * \param theShape1 Shape to find sub-shapes in.
909 * \param theShape2 Shape to find shared sub-shapes with.
910 * \param theShapeType Type of sub-shapes to be retrieved.
911 * \return List of sub-shapes of theShape1, shared with theShape2.
913 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
914 in GEOM_Object theShape2,
915 in long theShapeType);
918 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
919 * the specified plane by the certain way, defined through \a theState parameter.
920 * \param theShape Shape to find sub-shapes of.
921 * \param theShapeType Type of sub-shapes to be retrieved.
922 * \param theAx1 Vector (or line, or linear edge), specifying normal
923 * direction and location of the plane to find shapes on.
924 * \param theState The state of the subshapes to find.
925 * \return List of all found sub-shapes.
927 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
928 in long theShapeType,
929 in GEOM_Object theAx1,
930 in shape_state theState);
933 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
934 * the specified cylinder by the certain way, defined through \a theState parameter.
935 * \param theShape Shape to find sub-shapes of.
936 * \param theShapeType Type of sub-shapes to be retrieved.
937 * \param theAxis Vector (or line, or linear edge), specifying
938 * axis of the cylinder to find shapes on.
939 * \param theRadius Radius of the cylinder to find shapes on.
940 * \param theState The state of the subshapes to find.
941 * \return List of all found sub-shapes.
943 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
944 in long theShapeType,
945 in GEOM_Object theAxis,
947 in shape_state theState);
950 * Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
951 * the specified sphere by the certain way, defined through \a theState parameter.
952 * \param theShape Shape to find sub-shapes of.
953 * \param theShapeType Type of sub-shapes to be retrieved.
954 * \param theCenter Point, specifying center of the sphere to find shapes on.
955 * \param theRadius Radius of the sphere to find shapes on.
956 * \param theState The state of the subshapes to find.
957 * \return List of all found sub-shapes.
959 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
960 in long theShapeType,
961 in GEOM_Object theCenter,
963 in shape_state theState);
966 * Get sub-shape(s) of theShapeWhere, which are
967 * coincident with \a theShapeWhat or could be a part of it.
968 * \param theShapeWhere Shape to find sub-shapes of.
969 * \param theShapeWhat Shape, specifying what to find.
970 * \return Group of all found sub-shapes or a single found sub-shape.
972 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
973 in GEOM_Object theShapeWhat);
977 * GEOM_IBlocksOperations: Interface for Blocks construction
978 * Face from points or edges, Block from faces,
979 * Blocks multi-translation and multi-rotation
981 interface GEOM_IBlocksOperations : GEOM_IOperations
988 * Create a quadrangle face from four edges. Order of Edges is not
989 * important. It is not necessary that edges share the same vertex.
990 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
991 * \return New GEOM_Object, containing the created face.
993 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
994 in GEOM_Object theEdge2,
995 in GEOM_Object theEdge3,
996 in GEOM_Object theEdge4);
999 * Create a quadrangle face on two edges.
1000 * The missing edges will be built by creating the shortest ones.
1001 * \param theEdge1,theEdge2 Two opposite edges for the face.
1002 * \return New GEOM_Object, containing the created face.
1004 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
1005 in GEOM_Object theEdge2);
1008 * Create a quadrangle face with specified corners.
1009 * The missing edges will be built by creating the shortest ones.
1010 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
1011 * \return New GEOM_Object, containing the created face.
1013 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
1014 in GEOM_Object thePnt2,
1015 in GEOM_Object thePnt3,
1016 in GEOM_Object thePnt4);
1019 * Create a hexahedral solid, bounded by the six given faces. Order of
1020 * faces is not important. It is not necessary that Faces share the same edge.
1021 * \param theFace1-theFace6 Faces for the hexahedral solid.
1022 * \return New GEOM_Object, containing the created solid.
1024 GEOM_Object MakeHexa (in GEOM_Object theFace1,
1025 in GEOM_Object theFace2,
1026 in GEOM_Object theFace3,
1027 in GEOM_Object theFace4,
1028 in GEOM_Object theFace5,
1029 in GEOM_Object theFace6);
1032 * Create a hexahedral solid between two given faces.
1033 * The missing faces will be built by creating the smallest ones.
1034 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
1035 * \return New GEOM_Object, containing the created solid.
1037 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
1038 in GEOM_Object theFace2);
1041 * Extract elements of blocks and blocks compounds
1045 * Get a vertex, found in the given shape by its coordinates.
1046 * \param theShape Block or a compound of blocks.
1047 * \param theX,theY,theZ Coordinates of the sought vertex.
1048 * \param theEpsilon Maximum allowed distance between the resulting
1049 * vertex and point with the given coordinates.
1050 * \return New GEOM_Object, containing the found vertex.
1052 GEOM_Object GetPoint (in GEOM_Object theShape,
1056 in double theEpsilon);
1059 * Get an edge, found in the given shape by two given vertices.
1060 * \param theShape Block or a compound of blocks.
1061 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
1062 * \return New GEOM_Object, containing the found edge.
1064 GEOM_Object GetEdge (in GEOM_Object theShape,
1065 in GEOM_Object thePoint1,
1066 in GEOM_Object thePoint2);
1069 * Find an edge of the given shape, which has minimal distance to the given point.
1070 * \param theShape Block or a compound of blocks.
1071 * \param thePoint Point, close to the desired edge.
1072 * \return New GEOM_Object, containing the found edge.
1074 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
1075 in GEOM_Object thePoint);
1078 * Returns a face, found in the given shape by four given corner vertices.
1079 * \param theShape Block or a compound of blocks.
1080 * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
1081 * \return New GEOM_Object, containing the found face.
1083 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
1084 in GEOM_Object thePoint1,
1085 in GEOM_Object thePoint2,
1086 in GEOM_Object thePoint3,
1087 in GEOM_Object thePoint4);
1090 * Get a face of block, found in the given shape by two given edges.
1091 * \param theShape Block or a compound of blocks.
1092 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
1093 * \return New GEOM_Object, containing the found face.
1095 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
1096 in GEOM_Object theEdge1,
1097 in GEOM_Object theEdge2);
1100 * Find a face, opposite to the given one in the given block.
1101 * \param theBlock Must be a hexahedral solid.
1102 * \param theFace Face of \a theBlock, opposite to the desired face.
1103 * \return New GEOM_Object, containing the found face.
1105 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
1106 in GEOM_Object theFace);
1109 * Find a face of the given shape, which has minimal distance to the given point.
1110 * \param theShape Block or a compound of blocks.
1111 * \param thePoint Point, close to the desired face.
1112 * \return New GEOM_Object, containing the found face.
1114 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
1115 in GEOM_Object thePoint);
1118 * Find a face of block, whose outside normale has minimal angle with the given vector.
1119 * \param theShape Block or a compound of blocks.
1120 * \param theVector Vector, close to the normale of the desired face.
1121 * \return New GEOM_Object, containing the found face.
1123 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
1124 in GEOM_Object theVector);
1127 * Extract blocks from blocks compounds
1131 * Check, if the compound contains only specified blocks.
1132 * \param theCompound The compound to check.
1133 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
1134 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1135 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1136 * \return TRUE, if the given compound contains only blocks.
1137 * \return theNbBlocks Number of specified blocks in theCompound.
1139 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
1140 in long theMinNbFaces,
1141 in long theMaxNbFaces,
1142 out long theNbBlocks);
1145 * Enumeration of Blocks Compound defects.
1149 /* Each element of the compound should be a Block */
1152 /* An element is a potential block, but has degenerated and/or seam edge(s). */
1155 /* A connection between two Blocks should be an entire face or an entire edge */
1158 /* The compound should be connexe */
1161 /* The glue between two quadrangle faces should be applied */
1166 * Description of Blocks Compound defect: type and incriminated sub-shapes.
1171 ListOfLong incriminated;
1175 * Sequence of all Blocks Compound defects.
1177 typedef sequence<BCError> BCErrors;
1180 * Check, if the compound of blocks is given.
1181 * To be considered as a compound of blocks, the
1182 * given shape must satisfy the following conditions:
1183 * - Each element of the compound should be a Block (6 faces and 12 edges).
1184 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
1185 * - The compound should be connexe.
1186 * - The glue between two quadrangle faces should be applied.
1187 * \note Single block is also accepted as a valid compound of blocks.
1188 * \param theCompound The compound to check.
1189 * \return TRUE, if the given shape is a compound of blocks.
1190 * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
1192 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
1193 out BCErrors theErrors);
1196 * Convert sequence of Blocks Compound errors, returned by
1197 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
1198 * \param theCompound The bad compound.
1199 * \param theErrors The sequence of \a theCompound errors.
1200 * \return String, describing all the errors in form, suitable for printing.
1202 string PrintBCErrors (in GEOM_Object theCompound,
1203 in BCErrors theErrors);
1206 * Remove all seam and degenerated edges from \a theShape.
1207 * Unite faces and edges, sharing one surface.
1208 * \param theShape The compound or single solid to remove irregular edges from.
1209 * \return Improved shape.
1211 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape);
1214 * Check, if the given shape is a blocks compound.
1215 * Fix all detected errors.
1216 * \note Single block can be also fixed by this method.
1217 * \param theCompound The compound to check and improve.
1218 * \return Improved compound.
1220 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
1223 * Get all the blocks, contained in the given compound.
1224 * \param theCompound The compound to explode.
1225 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
1226 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
1227 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
1228 * \return List of GEOM_Objects, containing the retrieved blocks.
1230 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
1231 in long theMinNbFaces,
1232 in long theMaxNbFaces);
1235 * Find block, containing the given point inside its volume or on boundary.
1236 * \param theCompound Compound, to find block in.
1237 * \param thePoint Point, close to the desired block. If the point lays on
1238 * boundary between some blocks, we return block with nearest center.
1239 * \return New GEOM_Object, containing the found block.
1241 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
1242 in GEOM_Object thePoint);
1245 * Find block, containing all the elements, passed as the parts, or maximum quantity of them.
1246 * \param theCompound Compound, to find block in.
1247 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
1248 * \return New GEOM_Object, containing the found block.
1250 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
1251 in ListOfGO theParts);
1254 * Return all blocks, containing all the elements, passed as the parts.
1255 * \param theCompound Compound, to find blocks in.
1256 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
1257 * \return List of GEOM_Objects, containing the found blocks.
1259 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
1260 in ListOfGO theParts);
1263 * Operations on blocks with gluing of result
1267 * Multi-transformate block and glue the result.
1268 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
1269 * \param theBlock Hexahedral solid to be multi-transformed.
1270 * \param theDirFace1 First direction face global index.
1271 * \param theDirFace2 Second direction face global index.
1272 * \param theNbTimes Quantity of transformations to be done.
1273 * \note Global index of sub-shape can be obtained, using method
1274 * <VAR>GEOM_ILocalOperations.GetSubShapeIndex()</VAR>.
1275 * \return New GEOM_Object, containing the result shape.
1277 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
1278 in long theDirFace1,
1279 in long theDirFace2,
1280 in long theNbTimes);
1283 * Multi-transformate block and glue the result.
1284 * \param theBlock Hexahedral solid to be multi-transformed.
1285 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
1286 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
1287 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
1288 * \return New GEOM_Object, containing the result shape.
1290 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
1291 in long theDirFace1U,
1292 in long theDirFace2U,
1293 in long theNbTimesU,
1294 in long theDirFace1V,
1295 in long theDirFace2V,
1296 in long theNbTimesV);
1299 * Special operation - propagation
1303 * Build all possible propagation groups.
1304 * Propagation group is a set of all edges, opposite to one (main)
1305 * edge of this group directly or through other opposite edges.
1306 * Notion of Opposite Edge make sence only on quadrangle face.
1307 * \param theShape Shape to build propagation groups on.
1308 * \return List of GEOM_Objects, each of them is a propagation group.
1310 ListOfGO Propagate (in GEOM_Object theShape);
1314 * GEOM_IBooleanOperations: Interface for boolean operations (Cut, Fuse, Common)
1316 interface GEOM_IBooleanOperations : GEOM_IOperations
1319 * Perform one of boolean operations on two given shapes.
1320 * \param theShape1 First argument for boolean operation.
1321 * \param theShape2 Second argument for boolean operation.
1322 * \param theOperation Indicates the operation to be done:
1323 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
1324 * \return New GEOM_Object, containing the result shape.
1326 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
1327 in GEOM_Object theShape2,
1328 in long theOperation);
1331 * Perform partition operation.
1332 * \param theShapes Shapes to be intersected.
1333 * \param theTools Shapes to intersect theShapes.
1334 * \param theKeepInside Shapes, outside which the results will be deleted.
1335 * Each shape from theKeepInside must belong to theShapes also.
1336 * \param theRemoveInside Shapes, inside which the results will be deleted.
1337 * Each shape from theRemoveInside must belong to theShapes also.
1338 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
1339 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
1340 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
1341 * \return New GEOM_Object, containing the result shapes.
1343 GEOM_Object MakePartition (in ListOfGO theShapes,
1344 in ListOfGO theTools,
1345 in ListOfGO theKeepInside,
1346 in ListOfGO theRemoveInside,
1348 in boolean theRemoveWebs,
1349 in ListOfLong theMaterials);
1352 * Perform partition of the Shape with the Plane
1353 * \param theShape Shape to be intersected.
1354 * \param thePlane Tool shape, to intersect theShape.
1355 * \return New GEOM_Object, containing the result shape.
1357 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
1358 in GEOM_Object thePlane);
1362 * GEOM_ICurvesOperations: Interface for curves creation.
1363 * Polyline, Circle, Spline (Bezier and Interpolation)
1365 interface GEOM_ICurvesOperations : GEOM_IOperations
1368 * Create a circle with given center, normal vector and radius.
1369 * \param thePnt Circle center.
1370 * \param theVec Vector, normal to the plane of the circle.
1371 * \param theR Circle radius.
1372 * \return New GEOM_Object, containing the created circle.
1374 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
1375 in GEOM_Object theVec,
1378 * Create a circle, passing through three given points
1379 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
1380 * \return New GEOM_Object, containing the created circle.
1382 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
1383 in GEOM_Object thePnt2,
1384 in GEOM_Object thePnt3);
1387 * Create an ellipse with given center, normal vector and radiuses.
1388 * \param thePnt Ellipse center.
1389 * \param theVec Vector, normal to the plane of the ellipse.
1390 * \param theRMajor Major ellipse radius.
1391 * \param theRMinor Minor ellipse radius.
1392 * \return New GEOM_Object, containing the created ellipse.
1394 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
1395 in GEOM_Object theVec,
1396 in double theRMajor,
1397 in double theRMinor);
1400 * Create an arc of circle, passing through three given points.
1401 * \param thePnt1 Start point of the arc.
1402 * \param thePnt2 Middle point of the arc.
1403 * \param thePnt3 End point of the arc.
1404 * \return New GEOM_Object, containing the created arc.
1406 GEOM_Object MakeArc (in GEOM_Object thePnt1,
1407 in GEOM_Object thePnt2,
1408 in GEOM_Object thePnt3);
1411 * Create a polyline on the set of points.
1412 * \param thePoints Sequence of points for the polyline.
1413 * \return New GEOM_Object, containing the created polyline.
1415 GEOM_Object MakePolyline (in ListOfGO thePoints);
1418 * Create bezier curve on the set of points.
1419 * \param thePoints Sequence of points for the bezier curve.
1420 * \return New GEOM_Object, containing the created bezier curve.
1422 GEOM_Object MakeSplineBezier (in ListOfGO thePoints);
1425 * Create B-Spline curve on the set of points.
1426 * \param thePoints Sequence of points for the B-Spline curve.
1427 * \return New GEOM_Object, containing the created B-Spline curve.
1429 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints);
1432 * Create a sketcher (wire or face), following the textual description,
1433 * passed through \a theCommand argument. \n
1434 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
1435 * Format of the description string have to be the following:
1437 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
1440 * - x1, y1 are coordinates of the first sketcher point (zero by default),
1442 * - "R angle" : Set the direction by angle
1443 * - "D dx dy" : Set the direction by DX & DY
1446 * - "TT x y" : Create segment by point at X & Y
1447 * - "T dx dy" : Create segment by point with DX & DY
1448 * - "L length" : Create segment by direction & Length
1449 * - "IX x" : Create segment by direction & Intersect. X
1450 * - "IY y" : Create segment by direction & Intersect. Y
1453 * - "C radius length" : Create arc by direction, radius and length(in degree)
1456 * - "WW" : Close Wire (to finish)
1457 * - "WF" : Close Wire and build face (to finish)
1459 * \param theCommand String, defining the sketcher in local
1460 * coordinates of the working plane.
1461 * \param theWorkingPlane Nine double values, defining origin,
1462 * OZ and OX directions of the working plane.
1463 * \return New GEOM_Object, containing the created wire.
1465 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
1468 * Create a sketcher (wire or face), following the textual description,
1469 * passed through \a theCommand argument. \n
1470 * For format of the description string see the previous method.\n
1471 * \param theCommand String, defining the sketcher in local
1472 * coordinates of the working plane.
1473 * \param theWorkingPlane Planar Face of the working plane.
1474 * \return New GEOM_Object, containing the created wire.
1476 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
1480 * GEOM_ILocalOperations: Interface for fillet and chamfer creation.
1482 interface GEOM_ILocalOperations : GEOM_IOperations
1485 * Perform a fillet on all edges of the given shape.
1486 * \param theShape Shape, to perform fillet on.
1487 * \param theR Fillet radius.
1488 * \return New GEOM_Object, containing the result shape.
1490 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
1494 * Perform a fillet on the specified edges of the given shape
1495 * \param theShape Shape, to perform fillet on.
1496 * \param theR Fillet radius.
1497 * \param theEdges Global indices of edges to perform fillet on.
1498 * \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1499 * \return New GEOM_Object, containing the result shape.
1501 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
1503 in ListOfLong theEdges);
1506 * Perform a fillet on all edges of the specified faces of the given shape.
1507 * \param theShape Shape, to perform fillet on.
1508 * \param theR Fillet radius.
1509 * \param theFaces Global indices of faces to perform fillet on.
1510 * \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1511 * \return New GEOM_Object, containing the result shape.
1513 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
1515 in ListOfLong theFaces);
1518 * Perform a symmetric chamfer on all edges of the given shape.
1519 * \param theShape Shape, to perform chamfer on.
1520 * \param theD Chamfer size along each face.
1521 * \return New GEOM_Object, containing the result shape.
1523 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
1527 * Perform a chamfer on edges, common to the specified faces.
1528 * with distance D1 on the Face1
1529 * \param theShape Shape, to perform chamfer on.
1530 * \param theD1 Chamfer size along \a theFace1.
1531 * \param theD2 Chamfer size along \a theFace2.
1532 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
1533 * \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1534 * \return New GEOM_Object, containing the result shape.
1536 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
1537 in double theD1, in double theD2,
1538 in long theFace1, in long theFace2);
1541 * Perform a chamfer on all edges of the specified faces.
1542 * with distance D1 on the first specified face (if several for one edge)
1543 * \param theShape Shape, to perform chamfer on.
1544 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
1545 * connected to the edge, are in \a theFaces, \a theD1
1546 * will be get along face, which is nearer to \a theFaces beginning.
1547 * \param theD2 Chamfer size along another of two faces, connected to the edge.
1548 * \param theFaces Sequence of global indices of faces of \a theShape.
1549 * \note Global index of sub-shape can be obtained, using method <VAR>GetSubShapeIndex()</VAR>.
1550 * \return New GEOM_Object, containing the result shape.
1552 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
1553 in double theD1, in double theD2,
1554 in ListOfLong theFaces);
1557 * Perform an Archimde operation on the given shape with given parameters.
1558 * The object presenting the resulting face is returned
1559 * \param theShape Shape to be put in water.
1560 * \param theWeight Weight og the shape.
1561 * \param theWaterDensity Density of the water.
1562 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
1563 * \return New GEOM_Object, containing a section of \a theShape
1564 * by a plane, corresponding to water level.
1566 GEOM_Object MakeArchimede (in GEOM_Object theShape,
1567 in double theWeight,
1568 in double theWaterDensity,
1569 in double theMeshDeflection);
1572 * Get global index of \a theSubShape in \a theShape.
1573 * \param theShape Main shape.
1574 * \param theSubShape Sub-shape of the main shape.
1575 * \return global index of \a theSubShape in \a theShape.
1577 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
1581 * GEOM_IHealingOperations: Interface for shape healing operations.
1582 * Shape Processing, SuppressFaces, etc.
1584 interface GEOM_IHealingOperations : GEOM_IOperations
1587 * Apply a sequence of Shape Healing operators to the given object.
1588 * \param theShapes Shape to be processed.
1589 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
1590 * \param theParameters List of names of parameters
1591 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
1592 * \param theValues List of values of parameters, in the same order
1593 * as parameters are listed in \a theParameters list.
1594 * \return New GEOM_Object, containing processed shape.
1596 GEOM_Object ProcessShape (in GEOM_Object theShapes,
1597 in string_array theOperators,
1598 in string_array theParameters,
1599 in string_array theValues);
1602 * Get default sequence of operators, their parameters and parameters' values
1603 * of Shape Process operation. In the current implementation the defaults are
1604 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
1605 * \param theOperators Output. Default list of names of operators.
1606 * \param theParameters Output. Default list of names of parameters.
1607 * \param theValues Output. List of default values of parameters, in the same order
1608 * as parameters are listed in \a theParameters list.
1610 void GetShapeProcessParameters (out string_array theOperators,
1611 out string_array theParameters,
1612 out string_array theValues);
1614 * Get parameters and parameters' values for the given Shape Process operation.
1615 * In the current implementation the defaults are
1616 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
1617 * \param theOperator Input. The operator's name.
1618 * \param theParameters Output. Default list of names of parameters.
1619 * \param theValues Output. List of default values of parameters, in the same order
1620 * as parameters are listed in \a theParameters list.
1622 void GetOperatorParameters (in string theOperator,
1623 out string_array theParameters,
1624 out string_array theValues);
1627 * Remove faces from the given object (shape).
1628 * \param theObject Shape to be processed.
1629 * \param theFaces Indices of faces to be removed, if EMPTY then the method
1630 * removes ALL faces of the given object.
1631 * \return New GEOM_Object, containing processed shape.
1633 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
1636 * Close an open wire.
1637 * \param theObject Shape to be processed.
1638 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
1639 * if -1, then theObject itself is a wire.
1640 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
1641 * If FALS : closure by creation of an edge between ends.
1642 * \return New GEOM_Object, containing processed shape.
1644 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
1645 in boolean isCommonVertex);
1648 * Remove internal wires and edges from the given object (face).
1649 * \param theObject Shape to be processed.
1650 * \param theWires Indices of wires to be removed, if EMPTY then the method
1651 * removes ALL internal wires of the given object.
1652 * \return New GEOM_Object, containing processed shape.
1654 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
1657 * Remove internal closed contours (holes) from the given object.
1658 * \param theObject Shape to be processed.
1659 * \param theWires Indices of wires to be removed, if EMPTY then the method
1660 * removes ALL internal holes of the given object
1661 * \return New GEOM_Object, containing processed shape.
1663 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
1666 * Sewing of the given object.
1667 * \param theObject Shape to be processed.
1668 * \param theTolerance Required tolerance value.
1669 * \return New GEOM_Object, containing processed shape.
1671 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
1674 * Addition of a point to a given edge object.
1675 * \param theObject Shape to be processed.
1676 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
1677 * if -1, then theObject itself is the edge.
1678 * \param theValue Value of parameter on edge or length parameter,
1679 * depending on \a isByParameter.
1680 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
1681 * if FALSE : \a theValue is treated as a length parameter [0..1]
1682 * \return New GEOM_Object, containing processed shape.
1684 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
1685 in double theValue, in boolean isByParameter);
1688 * Get a list of wires (wrapped in GEOM_Object-s),
1689 * that constitute a free boundary of the given shape.
1690 * \param theObject Shape to get free boundary of.
1691 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
1692 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
1693 * \return FALSE, if an error(s) occured during the method execution.
1695 boolean GetFreeBoundary (in GEOM_Object theObject,
1696 out ListOfGO theClosedWires,
1697 out ListOfGO theOpenWires);
1701 * GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).
1704 interface GEOM_IInsertOperations : GEOM_IOperations
1707 * Create a copy of the given object
1709 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
1712 * Export the given shape into a file with given name.
1713 * \param theObject Shape to be stored in the file.
1714 * \param theFileName Name of the file to store the given shape in.
1715 * \param theFormatName Specify format for the shape storage.
1716 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
1718 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
1721 * Import a shape from the BRep or IGES or STEP file
1722 * (depends on given format) with given name.
1723 * \param theFileName The file, containing the shape.
1724 * \param theFormatName Specify format for the file reading.
1725 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
1726 * \return New GEOM_Object, containing the imported shape.
1728 GEOM_Object Import (in string theFileName, in string theFormatName);
1731 * Get the supported import formats and corresponding patterns for File dialog.
1732 * \param theFormats Output. List of formats, available for import.
1733 * \param thePatterns Output. List of file patterns, corresponding to available formats.
1734 * \return Returns available formats and patterns through the arguments.
1736 void ImportTranslators (out string_array theFormats,
1737 out string_array thePatterns);
1740 * Get the supported export formats and corresponding patterns for File dialog.
1741 * \param theFormats Output. List of formats, available for export.
1742 * \param thePatterns Output. List of file patterns, corresponding to available formats.
1743 * \return Returns available formats and patterns through the arguments.
1745 void ExportTranslators (out string_array theFormats,
1746 out string_array thePatterns);
1750 * GEOM_IMeasureOperations: Interface for measurement (distance, whatis) and
1751 * properties calculation (like Centre of Mass, Inertia, etc.).
1754 interface GEOM_IMeasureOperations : GEOM_IOperations
1757 * Get summarized length of all wires,
1758 * area of surface and volume of the given shape.
1759 * \param theShape Shape to define properties of.
1760 * \param theLength Output. Summarized length of all wires of the given shape.
1761 * \param theSurfArea Output. Area of surface of the given shape.
1762 * \param theVolume Output. Volume of the given shape.
1763 * \return Returns shape properties through the last three arguments.
1765 void GetBasicProperties (in GEOM_Object theShape,
1766 out double theLength,
1767 out double theSurfArea,
1768 out double theVolume);
1771 * Get a point, situated at the centre of mass of theShape.
1772 * \param theShape Shape to define centre of mass of.
1773 * \return New GEOM_Object, containing the created point.
1775 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
1778 * Get inertia matrix and moments of inertia of theShape.
1779 * \param theShape Shape to calculate inertia of.
1780 * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
1781 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
1782 * \return Returns inertia through the last twelve arguments.
1784 void GetInertia (in GEOM_Object theShape,
1785 out double I11, out double I12, out double I13,
1786 out double I21, out double I22, out double I23,
1787 out double I31, out double I32, out double I33,
1788 out double Ix , out double Iy , out double Iz);
1791 * Get parameters of bounding box of the given shape
1792 * \param theShape Shape to obtain bounding box of.
1793 * \param Xmin,Xmax Output. Limits of shape along OX axis.
1794 * \param Ymin,Ymax Output. Limits of shape along OY axis.
1795 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
1796 * \return Returns parameters of bounding box through the last six arguments.
1798 void GetBoundingBox (in GEOM_Object theShape,
1799 out double Xmin, out double Xmax,
1800 out double Ymin, out double Ymax,
1801 out double Zmin, out double Zmax);
1804 * Get min and max tolerances of sub-shapes of theShape
1805 * \param theShape Shape, to get tolerances of.
1806 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
1807 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
1808 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
1809 * \return Returns shape tolerances through the last six arguments.
1811 void GetTolerance (in GEOM_Object theShape,
1812 out double FaceMin, out double FaceMax,
1813 out double EdgeMin, out double EdgeMax,
1814 out double VertMin, out double VertMax);
1817 * Check a topology of the given shape.
1818 * \param theShape Shape to check validity of.
1819 * \param theDescription Output. Description of problems in the shape, if they are.
1820 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
1822 boolean CheckShape (in GEOM_Object theShape,
1823 out string theDescription);
1826 * Obtain description of the given shape
1827 * \param theShape Shape to be described.
1828 * \return Description of the given shape.
1830 string WhatIs (in GEOM_Object theShape);
1833 * Get minimal distance between the given shapes.
1834 * \param theShape1,theShape2 Shapes to find minimal distance between.
1835 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
1836 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
1837 * \return Value of the minimal distance between the given shapes.
1839 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
1840 out double X1, out double Y1, out double Z1,
1841 out double X2, out double Y2, out double Z2);
1845 * Get point coordinates
1847 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
1852 * GEOM_IGroupOperations: Interface for groups creation.
1854 interface GEOM_IGroupOperations : GEOM_IOperations
1857 * Creates a new group which will store sub shapes of theMainShape
1858 * \param theMainShape is a GEOM object on which the group is selected
1859 * \param theShapeType defines a shape type of the group
1860 * \return a newly created GEOM group
1862 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
1865 * Adds a sub object with ID theSubShapeId to the group
1866 * \param theGroup is a GEOM group to which the new sub shape is added
1867 * \param theSubShapeId is a sub shape ID in the main object.
1868 * \note Use method <VAR>ILocalOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
1870 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
1873 * Removes a sub object with ID \a theSubShapeId from the group
1874 * \param theGroup is a GEOM group from which the sub shape is removed.
1875 * \param theSubShapeId is a sub shape ID in the main object.
1876 * \note Use method <VAR>ILocalOperations.GetSubShapeIndex()</VAR> to get an ID by the sub shape
1878 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
1881 * Adds to the group all the given shapes. No errors, if some shapes are alredy included.
1882 * \param theGroup is a GEOM group to which the new sub shapes are added.
1883 * \param theSubShapes is a list of sub shapes to be added.
1885 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
1888 * Removes from the group all the given shapes. No errors, if some shapes are not included.
1889 * \param theGroup is a GEOM group from which the sub-shapes are removed.
1890 * \param theSubShapes is a list of sub-shapes to be removed.
1892 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
1895 * Returns a type of sub objects stored in the group
1896 * \param theGroup is a GEOM group which type is returned.
1898 long GetType (in GEOM_Object theGroup);
1901 * Returns a main shape associated with the group
1902 * \param theGroup is a GEOM group for which a main shape object is requested
1903 * \return a GEOM object which is a main shape for theGroup
1905 GEOM_Object GetMainShape (in GEOM_Object theGroup);
1908 * Returns a list of sub objects ID stored in the group
1909 * \param theGroup is a GEOM group for which a list of IDs is requested
1911 ListOfLong GetObjects (in GEOM_Object theGroup);
1916 * GEOM_Gen: Interface to access other GEOM interfaces.
1917 * Also contains some methods to access and manage GEOM objects.
1919 interface GEOM_Gen : Engines::Component,SALOMEDS::Driver
1922 * Undo/Redo Management
1925 void Undo (in long theStudyID);
1927 void Redo (in long theStudyID);
1930 * Publishing manangement
1931 * Adds in theStudy a object theObject under with a name theName,
1932 * if theFather is not NULL the object is placed under thFather's SObject.
1933 * Returns a SObject where theObject is placed
1935 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
1936 in GEOM_Object theObject,
1938 in GEOM_Object theFather);
1941 * Methods to access interfaces for objects creation and transformation
1943 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1944 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
1945 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1946 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1947 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1948 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1949 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1950 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1951 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1952 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1953 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1954 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
1957 * Objects Management
1961 * Removes the object from the GEOM component
1962 * \param theObject is a GEOM object to be removed
1964 void RemoveObject (in GEOM_Object theObject);
1967 * Returns an object defined by the study and its entry in the GEOM component
1968 * \param theStudyID is a SALOMEDS Study ID
1969 * \param theEntry is an entry of the requested GEOM object in the GEOM component
1970 * \note if the object has not previously been created a NULL GEOM object is returned
1972 GEOM_Object GetObject (in long theStudyID, in string theEntry);
1975 * Add a sub shape defined by indices in \a theIndices
1976 * (contains unique IDs of sub shapes inside theMainShape)
1977 * \note The sub shape GEOM_Objects can has ONLY ONE function.
1978 * Don't try to apply modification operations on them.
1979 * \note Internal method
1981 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
1984 * GEOM object's IOR Management
1988 * Returns a GEOM Object defined by its IOR
1989 * \param theIOR a string containg an IOR of the requested GEOM object
1991 GEOM_Object GetIORFromString (in string theIOR);
1994 * Returns a string which contains an IOR of the GEOM object
1995 * \param theObject is a GEOM object which IOR is requested
1997 string GetStringFromIOR (in GEOM_Object theObject);