1 // Copyright (C) 2007-2014 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, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : GEOM_Gen.idl
23 // Author : Sergey RUIN
28 #include "SALOME_Exception.idl"
29 #include "SALOME_Component.idl"
30 #include "SALOMEDS.idl"
31 #include "SALOMEDS_Attributes.idl"
33 #include "SALOME_GenericObj.idl"
38 * \brief Topological types of shapes (like Open Cascade types)
44 /*! A collection of solids */
46 /*! A part of 3D space bound by a shell */
48 /*! A collection of faces connected by some edges of their wire boundaries */
50 /*! Part of a plane (in 2D geometry) or a surface (in 3D geometry) bounded by a close wire */
52 /*! A sequence of edges connected by their vertices */
54 /*! Edge, a shape corresponding to a curve, and bound by a vertex at each extremity */
56 /*! A zero-dimensional shape corresponding to a point in geometry */
64 enum marker_type { MT_NONE, MT_POINT, MT_PLUS, MT_STAR, MT_X, MT_O, MT_O_POINT, MT_O_PLUS,
65 MT_O_STAR, MT_O_X, MT_RING1, MT_RING2, MT_RING3, MT_BALL, MT_USER };
70 enum marker_size { MS_NONE, MS_10, MS_15, MS_20, MS_25, MS_30, MS_35,
71 MS_40, MS_45, MS_50, MS_55, MS_60, MS_65, MS_70 };
74 * \brief State of shape relatively geometrical surface like plane, sphere or cylinder.
76 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
80 /*! Shape is on surface */
84 * Shape is in the direction defined by the normal and not on surface.
85 * For plane it means above the plane,
86 * For sphere and cylinder it means outside of volume, bounded by the surface.
91 * Shape is in the direction defined by the normal and on surface.
97 * Complementary to ONOUT.
98 * For plane it means below the plane,
99 * For sphere and cylinder it means inside the volume, bounded by the surface
100 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
105 * Complementary to OUT.
112 * \brief Kind of method to find inside one main shape some sub-shapes,
113 * corresponding to other given shape (its argument)
115 * Is used in functions GEOM_Gen.RestoreSubShapesO(), GEOM_Gen.RestoreSubShapesSO()
117 enum find_shape_method
119 /*! Use GetInPlace functionality. Suits all cases, except transformations */
122 /*! To be used only for transformation result, to find sub-shapes of argument.
123 * Only this method can be used after transformation.
127 /*! To find only shared sub-shapes, not modified by the operation */
130 /*! Use GetShapesOnShape method (can work only on solids) */
131 FSM_GetShapesOnShape,
133 /*! Use GetInPlaceByHistory method (can work only after Partition) */
134 FSM_GetInPlaceByHistory,
136 /*! To be used only for multi-transformation result.
137 * Only this method can be used after multi-transformation.
143 * \brief Kind of method to perform filling operation
145 * Is used in functions GEOM_I3DPrimOperations.MakeFilling()
147 enum filling_oper_method
149 /*! Default (standard behaviour) */
152 /*! Use edges orientation - orientation of edges is used: if the edge is
153 * reversed, the curve from this edge is reversed before using it in
154 * the filling algorithm.
158 /*! Auto-correct edges orientation - changes the orientation of the curves
159 * using minimization of sum of distances between the end points of the edges.
165 * \brief Kind of the curves.
167 * Used in the functions GEOM_ICurvesOperations.MakeCurveParametric(), GEOM_ICurvesOperations.MakeCurveParametricNew()
170 /*! Polyline curve */
176 /*! Interpolation, curve */
181 * \brief Pattern for block division of the disk
183 * Used in the functions GEOM_IAdvancedOperations.MakeDividedDisk(), GEOM_ICurvesOperations.MakeDividedDiskPntVecR()
194 * \brief Type of field data
196 enum field_data_type {
205 * \brief Object creation parameters
207 * Is returned by GEOM_Object::GetCreationInformation()
215 typedef sequence<Parameter> Parameters;
217 struct CreationInformation
219 string operationName;
224 typedef sequence<string> string_array;
225 typedef sequence<short> short_array;
226 typedef sequence<boolean> ListOfBool;
227 typedef sequence<long> ListOfLong;
228 typedef sequence<double> ListOfDouble;
230 interface GEOM_Object;
231 interface GEOM_BaseObject;
232 interface GEOM_Field;
233 interface GEOM_FieldStep;
235 typedef sequence<GEOM_Object> ListOfGO;
236 typedef sequence<GEOM_BaseObject> ListOfGBO;
237 typedef sequence<GEOM_Field> ListOfFields;
238 typedef sequence<SALOMEDS::SObject> object_list;
242 * \brief A common root of objects in GEOM module
244 interface GEOM_BaseObject : SALOME::GenericObj
247 * \brief Set name of the object.
249 * \param theName is a name which will be associated with this object.
251 void SetName (in string theName);
254 * \brief Get name of the object associated with this object.
259 * \brief Get internal (unique) entry of the object in the GEOM component's data tree.
260 * \note This is not an entry of the data object in SALOME study.
261 * This is internal function of GEOM component, though it can be used outside it for
262 appropriate reason (e.g. for unique identification of geometry object).
267 * \brief Get ID of study, where the object is created.
272 * \brief Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
277 * \brief Get value of a modification counter of the object
282 * \brief Set a Study entry where this object was published.
284 void SetStudyEntry (in string theEntry);
287 * \brief Get a Study entry where this object was published.
289 string GetStudyEntry();
292 * \brief Get a list of all GEOM_Object on which were the arguments
293 * when this object was constructed and modified.
294 * \note This method is supposed to be used by GUI only.
296 ListOfGBO GetDependency();
299 * \brief Get a list of GEOM_Object on which the last function that created or modified the object depends.
300 * \note This method is supposed to be used by GUI only.
302 ListOfGBO GetLastDependency();
305 * \brief Return true if geom object representes a shape.
307 * For example, method return false for GEOM_MARKER
312 * \brief Return true if passed object is identical to this object
314 * \param other object being compared with this one
316 boolean IsSame(in GEOM_BaseObject other);
319 * Set list of parameters
320 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
321 * used for object creation
323 void SetParameters (in string theParameters);
326 * \brief Return list of notebook variables used for object creation separated by ":" symbol
328 string GetParameters();
331 * \brief Return name of operation and values of parameters used for object creation
333 CreationInformation GetCreationInformation();
338 * \brief Interface of geometric object
340 interface GEOM_Object : GEOM_BaseObject
343 * \brief Get a <VAR>shape_type</VAR> of the object value.
345 shape_type GetShapeType();
348 * \brief Get the topology type of the object value.
350 * In contrast to the shape type, this function returns type of the most
351 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
355 shape_type GetTopologyType();
358 * \brief Get a minimal type of the top-level shapes contained in the object.
360 * This function is useful for the compounds only; for simple shapes it
361 * exactly the same value as GetShapeType().
362 * Note, that compounds are procesed recursively.
364 * \sa GetShapeType(), GetTopologyType(), GetMaxShapeType()
366 shape_type GetMinShapeType();
369 * \brief Get a maximal type of the top-level shapes contained in the object.
371 * This function is useful for the compounds only; for simple shapes it
372 * exactly the same value as GetShapeType().
373 * Note, that compounds are procesed recursively.
375 * \sa GetShapeType(), GetTopologyType(), GetMinShapeType()
377 shape_type GetMaxShapeType();
380 * \brief Set color of the object.
382 * \param theColor is a color of the object.
384 void SetColor(in SALOMEDS::Color theColor);
387 * Get color of the object.
389 SALOMEDS::Color GetColor();
392 * Toggle auto color mode on the object.
393 * \param theAutoColor is a flag which toggles auto color mode.
395 void SetAutoColor(in boolean theAutoColor);
398 * \brief Get flag of object's auto color mode.
400 boolean GetAutoColor();
403 * \brief Set standard point marker for the object
404 * \param theType standard marker type
405 * \param theSize marker relative size
407 void SetMarkerStd(in marker_type theType, in marker_size theSize );
410 * \brief Set custom point marker for the object.
412 * The texture can be added by LoadTexture() or AddTexture() functions.
413 * \param theTextureId texture ID
415 void SetMarkerTexture(in long theTextureId);
418 * \brief Get type of the point marker assigned to the object
419 * \return current marker type (MT_NONE if no marker is set)
421 marker_type GetMarkerType();
424 * \brief Get size of the point marker assigned to the object
425 * \return current marker relative size (MS_NONE if no marker is set)
427 marker_size GetMarkerSize();
430 * \brief Get texture idenifier of the point marker assigned to the object
431 * \return marker texture ID (0 if no marker set)
433 long GetMarkerTexture();
436 * \brief Get the TopoDS_Shape, for colocated case only.
438 long long getShape();
440 // ######################################################################
441 // # Internal methods (For sub-shape identification)
442 // ######################################################################
444 * \brief Get geometric shape of the object as a byte stream in BRep format
445 * \note GEOM_IInsertOperations::RestoreShape() method can be used to restore shape from a BRep stream.
447 SALOMEDS::TMPFile GetShapeStream();
450 * \brief Returns True if this object is not a sub-shape of another object.
452 boolean IsMainShape();
455 * \brief Get a list of ID's of sub-shapes in the main shape.
456 * \note Internal method, suppopsed to be used only by GEOM_Client
458 ListOfLong GetSubShapeIndices();
461 * \brief Get a main shape object to which this object is a sub-shape
462 * \note Internal method, suppopsed to be used only by GEOM_Client
464 GEOM_Object GetMainShape();
470 * \brief Interface of the field
472 interface GEOM_Field : GEOM_BaseObject
475 * \brief Returns the shape the field lies on
477 GEOM_Object GetShape();
480 * \brief Returns type of field data
482 field_data_type GetDataType();
485 * \brief Returns dimension of the shape the field lies on
486 * 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
488 short GetDimension();
491 * \brief Returns names of components
493 string_array GetComponents();
496 * \brief Removes a component. Component number counts from one.
498 //void RemoveComponent(in long number);
501 * \brief Adds a time step to the field
503 GEOM_FieldStep AddStep(in long stepID, in long stamp);
506 * \brief Remove a time step from the field
508 void RemoveStep(in long stepID);
511 * \brief Returns number of time steps in the field
516 * \brief Returns a list of time step IDs in the field
518 ListOfLong GetSteps();
521 * \brief Returns a time step by its ID
523 GEOM_FieldStep GetStep(in long stepID);
526 * \brief Returns a size of data array that is to be passed to
527 * GEOM_FieldStep.SetValues( dataArray ). This size depends on the
528 * number of sub-shapes of field dimension and the number of components
535 * \brief Interface of the field time step
537 interface GEOM_FieldStep : GEOM_BaseObject
540 * \brief Changes the time of the field step
542 void SetStamp(in long stamp);
545 * \brief Returns the time of the field step
550 * \brief Returns the number of the field step
555 * \brief Returns the field the step belongs to
557 GEOM_Field GetField();
560 // # GEOM_BoolFieldStep:
562 * \brief Interface of the boolean field time step
564 interface GEOM_BoolFieldStep : GEOM_FieldStep
567 * \brief Changes values of the field step. Returns false if number of values is wrong
569 boolean SetValues(in short_array boolValues);
572 * \brief Returns values of the field step
574 short_array GetValues();
577 // # GEOM_IntFieldStep:
579 * \brief Interface of the integer field time step
581 interface GEOM_IntFieldStep : GEOM_FieldStep
584 * \brief Changes values of the field step. Returns false if number of values is wrong
586 boolean SetValues(in ListOfLong intValues);
589 * \brief Returns values of the field step
591 ListOfLong GetValues();
594 // # GEOM_DoubleFieldStep:
596 * \brief Interface of the double field time step
598 interface GEOM_DoubleFieldStep : GEOM_FieldStep
601 * \brief Changes values of the field step. Returns false if number of values is wrong
603 boolean SetValues(in ListOfDouble doubleValues);
606 * \brief Returns values of the field step
608 ListOfDouble GetValues();
611 // # GEOM_StringFieldStep:
613 * \brief Interface of the string field time step
615 interface GEOM_StringFieldStep : GEOM_FieldStep
618 * \brief Changes values of the field step. Returns false if number of values is wrong
620 boolean SetValues(in string_array strValues);
623 * \brief Returns values of the field step
625 string_array GetValues();
628 // # GEOM_IOperations:
630 * \brief Basic methods of all geometric operations
632 interface GEOM_IOperations : SALOME::GenericObj
635 * \brief To know, if the operation was successfully performed
640 * \brief Set the operation error code
641 * \param theErrorID is a string describing the error occured
642 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
644 void SetErrorCode (in string theErrorID);
647 * \brief Get the operation error code
649 string GetErrorCode();
652 * \brief Get ID of study, where the operation is defined
657 * \brief Opens a new transaction
659 void StartOperation();
662 * \brief Closes the previously opened trasaction
664 void FinishOperation();
667 * \brief Aborts the previously opened transaction
669 void AbortOperation();
671 //# GEOM_IBasicOperations:
673 * \brief Interface for basic geometry creation
675 * (Point, Vector, Plane, Marker)
677 interface GEOM_IBasicOperations : GEOM_IOperations
680 * \brief Create point by three coordinates.
681 * \param theX The X coordinate of the point.
682 * \param theY The Y coordinate of the point.
683 * \param theZ The Z coordinate of the point.
684 * \return New GEOM_Object, containing the created point.
686 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
689 * \brief Create a point, distant from the referenced point
690 * on the given distances along the coordinate axes.
691 * \param theReference The referenced point.
692 * \param theX Displacement from the referenced point along OX axis.
693 * \param theY Displacement from the referenced point along OY axis.
694 * \param theZ Displacement from the referenced point along OZ axis.
695 * \return New GEOM_Object, containing the created point.
697 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
698 in double theX, in double theY, in double theZ);
701 * Create a point, corresponding to the given parameter on the given curve.
702 * \param theRefCurve The referenced curve.
703 * \param theParameter Value of parameter on the referenced curve.
704 * \return New GEOM_Object, containing the created point.
706 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
707 in double theParameter);
710 * \brief Create a point, corresponding to the given length on the given curve.
711 * \param theRefCurve The referenced curve.
712 * \param theLength Length on the referenced curve. It can be negative.
713 * \param theStartPoint Any vertex close to one of edge's
714 * ends to select start point among them.
715 * If NULL, fist vertex is used.
716 * \return New GEOM_Object, containing the created point.
718 GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve,
720 in GEOM_Object theStartPoint);
723 * \brief Create a point on the given curve, projecting given point
724 * \param theRefCurve The referenced curve.
725 * \param theXParameter X co-ordinate of point to project on curve
726 * \param theYParameter Y co-ordinate of point to project on curve
727 * \param theZParameter Z co-ordinate of point to project on curve
728 * \return New GEOM_Object, containing the created point.
730 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
731 in double theXParameter,
732 in double theYParameter,
733 in double theZParameter);
736 * \brief Create a point, corresponding to the given parameters on the
738 * \param theRefSurf The referenced surface.
739 * \param theUParameter Value of U-parameter on the referenced surface.
740 * \param theVParameter Value of V-parameter on the referenced surface.
741 * \return New GEOM_Object, containing the created point.
743 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
744 in double theUParameter,
745 in double theVParameter);
748 * \brief Create a point on the given surface, projecting given point
749 * \param theRefSurf The referenced surface.
750 * \param theXParameter X co-ordinate of point to project on curve
751 * \param theYParameter Y co-ordinate of point to project on curve
752 * \param theZParameter Z co-ordinate of point to project on curve
753 * \return New GEOM_Object, containing the created point.
755 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
756 in double theXParameter,
757 in double theYParameter,
758 in double theZParameter);
761 * \brief Create a point, which lays on the given face.
762 * The point will lay in arbitrary place of the face.
763 * The only condition on it is a non-zero distance to the face boundary.
764 * Such point can be used to uniquely identify the face inside any
765 * shape in case, when the shape does not contain overlapped faces.
766 * \param theFace The referenced face.
767 * \return New GEOM_Object, containing the created point.
769 GEOM_Object MakePointOnFace (in GEOM_Object theFace);
772 * \brief Create a point, on two lines intersection.
773 * \param theRefLine1, theRefLine2 The referenced lines.
774 * \return New GEOM_Object, containing the created point.
776 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
777 in GEOM_Object theRefLine2);
780 * \brief Create a vector, corresponding to tangent to the given parameter on the given curve.
781 * \param theRefCurve The referenced curve.
782 * \param theParameter Value of parameter on the referenced curve.This value should be have value
783 * between 0. and 1.. Value of 0. corresponds first parameter of curve; value
784 * 1. corresponds last parameter of curve.
785 * \return New GEOM_Object, containing the created point.
787 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
788 in double theParameter);
791 * \brief Create a vector with the given components.
792 * \param theDX X component of the vector.
793 * \param theDY Y component of the vector.
794 * \param theDZ Z component of the vector.
795 * \return New GEOM_Object, containing the created vector.
797 GEOM_Object MakeVectorDXDYDZ (in double theDX,
802 * \brief Create a vector between two points.
803 * \param thePnt1 Start point for the vector.
804 * \param thePnt2 End point for the vector.
805 * \return New GEOM_Object, containing the created vector.
807 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
810 * C\brief reate a line, passing through the given point
811 * and parrallel to the given direction
812 * \param thePnt Point. The resulting line will pass through it.
813 * \param theDir Direction. The resulting line will be parallel to it.
814 * \return New GEOM_Object, containing the created line.
816 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
819 * \brief Create a line, passing through the given points
820 * \param thePnt1 First of two points, defining the line.
821 * \param thePnt2 Second of two points, defining the line.
822 * \return New GEOM_Object, containing the created line.
824 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
827 * \brief Create a line, given by two faces intersection.
828 * \param theFace1 First of two faces, defining the line.
829 * \param theFace2 Second of two faces, defining the line.
830 * \return New GEOM_Object, containing the created line.
832 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
835 * \brief Create a plane, passing through the three given points
836 * \param thePnt1 First of three points, defining the plane.
837 * \param thePnt2 Second of three points, defining the plane.
838 * \param thePnt3 Fird of three points, defining the plane.
839 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
840 * \return New GEOM_Object, containing the created plane.
842 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
843 in GEOM_Object thePnt2,
844 in GEOM_Object thePnt3,
845 in double theTrimSize);
848 * \brief Create a plane, passing through the given point
849 * and normal to the given vector.
850 * \param thePnt Point, the plane has to pass through.
851 * \param theVec Vector, defining the plane normal direction.
852 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
853 * \return New GEOM_Object, containing the created plane.
855 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
856 in GEOM_Object theVec,
857 in double theTrimSize);
860 * \brief Create a plane, similar to the existing one, but with another size of representing face.
861 * \param theFace Referenced plane or LCS(Marker).
862 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
863 * \return New GEOM_Object, containing the created plane.
865 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
866 in double theTrimSize);
869 * \brief Create a plane, by two vectors.
870 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
871 * \param theVec2 Vector2, defining the plane normal direction.
872 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
873 * \return New GEOM_Object, containing the created plane.
875 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
876 in GEOM_Object theVec2,
877 in double theTrimSize);
880 * \brief Create a plane, defined by local coordinate system.
881 * \param theLCS Referenced LCS(Marker).
882 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
883 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
884 * \return New GEOM_Object, containing the created plane.
886 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
887 in double theTrimSize,
888 in double theOrientation);
891 * \brief Create a local coordinate system.
892 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
893 * \param theXDX,theXDY,theXDZ Three components of OX direction
894 * \param theYDX,theYDY,theYDZ Three components of OY direction
895 * \return New GEOM_Object, containing the created coordinate system.
897 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
898 in double theXDX, in double theXDY, in double theXDZ,
899 in double theYDX, in double theYDY, in double theYDZ);
902 * \brief Create a local coordinate system from shape.
903 * \param theShape The initial shape to detect the coordinate system.
904 * \return New GEOM_Object, containing the created coordinate system.
906 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
909 * \brief Create a local coordinate system from point and two vectors (DX, DY).
910 * \param theOrigin Point of coordinate system origin.
911 * \param theXVec Vector of X direction.
912 * \param theYVec Vector of Y direction.
913 * \return New GEOM_Object, containing the created coordinate system.
915 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin,
916 in GEOM_Object theXVec, in GEOM_Object theYVec);
919 * \brief Create a tangent plane to specified face in the point with specified parameters.
921 * Values of parameters should be between 0. and 1.0
922 * \param theFace - face for which tangent plane shuold be built.
923 * \param theParameterU - value of parameter by U
924 * \param theParameterV - value of parameter Vthe
925 * \param theTrimSize - defines sizes of created face
926 * \return New GEOM_Object, containing the face built on tangent plane.
928 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
929 in double theParameterU,
930 in double theParameterV,
931 in double theTrimSize);
935 * \brief Interface for shapes transforming.
937 * Translation, rotation, scaling, mirroring, offset, projection, recomputing.
939 interface GEOM_ITransformOperations : GEOM_IOperations
942 * \brief Translate the given object along the vector, specified by its end points.
943 * \param theObject The object to be translated.
944 * \param thePoint1 Start point of translation vector.
945 * \param thePoint2 End point of translation vector.
948 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
949 in GEOM_Object thePoint1,
950 in GEOM_Object thePoint2);
953 * \brief Translate the given object along the vector, specified
954 * by its end points, creating its copy before the translation.
955 * \param theObject The object to be translated.
956 * \param thePoint1 Start point of translation vector.
957 * \param thePoint2 End point of translation vector.
958 * \return New GEOM_Object, containing the translated object.
960 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
961 in GEOM_Object thePoint1,
962 in GEOM_Object thePoint2);
965 * \brief Translate the given object along the vector, specified by its components.
966 * \param theObject The object to be translated.
967 * \param theDX,theDY,theDZ Components of translation vector.
970 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
971 in double theDX, in double theDY, in double theDZ);
974 * \brief Translate the given object along the vector, specified
975 * by its components, creating its copy before the translation.
976 * \param theObject The object to be translated.
977 * \param theDX,theDY,theDZ Components of translation vector.
978 * \return New GEOM_Object, containing the translated object.
980 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
981 in double theDX, in double theDY, in double theDZ);
985 * \brief Translate the given object along the given vector.
986 * \param theObject The object to be translated.
987 * \param theVector Translation vector, giving both direction and distance.
990 GEOM_Object TranslateVector (in GEOM_Object theObject,
991 in GEOM_Object theVector);
994 * \brief Translate the given object along the given vector,
995 * creating its copy before the translation.
996 * \param theObject The object to be translated.
997 * \param theVector Translation vector, giving both direction and distance.
998 * \return New GEOM_Object, containing the translated object.
1000 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
1001 in GEOM_Object theVector);
1004 * \brief Translate the given object along the given vector on given distance,
1005 * creating its copy before the translation.
1006 * \param theObject The object to be translated.
1007 * \param theVector Translation vector, giving a direction.
1008 * \param theDistance Translation distance, giving a distance.
1009 * \param theCopy Translation copy, creating its copy if true.
1010 * \return New GEOM_Object, containing the translated object.
1012 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
1013 in GEOM_Object theVector,
1014 in double theDistance,
1015 in boolean theCopy);
1018 * \brief Translate the given object along the given vector a given number times
1019 * \param theObject The object to be translated.
1020 * \param theVector Direction of the translation. DX if None.
1021 * \param theStep Distance to translate on.
1022 * \param theNbTimes Quantity of translations to be done.
1023 * \return New GEOM_Object, containing compound of all
1024 * the shapes, obtained after each translation.
1026 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
1027 in GEOM_Object theVector,
1029 in long theNbTimes);
1032 * \brief Conseqently apply two specified translations to theObject specified number of times.
1033 * \param theObject The object to be translated.
1034 * \param theVector1 Direction of the first translation. DX if None.
1035 * \param theStep1 Step of the first translation.
1036 * \param theNbTimes1 Quantity of translations to be done along theVector1.
1037 * \param theVector2 Direction of the second translation. DY if None.
1038 * \param theStep2 Step of the second translation.
1039 * \param theNbTimes2 Quantity of translations to be done along theVector2.
1040 * \return New GEOM_Object, containing compound of all
1041 * the shapes, obtained after each translation.
1043 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
1044 in GEOM_Object theVector1,
1046 in long theNbTimes1,
1047 in GEOM_Object theVector2,
1049 in long theNbTimes2);
1052 * \brief Rotate given object around vector perpendicular to plane containing three points.
1053 * \param theObject The object to be rotated.
1054 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
1055 * containing the three points.
1056 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
1057 * \return theObject.
1059 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
1060 in GEOM_Object theCentPoint,
1061 in GEOM_Object thePoint1,
1062 in GEOM_Object thePoint2);
1066 * \brief Rotate given object around vector perpendicular to plane containing three points.
1068 * Creating its copy before the rotatation.
1069 * \param theObject The object to be rotated.
1070 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
1071 * containing the three points.
1072 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
1073 * \return New GEOM_Object, containing the rotated object.
1075 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
1076 in GEOM_Object theCentPoint,
1077 in GEOM_Object thePoint1,
1078 in GEOM_Object thePoint2);
1081 * \brief Rotate the given object around the given axis on the given angle.
1082 * \param theObject The object to be rotated.
1083 * \param theAxis Rotation axis.
1084 * \param theAngle Rotation angle in radians.
1085 * \return theObject.
1087 GEOM_Object Rotate (in GEOM_Object theObject,
1088 in GEOM_Object theAxis,
1089 in double theAngle);
1093 * Rotate the given object around the given axis
1094 * on the given angle, creating its copy before the rotatation.
1095 * \param theObject The object to be rotated.
1096 * \param theAxis Rotation axis.
1097 * \param theAngle Rotation angle in radians.
1098 * \return New GEOM_Object, containing the rotated object.
1100 GEOM_Object RotateCopy (in GEOM_Object theObject,
1101 in GEOM_Object theAxis,
1102 in double theAngle);
1105 * \brief Rotate the given object around the given axis a given number times.
1107 * Rotation angle will be 2*PI/theNbObjects.
1108 * \param theObject The object to be rotated.
1109 * \param theAxis The rotation axis. DZ if None.
1110 * \param theNbObjects Quantity of rotations to be done.
1111 * \return New GEOM_Object, containing compound of all the
1112 * shapes, obtained after each rotation.
1114 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
1115 in GEOM_Object theAxis,
1116 in long theNbObjects);
1119 * \brief Rotate the given object around the given axis
1120 * a given number times on the given angle.
1122 * \param theObject The object to be rotated.
1123 * \param theAxis The rotation axis. DZ if None.
1124 * \param theAngleStep Rotation angle in radians.
1125 * \param theNbSteps Quantity of rotations to be done.
1126 * \return New GEOM_Object, containing compound of all the
1127 * shapes, obtained after each rotation.
1129 GEOM_Object MultiRotate1DByStep (in GEOM_Object theObject,
1130 in GEOM_Object theAxis,
1131 in double theAngleStep,
1132 in long theNbSteps);
1135 * \brief Rotate the given object around the given axis
1136 * a given number times and multi-translate each rotation result.
1138 * Rotation angle will be 2*PI/theNbObjects.
1139 * Translation direction passes through center of gravity
1140 * of rotated shape and its projection on the rotation axis.
1141 * \param theObject The object to be rotated.
1142 * \param theAxis Rotation axis. DZ if None.
1143 * \param theNbObjects Quantity of rotations to be done.
1144 * \param theRadialStep Translation distance.
1145 * \param theNbSteps Quantity of translations to be done.
1146 * \return New GEOM_Object, containing compound of all the
1147 * shapes, obtained after each transformation.
1149 GEOM_Object MultiRotate2DNbTimes (in GEOM_Object theObject,
1150 in GEOM_Object theAxis,
1151 in long theNbObjects,
1152 in double theRadialStep,
1153 in long theNbSteps);
1156 * \brief Rotate the given object around the
1157 * given axis on the given angle a given number
1158 * times and multi-translate each rotation result.
1160 * Translation direction passes through center of gravity
1161 * of rotated shape and its projection on the rotation axis.
1162 * \param theObject The object to be rotated.
1163 * \param theAxis Rotation axis. DZ if None.
1164 * \param theAngleStep Rotation angle in radians.
1165 * \param theNbSteps1 Quantity of rotations to be done.
1166 * \param theRadialStep Translation distance.
1167 * \param theNbSteps2 Quantity of translations to be done.
1168 * \return New GEOM_Object, containing compound of all the
1169 * shapes, obtained after each transformation.
1171 GEOM_Object MultiRotate2DByStep (in GEOM_Object theObject,
1172 in GEOM_Object theAxis,
1173 in double theAngleStep,
1174 in long theNbSteps1,
1175 in double theRadialStep,
1176 in long theNbSteps2);
1179 * \brief Rotate the given object around the
1180 * given axis on the given angle a given number
1181 * times and multi-translate each rotation result.
1183 * Translation direction passes through center of gravity
1184 * of rotated shape and its projection on the rotation axis.
1185 * \param theObject The object to be rotated.
1186 * \param theAxis Rotation axis. DZ if None.
1187 * \param theAngleStep Rotation angle in degrees.
1188 * \param theNbSteps1 Quantity of rotations to be done.
1189 * \param theRadialStep Translation distance.
1190 * \param theNbSteps2 Quantity of translations to be done.
1191 * \return New GEOM_Object, containing compound of all the
1192 * shapes, obtained after each transformation.
1194 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
1195 in GEOM_Object theAxis,
1196 in double theAngleStep,
1197 in long theNbSteps1,
1198 in double theRadialStep,
1199 in long theNbSteps2);
1202 * \brief Replace the given object by an object,
1203 * symmetrical to it relatively the given plane.
1204 * \param theObject The object to be mirrored.
1205 * \param thePlane Plane of symmetry.
1207 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
1210 * \brief Create an object, symmetrical
1211 * to the given one relatively the given plane.
1212 * \param theObject The object to be mirrored.
1213 * \param thePlane Plane of symmetry.
1214 * \return New GEOM_Object, containing the mirrored shape.
1216 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
1219 * \brief Replace the given object by an object,
1220 * symmetrical to it relatively the given axis.
1221 * \param theObject The object to be mirrored.
1222 * \param theAxis Axis of symmetry.
1223 * \return theObject.
1225 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
1228 * \brief Create an object, symmetrical
1229 * to the given one relatively the given axis.
1230 * \param theObject The object to be mirrored.
1231 * \param theAxis Axis of symmetry.
1232 * \return New GEOM_Object, containing the mirrored object.
1234 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
1237 * \brief Replace the given object by an object, symmetrical to it relatively the given point.
1238 * \param theObject The object to be mirrored.
1239 * \param thePoint Point of symmetry.
1240 * \return theObject.
1242 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
1245 * \brief Create an object, symmetrical to the given one relatively the given point.
1246 * \param theObject The object to be mirrored.
1247 * \param thePoint Point of symmetry.
1248 * \return New GEOM_Object, containing the mirrored object.
1250 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
1253 * \brief Replace the given object by its offset.
1254 * \param theObject The base object for the offset.
1255 * \param theOffset Offset value.
1256 * \return theObject.
1258 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
1261 * \brief Create new object as offset of the given one.
1262 * \param theObject The base object for the offset.
1263 * \param theOffset Offset value.
1264 * \return New GEOM_Object, containing the offset object.
1266 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
1269 * \brief Create new object as projection of the given one on a 2D surface.
1270 * \param theSource The source object for the projection. It can be a point, edge or wire.
1271 * \param theTarget The target object. It can be planar or cylindrical face.
1272 * \return New GEOM_Object, containing the projection.
1274 GEOM_Object ProjectShapeCopy (in GEOM_Object theSource, in GEOM_Object theTarget);
1277 * \brief Create a projection projection of the given point on a wire or
1280 * If there are no solutions or there are 2 or more solutions It throws an
1282 * \param thePoint the point to be projected.
1283 * \param theWire the wire. The edge is accepted as well.
1284 * \param thePointOnEdge the projection point.
1285 * \param theEdgeInWireIndex the index of an edge in a wire.
1286 * \return the parameter of projection point on edge.
1288 double ProjectPointOnWire (in GEOM_Object thePoint,
1289 in GEOM_Object theWire,
1290 out GEOM_Object thePointOnEdge,
1291 out long theEdgeInWireIndex);
1294 * \brief Scale the given object by the factor.
1295 * \param theObject The object to be scaled.
1296 * \param thePoint Center point for scaling.
1297 * \param theFactor Scaling factor value.
1298 * \return theObject.
1300 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
1301 in double theFactor);
1304 * \brief Scale the given object by the factor, creating its copy before the scaling.
1305 * \param theObject The object to be scaled.
1306 * \param thePoint Center point for scaling.
1307 * \param theFactor Scaling factor value.
1308 * \return New GEOM_Object, containing the scaled shape.
1310 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
1311 in double theFactor);
1314 * \brief Scale the given object by different factors along coordinate axes.
1315 * \param theObject The object to be scaled.
1316 * \param thePoint Center point for scaling.
1317 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1318 * \return theObject.
1320 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
1321 in GEOM_Object thePoint,
1322 in double theFactorX,
1323 in double theFactorY,
1324 in double theFactorZ);
1327 * \brief Scale the given object by different factors along coordinate axes,
1328 * creating its copy before the scaling.
1329 * \param theObject The object to be scaled.
1330 * \param thePoint Center point for scaling.
1331 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1332 * \return New GEOM_Object, containing the scaled shape.
1334 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
1335 in GEOM_Object thePoint,
1336 in double theFactorX,
1337 in double theFactorY,
1338 in double theFactorZ);
1341 * \brief Modify the Location of the given object by LCS.
1342 * \param theObject The object to be displaced.
1343 * \param theStartLCS Coordinate system to perform displacement from it.
1344 * If \a theStartLCS is NULL, displacement
1345 * will be performed from global CS.
1346 * If \a theObject itself is used as \a theStartLCS,
1347 * its location will be changed to \a theEndLCS.
1348 * \param theEndLCS Coordinate system to perform displacement to it.
1349 * \return theObject.
1351 GEOM_Object PositionShape (in GEOM_Object theObject,
1352 in GEOM_Object theStartLCS,
1353 in GEOM_Object theEndLCS);
1356 * \brief Modify the Location of the given object by LCS,
1357 * creating its copy before the setting.
1358 * \param theObject The object to be displaced.
1359 * \param theStartLCS Coordinate system to perform displacement from it.
1360 * If \a theStartLCS is NULL, displacement
1361 * will be performed from global CS.
1362 * If \a theObject itself is used as \a theStartLCS,
1363 * its location will be changed to \a theEndLCS.
1364 * \param theEndLCS Coordinate system to perform displacement to it.
1365 * \return New GEOM_Object, containing the displaced shape.
1367 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
1368 in GEOM_Object theStartLCS,
1369 in GEOM_Object theEndLCS);
1372 * \brief Modify the Location of the given object by Path,
1373 * \param theObject The object to be displaced.
1374 * \param thePath Wire or Edge along that the object will be translated.
1375 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
1376 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
1377 * \param theReverse is a true or false parameter. True is to reverse
1378 * direction, false is to move normal direction.
1379 * \return New GEOM_Object, containing the displaced shape.
1381 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
1382 in GEOM_Object thePath,
1383 in double theDistance,
1385 in boolean theReverse);
1388 * \brief Recompute the shape from its arguments.
1389 * \param theObject The object to be recomputed.
1390 * \return theObject.
1392 GEOM_Object RecomputeObject (in GEOM_Object theObject);
1396 * \brief Interface for 3D primitives creation
1398 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
1399 * Pipe (extrusion along contour), Revolution, Solid (from shell).
1401 interface GEOM_I3DPrimOperations : GEOM_IOperations
1404 * \brief Create a box with specified dimensions along the coordinate axes
1405 * and with edges, parallel to the coordinate axes.
1407 * Center of the box will be at point (DX/2, DY/2, DZ/2).
1408 * \param theDX Length of Box edges, parallel to OX axis.
1409 * \param theDY Length of Box edges, parallel to OY axis.
1410 * \param theDZ Length of Box edges, parallel to OZ axis.
1411 * \return New GEOM_Object, containing the created box.
1413 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
1416 * \brief Create a box with two specified opposite vertices,
1417 * and with edges, parallel to the coordinate axes
1418 * \param thePnt1 First of two opposite vertices.
1419 * \param thePnt2 Second of two opposite vertices.
1420 * \return New GEOM_Object, containing the created box.
1422 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1425 * \brief Create a face specified dimensions along OX-OY coordinate axes,
1426 * with edges parallel to the coordinate axes.
1428 * Center of the face will be at point (0, 0, 0).
1429 * \param theH Height of the Face.
1430 * \param theW Width of the Face.
1431 * \param theOrientation Orientation belong axis OXY OYZ OZX
1432 * \return New GEOM_Object, containing the created face.
1434 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1436 * \brief Create a face by normale vector or edge and two specified sizes,
1437 * vertical (H) and horisontal (W).
1438 * \param theObj defines plane.
1439 * \param theH vertical size (height).
1440 * \param theW horisontal size (width).
1441 * \return New GEOM_Object, containing the created face.
1443 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1445 * \brief Create a Disk (circular face) with given center, normal vector and radius.
1446 * \param thePnt disk center.
1447 * \param theVec Vector, normal to the plane of the disk.
1448 * \param theR Disk radius.
1449 * \return New GEOM_Object, containing the created disk.
1451 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1452 in GEOM_Object theVec,
1455 * \brief Create a disk (circular face), passing through three given points
1456 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1457 * \return New GEOM_Object, containing the created disk.
1459 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1460 in GEOM_Object thePnt2,
1461 in GEOM_Object thePnt3);
1464 * \brief Create a disk specified dimensions along OX-OY coordinate axes.
1466 * Center of the disk at point (0, 0, 0).
1467 * \param theR of the Disk.
1468 * \param theOrientation Orientation belong axis OXY OYZ OZX
1469 * \return New GEOM_Object, containing the created disk.
1471 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1474 * \brief Create a cylinder with given radius, height and angle (portion of cylinder) at
1475 * the origin of coordinate system.
1477 * Axis of the cylinder will be collinear to the OZ axis of the coordinate system.
1478 * \param theR Cylinder radius.
1479 * \param theH Cylinder height.
1480 * \param theA Cylinder angle.
1481 * \return New GEOM_Object, containing the created cylinder.
1483 GEOM_Object MakeCylinderRH (in double theR, in double theH, in double theA);
1486 * \brief Create a cylinder with given base point, axis, radius, height and angle (portion of cylinder).
1487 * \param thePnt Central point of cylinder base.
1488 * \param theAxis Cylinder axis.
1489 * \param theR Cylinder radius.
1490 * \param theH Cylinder height.
1491 * \param theA Cylinder angle.
1492 * \return New GEOM_Object, containing the created cylinder.
1494 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1495 in GEOM_Object theAxis,
1501 * \brief Create a cone with given height and radiuses at
1502 * the origin of coordinate system.
1504 * Axis of the cone will be collinear to the OZ axis of the coordinate system.
1505 * \param theR1 Radius of the first cone base.
1506 * \param theR2 Radius of the second cone base.
1507 * \note If both radiuses are non-zero, the cone will be truncated.
1508 * \note If the radiuses are equal, a cylinder will be created instead.
1509 * \param theH Cone height.
1510 * \return New GEOM_Object, containing the created cone.
1512 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1515 * \brief Create a cone with given base point, axis, height and radiuses.
1516 * \param thePnt Central point of the first cone base.
1517 * \param theAxis Cone axis.
1518 * \param theR1 Radius of the first cone base.
1519 * \param theR2 Radius of the second cone base.
1520 * \note If both radiuses are non-zero, the cone will be truncated.
1521 * \note If the radiuses are equal, a cylinder will be created instead.
1522 * \param theH Cone height.
1523 * \return New GEOM_Object, containing the created cone.
1525 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1526 in GEOM_Object theAxis,
1532 * \brief Create a torus with given radiuses at the origin of coordinate system.
1533 * \param theRMajor Torus major radius.
1534 * \param theRMinor Torus minor radius.
1535 * \return New GEOM_Object, containing the created torus.
1537 GEOM_Object MakeTorusRR (in double theRMajor,
1538 in double theRMinor);
1541 * \brief Create a torus with given center, normal vector and radiuses.
1542 * \param thePnt Torus central point.
1543 * \param theVec Torus axis of symmetry.
1544 * \param theRMajor Torus major radius.
1545 * \param theRMinor Torus minor radius.
1546 * \return New GEOM_Object, containing the created torus.
1548 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1549 in GEOM_Object theVec,
1550 in double theRMajor,
1551 in double theRMinor);
1554 * \brief Create a sphere with given radius at the origin of coordinate system.
1555 * \param theR Sphere radius.
1556 * \return New GEOM_Object, containing the created sphere.
1558 GEOM_Object MakeSphereR (in double theR);
1561 * \brief Create a sphere with given center and radius.
1562 * \param thePnt Sphere center.
1563 * \param theR Sphere radius.
1564 * \return New GEOM_Object, containing the created .
1566 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1569 * \brief Create a shape by extrusion of the base shape along the vector
1571 * All the space, transfixed by the base shape during its translation
1572 * along the vector on the given distance.
1573 * \param theBase Base shape to be extruded.
1574 * \param theVec Direction of extrusion.
1575 * \param theH Prism dimension along theVec.
1576 * \return New GEOM_Object, containing the created prism.
1578 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1579 in GEOM_Object theVec,
1581 /* \brief The Same Prism but in 2 directions (forward&backward) */
1582 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1583 in GEOM_Object theVec,
1585 /* \brief The Same as MakePrismVecH but with scaling */
1586 GEOM_Object MakePrismVecHWithScaling (in GEOM_Object theBase,
1587 in GEOM_Object theVec,
1589 in double theScaleFactor);
1592 * \brief Create a shape by extrusion of the base shape along a vector, defined by two points.
1593 * \param theBase Base shape to be extruded.
1594 * \param thePoint1 First end of extrusion vector.
1595 * \param thePoint2 Second end of extrusion vector.
1596 * \return New GEOM_Object, containing the created prism.
1598 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1599 in GEOM_Object thePoint1,
1600 in GEOM_Object thePoint2);
1601 /* \brief The same prism but in two directions forward&backward */
1602 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1603 in GEOM_Object thePoint1,
1604 in GEOM_Object thePoint2);
1605 /* \brief The Same as MakePrismTwoPnt but with scaling */
1606 GEOM_Object MakePrismTwoPntWithScaling (in GEOM_Object theBase,
1607 in GEOM_Object thePoint1,
1608 in GEOM_Object thePoint2,
1609 in double theScaleFactor);
1612 * \brief Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1613 * \param theBase Base shape to be extruded.
1614 * \param theDX, theDY, theDZ end of extrusion vector.
1615 * \return New GEOM_Object, containing the created prism.
1617 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1618 in double theDX, in double theDY, in double theDZ);
1619 /* \brief The same prism but in two directions forward&backward */
1620 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1621 in double theDX, in double theDY, in double theDZ);
1622 /* \brief The Same as MakePrismDXDYDZ but with scaling */
1623 GEOM_Object MakePrismDXDYDZWithScaling (in GEOM_Object theBase,
1624 in double theDX, in double theDY, in double theDZ,
1625 in double theScaleFactor);
1629 * \brief Add / Remove material to / from a solid by extrusion of the base shape on the given distance.
1630 * \param theInitShape Initial shape on which to perform the feature.It has to be a solid or
1631 * a compound made of a single solid
1632 * \param theBase Edge or wire defining the base shape to be extruded.
1633 * \param theHeight Prism dimension along the normal of the face.
1634 * \param theAngle Draft angel in degrees
1635 * \param theFuse If true material is added else material is removed
1636 * \return New GEOM_Object, containing the modified shape
1638 GEOM_Object MakeDraftPrism (in GEOM_Object theInitShape,
1639 in GEOM_Object theBase,
1640 in double theHeight,
1642 in boolean theFuse);
1645 * \brief Create a shape by extrusion of the base shape along
1646 * the path shape. The path shape can be a wire or an edge.
1647 * \param theBase Base shape to be extruded.
1648 * \param thePath Path shape to extrude the base shape along it.
1649 * \return New GEOM_Object, containing the created pipe.
1651 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1654 * \brief Create a shape by revolution of the base shape around the axis
1655 * on the given angle.
1657 * All the space, transfixed by the base
1658 * shape during its rotation around the axis on the given angle.
1659 * \param theBase Base shape to be rotated.
1660 * \param theAxis Rotation axis.
1661 * \param theAngle Rotation angle in radians.
1662 * \return New GEOM_Object, containing the created revolution.
1664 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1665 in GEOM_Object theAxis,
1666 in double theAngle);
1667 /* The Same Revolution but in both ways forward&backward */
1668 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1669 in GEOM_Object theAxis,
1670 in double theAngle);
1673 * \brief Create a filling from the given compound of contours.
1674 * \param theShape Initial shape on which to perform the feature.
1675 * \param theMinDeg a minimal degree of BSpline surface to create
1676 * \param theMaxDeg a maximal degree of BSpline surface to create
1677 * \param theTol2D a 2d tolerance to be reached
1678 * \param theTol3D a 3d tolerance to be reached
1679 * \param theNbIter a number of iteration of approximation algorithm
1680 * \param theMethod Kind of method to perform filling operation.
1681 * \param theApprox Boolean indicating if result should be approximated
1682 * \return New GEOM_Object, containing the created filling surface.
1684 GEOM_Object MakeFilling (in GEOM_Object theShape,
1685 in long theMinDeg, in long theMaxDeg,
1686 in double theTol2D, in double theTol3D,
1688 in filling_oper_method theMethod,
1689 in boolean theApprox);
1692 * \brief Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1693 * \param theSeqSections - set of specified sections.
1694 * \param theModeSolid - mode defining building solid or shell
1695 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1696 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1697 * \return New GEOM_Object, containing the created shell or solid.
1699 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1700 in boolean theModeSolid,
1702 in boolean theRuled);
1705 * \brief Create a shape by extrusion of the profile shape along
1708 * The path shape can be a wire or an edge.
1709 * the several profiles can be specified in the several locations of path.
1710 * \param theSeqBases - list of Bases shape to be extruded.
1711 * \param theLocations - list of locations on the path corresponding
1712 * specified list of the Bases shapes. Number of locations
1713 * should be equal to number of bases or list of locations can be empty.
1714 * \param thePath - Path shape to extrude the base shape along it.
1715 * \param theWithContact - the mode defining that the section is translated to be in
1716 * contact with the spine.
1717 * \param theWithCorrection - defining that the section is rotated to be
1718 * orthogonal to the spine tangent in the correspondent point
1719 * \return New GEOM_Object, containing the created pipe.
1721 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1722 in ListOfGO theLocations,
1723 in GEOM_Object thePath,
1724 in boolean theWithContact ,
1725 in boolean theWithCorrection );
1728 * \brief Create a shape by extrusion of the profile shape along
1731 * The path shape can be a shell or a face.
1732 * the several profiles can be specified in the several locations of path.
1733 * \param theSeqBases - list of Bases shape to be extruded.
1734 * \param theSeqSubBases - list of corresponding sub-shapes of section shapes.
1735 * \param theLocations - list of locations on the path corresponding
1736 * specified list of the Bases shapes. Number of locations
1737 * should be equal to number of bases.
1738 * \param thePath - Path shape to extrude the base shape along it.
1739 * \param theWithContact - the mode defining that the section is translated to be in
1740 * contact with the spine.
1741 * \param theWithCorrection - defining that the section is rotated to be
1742 * orthogonal to the spine tangent in the correspondent point
1743 * \return New GEOM_Object, containing the created pipe.
1745 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1746 in ListOfGO theSeqSubBases,
1747 in ListOfGO theLocations,
1748 in GEOM_Object thePath,
1749 in boolean theWithContact ,
1750 in boolean theWithCorrection );
1753 * \brief Create solids between given sections
1754 * \param theSeqBases - list of sections (shell or face).
1755 * \param theLocations - list of corresponding vertexes
1756 * \return New GEOM_Object, containing the created solids.
1758 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1759 in ListOfGO theLocations);
1762 * \brief Create a shape by extrusion of the base shape along
1763 * the path shape with constant bi-normal direction along the given vector.
1765 * The path shape can be a wire or an edge.
1766 * \param theBase Base shape to be extruded.
1767 * \param thePath Path shape to extrude the base shape along it.
1768 * \param theVec Vector defines a constant binormal direction to keep the
1769 * same angle beetween the Direction and the sections
1770 * along the sweep surface.
1771 * \return New GEOM_Object, containing the created pipe.
1773 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1774 in GEOM_Object thePath,
1775 in GEOM_Object theVec);
1779 * \brief Make a thick solid from a surface shape (face or shell)
1780 * \param theObject Surface from which the thick solid is made
1781 * \param theThickness Value of the thickness
1782 * \param isCopy To make a copy of \a theObject ot to modify \a theObject.
1783 * \return New GEOM_Object, containing the created pipe if isCopy = true
1784 * or the modified object if isCopy = false
1786 GEOM_Object MakeThickening (in GEOM_Object theObject,
1787 in double theThickness,
1792 * \brief Build a middle path of a pipe-like shape.
1794 * The path shape can be a wire or an edge.
1795 * \param theShape It can be closed or unclosed pipe-like shell
1796 * or a pipe-like solid.
1797 * \param theBase1, theBase2 Two bases of the supposed pipe. This
1798 * should be wires or faces of \a theShape.
1799 * \note It is not assumed that exact or approximate copy of \a theShape
1800 * can be obtained by applying existing Pipe operation on the
1801 * resulting "Path" wire taking \a theBase1 as the base - it is not
1802 * always possible; though in some particular cases it might work
1803 * it is not guaranteed. Thus, RestorePath function should not be
1804 * considered as an exact reverse operation of the Pipe.
1805 * \return New GEOM_Object, containing an edge or wire that represent
1806 * source pipe's "path".
1808 GEOM_Object RestorePath (in GEOM_Object theShape,
1809 in GEOM_Object theBase1,
1810 in GEOM_Object theBase2);
1813 * \brief Build a middle path of a pipe-like shape.
1815 * The path shape can be a wire or an edge.
1816 * \param theShape It can be closed or unclosed pipe-like shell
1817 * or a pipe-like solid.
1818 * \param theBase1, theBase2 Two bases of the supposed pipe. This
1819 * should be lists of edges of \a theShape.
1820 * \note It is not assumed that exact or approximate copy of \a theShape
1821 * can be obtained by applying existing Pipe operation on the
1822 * resulting "Path" wire taking \a theBase1 as the base - it is not
1823 * always possible; though in some particular cases it might work
1824 * it is not guaranteed. Thus, RestorePath function should not be
1825 * considered as an exact reverse operation of the Pipe.
1826 * \return New GEOM_Object, containing an edge or wire that represent
1827 * source pipe's "path".
1829 GEOM_Object RestorePathEdges (in GEOM_Object theShape,
1830 in ListOfGO theBase1,
1831 in ListOfGO theBase2);
1835 * \brief Interface for Shapes creation:
1837 * Edge from two points, Wire from edges, Face from wire,
1838 * Shell from faces, Solid from shells, Compound from shapes
1840 interface GEOM_IShapesOperations : GEOM_IOperations
1843 * \brief Create a linear edge with specified ends.
1844 * \param thePnt1 Point for the first end of edge.
1845 * \param thePnt2 Point for the second end of edge.
1846 * \return New GEOM_Object, containing the created edge.
1848 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1851 * \brief Create an edge on another edge, corresponding to the given length on the given edge.
1852 * \param theRefCurve The referenced edge.
1853 * \param theLength Length on the referenced edge. It can be
1854 * negative for extrapolation on base curve.
1855 * \param theStartPoint Any vertex close to one of edge's
1856 * ends to select start point among them.
1857 * If NULL, fist vertex is used.
1858 * \return New GEOM_Object, containing the created edge.
1860 GEOM_Object MakeEdgeOnCurveByLength (in GEOM_Object theRefCurve,
1861 in double theLength,
1862 in GEOM_Object theStartPoint);
1865 * \brief Create an edge from specified wire.
1866 * \param theWire source Wire.
1867 * \param theLinearTolerance linear tolerance value
1868 * \param theAngularTolerance angular tolerance value
1869 * \return New GEOM_Object, containing the created edge.
1871 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1872 in double theLinearTolerance,
1873 in double theAngularTolerance);
1876 * \brief Create a wire from the set of edges and wires.
1877 * \param theEdgesAndWires List of edge and/or wires.
1878 * \param theTolerance Maximum distance between vertices, that will be merged.
1879 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1880 * \return New GEOM_Object, containing the created wire.
1882 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1883 in double theTolerance);
1886 * \brief Create a face on the given wire.
1887 * \param theWire closed Wire or Edge to build the face on.
1888 * \param isPlanarWanted If TRUE, only planar face will be built.
1889 * If impossible, NULL object will be returned.
1890 * \return New GEOM_Object, containing the created face.
1892 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1895 * \brief Create a face on the given wires set.
1896 * \param theWires List of closed wires or edges to build the face on.
1897 * \param isPlanarWanted If TRUE, only planar face will be built.
1898 * If impossible, NULL object will be returned.
1899 * \return New GEOM_Object, containing the created face.
1901 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1904 * \brief Create a shell from the set of faces and shells.
1905 * \param theFacesAndShells List of faces and/or shells.
1906 * \return New GEOM_Object, containing the created shell.
1908 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1911 * \brief Create a solid, bounded by the given shell.
1912 * \param theShell Bounding shell.
1913 * \return New GEOM_Object, containing the created solid.
1915 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1918 * \brief Create a solid, bounded by the given shells.
1919 * \param theShells Bounding shells.
1920 * \return New GEOM_Object, containing the created solid.
1922 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1925 * \brief Create a compound of the given shapes.
1926 * \param theShapes List of shapes to put in compound.
1927 * \return New GEOM_Object, containing the created compound.
1929 GEOM_Object MakeCompound (in ListOfGO theShapes);
1932 * \brief Replace coincident faces in theShape by one face.
1933 * \param theShape Initial shape.
1934 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1935 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1936 * \return New GEOM_Object, containing a copy of theShape without coincident faces.
1938 GEOM_Object MakeGlueFaces (in GEOM_Object theShape, in double theTolerance, in boolean doKeepNonSolids);
1941 * Find coincident faces in theShape for possible gluing.
1942 * \param theShape Initial shape.
1943 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1946 ListOfGO GetGlueFaces (in GEOM_Object theShape, in double theTolerance);
1949 * \brief Replace coincident faces in theShape by one face
1950 * in compliance with given list of faces
1951 * \param theShape Initial shape.
1952 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
1953 * \param theFaces List of faces for gluing.
1954 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
1955 * \param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
1956 * will be glued, otherwise only the edges,
1957 * belonging to <VAR>theFaces</VAR>.
1958 * \return New GEOM_Object, containing a copy of theShape without some faces.
1960 GEOM_Object MakeGlueFacesByList (in GEOM_Object theShape, in double theTolerance,
1961 in ListOfGO theFaces, in boolean doKeepNonSolids,
1962 in boolean doGlueAllEdges);
1965 * \brief Replace coincident edges in theShape by one edge.
1966 * \param theShape Initial shape.
1967 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1968 * \return New GEOM_Object, containing a copy of theShape without coincident edges.
1970 GEOM_Object MakeGlueEdges (in GEOM_Object theShape, in double theTolerance);
1973 * Find coincident edges in theShape for possible gluing.
1974 * \param theShape Initial shape.
1975 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1978 ListOfGO GetGlueEdges (in GEOM_Object theShape, in double theTolerance);
1981 * \brief Replace coincident edges in theShape by one edge
1982 * in compliance with given list of edges
1983 * \param theShape Initial shape.
1984 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
1985 * \param theEdges List of edges for gluing.
1986 * \return New GEOM_Object, containing a copy of theShape without some edges.
1988 GEOM_Object MakeGlueEdgesByList (in GEOM_Object theShape,
1989 in double theTolerance,
1990 in ListOfGO theEdges);
1993 * \brief Get all sub-shapes and groups of \a theShape,
1994 * that were created already by any other methods.
1995 * \param theShape Any shape.
1996 * \param theGroupsOnly If this parameter is TRUE, only groups will be
1997 * returned, else all found sub-shapes and groups.
1998 * \return List of existing sub-objects of \a theShape.
2000 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
2001 in boolean theGroupsOnly);
2004 * \brief Deprecated method.
2006 * Use MakeAllSubShapes() instead.
2008 ListOfGO MakeExplode (in GEOM_Object theShape,
2009 in long theShapeType,
2010 in boolean isSorted);
2013 * \brief Explode a shape on sub-shapes of a given type.
2015 * If the shape itself has the given type, it is also returned.
2016 * \param theShape Shape to be exploded.
2017 * \param theShapeType Type of sub-shapes to be retrieved.
2018 * \param isSorted If this parameter is TRUE, sub-shapes will be
2019 * sorted by coordinates of their gravity centers.
2020 * \return List of sub-shapes of type theShapeType, contained in theShape.
2022 ListOfGO MakeAllSubShapes (in GEOM_Object theShape,
2023 in long theShapeType,
2024 in boolean isSorted);
2027 * \brief Extract all sub-shapes of the given type from
2028 * the given shape, excluding the shape itself.
2029 * \param theShape Shape to be exploded.
2030 * \param theShapeType Type of sub-shapes to be retrieved.
2031 * \param isSorted If this parameter is TRUE, sub-shapes will be
2032 * sorted by coordinates of their gravity centers.
2033 * \return List of sub-shapes of type theShapeType, contained in theShape.
2035 ListOfGO ExtractSubShapes (in GEOM_Object theShape,
2036 in long theShapeType,
2037 in boolean isSorted);
2040 * \brief Deprecated method. Use GetAllSubShapesIDs() instead.
2042 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
2043 in long theShapeType,
2044 in boolean isSorted);
2047 * \brief Explode a shape on sub-shapes of a given type.
2049 * Does the same, as MakeAllSubShapes, but returns IDs of
2050 * sub-shapes, not GEOM_Object. It works faster.
2051 * \param theShape Shape to be exploded.
2052 * \param theShapeType Type of sub-shapes to be retrieved.
2053 * \param isSorted If this parameter is TRUE, sub-shapes will be
2054 * sorted by coordinates of their gravity centers.
2055 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
2057 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
2058 in long theShapeType,
2059 in boolean isSorted);
2062 * \brief Get a sub-shape defined by its unique ID inside \a theMainShape
2063 * \param theMainShape Main shape.
2064 * \param theID Unique ID of sub-shape inside \a theMainShape.
2065 * \return GEOM_Object, corresponding to found sub-shape.
2066 * \note The sub-shape GEOM_Object can has ONLY ONE function.
2067 * Don't try to apply modification operations (without copy) on them.
2069 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
2073 * \brief Get a set of sub-shapes defined by their unique IDs inside \a theMainShape
2074 * \param theMainShape Main shape.
2075 * \param theIndices List of unique IDs of sub-shapes inside \a theMainShape.
2076 * \return List of GEOM_Object, corresponding to found sub-shapes.
2077 * \note The sub-shape GEOM_Object can has ONLY ONE function.
2078 * Don't try to apply modification operations (without copy) on them.
2080 ListOfGO MakeSubShapes (in GEOM_Object theMainShape,
2081 in ListOfLong theIndices);
2084 * Get global index of \a theSubShape in \a theMainShape.
2085 * \param theMainShape Main shape.
2086 * \param theSubShape Sub-shape of the main shape.
2087 * \return global index of \a theSubShape in \a theMainShape.
2089 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
2092 * Get global indices of \a theSubShapes in \a theMainShape.
2093 * \param theMainShape Main shape.
2094 * \param theSubShapes List of sub-shapes of the main shape.
2095 * \return list of global indices of \a theSubShapes in \a theMainShape.
2097 ListOfLong GetSubShapesIndices (in GEOM_Object theMainShape, in ListOfGO theSubShapes);
2100 * \brief Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
2102 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
2103 * to generate automatic names for sub-shapes, when publishing them in a study.
2104 * \param theMainShape Main shape.
2105 * \param theSubShape Sub-shape of the main shape.
2106 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
2108 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
2111 * \brief Get name of type of \a theShape.
2113 * Use wide type notation, taking into consideration both topology and geometry of the shape.
2114 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
2115 * to generate automatic names for sub-shapes, when publishing them in a study.
2116 * \param theShape The shape to get a type of.
2117 * \return String, containing a type name of \a theShape.
2119 string GetShapeTypeString (in GEOM_Object theShape);
2122 * \brief Count number of faces in the given shape.
2123 * \param theShape Shape to count faces in.
2124 * \return Number of faces in the given shape.
2126 long NumberOfFaces (in GEOM_Object theShape);
2129 * \brief Count number of edges in the given shape.
2130 * \param theShape Shape to count edges in.
2131 * \return Number of edges in theShape.
2133 long NumberOfEdges (in GEOM_Object theShape);
2136 * \brief Count number of sub-shapes of type \a theShapeType in the given shape.
2137 * \param theShape Shape to count sub-shapes in.
2138 * \param theShapeType The type of sub-shapes to count.
2139 * \return Number of sub-shapes of type \a theShapeType in \a theShape.
2141 long NumberOfSubShapes (in GEOM_Object theShape,
2142 in long theShapeType);
2145 * Reverses an orientation the given shape.
2146 * \param theShape Shape to be reversed.
2147 * \return The reversed copy of theShape.
2149 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
2152 * \brief Retrieve all free faces from the given shape.
2154 * Free face is a face, which is not shared between two shells of the shape.
2155 * \param theShape Shape to find free faces in.
2156 * \return List of IDs of all free faces, contained in theShape.
2158 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
2161 * \brief Get all sub-shapes of theShape1 of the given type, shared with theShape2.
2162 * \param theShape1 Shape to find sub-shapes in.
2163 * \param theShape2 Shape to find shared sub-shapes with.
2164 * \param theShapeType Type of sub-shapes to be retrieved.
2165 * \return List of sub-shapes of theShape1, shared with theShape2.
2167 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
2168 in GEOM_Object theShape2,
2169 in long theShapeType);
2172 * \brief Get all sub-shapes, shared by all shapes in the list \a theShapes.
2173 * \param theShapes Shapes to find common sub-shapes of.
2174 * \param theShapeType Type of sub-shapes to be retrieved.
2175 * \return List of objects, that are sub-shapes of all given shapes.
2177 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
2178 in long theShapeType);
2181 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2182 * the specified plane by the certain way, defined through \a theState parameter.
2183 * \param theShape Shape to find sub-shapes of.
2184 * \param theShapeType Type of sub-shapes to be retrieved.
2185 * \param theAx1 Vector (or line, or linear edge), specifying normal
2186 * direction and location of the plane to find shapes on.
2187 * \param theState The state of the sub-shapes to find.
2188 * \return List of all found sub-shapes.
2190 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
2191 in long theShapeType,
2192 in GEOM_Object theAx1,
2193 in shape_state theState);
2195 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2196 * the specified plane by the certain way, defined through \a theState parameter.
2197 * \param theShape Shape to find sub-shapes of.
2198 * \param theShapeType Type of sub-shapes to be retrieved.
2199 * \param theAx1 Vector (or line, or linear edge), specifying normal
2200 * direction of the plane to find shapes on.
2201 * \param thePnt Point specifying location of the plane to find shapes on.
2202 * \param theState The state of the sub-shapes to find.
2203 * \return List of all found sub-shapes.
2205 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
2206 in long theShapeType,
2207 in GEOM_Object theAx1,
2208 in GEOM_Object thePnt,
2209 in shape_state theState);
2214 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2215 * the specified cylinder by the certain way, defined through \a theState parameter.
2216 * \param theShape Shape to find sub-shapes of.
2217 * \param theShapeType Type of sub-shapes to be retrieved.
2218 * \param theAxis Vector (or line, or linear edge), specifying
2219 * axis of the cylinder to find shapes on.
2220 * \param theRadius Radius of the cylinder to find shapes on.
2221 * \param theState The state of the sub-shapes to find.
2222 * \return List of all found sub-shapes.
2224 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
2225 in long theShapeType,
2226 in GEOM_Object theAxis,
2227 in double theRadius,
2228 in shape_state theState);
2231 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2232 * the specified cylinder by the certain way, defined through \a theState parameter.
2233 * \param theShape Shape to find sub-shapes of.
2234 * \param theShapeType Type of sub-shapes to be retrieved.
2235 * \param theAxis Vector (or line, or linear edge), specifying
2236 * axis of the cylinder to find shapes on.
2237 * \param thePnt Point specifying location of the bottom of the cylinder.
2238 * \param theRadius Radius of the cylinder to find shapes on.
2239 * \param theState The state of the sub-shapes to find.
2240 * \return List of all found sub-shapes.
2242 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
2243 in long theShapeType,
2244 in GEOM_Object theAxis,
2245 in GEOM_Object thePnt,
2246 in double theRadius,
2247 in shape_state theState);
2250 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2251 * the specified sphere by the certain way, defined through \a theState parameter.
2252 * \param theShape Shape to find sub-shapes of.
2253 * \param theShapeType Type of sub-shapes to be retrieved.
2254 * \param theCenter Point, specifying center of the sphere to find shapes on.
2255 * \param theRadius Radius of the sphere to find shapes on.
2256 * \param theState The state of the sub-shapes to find.
2257 * \return List of all found sub-shapes.
2259 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
2260 in long theShapeType,
2261 in GEOM_Object theCenter,
2262 in double theRadius,
2263 in shape_state theState);
2266 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2267 * the specified quadrangle by the certain way, defined through \a theState parameter.
2268 * \param theShape Shape to find sub-shapes of.
2269 * \param theShapeType Type of sub-shapes to be retrieved.
2270 * \param theTopLeftPoint Top left quadrangle corner
2271 * \param theTopRigthPoint Top right quadrangle corner
2272 * \param theBottomLeftPoint Bottom left quadrangle corner
2273 * \param theBottomRigthPoint Bottom right quadrangle corner
2274 * \param theState The state of the sub-shapes to find.
2275 * \return List of all found sub-shapes.
2277 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
2278 in long theShapeType,
2279 in GEOM_Object theTopLeftPoint,
2280 in GEOM_Object theTopRigthPoint,
2281 in GEOM_Object theBottomLeftPoint,
2282 in GEOM_Object theBottomRigthPoint,
2283 in shape_state theState);
2286 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2287 * the specified plane by the certain way, defined through \a theState parameter.
2288 * \param theShape Shape to find sub-shapes of.
2289 * \param theShapeType Type of sub-shapes to be retrieved.
2290 * \param theAx1 Vector (or line, or linear edge), specifying normal
2291 * direction and location of the plane to find shapes on.
2292 * \param theState The state of the sub-shapes to find.
2293 * \return List of IDs of all found sub-shapes.
2295 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
2296 in long theShapeType,
2297 in GEOM_Object theAx1,
2298 in shape_state theState);
2301 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2302 * the specified plane by the certain way, defined through \a theState parameter.
2303 * \param theShape Shape to find sub-shapes of.
2304 * \param theShapeType Type of sub-shapes to be retrieved.
2305 * \param theAx1 Vector (or line, or linear edge), specifying normal
2306 * direction of the plane to find shapes on.
2307 * \param thePnt Point specifying location of the plane to find shapes on.
2308 * \param theState The state of the sub-shapes to find.
2309 * \return List of IDs of all found sub-shapes.
2311 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
2312 in long theShapeType,
2313 in GEOM_Object theAx1,
2314 in GEOM_Object thePnt,
2315 in shape_state theState);
2318 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2319 * the specified cylinder by the certain way, defined through \a theState parameter.
2320 * \param theShape Shape to find sub-shapes of.
2321 * \param theShapeType Type of sub-shapes to be retrieved.
2322 * \param theAxis Vector (or line, or linear edge), specifying
2323 * axis of the cylinder to find shapes on.
2324 * \param theRadius Radius of the cylinder to find shapes on.
2325 * \param theState The state of the sub-shapes to find.
2326 * \return List of IDs of all found sub-shapes.
2328 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
2329 in long theShapeType,
2330 in GEOM_Object theAxis,
2331 in double theRadius,
2332 in shape_state theState);
2335 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2336 * the specified cylinder by the certain way, defined through \a theState parameter.
2337 * \param theShape Shape to find sub-shapes of.
2338 * \param theShapeType Type of sub-shapes to be retrieved.
2339 * \param theAxis Vector (or line, or linear edge), specifying
2340 * axis of the cylinder to find shapes on.
2341 * \param thePnt Point specifying location of the bottom of the cylinder.
2342 * \param theRadius Radius of the cylinder to find shapes on.
2343 * \param theState The state of the sub-shapes to find.
2344 * \return List of IDs all found sub-shapes.
2346 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
2347 in long theShapeType,
2348 in GEOM_Object theAxis,
2349 in GEOM_Object thePnt,
2350 in double theRadius,
2351 in shape_state theState);
2354 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2355 * the specified sphere by the certain way, defined through \a theState parameter.
2356 * \param theShape Shape to find sub-shapes of.
2357 * \param theShapeType Type of sub-shapes to be retrieved.
2358 * \param theCenter Point, specifying center of the sphere to find shapes on.
2359 * \param theRadius Radius of the sphere to find shapes on.
2360 * \param theState The state of the sub-shapes to find.
2361 * \return List of IDs of all found sub-shapes.
2363 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
2364 in long theShapeType,
2365 in GEOM_Object theCenter,
2366 in double theRadius,
2367 in shape_state theState);
2370 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2371 * the specified quadrangle by the certain way, defined through \a theState parameter.
2372 * \param theShape Shape to find sub-shapes of.
2373 * \param theShapeType Type of sub-shapes to be retrieved.
2374 * \param theTopLeftPoint Top left quadrangle corner
2375 * \param theTopRigthPoint Top right quadrangle corner
2376 * \param theBottomLeftPoint Bottom left quadrangle corner
2377 * \param theBottomRigthPoint Bottom right quadrangle corner
2378 * \param theState The state of the sub-shapes to find.
2379 * \return List of IDs of all found sub-shapes.
2381 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
2382 in long theShapeType,
2383 in GEOM_Object theTopLeftPoint,
2384 in GEOM_Object theTopRigthPoint,
2385 in GEOM_Object theBottomLeftPoint,
2386 in GEOM_Object theBottomRigthPoint,
2387 in shape_state theState);
2390 * \brief Find sub-shapes complying with given status
2391 * \param theBox - the box to check state of sub-shapes against
2392 * \param theShape - the shape to explore
2393 * \param theShapeType - type of sub-shape of theShape
2394 * \param theState - required state
2395 * \return List of IDs of all found sub-shapes.
2397 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
2398 in GEOM_Object theShape,
2399 in long theShapeType,
2400 in shape_state theState);
2403 * \brief Find sub-shapes complying with given status
2404 * \param theBox - the box to check state of sub-shapes against
2405 * \param theShape - the shape to explore
2406 * \param theShapeType - type of sub-shape of theShape
2407 * \param theState - required state
2408 * \return List of all found sub-shapes.
2410 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
2411 in GEOM_Object theShape,
2412 in long theShapeType,
2413 in shape_state theState);
2416 * \brief Find sub-shapes complying with given status
2417 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2418 * \param theShape - the shape to explore
2419 * \param theShapeType - type of sub-shape of theShape
2420 * \param theState - required state
2421 * \return List of IDs of all found sub-shapes.
2423 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
2424 in GEOM_Object theShape,
2425 in short theShapeType,
2426 in shape_state theState);
2429 * \brief Find sub-shapes complying with given status
2430 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2431 * \param theShape - the shape to explore
2432 * \param theShapeType - type of sub-shape of theShape
2433 * \param theState - required state
2434 * \return List of all found sub-shapes.
2436 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
2437 in GEOM_Object theShape,
2438 in short theShapeType,
2439 in shape_state theState);
2442 * \brief Find sub-shapes complying with given status
2443 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2444 * \param theShape - the shape to explore
2445 * \param theShapeType - type of sub-shape of theShape
2446 * \param theState - required state
2447 * \return compound includes all found sub-shapes.
2449 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
2450 in GEOM_Object theShape,
2451 in short theShapeType,
2452 in shape_state theState);
2455 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2456 * coincident with \a theShapeWhat or could be a part of it.
2457 * \param theShapeWhere Shape to find sub-shapes of.
2458 * \param theShapeWhat Shape, specifying what to find.
2459 * \return Group of all found sub-shapes or a single found sub-shape.
2461 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
2462 in GEOM_Object theShapeWhat);
2465 * Old implementation of GetInPlace functionality, based on shape properties.
2467 GEOM_Object GetInPlaceOld (in GEOM_Object theShapeWhere,
2468 in GEOM_Object theShapeWhat);
2471 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2472 * coincident with \a theShapeWhat or could be a part of it.
2474 * Implementation of this method is based on a saved history of an operation,
2475 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
2476 * arguments (an argument shape or a sub-shape of an argument shape).
2477 * The operation could be the Partition or one of boolean operations,
2478 * performed on simple shapes (not on compounds).
2480 * \param theShapeWhere Shape to find sub-shapes of.
2481 * \param theShapeWhat Shape, specifying what to find.
2482 * \return Group of all found sub-shapes or a single found sub-shape.
2484 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
2485 in GEOM_Object theShapeWhat);
2488 * \brief Get sub-shape of theShapeWhere, which are
2489 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2490 * \param theShapeWhere Shape to find sub-shapes of.
2491 * \param theShapeWhat Shape, specifying what to find.
2492 * \return found sub-shape.
2494 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
2495 in GEOM_Object theShapeWhat);
2498 * \brief Get sub-shape Ids of theShapeWhere, which are
2499 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2500 * \param theShapeWhere Shape to find sub-shapes of.
2501 * \param theShapeWhat Shape, specifying what to find.
2502 * \return found sub-shape Ids.
2504 ListOfLong GetSameIDs (in GEOM_Object theShapeWhere,
2505 in GEOM_Object theShapeWhat);
2509 // # GEOM_IBlocksOperations:
2511 * \brief Interface for Blocks construction
2512 * Face from points or edges, Block from faces,
2513 * Blocks multi-translation and multi-rotation
2515 interface GEOM_IBlocksOperations : GEOM_IOperations
2518 // # Creation of blocks
2521 * \brief Create a quadrangle face from four edges. Order of Edges is not
2522 * important. It is not necessary that edges share the same vertex.
2523 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
2524 * \return New GEOM_Object, containing the created face.
2526 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
2527 in GEOM_Object theEdge2,
2528 in GEOM_Object theEdge3,
2529 in GEOM_Object theEdge4);
2532 * \brief Create a quadrangle face on two edges.
2534 * The missing edges will be built by creating the shortest ones.
2535 * \param theEdge1,theEdge2 Two opposite edges for the face.
2536 * \return New GEOM_Object, containing the created face.
2538 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
2539 in GEOM_Object theEdge2);
2542 * \brief Create a quadrangle face with specified corners.
2544 * The missing edges will be built by creating the shortest ones.
2545 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
2546 * \return New GEOM_Object, containing the created face.
2548 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
2549 in GEOM_Object thePnt2,
2550 in GEOM_Object thePnt3,
2551 in GEOM_Object thePnt4);
2554 * \brief Create a hexahedral solid, bounded by the six given faces. Order of
2555 * faces is not important.
2557 * It is not necessary that Faces share the same edge.
2558 * \param theFace1,theFace2,theFace3,theFace4,theFace5,theFace6 Faces for the hexahedral solid.
2559 * \return New GEOM_Object, containing the created solid.
2561 GEOM_Object MakeHexa (in GEOM_Object theFace1,
2562 in GEOM_Object theFace2,
2563 in GEOM_Object theFace3,
2564 in GEOM_Object theFace4,
2565 in GEOM_Object theFace5,
2566 in GEOM_Object theFace6);
2569 * \brief Create a hexahedral solid between two given faces.
2571 * The missing faces will be built by creating the smallest ones.
2572 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
2573 * \return New GEOM_Object, containing the created solid.
2575 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
2576 in GEOM_Object theFace2);
2579 // # Extract elements of blocks and blocks compounds
2583 * \brief Get a vertex, found in the given shape by its coordinates.
2584 * \param theShape Block or a compound of blocks.
2585 * \param theX,theY,theZ Coordinates of the sought vertex.
2586 * \param theEpsilon Maximum allowed distance between the resulting
2587 * vertex and point with the given coordinates.
2588 * \return New GEOM_Object, containing the found vertex.
2590 GEOM_Object GetPoint (in GEOM_Object theShape,
2594 in double theEpsilon);
2597 * \brief Find a vertex of the given shape, which has minimal distance to the given point.
2598 * \param theShape Any shape.
2599 * \param thePoint Point, close to the desired vertex.
2600 * \return New GEOM_Object, containing the found vertex.
2602 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
2603 in GEOM_Object thePoint);
2606 * \brief Get an edge, found in the given shape by two given vertices.
2607 * \param theShape Block or a compound of blocks.
2608 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2609 * \return New GEOM_Object, containing the found edge.
2611 GEOM_Object GetEdge (in GEOM_Object theShape,
2612 in GEOM_Object thePoint1,
2613 in GEOM_Object thePoint2);
2616 * \brief Find an edge of the given shape, which has minimal distance to the given point.
2617 * \param theShape Block or a compound of blocks.
2618 * \param thePoint Point, close to the desired edge.
2619 * \return New GEOM_Object, containing the found edge.
2621 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
2622 in GEOM_Object thePoint);
2625 * \brief Returns a face, found in the given shape by four given corner vertices.
2626 * \param theShape Block or a compound of blocks.
2627 * \param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
2628 * \return New GEOM_Object, containing the found face.
2630 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
2631 in GEOM_Object thePoint1,
2632 in GEOM_Object thePoint2,
2633 in GEOM_Object thePoint3,
2634 in GEOM_Object thePoint4);
2637 * \brief Get a face of block, found in the given shape by two given edges.
2638 * \param theShape Block or a compound of blocks.
2639 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2640 * \return New GEOM_Object, containing the found face.
2642 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2643 in GEOM_Object theEdge1,
2644 in GEOM_Object theEdge2);
2647 * \brief Find a face, opposite to the given one in the given block.
2648 * \param theBlock Must be a hexahedral solid.
2649 * \param theFace Face of \a theBlock, opposite to the desired face.
2650 * \return New GEOM_Object, containing the found face.
2652 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2653 in GEOM_Object theFace);
2656 * \brief Find a face of the given shape, which has minimal distance to the given point.
2657 * \param theShape Block or a compound of blocks.
2658 * \param thePoint Point, close to the desired face.
2659 * \return New GEOM_Object, containing the found face.
2661 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2662 in GEOM_Object thePoint);
2665 * \brief Find a face of block, whose outside normale has minimal angle with the given vector.
2666 * \param theBlock Block or a compound of blocks.
2667 * \param theVector Vector, close to the normale of the desired face.
2668 * \return New GEOM_Object, containing the found face.
2670 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2671 in GEOM_Object theVector);
2674 * \brief Find all sub-shapes of type \a theShapeType of the given shape,
2675 * which have minimal distance to the given point.
2676 * \param theShape Any shape.
2677 * \param thePoint Point, close to the desired shape.
2678 * \param theShapeType Defines what kind of sub-shapes is searched.
2679 * \param theTolerance The tolerance for distances comparison. All shapes
2680 * with distances to the given point in interval
2681 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2682 * \return New GEOM_Object, containing a group of all found shapes.
2684 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2685 in GEOM_Object thePoint,
2686 in long theShapeType,
2687 in double theTolerance);
2689 // # Extract blocks from blocks compounds
2693 * \brief Check, if the compound contains only specified blocks.
2694 * \param theCompound The compound to check.
2695 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2696 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2697 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2698 * \param theNbBlocks Number of specified blocks in theCompound.
2699 * \return TRUE, if the given compound contains only blocks.
2701 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2702 in long theMinNbFaces,
2703 in long theMaxNbFaces,
2704 out long theNbBlocks);
2707 * \brief Enumeration of Blocks Compound defects.
2711 /* Each element of the compound should be a Block */
2714 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2717 /* A connection between two Blocks should be an entire face or an entire edge */
2720 /* The compound should be connexe */
2723 /* The glue between two quadrangle faces should be applied */
2728 * \brief Description of Blocks Compound defect: type and incriminated sub-shapes.
2733 ListOfLong incriminated;
2737 * \brief Sequence of all Blocks Compound defects.
2739 typedef sequence<BCError> BCErrors;
2742 * \brief Check, if the compound of blocks is given.
2744 * To be considered as a compound of blocks, the
2745 * given shape must satisfy the following conditions:
2746 * - Each element of the compound should be a Block (6 faces and 12 edges).
2747 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2748 * - The compound should be connexe.
2749 * - The glue between two quadrangle faces should be applied.
2750 * \note Single block is also accepted as a valid compound of blocks.
2751 * \param theCompound The compound to check.
2752 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
2753 * \return TRUE, if the given shape is a compound of blocks.
2755 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2756 out BCErrors theErrors);
2759 * \brief Convert sequence of Blocks Compound errors, returned by
2760 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2761 * \param theCompound The bad compound.
2762 * \param theErrors The sequence of \a theCompound errors.
2763 * \return String, describing all the errors in form, suitable for printing.
2765 string PrintBCErrors (in GEOM_Object theCompound,
2766 in BCErrors theErrors);
2769 * \brief Retrieve all non blocks solids and faces from a shape.
2771 * \param theShape The shape to explore.
2772 * \param theNonQuads Output parameter. Group of all non quadrangular faces.
2774 * \return Group of all non block solids (= not 6 faces, or with 6
2775 * faces, but with the presence of non-quadrangular faces).
2777 GEOM_Object GetNonBlocks (in GEOM_Object theShape, out GEOM_Object theNonQuads);
2780 * \brief Remove all seam and degenerated edges from \a theShape.
2782 * Unite faces and edges, sharing one surface.
2783 * \param theShape The compound or single solid to remove irregular edges from.
2784 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2785 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2786 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2787 * For blocks repairing recommended value is 6.
2788 * \return Improved shape.
2790 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2791 in long theOptimumNbFaces);
2794 * \brief Performs union faces of \a theShape.
2796 * Unite faces sharing one surface.
2797 * \param theShape The compound or single solid that contains faces to perform union.
2798 * \return Improved shape.
2800 GEOM_Object UnionFaces (in GEOM_Object theShape);
2803 * \brief Check, if the given shape is a blocks compound.
2805 * Fix all detected errors.
2806 * \note Single block can be also fixed by this method.
2807 * \param theCompound The compound to check and improve.
2808 * \return Improved compound.
2810 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2813 * \brief Get all the blocks, contained in the given compound.
2815 * \param theCompound The compound to explode.
2816 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2817 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2818 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2819 * \return List of GEOM_Object, containing the retrieved blocks.
2821 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2822 in long theMinNbFaces,
2823 in long theMaxNbFaces);
2826 * \brief Find block, containing the given point inside its volume or on boundary.
2827 * \param theCompound Compound, to find block in.
2828 * \param thePoint Point, close to the desired block. If the point lays on
2829 * boundary between some blocks, we return block with nearest center.
2830 * \return New GEOM_Object, containing the found block.
2832 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2833 in GEOM_Object thePoint);
2836 * \brief Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2837 * \param theCompound Compound, to find block in.
2838 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2839 * \return New GEOM_Object, containing the found block.
2841 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2842 in ListOfGO theParts);
2845 * \brief Return all blocks, containing all the elements, passed as the parts.
2846 * \param theCompound Compound, to find blocks in.
2847 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
2848 * \return List of GEOM_Object, containing the found blocks.
2850 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
2851 in ListOfGO theParts);
2853 // # Operations on blocks with gluing of result
2856 * \brief Multi-transformate block and glue the result.
2858 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
2859 * \param theBlock Hexahedral solid to be multi-transformed.
2860 * \param theDirFace1 First direction face global index.
2861 * \param theDirFace2 Second direction face global index.
2862 * \param theNbTimes Quantity of transformations to be done.
2863 * \note Global index of sub-shape can be obtained, using method
2864 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
2865 * \return New GEOM_Object, containing the result shape.
2867 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
2868 in long theDirFace1,
2869 in long theDirFace2,
2870 in long theNbTimes);
2873 * \brief Multi-transformate block and glue the result.
2874 * \param theBlock Hexahedral solid to be multi-transformed.
2875 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
2876 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
2877 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
2878 * \return New GEOM_Object, containing the result shape.
2880 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
2881 in long theDirFace1U,
2882 in long theDirFace2U,
2883 in long theNbTimesU,
2884 in long theDirFace1V,
2885 in long theDirFace2V,
2886 in long theNbTimesV);
2888 // # Special operation - propagation
2892 * \brief Build all possible propagation groups.
2894 * Propagation group is a set of all edges, opposite to one (main)
2895 * edge of this group directly or through other opposite edges.
2896 * Notion of Opposite Edge make sence only on quadrangle face.
2897 * \param theShape Shape to build propagation groups on.
2898 * \return List of GEOM_Object, each of them is a propagation group.
2900 ListOfGO Propagate (in GEOM_Object theShape);
2903 // # GEOM_IBooleanOperations
2905 * \brief Interface for boolean operations (Cut, Fuse, Common)
2907 interface GEOM_IBooleanOperations : GEOM_IOperations
2910 * \brief Perform one of boolean operations on two given shapes.
2911 * \param theShape1 First argument for boolean operation.
2912 * \param theShape2 Second argument for boolean operation.
2913 * \param theOperation Indicates the operation to be done:
2914 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
2915 * \param IsCheckSelfInte If TRUE, perform check self intersection
2916 * of arguments before an operation.
2917 * \return New GEOM_Object, containing the result shape.
2919 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
2920 in GEOM_Object theShape2,
2921 in long theOperation,
2922 in boolean IsCheckSelfInte);
2924 * \brief Perform fusion boolean operation on two given shapes.
2925 * \param theShape1 First argument for fuse operation.
2926 * \param theShape2 Second argument for fuse operation.
2927 * \param IsCheckSelfInte If TRUE, perform check self intersection
2928 * of arguments before an operation.
2929 * \param IsRmExtraEdges If TRUE, perform removal of extra edges
2930 * during an operation.
2931 * \return New GEOM_Object, containing the result shape.
2933 GEOM_Object MakeFuse (in GEOM_Object theShape1,
2934 in GEOM_Object theShape2,
2935 in boolean IsCheckSelfInte,
2936 in boolean IsRmExtraEdges);
2939 * \brief Perform fusion boolean operation on list of objects.
2940 * \param theShapes Shapes to be fused.
2941 * \param IsCheckSelfInte If TRUE, perform check self intersection
2942 * of arguments before an operation.
2943 * \param IsRmExtraEdges If TRUE, perform removal of extra edges
2944 * during an operation.
2945 * \return New GEOM_Object, containing the result shape.
2947 GEOM_Object MakeFuseList (in ListOfGO theShapes,
2948 in boolean IsCheckSelfInte,
2949 in boolean IsRmExtraEdges);
2952 * \brief Perform common boolean operation on list of objects.
2953 * \param theShapes Shapes for common operation.
2954 * \param IsCheckSelfInte If TRUE, perform check self intersection
2955 * of arguments before an operation.
2956 * \return New GEOM_Object, containing the result shape.
2958 GEOM_Object MakeCommonList (in ListOfGO theShapes,
2959 in boolean IsCheckSelfInte);
2962 * \brief Perform cutting of list of objects from theMainShape.
2963 * \param theMainShape the object for cut operation.
2964 * \param theShapes Shapes to be cut from theMainShape (tools).
2965 * \param IsCheckSelfInte If TRUE, perform check self intersection
2966 * of arguments before an operation.
2967 * \return New GEOM_Object, containing the result shape.
2969 GEOM_Object MakeCutList (in GEOM_Object theMainShape,
2970 in ListOfGO theShapes,
2971 in boolean IsCheckSelfInte);
2974 * \brief Perform partition operation.
2976 * \param theShapes Shapes to be intersected.
2977 * \param theTools Shapes to intersect theShapes.
2978 * \note Each compound from ListShapes and ListTools will be exploded in order
2979 * to avoid possible intersection between shapes from this compound.
2980 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
2981 * \param theKeepNonlimitShapes: if this parameter == 0, then only shapes of
2982 * target type (equal to Limit) are kept in the result,
2983 * else standalone shapes of lower dimension
2984 * are kept also (if they exist).
2986 * After implementation new version of PartitionAlgo (October 2006)
2987 * other parameters are ignored by current functionality. They are kept
2988 * in this function only for supporting old versions.
2989 * Ignored parameters:
2990 * \param theKeepInside Shapes, outside which the results will be deleted.
2991 * Each shape from theKeepInside must belong to theShapes also.
2992 * \param theRemoveInside Shapes, inside which the results will be deleted.
2993 * Each shape from theRemoveInside must belong to theShapes also.
2994 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
2995 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
2997 * \return New GEOM_Object, containing the result shapes.
2999 GEOM_Object MakePartition (in ListOfGO theShapes,
3000 in ListOfGO theTools,
3001 in ListOfGO theKeepInside,
3002 in ListOfGO theRemoveInside,
3004 in boolean theRemoveWebs,
3005 in ListOfLong theMaterials,
3006 in short theKeepNonlimitShapes);
3009 * \brief Perform partition operation.
3011 * This method may be usefull if it is needed to make a partition for
3012 * a compound containing nonintersected shapes. Performance will be better
3013 * since intersection between shapes from compound is not performed.
3015 * Description of all parameters as in previous method MakePartition().
3016 * One additional parameter is provided:
3017 * \param IsCheckSelfInte If TRUE, perform check self intersection
3018 * of arguments before an operation.
3020 * \note Passed compounds (via ListShapes or via ListTools)
3021 * have to consist of nonintersecting shapes.
3023 * \return New GEOM_Object, containing the result shapes.
3025 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
3026 in ListOfGO theTools,
3027 in ListOfGO theKeepInside,
3028 in ListOfGO theRemoveInside,
3030 in boolean theRemoveWebs,
3031 in ListOfLong theMaterials,
3032 in short theKeepNonlimitShapes,
3033 in boolean IsCheckSelfInte);
3036 * \brief Perform partition of the Shape with the Plane
3037 * \param theShape Shape to be intersected.
3038 * \param thePlane Tool shape, to intersect theShape.
3039 * \return New GEOM_Object, containing the result shape.
3041 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
3042 in GEOM_Object thePlane);
3045 // # GEOM_ICurvesOperations:
3047 * \brief Interface for curves creation.
3049 * Polyline, Circle, Spline (Bezier and Interpolation)
3051 interface GEOM_ICurvesOperations : GEOM_IOperations
3054 * \brief Create a circle with given center, normal vector and radius.
3055 * \param thePnt Circle center.
3056 * \param theVec Vector, normal to the plane of the circle.
3057 * \param theR Circle radius.
3058 * \return New GEOM_Object, containing the created circle.
3060 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
3061 in GEOM_Object theVec,
3064 * \brief Create a circle, passing through three given points
3065 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
3066 * \return New GEOM_Object, containing the created circle.
3068 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
3069 in GEOM_Object thePnt2,
3070 in GEOM_Object thePnt3);
3072 * \brief Create a circle with given center, with a radius equals the distance from center to Point1
3073 * and on a plane defined by all of three points.
3074 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
3075 * \return New GEOM_Object, containing the created circle.
3077 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
3078 in GEOM_Object thePnt2,
3079 in GEOM_Object thePnt3);
3081 * \brief Create an ellipse with given center, normal vector and radiuses.
3082 * \param thePnt Ellipse center.
3083 * \param theVec Vector, normal to the plane of the ellipse.
3084 * \param theRMajor Major ellipse radius.
3085 * \param theRMinor Minor ellipse radius.
3086 * \return New GEOM_Object, containing the created ellipse.
3088 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
3089 in GEOM_Object theVec,
3090 in double theRMajor,
3091 in double theRMinor);
3094 * \brief Create an ellipse with given center, normal vector, main axis vector and radiuses.
3095 * \param thePnt Ellipse center.
3096 * \param theVec Vector, normal to the plane of the ellipse.
3097 * \param theRMajor Major ellipse radius.
3098 * \param theRMinor Minor ellipse radius.
3099 * \param theVecMaj Vector, direction of the ellipse's main axis.
3100 * \return New GEOM_Object, containing the created ellipse.
3102 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
3103 in GEOM_Object theVec,
3104 in double theRMajor,
3105 in double theRMinor,
3106 in GEOM_Object theVecMaj);
3109 * \brief Create an arc of circle, passing through three given points.
3110 * \param thePnt1 Start point of the arc.
3111 * \param thePnt2 Middle point of the arc.
3112 * \param thePnt3 End point of the arc.
3113 * \return New GEOM_Object, containing the created arc.
3115 GEOM_Object MakeArc (in GEOM_Object thePnt1,
3116 in GEOM_Object thePnt2,
3117 in GEOM_Object thePnt3);
3120 * \brief Create an arc of circle of center C from one point to another
3121 * \param theCenter Center point of the arc.
3122 * \param thePnt1 Start point of the arc.
3123 * \param thePnt2 End point of the arc.
3124 * \param theSense Orientation of the arc
3125 * \return New GEOM_Object, containing the created arc.
3127 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
3128 in GEOM_Object thePnt1,
3129 in GEOM_Object thePnt2,
3130 in boolean theSense);
3133 * \brief Create an arc of ellipse of center C and two points P1 P2.
3134 * \param theCenter Center point of the arc.
3135 * \param thePnt1 Major radius is distance from center to Pnt1.
3136 * \param thePnt2 define a plane and Minor radius as a shortest
3137 * distance from Pnt2 to vector Center->Pnt1.
3138 * \return New GEOM_Object, containing the created arc.
3140 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
3141 in GEOM_Object thePnt1,
3142 in GEOM_Object thePnt2);
3146 * \brief Create a polyline on the set of points.
3147 * \param thePoints Sequence of points for the polyline.
3148 * \param theIsClosed If TRUE, build a closed wire.
3149 * \return New GEOM_Object, containing the created polyline.
3151 GEOM_Object MakePolyline (in ListOfGO thePoints,
3152 in boolean theIsClosed);
3155 * \brief Create bezier curve on the set of points.
3156 * \param thePoints Sequence of points for the bezier curve.
3157 * \param theIsClosed If TRUE, build a closed curve.
3158 * \return New GEOM_Object, containing the created bezier curve.
3160 GEOM_Object MakeSplineBezier (in ListOfGO thePoints,
3161 in boolean theIsClosed);
3164 * \brief Create B-Spline curve on the set of points.
3165 * \param thePoints Sequence of points for the B-Spline curve.
3166 * \param theIsClosed If TRUE, build a closed curve.
3167 * \param theDoReordering If TRUE, the algo does not follow the order of
3168 * \a thePoints but searches for the closest vertex.
3169 * \return New GEOM_Object, containing the created B-Spline curve.
3171 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
3172 in boolean theIsClosed,
3173 in boolean theDoReordering);
3176 * \brief Create B-Spline curve on the set of points.
3177 * \param thePoints Sequence of points for the B-Spline curve.
3178 * \param theFirstVec Vector object, defining the curve direction at its first point.
3179 * \param theLastVec Vector object, defining the curve direction at its last point.
3180 * \return New GEOM_Object, containing the created B-Spline curve.
3182 GEOM_Object MakeSplineInterpolWithTangents (in ListOfGO thePoints,
3183 in GEOM_Object theFirstVec,
3184 in GEOM_Object theLastVec);
3187 * \brief Creates a curve using the parametric definition of the basic points.
3188 * \param thexExpr parametric equation of the coordinates X.
3189 * \param theyExpr parametric equation of the coordinates Y.
3190 * \param thezExpr parametric equation of the coordinates Z.
3191 * \param theParamMin the minimal value of the parameter.
3192 * \param theParamMax the maximum value of the parameter.
3193 * \param theParamStep the step of the parameter.
3194 * \param theCurveType the type of the curve.
3195 * \return New GEOM_Object, containing the created curve.
3197 GEOM_Object MakeCurveParametric(in string thexExpr,
3200 in double theParamMin,
3201 in double theParamMax,
3202 in double theParamStep,
3203 in curve_type theCurveType);
3206 * \brief Creates a curve using the parametric definition of the basic points.
3207 * \param thexExpr parametric equation of the coordinates X.
3208 * \param theyExpr parametric equation of the coordinates Y.
3209 * \param thezExpr parametric equation of the coordinates Z.
3210 * \param theParamMin the minimal value of the parameter.
3211 * \param theParamMax the maximum value of the parameter.
3212 * \param theParamNbStep the number of steps of the parameter discretization.
3213 * \param theCurveType the type of the curve.
3214 * \return New GEOM_Object, containing the created curve.
3216 GEOM_Object MakeCurveParametricNew(in string thexExpr,
3219 in double theParamMin,
3220 in double theParamMax,
3221 in long theParamNbStep,
3222 in curve_type theCurveType);
3225 * \brief Creates an isoline curve on a face.
3226 * \param theFace the face for which an isoline is created.
3227 * \param IsUIsoline True for U-isoline creation; False for V-isoline
3229 * \param theParameter the U parameter for U-isoline or V parameter
3231 * \return New GEOM_Object, containing the created isoline edge or a
3232 * compound of edges.
3234 GEOM_Object MakeIsoline(in GEOM_Object theFace,
3235 in boolean IsUIsoline,
3236 in double theParameter);
3239 * \brief Create a sketcher (wire or face), following the textual description,
3240 * passed through \a theCommand argument.
3242 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
3243 * Format of the description string has to be the following:
3245 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
3248 * - x1, y1 are coordinates of the first sketcher point (zero by default),
3250 * - "R angle" : Set the direction by angle
3251 * - "D dx dy" : Set the direction by DX & DY
3254 * - "TT x y" : Create segment by point at X & Y
3255 * - "T dx dy" : Create segment by point with DX & DY
3256 * - "L length" : Create segment by direction & Length
3257 * - "IX x" : Create segment by direction & Intersect. X
3258 * - "IY y" : Create segment by direction & Intersect. Y
3261 * - "C radius length" : Create arc by direction, radius and length(in degree)
3264 * - "WW" : Close Wire (to finish)
3265 * - "WF" : Close Wire and build face (to finish)
3267 * \param theCommand String, defining the sketcher in local
3268 * coordinates of the working plane.
3269 * \param theWorkingPlane Nine double values, defining origin,
3270 * OZ and OX directions of the working plane.
3271 * \return New GEOM_Object, containing the created wire or face.
3273 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
3276 * \brief Create a sketcher (wire or face), following the textual description,
3277 * passed through \a theCommand argument.
3279 * For format of the description string see the previous method.\n
3281 * \param theCommand String, defining the sketcher in local
3282 * coordinates of the working plane.
3283 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
3284 * \return New GEOM_Object, containing the created wire or face.
3286 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
3289 * \brief Create a 3D sketcher, following the textual description,
3290 * passed through \a theCommand argument.
3292 * Format of the description string has to be the following:
3294 * "3DSketcher:CMD[:CMD[:CMD...]]"
3296 * Where CMD is one of
3297 * - "TT x y z" : Create segment by point at X & Y or set the first point
3298 * - "T dx dy dz" : Create segment by point with DX & DY
3301 * - "OXY angleX angle2 length" : Create segment by two angles and length
3302 * - "OYZ angleY angle2 length" : Create segment by two angles and length
3303 * - "OXZ angleX angle2 length" : Create segment by two angles and length
3306 * - "WW" : Close Wire (to finish)
3308 * \param theCommand String, defining the sketcher in local
3309 * coordinates of the working plane.
3310 * \return New GEOM_Object, containing the created wire.
3312 GEOM_Object Make3DSketcherCommand (in string theCommand);
3315 * \brief Create a 3D sketcher, made of a straight segments, joining points
3316 * with coordinates passed through \a theCoordinates argument.
3318 * Order of coordinates has to be the following:
3319 * x1, y1, z1, x2, y2, z2, ..., xN, yN, zN
3321 * \param theCoordinates List of double values.
3322 * \return New GEOM_Object, containing the created wire.
3324 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
3327 // # GEOM_ILocalOperations:
3329 * \brief Interface for fillet and chamfer creation.
3331 interface GEOM_ILocalOperations : GEOM_IOperations
3334 * \brief Perform a fillet on all edges of the given shape.
3335 * \param theShape Shape, to perform fillet on.
3336 * \param theR Fillet radius.
3337 * \return New GEOM_Object, containing the result shape.
3339 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
3343 * \brief Perform a fillet on the specified edges of the given shape
3344 * \param theShape Shape, to perform fillet on.
3345 * \param theR Fillet radius.
3346 * \param theEdges Global indices of edges to perform fillet on.
3347 * \note Global index of sub-shape can be obtained, using method
3348 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3349 * \return New GEOM_Object, containing the result shape.
3351 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
3353 in ListOfLong theEdges);
3354 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
3357 in ListOfLong theEdges);
3360 * \brief Perform a fillet on all edges of the specified faces of the given shape.
3361 * \param theShape Shape, to perform fillet on.
3362 * \param theR Fillet radius.
3363 * \param theFaces Global indices of faces to perform fillet on.
3364 * \note Global index of sub-shape can be obtained, using method
3365 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3366 * \return New GEOM_Object, containing the result shape.
3368 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
3370 in ListOfLong theFaces);
3372 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
3375 in ListOfLong theFaces);
3378 * \brief Perform a fillet on a face or a shell at the specified vertexes.
3379 * \param theShape Shape, to perform fillet on.
3380 * \param theR Fillet radius.
3381 * \param theVertexes Global indices of vertexes to perform fillet on.
3382 * \note Global index of sub-shape can be obtained, using method
3383 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3384 * \return New GEOM_Object, containing the result shape.
3386 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
3388 in ListOfLong theVertexes);
3391 * \brief Perform a fillet on edges of the specified vertexes of the given wire.
3392 * \param theShape Shape, to perform fillet on.
3393 * \param theR Fillet radius.
3394 * \param theVertexes Global indices of vertexes to perform fillet on.
3395 * \note Global index of sub-shape can be obtained, using method
3396 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3397 * \note The list of vertices coudl be empty, in this case fillet fill be done
3398 * at all vertices in given wire
3399 * \param doIgnoreSecantVertices If FALSE, fillet radius is always limited
3400 * by the length of the edges, nearest to the fillet vertex.
3401 * But sometimes the next edge is C1 continuous with the one, nearest to
3402 * the fillet point, and such two (or more) edges can be united to allow
3403 * bigger radius. Set this flag to TRUE to allow collinear edges union,
3404 * thus ignoring the secant vertex (vertices).
3405 * \return New GEOM_Object, containing the result shape.
3407 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
3409 in ListOfLong theVertexes,
3410 in boolean doIgnoreSecantVertices);
3413 * \brief Perform a symmetric chamfer on all edges of the given shape.
3414 * \param theShape Shape, to perform chamfer on.
3415 * \param theD Chamfer size along each face.
3416 * \return New GEOM_Object, containing the result shape.
3418 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
3422 * \brief Perform a chamfer on edges, common to the specified faces.
3423 * with distance D1 on the Face1
3424 * \param theShape Shape, to perform chamfer on.
3425 * \param theD1 Chamfer size along \a theFace1.
3426 * \param theD2 Chamfer size along \a theFace2.
3427 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
3428 * \note Global index of sub-shape can be obtained, using method
3429 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3430 * \return New GEOM_Object, containing the result shape.
3432 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
3433 in double theD1, in double theD2,
3434 in long theFace1, in long theFace2);
3436 * \brief The Same but with params theD = Chamfer Lenght
3437 * and theAngle = Chamfer Angle (Angle in radians)
3439 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
3440 in double theD, in double theAngle,
3441 in long theFace1, in long theFace2);
3444 * \brief Perform a chamfer on all edges of the specified faces.
3445 * with distance D1 on the first specified face (if several for one edge)
3446 * \param theShape Shape, to perform chamfer on.
3447 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
3448 * connected to the edge, are in \a theFaces, \a theD1
3449 * will be get along face, which is nearer to \a theFaces beginning.
3450 * \param theD2 Chamfer size along another of two faces, connected to the edge.
3451 * \param theFaces Sequence of global indices of faces of \a theShape.
3452 * \note Global index of sub-shape can be obtained, using method
3453 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3454 * \return New GEOM_Object, containing the result shape.
3456 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
3457 in double theD1, in double theD2,
3458 in ListOfLong theFaces);
3460 * The Same but with params theD = Chamfer Lenght
3461 * and theAngle = Chamfer Angle (Angle in radians)
3463 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
3464 in double theD, in double theAngle,
3465 in ListOfLong theFaces);
3468 * \brief Perform a chamfer on edges,
3469 * with distance D1 on the first specified face (if several for one edge)
3470 * \param theShape Shape, to perform chamfer on.
3471 * \param theD1,theD2 Chamfer size
3472 * \param theEdges Sequence of edges of \a theShape.
3473 * \return New GEOM_Object, containing the result shape.
3475 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
3476 in double theD1, in double theD2,
3477 in ListOfLong theEdges);
3479 * The Same but with params theD = Chamfer Lenght
3480 * and theAngle = Chamfer Angle (Angle in radians)
3482 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
3483 in double theD, in double theAngle,
3484 in ListOfLong theEdges);
3487 * \brief Perform an Archimde operation on the given shape with given parameters.
3488 * The object presenting the resulting face is returned
3489 * \param theShape Shape to be put in water.
3490 * \param theWeight Weight og the shape.
3491 * \param theWaterDensity Density of the water.
3492 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
3493 * \return New GEOM_Object, containing a section of \a theShape
3494 * by a plane, corresponding to water level.
3496 GEOM_Object MakeArchimede (in GEOM_Object theShape,
3497 in double theWeight,
3498 in double theWaterDensity,
3499 in double theMeshDeflection);
3502 * \brief Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3504 * Present here only for compatibility.
3506 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
3509 // # GEOM_IHealingOperations:
3511 * \brief Interface for shape healing operations
3513 * Shape Processing, SuppressFaces, etc.
3515 interface GEOM_IHealingOperations : GEOM_IOperations
3518 * \brief Apply a sequence of Shape Healing operators to the given object.
3519 * \param theShapes Shape to be processed.
3520 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
3521 * \param theParameters List of names of parameters
3522 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
3523 * \param theValues List of values of parameters, in the same order
3524 * as parameters are listed in \a theParameters list.
3525 * \return New GEOM_Object, containing processed shape.
3527 GEOM_Object ProcessShape (in GEOM_Object theShapes,
3528 in string_array theOperators,
3529 in string_array theParameters,
3530 in string_array theValues);
3533 * \brief Get default sequence of operators, their parameters and parameters' values
3534 * of Shape Process operation.
3536 * In the current implementation the defaults are
3537 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3538 * \param theOperators Output. Default list of names of operators.
3539 * \param theParameters Output. Default list of names of parameters.
3540 * \param theValues Output. List of default values of parameters, in the same order
3541 * as parameters are listed in \a theParameters list.
3543 void GetShapeProcessParameters (out string_array theOperators,
3544 out string_array theParameters,
3545 out string_array theValues);
3547 * \brief Get parameters and parameters' values for the given Shape Process operation.
3549 * In the current implementation the defaults are
3550 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3551 * \param theOperator Input. The operator's name.
3552 * \param theParameters Output. Default list of names of parameters.
3553 * \param theValues Output. List of default values of parameters, in the same order
3554 * as parameters are listed in \a theParameters list.
3556 void GetOperatorParameters (in string theOperator,
3557 out string_array theParameters,
3558 out string_array theValues);
3561 * \brief Remove faces from the given object (shape).
3562 * \param theObject Shape to be processed.
3563 * \param theFaces Indices of faces to be removed, if EMPTY then the method
3564 * removes ALL faces of the given object.
3565 * \return New GEOM_Object, containing processed shape.
3567 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
3570 * \brief Close an open wire.
3571 * \param theObject Shape to be processed.
3572 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
3573 * if -1, then theObject itself is a wire.
3574 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
3575 * If FALS : closure by creation of an edge between ends.
3576 * \return New GEOM_Object, containing processed shape.
3578 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
3579 in boolean isCommonVertex);
3582 * \brief Remove internal wires and edges from the given object (face).
3583 * \param theObject Shape to be processed.
3584 * \param theWires Indices of wires to be removed, if EMPTY then the method
3585 * removes ALL internal wires of the given object.
3586 * \return New GEOM_Object, containing processed shape.
3588 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
3591 * \brief Remove internal closed contours (holes) from the given object.
3592 * \param theObject Shape to be processed.
3593 * \param theWires Indices of wires to be removed, if EMPTY then the method
3594 * removes ALL internal holes of the given object
3595 * \return New GEOM_Object, containing processed shape.
3597 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
3600 * Sewing of the given object.
3601 * \param theObject Shape to be processed.
3602 * \param theTolerance Required tolerance value.
3603 * \return New GEOM_Object, containing processed shape.
3605 GEOM_Object Sew (in GEOM_Object theObject, in double theTolerance);
3608 * Sewing of the given object. Allows non-manifold sewing.
3609 * \param theObject Shape to be processed.
3610 * \param theTolerance Required tolerance value.
3611 * \return New GEOM_Object, containing processed shape.
3613 GEOM_Object SewAllowNonManifold(in GEOM_Object theObject, in double theTolerance);
3616 * Rebuild the topology of theCompound of solids by removing
3617 * of the faces that are shared by several solids.
3618 * \param theCompound Shape to be processed.
3619 * \return New GEOM_Object, containing processed shape.
3621 GEOM_Object RemoveInternalFaces (in GEOM_Object theCompound);
3624 * \brief Addition of a point to a given edge object.
3625 * \param theObject Shape to be processed.
3626 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
3627 * if -1, then theObject itself is the edge.
3628 * \param theValue Value of parameter on edge or length parameter,
3629 * depending on \a isByParameter.
3630 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
3631 * if FALSE : \a theValue is treated as a length parameter [0..1]
3632 * \return New GEOM_Object, containing processed shape.
3634 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
3635 in double theValue, in boolean isByParameter);
3638 * \brief Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
3639 * \param theWire Wire to minimize the number of C1 continuous edges in.
3640 * \param theVertices A list of vertices to suppress. If the list
3641 * is empty, all vertices in a wire will be assumed.
3642 * \return New GEOM_Object with modified wire.
3644 GEOM_Object FuseCollinearEdgesWithinWire (in GEOM_Object theWire,
3645 in ListOfGO theVertices);
3648 * \brief Get a list of wires (wrapped in GEOM_Object-s),
3649 * that constitute a free boundary of the given shape.
3650 * \param theObject Shape to get free boundary of.
3651 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
3652 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
3653 * \return FALSE, if an error(s) occured during the method execution.
3655 boolean GetFreeBoundary (in GEOM_Object theObject,
3656 out ListOfGO theClosedWires,
3657 out ListOfGO theOpenWires);
3660 * \brief Change orientation of the given object.
3661 * \param theObject Shape to be processed.
3662 * \return New GEOM_Object, containing processed shape.
3664 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
3665 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
3668 * \brief Try to limit tolerance of the given object by value \a theTolerance.
3669 * \param theObject Shape to be processed.
3670 * \param theTolerance Required tolerance value.
3671 * \return New GEOM_Object, containing processed shape.
3673 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
3677 // # GEOM_IInsertOperations:
3679 * \brief Interface for shape insert operations (like copy, import).
3682 interface GEOM_IInsertOperations : GEOM_IOperations
3685 * \brief Create a copy of the given object
3687 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
3690 * \brief Export the given shape into a file with given name.
3691 * \param theObject Shape to be stored in the file.
3692 * \param theFileName Name of the file to store the given shape in.
3693 * \param theFormatName Specify format for the shape storage.
3694 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3696 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
3699 * \brief Import a shape from the BRep or IGES or STEP file
3700 * (depends on given format) with given name.
3701 * \param theFileName The file, containing the shape.
3702 * \param theFormatName Specify format for the file reading.
3703 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3704 * If format 'IGES_SCALE' is used instead of 'IGES' or
3705 * format 'STEP_SCALE' is used instead of 'STEP',
3706 * file length unit will be ignored (set to 'meter') and result model will be scaled.
3707 * \return List of GEOM_Object, containing the created shape and groups of materials.
3709 ListOfGO ImportFile (in string theFileName, in string theFormatName);
3712 * \brief Read a value of parameter from a file, containing a shape.
3713 * \param theFileName The file, containing the shape.
3714 * \param theFormatName Specify format for the file reading.
3715 * Available formats can be obtained with <VAR>ImportTranslators()</VAR> method.
3716 * \param theParameterName Specify the parameter. For example, pass "LEN_UNITS"
3717 * to obtain length units, in which the file is written.
3718 * \return Value of requested parameter in form of text string.
3720 string ReadValue (in string theFileName, in string theFormatName, in string theParameterName);
3723 * \brief Get the supported import formats and corresponding patterns for File dialog.
3724 * \param theFormats Output. List of formats, available for import.
3725 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3726 * \return Returns available formats and patterns through the arguments.
3728 void ImportTranslators (out string_array theFormats,
3729 out string_array thePatterns);
3732 * \brief Get the supported export formats and corresponding patterns for File dialog.
3733 * \param theFormats Output. List of formats, available for export.
3734 * \param thePatterns Output. List of file patterns, corresponding to available formats.
3735 * \return Returns available formats and patterns through the arguments.
3737 void ExportTranslators (out string_array theFormats,
3738 out string_array thePatterns);
3741 * \brief Read a shape from the binary stream, containing its bounding representation (BRep).
3742 * \note GEOM_Object::GetShapeStream() method can be used to obtain the shape's BRep stream.
3743 * \param theStream The BRep binary stream.
3744 * \return New GEOM_Object, containing the shape, read from theStream.
3746 GEOM_Object RestoreShape (in SALOMEDS::TMPFile theStream);
3749 * \brief Load texture from file
3750 * \param theTextureFile texture file name
3751 * \return unique texture identifier
3753 long LoadTexture(in string theTextureFile);
3756 * \brief Add texture to the study
3757 * \param theWidth texture width in pixels
3758 * \param theHeight texture height in pixels
3759 * \param theTexture texture byte array
3760 * \return unique texture identifier
3762 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
3765 * \brief Get previously loaded texture data
3766 * \param theID texture identifier
3767 * \param theWidth texture width in pixels
3768 * \param theHeight texture height in pixels
3769 * \return texture byte array
3771 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
3774 * \brief Get list of all avaiable texture IDs
3775 * \return list of all texture IDs avaiable for the current study
3777 ListOfLong GetAllTextures();
3780 * Export a shape to XAO format
3781 * \param shape The shape to export
3782 * \param groups The list of groups to export
3783 * \param fields The list of fields to export
3784 * \param author The author of the export
3785 * \param fileName The name of the file to export
3786 * \return boolean indicating if export was successful.
3788 boolean ExportXAO(in GEOM_Object shape,
3789 in ListOfGO groups, in ListOfFields fields,
3790 in string author, in string fileName);
3793 * Import a shape from XAO format
3794 * \param fileName The name of the file to import
3795 * \param shape The imported shape
3796 * \param subShapes The list of imported subShapes
3797 * \param groups The list of imported groups
3798 * \param fields The list of imported fields
3799 * \return boolean indicating if import was successful.
3801 boolean ImportXAO(in string fileName, out GEOM_Object shape,
3802 out ListOfGO subShapes, out ListOfGO groups, out ListOfFields fields);
3805 // # GEOM_IKindOfShape:
3807 * \brief Interface for shape_kind enumeration.
3809 interface GEOM_IKindOfShape
3823 /*! box with faces, parallel to global coordinate planes */
3831 /*! solid, bounded by polygons */
3836 /*! spherical face (closed) */
3838 /*! cylindrical face with defined height */
3840 /*! toroidal face (closed) */
3842 /*! conical face with defined height */
3844 /*! planar, bounded by circle */
3846 /*! planar, bounded by ellipse */
3848 /*! planar, bounded by segments */
3850 /*! infinite planar */
3859 /*! arc of circle */
3863 /*! arc of ellipse */
3865 /*! infinite segment */
3874 /*! all advanced shapes (temporary implementation) */
3879 // # GEOM_IMeasureOperations:
3881 * \brief Interface for measurement (distance, whatis) and
3882 * properties calculation (like Centre of Mass, Inertia, etc.).
3885 interface GEOM_IMeasureOperations : GEOM_IOperations
3888 * \brief Get kind of theShape.
3889 * \param theShape Shape to get a kind of.
3890 * \param theIntegers Output. Integer and enumerated shape's parameters
3891 * (kind of surface, closed/unclosed, number of edges, etc.)
3892 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
3893 * \note Concrete meaning of each value, returned via \a theIntegers
3894 * or \a theDoubles list depends on the kind of the shape.
3895 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
3897 //short KindOfShape (in GEOM_Object theShape,
3898 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
3899 out ListOfLong theIntegers,
3900 out ListOfDouble theDoubles);
3903 * \brief Get position (LCS) of theShape.
3904 * \param theShape Shape to calculate position of.
3905 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
3906 * Origin of the LCS is situated at the shape's center of mass.
3907 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
3908 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
3909 * Axes of the LCS are obtained from shape's location or,
3910 * if the shape is a planar face, from position of its plane.
3911 * \return Returns position of the shape through the last nine arguments.
3913 void GetPosition (in GEOM_Object theShape,
3914 out double Ox, out double Oy, out double Oz,
3915 out double Zx, out double Zy, out double Zz,
3916 out double Xx, out double Xy, out double Xz);
3919 * \brief Get summarized length of all wires,
3920 * area of surface and volume of the given shape.
3921 * \param theShape Shape to define properties of.
3922 * \param theLength Output. Summarized length of all wires of the given shape.
3923 * \param theSurfArea Output. Area of surface of the given shape.
3924 * \param theVolume Output. Volume of the given shape.
3925 * \return Returns shape properties through the last three arguments.
3927 void GetBasicProperties (in GEOM_Object theShape,
3928 out double theLength,
3929 out double theSurfArea,
3930 out double theVolume);
3933 * \brief Get a point, situated at the centre of mass of theShape.
3934 * \param theShape Shape to define centre of mass of.
3935 * \return New GEOM_Object, containing the created point.
3937 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
3940 * Get the vertex by index for 1D objects depends the edge/wire orientation
3941 * \param theShape Shape (wire or edge) to find the vertex on it
3942 * \param theIndex Index of vertex sub-shape
3943 * \return New GEOM_Object, vertex.
3945 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
3948 * \brief Get a vector, representing the normal of theFace.
3949 * If the face is not planar, theOptionalPoint is obligatory.
3950 * \param theFace Shape (face) to define the normal of.
3951 * \param theOptionalPoint Shape (point) to define the normal at.
3952 * Can be NULL in case of planar face.
3953 * \return New GEOM_Object, containing the created normal vector.
3955 GEOM_Object GetNormal (in GEOM_Object theFace,
3956 in GEOM_Object theOptionalPoint);
3959 * \brief Get inertia matrix and moments of inertia of theShape.
3960 * \param theShape Shape to calculate inertia of.
3961 * \param I11,I12,I13,I21,I22,I23,I31,I32,I33 Output. Components of the inertia matrix of the given shape.
3962 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
3963 * \return Returns inertia through the last twelve arguments.
3965 void GetInertia (in GEOM_Object theShape,
3966 out double I11, out double I12, out double I13,
3967 out double I21, out double I22, out double I23,
3968 out double I31, out double I32, out double I33,
3969 out double Ix , out double Iy , out double Iz);
3972 * \brief Get parameters of bounding box of the given shape
3973 * \param theShape Shape to obtain bounding box of.
3974 * \param precise TRUE for precise computation; FALSE for fast one.
3975 * \param Xmin,Xmax Output. Limits of shape along OX axis.
3976 * \param Ymin,Ymax Output. Limits of shape along OY axis.
3977 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
3978 * \return Returns parameters of bounding box through the last six arguments.
3980 void GetBoundingBox (in GEOM_Object theShape,
3982 out double Xmin, out double Xmax,
3983 out double Ymin, out double Ymax,
3984 out double Zmin, out double Zmax);
3987 * \brief Get bounding box of the given shape
3988 * \param theShape Shape to obtain bounding box of.
3989 * \param precise TRUE for precise computation; FALSE for fast one.
3990 * \return New GEOM_Object, containing the created bounding box.
3992 GEOM_Object MakeBoundingBox (in GEOM_Object theShape,
3993 in boolean precise);
3996 * \brief Get min and max tolerances of sub-shapes of theShape
3997 * \param theShape Shape, to get tolerances of.
3998 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
3999 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
4000 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
4001 * \return Returns shape tolerances through the last six arguments.
4003 void GetTolerance (in GEOM_Object theShape,
4004 out double FaceMin, out double FaceMax,
4005 out double EdgeMin, out double EdgeMax,
4006 out double VertMin, out double VertMax);
4009 * \brief Enumeration of Shape defects coming from CheckShape algorithms.
4014 InvalidPointOnCurve,
4015 InvalidPointOnCurveOnSurface,
4016 InvalidPointOnSurface,
4023 InvalidCurveOnSurface,
4024 InvalidCurveOnClosedSurface,
4025 InvalidSameRangeFlag,
4026 InvalidSameParameterFlag,
4027 InvalidDegeneratedFlag,
4030 InvalidMultiConnexity,
4036 SelfIntersectingWire, /* on a face */
4043 InvalidImbricationOfWires,
4057 BadOrientationOfSubshape,
4059 InvalidToleranceValue,
4066 * \brief Description of a shape defect: type and incriminated sub-shapes.
4070 ShapeErrorType error;
4071 ListOfLong incriminated;
4075 * \brief Sequence of all shape defects.
4077 typedef sequence<ShapeError> ShapeErrors;
4080 * \brief Check a topology of the given shape.
4081 * \param theShape Shape to check validity of.
4082 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
4083 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
4085 boolean CheckShape (in GEOM_Object theShape,
4086 out ShapeErrors theErrors);
4089 * \brief Check a topology and a geometry of the given shape.
4090 * \param theShape Shape to check validity of.
4091 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
4092 * \return TRUE, if the shape "seems to be valid".
4094 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
4095 out ShapeErrors theErrors);
4098 * \brief Convert sequence of shape errors, returned by
4099 * <VAR>CheckShape()</VAR> or <VAR>CheckShapeWithGeometry()</VAR>, into string.
4100 * \param theShape the invalid shape.
4101 * \param theErrors The sequence of \a theShape errors.
4102 * \return String, describing all the errors in form, suitable for printing.
4104 string PrintShapeErrors (in GEOM_Object theShape,
4105 in ShapeErrors theErrors);
4108 * \brief Check a topology of the given shape on self-intersections presence.
4109 * \param theShape Shape to check validity of.
4110 * \param theIntersections Output. List of intersected sub-shapes IDs, it contains pairs of IDs.
4111 * \return TRUE, if the shape does not have any self-intersections.
4113 boolean CheckSelfIntersections (in GEOM_Object theShape,
4114 out ListOfLong theIntersections);
4117 * \brief Check if the given shape can be an argument for MakeSolid operation
4118 * \param theShape Shape to be described.
4119 * \return Empty string if a solid can be made on this shape, error code otherwise.
4121 string IsGoodForSolid (in GEOM_Object theShape);
4124 * O\brief btain description of the given shape
4125 * \param theShape Shape to be described.
4126 * \return Description of the given shape.
4128 string WhatIs (in GEOM_Object theShape);
4131 * \brief Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on
4132 * the shape theShape.
4133 * \param theShape Shape to check.
4134 * \param coords list of coordinates.
4135 * \param tolerance tolerance.
4136 * \return list of boolean.
4138 ListOfBool AreCoordsInside(in GEOM_Object theShape, in ListOfDouble coords, in double tolerance);
4141 * \brief Get minimal distance between the given shapes.
4142 * \param theShape1,theShape2 Shapes to find minimal distance between.
4143 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
4144 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
4145 * \return Value of the minimal distance between the given shapes.
4147 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
4148 out double X1, out double Y1, out double Z1,
4149 out double X2, out double Y2, out double Z2);
4152 * \brief Get closest points of the given shapes.
4153 * \param theShape1,theShape2 Shapes to find closest points of.
4154 * \param theCoords Output. List of (X, Y, Z) coordinates for all couples of points.
4155 * \return The number of found solutions (-1 in case of infinite number of solutions).
4157 long ClosestPoints (in GEOM_Object theShape1,
4158 in GEOM_Object theShape2,
4159 out ListOfDouble theCoords);
4162 * \brief Get angle between the given lines or linear edges.
4163 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
4164 * \return Value of the angle between the given shapes.
4166 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
4169 * \brief Get angle between the given vectors.
4170 * \param theShape1,theShape2 Vectors to find angle between.
4171 * \return Value of the angle between the given vectors.
4173 double GetAngleBtwVectors (in GEOM_Object theShape1, in GEOM_Object theShape2);
4176 * \brief Get point coordinates
4178 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
4181 * \brief Get radius of curvature of curve in the point determinated by param
4182 * \param theShape - curve.
4183 * \param theParam - parameter on curve
4184 * \return Value of curvature.
4186 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
4189 * \brief Get radius of curvature of curve in the given point
4190 * \param theShape - curve.
4191 * \param thePoint - point
4192 * \return Value of curvature.
4194 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
4197 * \brief Get max radius of curvature of surface in the point determinated by params
4198 * \param theShape - surface.
4199 * \param theUParam - U-parameter on surface
4200 * \param theVParam - V-parameter on surface
4201 * \return Value of curvature.
4203 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
4204 in double theVParam);
4207 * \brief Get max radius of curvature of surface in the given point
4208 * \param theShape - surface.
4209 * \param thePoint - point
4210 * \return Value of curvature.
4212 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
4215 * \brief Get min radius of curvature of surface in the point determinated by params
4216 * \param theShape - surface.
4217 * \param theUParam - U-parameter on surface
4218 * \param theVParam - V-parameter on surface
4219 * \return Value of curvature.
4221 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
4222 in double theVParam);
4225 * \brief Get min radius of curvature of surface in the given point
4226 * \param theShape - surface.
4227 * \param thePoint - point
4228 * \return Value of curvature.
4230 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
4234 // # GEOM_IGroupOperations:
4236 * \brief Interface for groups creation.
4238 interface GEOM_IGroupOperations : GEOM_IOperations
4241 * \brief Creates a new group which will store sub-shapes of theMainShape
4242 * \param theMainShape is a GEOM_Object on which the group is selected
4243 * \param theShapeType defines a shape type of the group
4244 * \return a newly created GEOM group
4246 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
4249 * \brief Adds a sub-object with ID theSubShapeId to the group
4250 * \param theGroup is a GEOM group to which the new sub-shape is added
4251 * \param theSubShapeId is a sub-shape ID in the main object.
4252 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
4254 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
4257 * \brief Removes a sub-object with ID \a theSubShapeId from the group
4258 * \param theGroup is a GEOM group from which the sub-shape is removed.
4259 * \param theSubShapeId is a sub-shape ID in the main object.
4260 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
4262 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
4265 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
4266 * \param theGroup is a GEOM group to which the new sub-shapes are added.
4267 * \param theSubShapes is a list of sub-shapes to be added.
4269 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
4272 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
4273 * \param theGroup is a GEOM group from which the sub-shapes are removed.
4274 * \param theSubShapes is a list of sub-shapes to be removed.
4276 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
4279 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
4280 * \param theGroup is a GEOM group to which the new sub-shapes are added.
4281 * \param theSubShapes is a list of IDs of sub-shapes to be added.
4283 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
4286 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
4287 * \param theGroup is a GEOM group from which the sub-shapes are removed.
4288 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
4290 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
4293 * \brief Union of two groups.
4294 * New group is created. It will contain all entities
4295 * which are present in groups theGroup1 and theGroup2.
4296 * \param theGroup1, theGroup2 are the initial GEOM groups
4297 * to create the united group from.
4298 * \return a newly created GEOM group.
4300 GEOM_Object UnionGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
4303 * \brief Intersection of two groups.
4304 * New group is created. It will contain only those entities
4305 * which are present in both groups theGroup1 and theGroup2.
4306 * \param theGroup1, theGroup2 are the initial GEOM groups to get common part of.
4307 * \return a newly created GEOM group.
4309 GEOM_Object IntersectGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
4312 * \brief Cut of two groups.
4313 * New group is created. It will contain entities which are
4314 * present in group theGroup1 but are not present in group theGroup2.
4315 * \param theGroup1 is a GEOM group to include elements of.
4316 * \param theGroup2 is a GEOM group to exclude elements of.
4317 * \return a newly created GEOM group.
4319 GEOM_Object CutGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
4322 * \brief Union of list of groups.
4323 * New group is created. It will contain all entities that are
4324 * present in groups listed in theGList.
4325 * \param theGList is a list of GEOM groups to create the united group from.
4326 * \return a newly created GEOM group.
4328 GEOM_Object UnionListOfGroups (in ListOfGO theGList);
4331 * \brief Intersection of list of groups.
4332 * New group is created. It will contain only entities
4333 * which are simultaneously present in the groups listed in theGList.
4334 * \param theGList is a list of GEOM groups to get common part of.
4335 * \return a newly created GEOM group.
4337 GEOM_Object IntersectListOfGroups (in ListOfGO theGList);
4340 * \brief Cut of lists of groups.
4341 * New group is created. It will contain only entities
4342 * which are present in groups listed in theGList1 but
4343 * are not present in groups from theGList2.
4344 * \param theGList1 is a list of GEOM groups to include elements of.
4345 * \param theGList2 is a list of GEOM groups to exclude elements of.
4346 * \return a newly created GEOM group.
4348 GEOM_Object CutListOfGroups (in ListOfGO theGList1,
4349 in ListOfGO theGList2);
4352 * \brief Returns a type of sub-objects stored in the group
4353 * \param theGroup is a GEOM group which type is returned.
4355 long GetType (in GEOM_Object theGroup);
4358 * \brief Returns a main shape associated with the group
4359 * \param theGroup is a GEOM group for which a main shape object is requested
4360 * \return a GEOM_Object which is a main shape for theGroup
4362 GEOM_Object GetMainShape (in GEOM_Object theGroup);
4365 * \brief Returns a list of sub-objects ID stored in the group
4366 * \param theGroup is a GEOM group for which a list of IDs is requested
4368 ListOfLong GetObjects (in GEOM_Object theGroup);
4371 // # GEOM_IAdvancedOperations:
4373 * \brief Interface for advanced modeling functions.
4375 interface GEOM_IAdvancedOperations : GEOM_IOperations
4377 // T-Shape WITHOUT Thickness reduction
4380 * \brief Create a T-shape object with specified caracteristics for the main and
4381 * the incident pipes (radius, width, half-length).
4383 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
4384 * \param theR1 Internal radius of main pipe
4385 * \param theW1 Width of main pipe
4386 * \param theL1 Half-length of main pipe
4387 * \param theR2 Internal radius of incident pipe (R2 < R1)
4388 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4389 * \param theL2 Half-length of incident pipe
4390 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4391 * \return List of GEOM_Object, containing the created shape and propagation groups.
4393 ListOfGO MakePipeTShape (in double theR1, in double theW1, in double theL1,
4394 in double theR2, in double theW2, in double theL2,
4395 in boolean theHexMesh);
4397 * \brief Create a T-shape object with specified caracteristics for the main and
4398 * the incident pipes (radius, width, half-length).
4400 * The extremities of the main pipe are located on junctions points P1 and P2.
4401 * The extremity of the incident pipe is located on junction point P3.
4402 * \param theR1 Internal radius of main pipe
4403 * \param theW1 Width of main pipe
4404 * \param theL1 Half-length of main pipe
4405 * \param theR2 Internal radius of incident pipe (R2 < R1)
4406 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4407 * \param theL2 Half-length of incident pipe
4408 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4409 * \param theP1 1st junction point of main pipe
4410 * \param theP2 2nd junction point of main pipe
4411 * \param theP3 Junction point of incident pipe
4412 * \return List of GEOM_Object, containing the created shape and propagation groups.
4414 ListOfGO MakePipeTShapeWithPosition (in double theR1, in double theW1, in double theL1,
4415 in double theR2, in double theW2, in double theL2,
4416 in boolean theHexMesh,
4417 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
4419 * \brief Create a T-shape object with specified caracteristics for the main and
4420 * the incident pipes (radius, width, half-length). A chamfer is created
4421 * on the junction of the pipes.
4423 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
4424 * \param theR1 Internal radius of main pipe
4425 * \param theW1 Width of main pipe
4426 * \param theL1 Half-length of main pipe
4427 * \param theR2 Internal radius of incident pipe (R2 < R1)
4428 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4429 * \param theL2 Half-length of incident pipe
4430 * \param theH Height of the chamfer.
4431 * \param theW Width of the chamfer.
4432 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4433 * \return List of GEOM_Object, containing the created shape and propagation groups.
4435 ListOfGO MakePipeTShapeChamfer (in double theR1, in double theW1, in double theL1,
4436 in double theR2, in double theW2, in double theL2,
4437 in double theH, in double theW, in boolean theHexMesh);
4439 * \brief Create a T-shape object with specified caracteristics for the main and
4440 * the incident pipes (radius, width, half-length).
4442 * A chamfer is created on the junction of the pipes.
4443 * The extremities of the main pipe are located on junctions points P1 and P2.
4444 * The extremity of the incident pipe is located on junction point P3.
4445 * \param theR1 Internal radius of main pipe
4446 * \param theW1 Width of main pipe
4447 * \param theL1 Half-length of main pipe
4448 * \param theR2 Internal radius of incident pipe (R2 < R1)
4449 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4450 * \param theL2 Half-length of incident pipe
4451 * \param theH Height of the chamfer.
4452 * \param theW Width of the chamfer.
4453 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4454 * \param theP1 1st junction point of main pipe
4455 * \param theP2 2nd junction point of main pipe
4456 * \param theP3 Junction point of incident pipe
4457 * \return List of GEOM_Object, containing the created shape and propagation groups.
4459 ListOfGO MakePipeTShapeChamferWithPosition (in double theR1, in double theW1, in double theL1,
4460 in double theR2, in double theW2, in double theL2,
4461 in double theH, in double theW, in boolean theHexMesh,
4462 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
4464 * \brief Create a T-shape object with specified caracteristics for the main and
4465 * the incident pipes (radius, width, half-length).
4467 * A fillet is created on the junction of the pipes.
4468 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
4469 * \param theR1 Internal radius of main pipe
4470 * \param theW1 Width of main pipe
4471 * \param theL1 Half-length of main pipe
4472 * \param theR2 Internal radius of incident pipe (R2 < R1)
4473 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4474 * \param theL2 Half-length of incident pipe
4475 * \param theRF Radius of curvature of fillet.
4476 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4477 * \return List of GEOM_Object, containing the created shape and propagation groups.
4479 ListOfGO MakePipeTShapeFillet (in double theR1, in double theW1, in double theL1,
4480 in double theR2, in double theW2, in double theL2,
4481 in double theRF, in boolean theHexMesh);
4483 * \brief Create a T-shape object with specified caracteristics for the main and
4484 * the incident pipes (radius, width, half-length).
4486 * A fillet is created on the junction of the pipes.
4487 * The extremities of the main pipe are located on junctions points P1 and P2.
4488 * The extremity of the incident pipe is located on junction point P3.
4489 * \param theR1 Internal radius of main pipe
4490 * \param theW1 Width of main pipe
4491 * \param theL1 Half-length of main pipe
4492 * \param theR2 Internal radius of incident pipe (R2 < R1)
4493 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4494 * \param theL2 Half-length of incident pipe
4495 * \param theRF Radius of curvature of fillet.
4496 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4497 * \param theP1 1st junction point of main pipe
4498 * \param theP2 2nd junction point of main pipe
4499 * \param theP3 Junction point of incident pipe
4500 * \return List of GEOM_Object, containing the created shape and propagation groups.
4502 ListOfGO MakePipeTShapeFilletWithPosition (in double theR1, in double theW1, in double theL1,
4503 in double theR2, in double theW2, in double theL2,
4504 in double theRF, in boolean theHexMesh,
4505 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
4507 // T-Shape WITH Thickness reduction
4510 * \brief Create a T-shape object with specified caracteristics for the main and
4511 * the incident pipes (radius, width, half-length).
4513 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
4514 * \param theR1 Internal radius of main pipe
4515 * \param theW1 Width of main pipe
4516 * \param theL1 Half-length of main pipe
4517 * \param theR2 Internal radius of incident pipe (R2 < R1)
4518 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4519 * \param theL2 Half-length of incident pipe
4521 * \param theRL Internal radius of left thickness reduction
4522 * \param theWL Width of left thickness reduction
4523 * \param theLtransL Length of left transition part
4524 * \param theLthinL Length of left thin part
4526 * \param theRR Internal radius of right thickness reduction
4527 * \param theWR Width of right thickness reduction
4528 * \param theLtransR Length of right transition part
4529 * \param theLthinR Length of right thin part
4531 * \param theRI Internal radius of incident thickness reduction
4532 * \param theWI Width of incident thickness reduction
4533 * \param theLtransI Length of incident transition part
4534 * \param theLthinI Length of incident thin part
4536 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4537 * \return List of GEOM_Object, containing the created shape and propagation groups.
4539 ListOfGO MakePipeTShapeTR (in double theR1, in double theW1, in double theL1,
4540 in double theR2, in double theW2, in double theL2,
4541 in double theRL, in double theWL, in double theLtransL, in double theLthinL,
4542 in double theRR, in double theWR, in double theLtransR, in double theLthinR,
4543 in double theRI, in double theWI, in double theLtransI, in double theLthinI,
4544 in boolean theHexMesh);
4546 * \brief Create a T-shape object with specified caracteristics for the main and
4547 * the incident pipes (radius, width, half-length).
4549 * The extremities of the main pipe are located on junctions points P1 and P2.
4550 * The extremity of the incident pipe is located on junction point P3.
4551 * \param theR1 Internal radius of main pipe
4552 * \param theW1 Width of main pipe
4553 * \param theL1 Half-length of main pipe
4554 * \param theR2 Internal radius of incident pipe (R2 < R1)
4555 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4556 * \param theL2 Half-length of incident pipe
4558 * \param theRL Internal radius of left thickness reduction
4559 * \param theWL Width of left thickness reduction
4560 * \param theLtransL Length of left transition part
4561 * \param theLthinL Length of left thin part
4563 * \param theRR Internal radius of right thickness reduction
4564 * \param theWR Width of right thickness reduction
4565 * \param theLtransR Length of right transition part
4566 * \param theLthinR Length of right thin part
4568 * \param theRI Internal radius of incident thickness reduction
4569 * \param theWI Width of incident thickness reduction
4570 * \param theLtransI Length of incident transition part
4571 * \param theLthinI Length of incident thin part
4573 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4574 * \param theP1 1st junction point of main pipe
4575 * \param theP2 2nd junction point of main pipe
4576 * \param theP3 Junction point of incident pipe
4577 * \return List of GEOM_Object, containing the created shape and propagation groups.
4579 ListOfGO MakePipeTShapeTRWithPosition
4580 (in double theR1, in double theW1, in double theL1,
4581 in double theR2, in double theW2, in double theL2,
4582 in double theRL, in double theWL, in double theLtransL, in double theLthinL,
4583 in double theRR, in double theWR, in double theLtransR, in double theLthinR,
4584 in double theRI, in double theWI, in double theLtransI, in double theLthinI,
4585 in boolean theHexMesh,
4586 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
4588 * \brief Create a T-shape object with specified caracteristics for the main and
4589 * the incident pipes (radius, width, half-length). A chamfer is created
4590 * on the junction of the pipes.
4592 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
4593 * \param theR1 Internal radius of main pipe
4594 * \param theW1 Width of main pipe
4595 * \param theL1 Half-length of main pipe
4596 * \param theR2 Internal radius of incident pipe (R2 < R1)
4597 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4598 * \param theL2 Half-length of incident pipe
4600 * \param theRL Internal radius of left thickness reduction
4601 * \param theWL Width of left thickness reduction
4602 * \param theLtransL Length of left transition part
4603 * \param theLthinL Length of left thin part
4605 * \param theRR Internal radius of right thickness reduction
4606 * \param theWR Width of right thickness reduction
4607 * \param theLtransR Length of right transition part
4608 * \param theLthinR Length of right thin part
4610 * \param theRI Internal radius of incident thickness reduction
4611 * \param theWI Width of incident thickness reduction
4612 * \param theLtransI Length of incident transition part
4613 * \param theLthinI Length of incident thin part
4615 * \param theH Height of the chamfer.
4616 * \param theW Width of the chamfer.
4617 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4618 * \return List of GEOM_Object, containing the created shape and propagation groups.
4620 ListOfGO MakePipeTShapeTRChamfer
4621 (in double theR1, in double theW1, in double theL1,
4622 in double theR2, in double theW2, in double theL2,
4623 in double theRL, in double theWL, in double theLtransL, in double theLthinL,
4624 in double theRR, in double theWR, in double theLtransR, in double theLthinR,
4625 in double theRI, in double theWI, in double theLtransI, in double theLthinI,
4626 in double theH, in double theW, in boolean theHexMesh);
4628 * \brief Create a T-shape object with specified caracteristics for the main and
4629 * the incident pipes (radius, width, half-length).
4631 * A chamfer is created on the junction of the pipes.
4632 * The extremities of the main pipe are located on junctions points P1 and P2.
4633 * The extremity of the incident pipe is located on junction point P3.
4634 * \param theR1 Internal radius of main pipe
4635 * \param theW1 Width of main pipe
4636 * \param theL1 Half-length of main pipe
4637 * \param theR2 Internal radius of incident pipe (R2 < R1)
4638 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4639 * \param theL2 Half-length of incident pipe
4641 * \param theRL Internal radius of left thickness reduction
4642 * \param theWL Width of left thickness reduction
4643 * \param theLtransL Length of left transition part
4644 * \param theLthinL Length of left thin part
4646 * \param theRR Internal radius of right thickness reduction
4647 * \param theWR Width of right thickness reduction
4648 * \param theLtransR Length of right transition part
4649 * \param theLthinR Length of right thin part
4651 * \param theRI Internal radius of incident thickness reduction
4652 * \param theWI Width of incident thickness reduction
4653 * \param theLtransI Length of incident transition part
4654 * \param theLthinI Length of incident thin part
4656 * \param theH Height of the chamfer.
4657 * \param theW Width of the chamfer.
4658 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4659 * \param theP1 1st junction point of main pipe
4660 * \param theP2 2nd junction point of main pipe
4661 * \param theP3 Junction point of incident pipe
4662 * \return List of GEOM_Object, containing the created shape and propagation groups.
4664 ListOfGO MakePipeTShapeTRChamferWithPosition
4665 (in double theR1, in double theW1, in double theL1,
4666 in double theR2, in double theW2, in double theL2,
4667 in double theRL, in double theWL, in double theLtransL, in double theLthinL,
4668 in double theRR, in double theWR, in double theLtransR, in double theLthinR,
4669 in double theRI, in double theWI, in double theLtransI, in double theLthinI,
4670 in double theH, in double theW, in boolean theHexMesh,
4671 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
4673 * \brief Create a T-shape object with specified caracteristics for the main and
4674 * the incident pipes (radius, width, half-length).
4676 * A fillet is created on the junction of the pipes.
4677 * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
4678 * \param theR1 Internal radius of main pipe
4679 * \param theW1 Width of main pipe
4680 * \param theL1 Half-length of main pipe
4681 * \param theR2 Internal radius of incident pipe (R2 < R1)
4682 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4683 * \param theL2 Half-length of incident pipe
4685 * \param theRL Internal radius of left thickness reduction
4686 * \param theWL Width of left thickness reduction
4687 * \param theLtransL Length of left transition part
4688 * \param theLthinL Length of left thin part
4690 * \param theRR Internal radius of right thickness reduction
4691 * \param theWR Width of right thickness reduction
4692 * \param theLtransR Length of right transition part
4693 * \param theLthinR Length of right thin part
4695 * \param theRI Internal radius of incident thickness reduction
4696 * \param theWI Width of incident thickness reduction
4697 * \param theLtransI Length of incident transition part
4698 * \param theLthinI Length of incident thin part
4700 * \param theRF Radius of curvature of fillet.
4701 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4702 * \return List of GEOM_Object, containing the created shape and propagation groups.
4704 ListOfGO MakePipeTShapeTRFillet
4705 (in double theR1, in double theW1, in double theL1,
4706 in double theR2, in double theW2, in double theL2,
4707 in double theRL, in double theWL, in double theLtransL, in double theLthinL,
4708 in double theRR, in double theWR, in double theLtransR, in double theLthinR,
4709 in double theRI, in double theWI, in double theLtransI, in double theLthinI,
4710 in double theRF, in boolean theHexMesh);
4712 * \brief Create a T-shape object with specified caracteristics for the main and
4713 * the incident pipes (radius, width, half-length).
4715 * A fillet is created on the junction of the pipes.
4716 * The extremities of the main pipe are located on junctions points P1 and P2.
4717 * The extremity of the incident pipe is located on junction point P3.
4718 * \param theR1 Internal radius of main pipe
4719 * \param theW1 Width of main pipe
4720 * \param theL1 Half-length of main pipe
4721 * \param theR2 Internal radius of incident pipe (R2 < R1)
4722 * \param theW2 Width of incident pipe (R2+W2 < R1+W1)
4723 * \param theL2 Half-length of incident pipe
4725 * \param theRL Internal radius of left thickness reduction
4726 * \param theWL Width of left thickness reduction
4727 * \param theLtransL Length of left transition part
4728 * \param theLthinL Length of left thin part
4730 * \param theRR Internal radius of right thickness reduction
4731 * \param theWR Width of right thickness reduction
4732 * \param theLtransR Length of right transition part
4733 * \param theLthinR Length of right thin part
4735 * \param theRI Internal radius of incident thickness reduction
4736 * \param theWI Width of incident thickness reduction
4737 * \param theLtransI Length of incident transition part
4738 * \param theLthinI Length of incident thin part
4740 * \param theRF Radius of curvature of fillet.
4741 * \param theHexMesh Boolean indicating if shape is prepared for hex mesh (default=true)
4742 * \param theP1 1st junction point of main pipe
4743 * \param theP2 2nd junction point of main pipe
4744 * \param theP3 Junction point of incident pipe
4745 * \return List of GEOM_Object, containing the created shape and propagation groups.
4747 ListOfGO MakePipeTShapeTRFilletWithPosition
4748 (in double theR1, in double theW1, in double theL1,
4749 in double theR2, in double theW2, in double theL2,
4750 in double theRL, in double theWL, in double theLtransL, in double theLthinL,
4751 in double theRR, in double theWR, in double theLtransR, in double theLthinR,
4752 in double theRI, in double theWI, in double theLtransI, in double theLthinI,
4753 in double theRF, in boolean theHexMesh,
4754 in GEOM_Object theP1, in GEOM_Object theP2, in GEOM_Object theP3);
4757 * This function allows to create a disk already divided into blocks. It
4758 * can be use to create divided pipes for later meshing in hexaedra.
4759 * \param theR Radius of the disk
4760 * \param theRatio Relative size of the central square diagonal against the disk diameter
4761 * \param theOrientation Plane on which the disk will be built
4762 * \param thePattern Division pattern. It can be GEOM.SQUARE or GEOM.HEXAGON
4763 * \return New GEOM_Object, containing the created shape.
4765 GEOM_Object MakeDividedDisk (in double theR,
4767 in short theOrientation,
4768 in pattern thePattern);
4771 * \brief Create a Disk prepared for hexa meshing with given center, normal vector and radius.
4772 * \param thePnt disk center.
4773 * \param theVec Vector, normal to the plane of the disk.
4774 * \param theR Disk radius.
4775 * \param theRatio Relative size of the central square diagonal against the disk diameter
4776 * \param thePattern Division pattern. It can be GEOM.SQUARE or GEOM.HEXAGON
4777 * \return New GEOM_Object, containing the created disk.
4779 GEOM_Object MakeDividedDiskPntVecR ( in GEOM_Object thePnt,
4780 in GEOM_Object theVec,
4783 in pattern thePattern);
4786 * Builds a cylinder prepared for hexa meshes
4787 * \param theR Radius of the cylinder
4788 * \param theH Height of the cylinder
4789 * \param thePattern Division pattern. It can be GEOM.SQUARE or GEOM.HEXAGON
4790 * \return New GEOM_Object, containing the created shape.
4792 GEOM_Object MakeDividedCylinder (in double theR,
4794 in pattern thePattern );
4797 * Create a smoothing surface from a set of points
4798 * \param thelPoints list of points. Compounds of points are accepted as well.
4799 * \param theNbMax maximum number of Bezier pieces in the resulting surface.
4800 * \param theDegMax maximum degree of the resulting BSpline surface
4801 * \param theDMax specifies maximum value of the GeomPlate_PlateG0Criterion criterion.
4802 * \return New GEOM_Object, containing the created shape.
4804 GEOM_Object MakeSmoothingSurface (in ListOfGO thelPoints,
4809 /*@@ insert new functions before this line @@ do not remove this line @@*/
4812 // # GEOM_IFieldOperations:
4814 * \brief Interface for field operation.
4816 interface GEOM_IFieldOperations : GEOM_IOperations
4819 * \brief Creates a field
4821 GEOM_Field CreateField(in GEOM_Object shape,
4823 in field_data_type type,
4825 in string_array componentNames);
4827 * \brief Returns number of fields on a shape
4829 long CountFields(in GEOM_Object shape);
4832 * \brief Returns all fields on a shape
4834 ListOfFields GetFields(in GEOM_Object shape);
4837 * \brief Returns a field on a shape by its name
4839 GEOM_Field GetField(in GEOM_Object shape, in string name);
4842 * \brief Returns number of sub-shapes of given dimension
4844 long GetNbSubShapes(in GEOM_Object shape, in short fieldDim);
4849 * \brief Interface to access other GEOM interfaces.
4851 * Also contains some methods to access and manage GEOM_Object.
4853 interface GEOM_Gen : Engines::EngineComponent,SALOMEDS::Driver
4856 * \brief Undo/Redo Management
4859 void Undo (in long theStudyID);
4861 void Redo (in long theStudyID);
4864 * \brief Publishing management
4866 * Adds in theStudy a object theObject under with a name theName,
4867 * if theFather is not NULL the object is placed under thFather's SObject.
4868 * Returns a SObject where theObject is placed
4870 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
4871 in GEOM_BaseObject theObject,
4873 in GEOM_BaseObject theFather);
4876 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4878 * To be used from python scripts out of geompy.addToStudy (non-default usage)
4879 * \param theStudy the study, in which theObject is published already,
4880 * and in which the arguments will be published
4881 * \param theObject published GEOM_Object, arguments of which will be published
4882 * \param theArgs list of GEOM_Object, operation arguments to be published.
4883 * If this list is empty, all operation arguments will be published
4884 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4885 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4886 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4887 * Do not publish sub-shapes in place of arguments, but only
4888 * in place of sub-shapes of the first argument,
4889 * because the whole shape corresponds to the first argument.
4890 * Mainly to be used after transformations, but it also can be
4891 * usefull after partition with one object shape, and some other
4892 * operations, where only the first argument has to be considered.
4893 * If theObject has only one argument shape, this flag is automatically
4894 * considered as True, not regarding really passed value.
4895 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4896 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4897 * \return list of published sub-shapes
4899 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
4900 in GEOM_Object theObject,
4901 in ListOfGO theArgs,
4902 in find_shape_method theFindMethod,
4903 in boolean theInheritFirstArg,
4904 in boolean theAddPrefix);
4907 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4909 * To be used from python scripts out of geompy.addToStudy (non-default usage)
4910 * \param theStudy the study, in which theObject is published already,
4911 * and in which the arguments will be published
4912 * \param theObject published GEOM_Object, arguments of which will be published
4913 * \param theArgs list of GEOM_Object, operation arguments to be published.
4914 * If this list is empty, all operation arguments will be published
4915 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4916 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4917 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4918 * Do not publish sub-shapes in place of arguments, but only
4919 * in place of sub-shapes of the first argument,
4920 * because the whole shape corresponds to the first argument.
4921 * Mainly to be used after transformations, but it also can be
4922 * usefull after partition with one object shape, and some other
4923 * operations, where only the first argument has to be considered.
4924 * If theObject has only one argument shape, this flag is automatically
4925 * considered as True, not regarding really passed value.
4926 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4927 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4928 * \return list of published sub-shapes
4930 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
4931 in GEOM_Object theObject,
4932 in ListOfGO theArgs,
4933 in find_shape_method theFindMethod,
4934 in boolean theInheritFirstArg,
4935 in boolean theAddPrefix);
4938 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4940 * To be used from GUI and from geompy.addToStudy.
4941 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
4942 * \param theStudy the study, in which theObject is published already,
4943 * and in which the arguments will be published
4944 * \param theSObject study object, referencing GEOM_Object, arguments of which will be published
4945 * \param theArgs list of GEOM_Object, operation arguments to be published.
4946 * If this list is empty, all operation arguments will be published
4947 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4948 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4949 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4950 * Do not publish sub-shapes in place of arguments, but only
4951 * in place of sub-shapes of the first argument,
4952 * because the whole shape corresponds to the first argument.
4953 * Mainly to be used after transformations, but it also can be
4954 * usefull after partition with one object shape, and some other
4955 * operations, where only the first argument has to be considered.
4956 * If theObject has only one argument shape, this flag is automatically
4957 * considered as True, not regarding really passed value.
4958 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4959 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4961 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
4962 in SALOMEDS::SObject theSObject,
4963 in ListOfGO theArgs,
4964 in find_shape_method theFindMethod,
4965 in boolean theInheritFirstArg,
4966 in boolean theAddPrefix);
4968 // # Methods to access interfaces for objects creation and transformation
4970 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4971 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
4972 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4973 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4974 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4975 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4976 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4977 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4978 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4979 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4980 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4981 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4982 GEOM_IFieldOperations GetIFieldOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4984 GEOM_IOperations GetPluginOperations (in long theStudyID,
4985 in string theLibName) raises (SALOME::SALOME_Exception);
4987 // # Objects Management
4991 * \brief Removes the object from the GEOM component
4992 * \param theObject is a GEOM_Object to be removed
4994 void RemoveObject (in GEOM_BaseObject theObject);
4997 * \brief Returns an object defined by the study and its entry in the GEOM component
4998 * \param theStudyID is a SALOMEDS Study ID
4999 * \param theEntry is an entry of the requested GEOM_Object in the GEOM component
5000 * \note if the object has not previously been created a NULL GEOM_Object is returned
5002 GEOM_BaseObject GetObject (in long theStudyID, in string theEntry);
5005 * \brief Add a sub-shape defined by indices in \a theIndices
5006 * (contains unique IDs of sub-shapes inside \a theMainShape)
5007 * \note The sub-shape GEOM_Object can has ONLY ONE function.
5008 * Don't try to apply modification operations on them.
5009 * \note Internal method
5011 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
5013 // # GEOM_Objects IOR Management
5016 * \brief Returns a GEOM_Object defined by its IOR
5017 * \param theIOR a string containg an IOR of the requested GEOM_Object
5019 GEOM_Object GetIORFromString (in string theIOR);
5022 * \brief Returns a string which contains an IOR of the GEOM_Object
5023 * \param theObject is a GEOM_Object which IOR is requested
5025 string GetStringFromIOR (in GEOM_Object theObject);
5028 * \brief Returns a name with which a GEOM_Object was dumped into python script
5029 * \param theStudyEntry is an entry of the GEOM_Object in the study
5031 string GetDumpName (in string theStudyEntry);
5034 * \brief Returns all names with which a GEOM_Object was dumped
5035 * into python script to avoid the same names in SMESH script
5037 string_array GetAllDumpNames();
5040 * \brief Publishes the named sub-shapes of given object in the study.
5041 * \param theStudy The study in which the object is published
5042 * \param theObject The object which named sub-shapes are published
5044 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
5045 //in SObject theSObject,
5046 in Object theObject);
5049 * \brief Creates a new folder
5051 * Creates a new container (folder) for any GEOM objects.
5052 * Folder will have name theName.
5053 * If theFather is not NULL, the folder is placed under theFather object.
5054 * Otherwise, the folder takes place under root 'Geometry' object.
5056 * \param theName name of the folder
5057 * \param theFather parent object
5058 * \return SObject represented the created folder.
5060 SALOMEDS::SObject CreateFolder (in string theName,
5061 in SALOMEDS::SObject theFather);
5064 * \brief Moves object to the specified folder
5066 * The moved object should be first published in the study.
5067 * \param theObject GEOM object to move
5068 * \param theFolder target folder
5070 void MoveToFolder (in GEOM_Object theObject,
5071 in SALOMEDS::SObject theFolder);
5074 * \brief Moves list of objects to the specified folder
5076 * The moved objects should be first published in the study.
5077 * \param theListOfGO list of GEOM objects to move
5078 * \param theFolder target folder
5080 void MoveListToFolder (in ListOfGO theListOfGO,
5081 in SALOMEDS::SObject theFolder);
5084 * \brief Moves objects to the specified position
5086 * This function is used in the drag-n-drop functionality.
5088 * \param what objects being moved
5089 * \param where parent object where objects are moved to
5090 * \param row position in the parent object's children list at which objects are moved
5092 void Move( in object_list what,
5093 in SALOMEDS::SObject where,
5097 * \brief Collects dependencies of the given objects from other ones
5098 * \param theStudy The study in which the object is published
5099 * \param theListOfEntries List of GEOM object entries in OCAF tree (not in study)
5100 * \return Struct of dependent entries and its links as a byte array
5101 * \note This method is supposed to be used by GUI only.
5103 SALOMEDS::TMPFile GetDependencyTree(in SALOMEDS::Study theStudy,
5104 in string_array theListOfEntries);
5107 * \brief Fills 3 lists that is used to reduce study of redundant objects:
5108 * - dependencies of the given objects from other ones;
5109 * - children of the given objects;
5110 * - all other objects in study.
5111 * \param theStudy The study in which the object was published
5112 * \param theSelectedEntries List of GEOM object entries in OCAF tree
5113 * \param theParentEntries List of GEOM object entries on which the given objects depend
5114 * \param theSubEntries Children entries list of the given objects
5115 * \param theOtherEntries List of GEOM object entries which are in the study, but not in parents and children lists
5116 * \note This method is supposed to be used by GUI only.
5118 void GetEntriesToReduceStudy(in SALOMEDS::Study theStudy,
5119 inout string_array theSelectedEntries,
5120 inout string_array theParentEntries,
5121 inout string_array theSubEntries,
5122 inout string_array theOtherEntries);