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)
42 /*! A collection of arbitrary shapes */
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 closed 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 */
58 /*! Arbitrary shape in a Compound (used for processing of Compounds in some operations) */
60 /*! Flat (top-level) contents of a Compound (used for processing of Compounds in some operations) */
67 enum marker_type { MT_NONE, MT_POINT, MT_PLUS, MT_STAR, MT_X, MT_O, MT_O_POINT, MT_O_PLUS,
68 MT_O_STAR, MT_O_X, MT_RING1, MT_RING2, MT_RING3, MT_BALL, MT_USER };
73 enum marker_size { MS_NONE, MS_10, MS_15, MS_20, MS_25, MS_30, MS_35,
74 MS_40, MS_45, MS_50, MS_55, MS_60, MS_65, MS_70 };
77 * \brief State of shape relatively geometrical surface like plane, sphere or cylinder.
79 * Is used in functions GEOM_IShapesOperations.GetShapesOn<xxx>()
83 /*! Shape is on surface */
87 * Shape is in the direction defined by the normal and not on surface.
88 * For plane it means above the plane,
89 * For sphere and cylinder it means outside of volume, bounded by the surface.
94 * Shape is in the direction defined by the normal and on surface.
100 * Complementary to ONOUT.
101 * For plane it means below the plane,
102 * For sphere and cylinder it means inside the volume, bounded by the surface
103 * (beyond axis and surface for cylinder and beyond cented and surface for sphere).
108 * Complementary to OUT.
115 * \brief Kind of method to find inside one main shape some sub-shapes,
116 * corresponding to other given shape (its argument)
118 * Is used in functions GEOM_Gen.RestoreSubShapesO(), GEOM_Gen.RestoreSubShapesSO(),
121 enum find_shape_method
123 /*! Use GetInPlace functionality. Suits all cases, except transformations */
126 /*! To be used only for transformation result, to find sub-shapes of argument.
127 * Only this method can be used after transformation.
131 /*! To find only shared sub-shapes, not modified by the operation */
134 /*! Use GetShapesOnShape method (can work only on solids) */
135 FSM_GetShapesOnShape,
137 /*! Use GetInPlaceByHistory method (can work only after Partition) */
138 FSM_GetInPlaceByHistory,
140 /*! To be used only for multi-transformation result.
141 * Only this method can be used after multi-transformation.
143 FSM_MultiTransformed,
145 /*! Use old GetInPlace functionality. */
150 * \brief Kind of method to perform filling operation
152 * Is used in functions GEOM_I3DPrimOperations.MakeFilling()
154 enum filling_oper_method
156 /*! Default (standard behaviour) */
159 /*! Use edges orientation - orientation of edges is used: if the edge is
160 * reversed, the curve from this edge is reversed before using it in
161 * the filling algorithm.
165 /*! Auto-correct edges orientation - changes the orientation of the curves
166 * using minimization of sum of distances between the end points of the edges.
172 * \brief Kind of the curves.
174 * Used in the functions GEOM_ICurvesOperations.MakeCurveParametric(), GEOM_ICurvesOperations.MakeCurveParametricNew(),
175 * GEOM_ICurvesOperations.MakePolyline2D, GEOM_ICurvesOperations.MakePolyline2DOnPlane.
178 /*! Polyline curve */
184 /*! Interpolation, curve */
189 * \brief Type of field data
191 enum field_data_type {
199 * This enumeration represents the level of checking shape on
200 * self-interference. It defines which interferferences will be checked.
204 SI_V_V, // only V/V interferences
205 SI_V_E, // V/V and V/E interferences
206 SI_E_E, // V/V, V/E and E/E interferences
207 SI_V_F, // V/V, V/E, E/E and V/F interferences
208 SI_E_F, // V/V, V/E, E/E, V/F and E/F interferences
209 SI_ALL // all interferences
213 * \brief Object creation parameters
215 * Is returned by GEOM_Object::GetCreationInformation()
222 typedef sequence<Parameter> Parameters;
224 struct CreationInformation
226 string operationName;
231 * \brief Reporting on shape healing
235 string name; // what changed
236 long count; // how many times
238 typedef sequence<ModifInfo> ModifStatistics;
241 typedef sequence<string> string_array;
242 typedef sequence<short> short_array;
243 typedef sequence<boolean> ListOfBool;
244 typedef sequence<long> ListOfLong;
245 typedef sequence<double> ListOfDouble;
246 typedef sequence<ListOfDouble> ListOfListOfDouble;
248 interface GEOM_Object;
249 interface GEOM_BaseObject;
250 interface GEOM_Field;
251 interface GEOM_FieldStep;
253 typedef sequence<GEOM_Object> ListOfGO;
254 typedef sequence<GEOM_BaseObject> ListOfGBO;
255 typedef sequence<GEOM_Field> ListOfFields;
256 typedef sequence<SALOMEDS::SObject> object_list;
260 * \brief A common root of objects in GEOM module
262 interface GEOM_BaseObject : SALOME::GenericObj
265 * \brief Set name of the object.
267 * \param theName is a name which will be associated with this object.
269 void SetName (in string theName);
272 * \brief Get name of the object associated with this object.
277 * \brief Get internal (unique) entry of the object in the GEOM component's data tree.
278 * \note This is not an entry of the data object in SALOME study.
279 * This is internal function of GEOM component, though it can be used outside it for
280 appropriate reason (e.g. for unique identification of geometry object).
285 * \brief Get ID of study, where the object is created.
290 * \brief Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
295 * \brief Get value of a modification counter of the object
300 * \brief Set a Study entry where this object was published.
302 void SetStudyEntry (in string theEntry);
305 * \brief Get a Study entry where this object was published.
307 string GetStudyEntry();
310 * \brief Get a list of all GEOM_Object on which were the arguments
311 * when this object was constructed and modified.
312 * \note This method is supposed to be used by GUI only.
314 ListOfGBO GetDependency();
317 * \brief Get a list of GEOM_Object on which the last function that created or modified the object depends.
318 * \note This method is supposed to be used by GUI only.
320 ListOfGBO GetLastDependency();
323 * \brief Return true if geom object representes a shape.
325 * For example, method return false for GEOM_MARKER
330 * \brief Return true if passed object is identical to this object
332 * \param other object being compared with this one
334 boolean IsSame(in GEOM_BaseObject other);
337 * Set list of parameters
338 * \param theParameters is a string containing the notebook variables separated by ":" symbol,
339 * used for object creation
341 void SetParameters (in string theParameters);
344 * \brief Return list of notebook variables used for object creation separated by ":" symbol
346 string GetParameters();
349 * \brief Return name of operation and values of parameters used for object creation
351 CreationInformation GetCreationInformation();
356 * \brief Interface of geometric object
358 interface GEOM_Object : GEOM_BaseObject
361 * \brief Get a <VAR>shape_type</VAR> of the object value.
363 shape_type GetShapeType();
366 * \brief Get the topology type of the object value.
368 * In contrast to the shape type, this function returns type of the most
369 * top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one
373 shape_type GetTopologyType();
376 * \brief Get a minimal type of the top-level shapes contained in the object.
378 * This function is useful for the compounds only; for simple shapes it
379 * exactly the same value as GetShapeType().
380 * Note, that compounds are procesed recursively.
382 * \sa GetShapeType(), GetTopologyType(), GetMaxShapeType()
384 shape_type GetMinShapeType();
387 * \brief Get a maximal type of the top-level shapes contained in the object.
389 * This function is useful for the compounds only; for simple shapes it
390 * exactly the same value as GetShapeType().
391 * Note, that compounds are procesed recursively.
393 * \sa GetShapeType(), GetTopologyType(), GetMinShapeType()
395 shape_type GetMaxShapeType();
398 * \brief Returns a name of a sub-shape if the sub-shape is published in the study
399 * \param subID - sub-shape ID
400 * \return string - the found name or an empty string if the sub-shape does not
401 * exits or is not published in the study
403 * \note Only sub-shapes directly retrieved (using e.g. ExtractSubShapes() or
404 * via group creation) can be found. Also, as sub-shape can be published in the study
405 * many times, only the first found name is returned.
407 string GetSubShapeName(in long subID);
410 * \brief Set color of the object.
412 * \param theColor is a color of the object.
414 void SetColor(in SALOMEDS::Color theColor);
417 * Get color of the object.
419 SALOMEDS::Color GetColor();
422 * Toggle auto color mode on the object.
423 * \param theAutoColor is a flag which toggles auto color mode.
425 void SetAutoColor(in boolean theAutoColor);
428 * \brief Get flag of object's auto color mode.
430 boolean GetAutoColor();
433 * \brief Set standard point marker for the object
434 * \param theType standard marker type
435 * \param theSize marker relative size
437 void SetMarkerStd(in marker_type theType, in marker_size theSize );
440 * \brief Set custom point marker for the object.
442 * The texture can be added by LoadTexture() or AddTexture() functions.
443 * \param theTextureId texture ID
445 void SetMarkerTexture(in long theTextureId);
448 * \brief Get type of the point marker assigned to the object
449 * \return current marker type (MT_NONE if no marker is set)
451 marker_type GetMarkerType();
454 * \brief Get size of the point marker assigned to the object
455 * \return current marker relative size (MS_NONE if no marker is set)
457 marker_size GetMarkerSize();
460 * \brief Get texture idenifier of the point marker assigned to the object
461 * \return marker texture ID (0 if no marker set)
463 long GetMarkerTexture();
466 * \brief Get the TopoDS_Shape, for colocated case only.
468 long long getShape();
470 // ######################################################################
471 // # Internal methods (For sub-shape identification)
472 // ######################################################################
474 * \brief Get geometric shape of the object as a byte stream in BRep format
475 * \note GEOM_IInsertOperations::RestoreShape() method can be used to restore shape from a BRep stream.
477 SALOMEDS::TMPFile GetShapeStream();
480 * \brief Returns True if this object is not a sub-shape of another object.
482 boolean IsMainShape();
485 * \brief Get a list of ID's of sub-shapes in the main shape.
486 * \note Internal method, suppopsed to be used only by GEOM_Client
488 ListOfLong GetSubShapeIndices();
491 * \brief Get a main shape object to which this object is a sub-shape
492 * \note Internal method, suppopsed to be used only by GEOM_Client
494 GEOM_Object GetMainShape();
500 * \brief Interface of the field
502 interface GEOM_Field : GEOM_BaseObject
505 * \brief Returns the shape the field lies on
507 GEOM_Object GetShape();
510 * \brief Returns type of field data
512 field_data_type GetDataType();
515 * \brief Returns dimension of the shape the field lies on
516 * 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
518 short GetDimension();
521 * \brief Returns names of components
523 string_array GetComponents();
526 * \brief Removes a component. Component number counts from one.
528 //void RemoveComponent(in long number);
531 * \brief Adds a time step to the field
533 GEOM_FieldStep AddStep(in long stepID, in long stamp);
536 * \brief Remove a time step from the field
538 void RemoveStep(in long stepID);
541 * \brief Returns number of time steps in the field
546 * \brief Returns a list of time step IDs in the field
548 ListOfLong GetSteps();
551 * \brief Returns a time step by its ID
553 GEOM_FieldStep GetStep(in long stepID);
556 * \brief Returns a size of data array that is to be passed to
557 * GEOM_FieldStep.SetValues( dataArray ). This size depends on the
558 * number of sub-shapes of field dimension and the number of components
565 * \brief Interface of the field time step
567 interface GEOM_FieldStep : GEOM_BaseObject
570 * \brief Changes the time of the field step
572 void SetStamp(in long stamp);
575 * \brief Returns the time of the field step
580 * \brief Returns the number of the field step
585 * \brief Returns the field the step belongs to
587 GEOM_Field GetField();
590 // # GEOM_BoolFieldStep:
592 * \brief Interface of the boolean field time step
594 interface GEOM_BoolFieldStep : GEOM_FieldStep
597 * \brief Changes values of the field step. Returns false if number of values is wrong
599 boolean SetValues(in short_array boolValues);
602 * \brief Returns values of the field step
604 short_array GetValues();
607 // # GEOM_IntFieldStep:
609 * \brief Interface of the integer field time step
611 interface GEOM_IntFieldStep : GEOM_FieldStep
614 * \brief Changes values of the field step. Returns false if number of values is wrong
616 boolean SetValues(in ListOfLong intValues);
619 * \brief Returns values of the field step
621 ListOfLong GetValues();
624 // # GEOM_DoubleFieldStep:
626 * \brief Interface of the double field time step
628 interface GEOM_DoubleFieldStep : GEOM_FieldStep
631 * \brief Changes values of the field step. Returns false if number of values is wrong
633 boolean SetValues(in ListOfDouble doubleValues);
636 * \brief Returns values of the field step
638 ListOfDouble GetValues();
641 // # GEOM_StringFieldStep:
643 * \brief Interface of the string field time step
645 interface GEOM_StringFieldStep : GEOM_FieldStep
648 * \brief Changes values of the field step. Returns false if number of values is wrong
650 boolean SetValues(in string_array strValues);
653 * \brief Returns values of the field step
655 string_array GetValues();
658 // # GEOM_IOperations:
660 * \brief Basic methods of all geometric operations
662 interface GEOM_IOperations : SALOME::GenericObj
665 * \brief To know, if the operation was successfully performed
670 * \brief Set the operation error code
671 * \param theErrorID is a string describing the error occured
672 * \note This method is supposed to be used only by interfaces inheriting from IOperations.
674 void SetErrorCode (in string theErrorID);
677 * \brief Get the operation error code
679 string GetErrorCode();
682 * \brief Get ID of study, where the operation is defined
687 * \brief Opens a new transaction
689 void StartOperation();
692 * \brief Closes the previously opened trasaction
694 void FinishOperation();
697 * \brief Aborts the previously opened transaction
699 void AbortOperation();
701 //# GEOM_IBasicOperations:
703 * \brief Interface for basic geometry creation
705 * (Point, Vector, Plane, Marker)
707 interface GEOM_IBasicOperations : GEOM_IOperations
710 * \brief Create point by three coordinates.
711 * \param theX The X coordinate of the point.
712 * \param theY The Y coordinate of the point.
713 * \param theZ The Z coordinate of the point.
714 * \return New GEOM_Object, containing the created point.
716 GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ);
719 * \brief Create a point, distant from the referenced point
720 * on the given distances along the coordinate axes.
721 * \param theReference The referenced point.
722 * \param theX Displacement from the referenced point along OX axis.
723 * \param theY Displacement from the referenced point along OY axis.
724 * \param theZ Displacement from the referenced point along OZ axis.
725 * \return New GEOM_Object, containing the created point.
727 GEOM_Object MakePointWithReference (in GEOM_Object theReference,
728 in double theX, in double theY, in double theZ);
731 * Create a point, corresponding to the given parameter on the given curve.
732 * \param theRefCurve The referenced curve.
733 * \param theParameter Value of parameter on the referenced curve.
734 * \return New GEOM_Object, containing the created point.
736 GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve,
737 in double theParameter);
740 * \brief Create a point, corresponding to the given length on the given curve.
741 * \param theRefCurve The referenced curve.
742 * \param theLength Length on the referenced curve. It can be negative.
743 * \param theStartPoint Any vertex close to one of edge's
744 * ends to select start point among them.
745 * If NULL, fist vertex is used.
746 * \return New GEOM_Object, containing the created point.
748 GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve,
750 in GEOM_Object theStartPoint);
753 * \brief Create a point on the given curve, projecting given point
754 * \param theRefCurve The referenced curve.
755 * \param theXParameter X co-ordinate of point to project on curve
756 * \param theYParameter Y co-ordinate of point to project on curve
757 * \param theZParameter Z co-ordinate of point to project on curve
758 * \return New GEOM_Object, containing the created point.
760 GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
761 in double theXParameter,
762 in double theYParameter,
763 in double theZParameter);
766 * \brief Create a point, corresponding to the given parameters on the
768 * \param theRefSurf The referenced surface.
769 * \param theUParameter Value of U-parameter on the referenced surface.
770 * \param theVParameter Value of V-parameter on the referenced surface.
771 * \return New GEOM_Object, containing the created point.
773 GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf,
774 in double theUParameter,
775 in double theVParameter);
778 * \brief Create a point on the given surface, projecting given point
779 * \param theRefSurf The referenced surface.
780 * \param theXParameter X co-ordinate of point to project on curve
781 * \param theYParameter Y co-ordinate of point to project on curve
782 * \param theZParameter Z co-ordinate of point to project on curve
783 * \return New GEOM_Object, containing the created point.
785 GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
786 in double theXParameter,
787 in double theYParameter,
788 in double theZParameter);
791 * \brief Create a point, which lays on the given face.
792 * The point will lay in arbitrary place of the face.
793 * The only condition on it is a non-zero distance to the face boundary.
794 * Such point can be used to uniquely identify the face inside any
795 * shape in case, when the shape does not contain overlapped faces.
796 * \param theFace The referenced face.
797 * \return New GEOM_Object, containing the created point.
799 GEOM_Object MakePointOnFace (in GEOM_Object theFace);
802 * \brief Create a point, on two lines intersection.
803 * \param theRefLine1, theRefLine2 The referenced lines.
804 * \return New GEOM_Object, containing the created point.
806 GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1,
807 in GEOM_Object theRefLine2);
810 * \brief Create a vector, corresponding to tangent to the given parameter on the given curve.
811 * \param theRefCurve The referenced curve.
812 * \param theParameter Value of parameter on the referenced curve.This value should be have value
813 * between 0. and 1.. Value of 0. corresponds first parameter of curve; value
814 * 1. corresponds last parameter of curve.
815 * \return New GEOM_Object, containing the created point.
817 GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
818 in double theParameter);
821 * \brief Create a vector with the given components.
822 * \param theDX X component of the vector.
823 * \param theDY Y component of the vector.
824 * \param theDZ Z component of the vector.
825 * \return New GEOM_Object, containing the created vector.
827 GEOM_Object MakeVectorDXDYDZ (in double theDX,
832 * \brief Create a vector between two points.
833 * \param thePnt1 Start point for the vector.
834 * \param thePnt2 End point for the vector.
835 * \return New GEOM_Object, containing the created vector.
837 GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
840 * C\brief reate a line, passing through the given point
841 * and parrallel to the given direction
842 * \param thePnt Point. The resulting line will pass through it.
843 * \param theDir Direction. The resulting line will be parallel to it.
844 * \return New GEOM_Object, containing the created line.
846 GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir);
849 * \brief Create a line, passing through the given points
850 * \param thePnt1 First of two points, defining the line.
851 * \param thePnt2 Second of two points, defining the line.
852 * \return New GEOM_Object, containing the created line.
854 GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
857 * \brief Create a line, given by two faces intersection.
858 * \param theFace1 First of two faces, defining the line.
859 * \param theFace2 Second of two faces, defining the line.
860 * \return New GEOM_Object, containing the created line.
862 GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2);
865 * \brief Create a plane, passing through the three given points
866 * \param thePnt1 First of three points, defining the plane.
867 * \param thePnt2 Second of three points, defining the plane.
868 * \param thePnt3 Fird of three points, defining the plane.
869 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
870 * \return New GEOM_Object, containing the created plane.
872 GEOM_Object MakePlaneThreePnt (in GEOM_Object thePnt1,
873 in GEOM_Object thePnt2,
874 in GEOM_Object thePnt3,
875 in double theTrimSize);
878 * \brief Create a plane, passing through the given point
879 * and normal to the given vector.
880 * \param thePnt Point, the plane has to pass through.
881 * \param theVec Vector, defining the plane normal direction.
882 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
883 * \return New GEOM_Object, containing the created plane.
885 GEOM_Object MakePlanePntVec (in GEOM_Object thePnt,
886 in GEOM_Object theVec,
887 in double theTrimSize);
890 * \brief Create a plane, similar to the existing one, but with another size of representing face.
891 * \param theFace Referenced plane or LCS(Marker).
892 * \param theTrimSize New half size of a side of quadrangle face, representing the plane.
893 * \return New GEOM_Object, containing the created plane.
895 GEOM_Object MakePlaneFace (in GEOM_Object theFace,
896 in double theTrimSize);
899 * \brief Create a plane, by two vectors.
900 * \param theVec1 Vector1, the plane has to pass through first point of this vector.
901 * \param theVec2 Vector2, defining the plane normal direction.
902 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
903 * \return New GEOM_Object, containing the created plane.
905 GEOM_Object MakePlane2Vec (in GEOM_Object theVec1,
906 in GEOM_Object theVec2,
907 in double theTrimSize);
910 * \brief Create a plane, defined by local coordinate system.
911 * \param theLCS Referenced LCS(Marker).
912 * \param theTrimSize Half size of a side of quadrangle face, representing the plane.
913 * \param theOrientation OXY, OYZ or OZX orientation = (1, 2 or 3).
914 * \return New GEOM_Object, containing the created plane.
916 GEOM_Object MakePlaneLCS (in GEOM_Object theLCS,
917 in double theTrimSize,
918 in double theOrientation);
921 * \brief Create a local coordinate system.
922 * \param theOX,theOY,theOZ Three coordinates of coordinate system origin.
923 * \param theXDX,theXDY,theXDZ Three components of OX direction
924 * \param theYDX,theYDY,theYDZ Three components of OY direction
925 * \return New GEOM_Object, containing the created coordinate system.
927 GEOM_Object MakeMarker (in double theOX , in double theOY , in double theOZ,
928 in double theXDX, in double theXDY, in double theXDZ,
929 in double theYDX, in double theYDY, in double theYDZ);
932 * \brief Create a local coordinate system from shape.
933 * \param theShape The initial shape to detect the coordinate system.
934 * \return New GEOM_Object, containing the created coordinate system.
936 GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape);
939 * \brief Create a local coordinate system from point and two vectors (DX, DY).
940 * \param theOrigin Point of coordinate system origin.
941 * \param theXVec Vector of X direction.
942 * \param theYVec Vector of Y direction.
943 * \return New GEOM_Object, containing the created coordinate system.
945 GEOM_Object MakeMarkerPntTwoVec (in GEOM_Object theOrigin,
946 in GEOM_Object theXVec, in GEOM_Object theYVec);
949 * \brief Create a tangent plane to specified face in the point with specified parameters.
951 * Values of parameters should be between 0. and 1.0
952 * \param theFace - face for which tangent plane shuold be built.
953 * \param theParameterU - value of parameter by U
954 * \param theParameterV - value of parameter Vthe
955 * \param theTrimSize - defines sizes of created face
956 * \return New GEOM_Object, containing the face built on tangent plane.
958 GEOM_Object MakeTangentPlaneOnFace(in GEOM_Object theFace,
959 in double theParameterU,
960 in double theParameterV,
961 in double theTrimSize);
965 * \brief Interface for shapes transforming.
967 * Translation, rotation, scaling, mirroring, offset, projection, recomputing.
969 interface GEOM_ITransformOperations : GEOM_IOperations
972 * \brief Translate the given object along the vector, specified by its end points.
973 * \param theObject The object to be translated.
974 * \param thePoint1 Start point of translation vector.
975 * \param thePoint2 End point of translation vector.
978 GEOM_Object TranslateTwoPoints (in GEOM_Object theObject,
979 in GEOM_Object thePoint1,
980 in GEOM_Object thePoint2);
983 * \brief Translate the given object along the vector, specified
984 * by its end points, creating its copy before the translation.
985 * \param theObject The object to be translated.
986 * \param thePoint1 Start point of translation vector.
987 * \param thePoint2 End point of translation vector.
988 * \return New GEOM_Object, containing the translated object.
990 GEOM_Object TranslateTwoPointsCopy (in GEOM_Object theObject,
991 in GEOM_Object thePoint1,
992 in GEOM_Object thePoint2);
995 * \brief Translate the given object along the vector, specified by its components.
996 * \param theObject The object to be translated.
997 * \param theDX,theDY,theDZ Components of translation vector.
1000 GEOM_Object TranslateDXDYDZ (in GEOM_Object theObject,
1001 in double theDX, in double theDY, in double theDZ);
1004 * \brief Translate the given object along the vector, specified
1005 * by its components, creating its copy before the translation.
1006 * \param theObject The object to be translated.
1007 * \param theDX,theDY,theDZ Components of translation vector.
1008 * \return New GEOM_Object, containing the translated object.
1010 GEOM_Object TranslateDXDYDZCopy (in GEOM_Object theObject,
1011 in double theDX, in double theDY, in double theDZ);
1015 * \brief Translate the given object along the given vector.
1016 * \param theObject The object to be translated.
1017 * \param theVector Translation vector, giving both direction and distance.
1018 * \return theObject.
1020 GEOM_Object TranslateVector (in GEOM_Object theObject,
1021 in GEOM_Object theVector);
1024 * \brief Translate the given object along the given vector,
1025 * creating its copy before the translation.
1026 * \param theObject The object to be translated.
1027 * \param theVector Translation vector, giving both direction and distance.
1028 * \return New GEOM_Object, containing the translated object.
1030 GEOM_Object TranslateVectorCopy (in GEOM_Object theObject,
1031 in GEOM_Object theVector);
1034 * \brief Translate the given object along the given vector on given distance,
1035 * creating its copy before the translation.
1036 * \param theObject The object to be translated.
1037 * \param theVector Translation vector, giving a direction.
1038 * \param theDistance Translation distance, giving a distance.
1039 * \param theCopy Translation copy, creating its copy if true.
1040 * \return New GEOM_Object, containing the translated object.
1042 GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
1043 in GEOM_Object theVector,
1044 in double theDistance,
1045 in boolean theCopy);
1048 * \brief Translate the given object along the given vector a given number times
1049 * \param theObject The object to be translated.
1050 * \param theVector Direction of the translation. DX if None.
1051 * \param theStep Distance to translate on.
1052 * \param theNbTimes Quantity of translations to be done.
1053 * \return New GEOM_Object, containing compound of all
1054 * the shapes, obtained after each translation.
1056 GEOM_Object MultiTranslate1D (in GEOM_Object theObject,
1057 in GEOM_Object theVector,
1059 in long theNbTimes);
1062 * \brief Conseqently apply two specified translations to theObject specified number of times.
1063 * \param theObject The object to be translated.
1064 * \param theVector1 Direction of the first translation. DX if None.
1065 * \param theStep1 Step of the first translation.
1066 * \param theNbTimes1 Quantity of translations to be done along theVector1.
1067 * \param theVector2 Direction of the second translation. DY if None.
1068 * \param theStep2 Step of the second translation.
1069 * \param theNbTimes2 Quantity of translations to be done along theVector2.
1070 * \return New GEOM_Object, containing compound of all
1071 * the shapes, obtained after each translation.
1073 GEOM_Object MultiTranslate2D (in GEOM_Object theObject,
1074 in GEOM_Object theVector1,
1076 in long theNbTimes1,
1077 in GEOM_Object theVector2,
1079 in long theNbTimes2);
1082 * \brief Rotate given object around vector perpendicular to plane containing three points.
1083 * \param theObject The object to be rotated.
1084 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
1085 * containing the three points.
1086 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
1087 * \return theObject.
1089 GEOM_Object RotateThreePoints (in GEOM_Object theObject,
1090 in GEOM_Object theCentPoint,
1091 in GEOM_Object thePoint1,
1092 in GEOM_Object thePoint2);
1096 * \brief Rotate given object around vector perpendicular to plane containing three points.
1098 * Creating its copy before the rotatation.
1099 * \param theObject The object to be rotated.
1100 * \param theCentPoint central point - the axis is the vector perpendicular to the plane
1101 * containing the three points.
1102 * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
1103 * \return New GEOM_Object, containing the rotated object.
1105 GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
1106 in GEOM_Object theCentPoint,
1107 in GEOM_Object thePoint1,
1108 in GEOM_Object thePoint2);
1111 * \brief Rotate the given object around the given axis on the given angle.
1112 * \param theObject The object to be rotated.
1113 * \param theAxis Rotation axis.
1114 * \param theAngle Rotation angle in radians.
1115 * \return theObject.
1117 GEOM_Object Rotate (in GEOM_Object theObject,
1118 in GEOM_Object theAxis,
1119 in double theAngle);
1123 * Rotate the given object around the given axis
1124 * on the given angle, creating its copy before the rotatation.
1125 * \param theObject The object to be rotated.
1126 * \param theAxis Rotation axis.
1127 * \param theAngle Rotation angle in radians.
1128 * \return New GEOM_Object, containing the rotated object.
1130 GEOM_Object RotateCopy (in GEOM_Object theObject,
1131 in GEOM_Object theAxis,
1132 in double theAngle);
1135 * \brief Rotate the given object around the given axis a given number times.
1137 * Rotation angle will be 2*PI/theNbObjects.
1138 * \param theObject The object to be rotated.
1139 * \param theAxis The rotation axis. DZ if None.
1140 * \param theNbObjects Quantity of rotations to be done.
1141 * \return New GEOM_Object, containing compound of all the
1142 * shapes, obtained after each rotation.
1144 GEOM_Object MultiRotate1D (in GEOM_Object theObject,
1145 in GEOM_Object theAxis,
1146 in long theNbObjects);
1149 * \brief Rotate the given object around the given axis
1150 * a given number times on the given angle.
1152 * \param theObject The object to be rotated.
1153 * \param theAxis The rotation axis. DZ if None.
1154 * \param theAngleStep Rotation angle in radians.
1155 * \param theNbSteps Quantity of rotations to be done.
1156 * \return New GEOM_Object, containing compound of all the
1157 * shapes, obtained after each rotation.
1159 GEOM_Object MultiRotate1DByStep (in GEOM_Object theObject,
1160 in GEOM_Object theAxis,
1161 in double theAngleStep,
1162 in long theNbSteps);
1165 * \brief Rotate the given object around the given axis
1166 * a given number times and multi-translate each rotation result.
1168 * Rotation angle will be 2*PI/theNbObjects.
1169 * Translation direction passes through center of gravity
1170 * of rotated shape and its projection on the rotation axis.
1171 * \param theObject The object to be rotated.
1172 * \param theAxis Rotation axis. DZ if None.
1173 * \param theNbObjects Quantity of rotations to be done.
1174 * \param theRadialStep Translation distance.
1175 * \param theNbSteps Quantity of translations to be done.
1176 * \return New GEOM_Object, containing compound of all the
1177 * shapes, obtained after each transformation.
1179 GEOM_Object MultiRotate2DNbTimes (in GEOM_Object theObject,
1180 in GEOM_Object theAxis,
1181 in long theNbObjects,
1182 in double theRadialStep,
1183 in long theNbSteps);
1186 * \brief Rotate the given object around the
1187 * given axis on the given angle a given number
1188 * times and multi-translate each rotation result.
1190 * Translation direction passes through center of gravity
1191 * of rotated shape and its projection on the rotation axis.
1192 * \param theObject The object to be rotated.
1193 * \param theAxis Rotation axis. DZ if None.
1194 * \param theAngleStep Rotation angle in radians.
1195 * \param theNbSteps1 Quantity of rotations to be done.
1196 * \param theRadialStep Translation distance.
1197 * \param theNbSteps2 Quantity of translations to be done.
1198 * \return New GEOM_Object, containing compound of all the
1199 * shapes, obtained after each transformation.
1201 GEOM_Object MultiRotate2DByStep (in GEOM_Object theObject,
1202 in GEOM_Object theAxis,
1203 in double theAngleStep,
1204 in long theNbSteps1,
1205 in double theRadialStep,
1206 in long theNbSteps2);
1209 * \brief Rotate the given object around the
1210 * given axis on the given angle a given number
1211 * times and multi-translate each rotation result.
1213 * Translation direction passes through center of gravity
1214 * of rotated shape and its projection on the rotation axis.
1215 * \param theObject The object to be rotated.
1216 * \param theAxis Rotation axis. DZ if None.
1217 * \param theAngleStep Rotation angle in degrees.
1218 * \param theNbSteps1 Quantity of rotations to be done.
1219 * \param theRadialStep Translation distance.
1220 * \param theNbSteps2 Quantity of translations to be done.
1221 * \return New GEOM_Object, containing compound of all the
1222 * shapes, obtained after each transformation.
1224 GEOM_Object MultiRotate2D (in GEOM_Object theObject,
1225 in GEOM_Object theAxis,
1226 in double theAngleStep,
1227 in long theNbSteps1,
1228 in double theRadialStep,
1229 in long theNbSteps2);
1232 * \brief Replace the given object by an object,
1233 * symmetrical to it relatively the given plane.
1234 * \param theObject The object to be mirrored.
1235 * \param thePlane Plane of symmetry.
1237 GEOM_Object MirrorPlane (in GEOM_Object theObject, in GEOM_Object thePlane);
1240 * \brief Create an object, symmetrical
1241 * to the given one relatively the given plane.
1242 * \param theObject The object to be mirrored.
1243 * \param thePlane Plane of symmetry.
1244 * \return New GEOM_Object, containing the mirrored shape.
1246 GEOM_Object MirrorPlaneCopy (in GEOM_Object theObject, in GEOM_Object thePlane);
1249 * \brief Replace the given object by an object,
1250 * symmetrical to it relatively the given axis.
1251 * \param theObject The object to be mirrored.
1252 * \param theAxis Axis of symmetry.
1253 * \return theObject.
1255 GEOM_Object MirrorAxis (in GEOM_Object theObject, in GEOM_Object theAxis);
1258 * \brief Create an object, symmetrical
1259 * to the given one relatively the given axis.
1260 * \param theObject The object to be mirrored.
1261 * \param theAxis Axis of symmetry.
1262 * \return New GEOM_Object, containing the mirrored object.
1264 GEOM_Object MirrorAxisCopy (in GEOM_Object theObject, in GEOM_Object theAxis);
1267 * \brief Replace the given object by an object, symmetrical to it relatively the given point.
1268 * \param theObject The object to be mirrored.
1269 * \param thePoint Point of symmetry.
1270 * \return theObject.
1272 GEOM_Object MirrorPoint (in GEOM_Object theObject, in GEOM_Object thePoint);
1275 * \brief Create an object, symmetrical to the given one relatively the given point.
1276 * \param theObject The object to be mirrored.
1277 * \param thePoint Point of symmetry.
1278 * \return New GEOM_Object, containing the mirrored object.
1280 GEOM_Object MirrorPointCopy (in GEOM_Object theObject, in GEOM_Object thePoint);
1283 * \brief Replace the given object by its offset.
1284 * \param theObject The base object for the offset.
1285 * \param theOffset Offset value.
1286 * \return theObject.
1288 GEOM_Object OffsetShape (in GEOM_Object theObject, in double theOffset);
1291 * \brief Create new object as offset of the given one.
1292 * \param theObject The base object for the offset.
1293 * \param theOffset Offset value.
1294 * \return New GEOM_Object, containing the offset object.
1296 GEOM_Object OffsetShapeCopy (in GEOM_Object theObject, in double theOffset);
1299 * \brief Create new object as projection of the given one on a 2D surface.
1300 * \param theSource The source object for the projection. It can be a point, edge or wire.
1301 * \param theTarget The target object. It can be planar or cylindrical face.
1302 * \return New GEOM_Object, containing the projection.
1304 GEOM_Object ProjectShapeCopy (in GEOM_Object theSource, in GEOM_Object theTarget);
1307 * \brief Create a projection projection of the given point on a wire or
1310 * If there are no solutions or there are 2 or more solutions It throws an
1312 * \param thePoint the point to be projected.
1313 * \param theWire the wire. The edge is accepted as well.
1314 * \param thePointOnEdge the projection point.
1315 * \param theEdgeInWireIndex the index of an edge in a wire.
1316 * \return the parameter of projection point on edge.
1318 double ProjectPointOnWire (in GEOM_Object thePoint,
1319 in GEOM_Object theWire,
1320 out GEOM_Object thePointOnEdge,
1321 out long theEdgeInWireIndex);
1324 * \brief Scale the given object by the factor.
1325 * \param theObject The object to be scaled.
1326 * \param thePoint Center point for scaling.
1327 * \param theFactor Scaling factor value.
1328 * \return theObject.
1330 GEOM_Object ScaleShape (in GEOM_Object theObject, in GEOM_Object thePoint,
1331 in double theFactor);
1334 * \brief Scale the given object by the factor, creating its copy before the scaling.
1335 * \param theObject The object to be scaled.
1336 * \param thePoint Center point for scaling.
1337 * \param theFactor Scaling factor value.
1338 * \return New GEOM_Object, containing the scaled shape.
1340 GEOM_Object ScaleShapeCopy (in GEOM_Object theObject, in GEOM_Object thePoint,
1341 in double theFactor);
1344 * \brief Scale the given object by different factors along coordinate axes.
1345 * \param theObject The object to be scaled.
1346 * \param thePoint Center point for scaling.
1347 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1348 * \return theObject.
1350 GEOM_Object ScaleShapeAlongAxes (in GEOM_Object theObject,
1351 in GEOM_Object thePoint,
1352 in double theFactorX,
1353 in double theFactorY,
1354 in double theFactorZ);
1357 * \brief Scale the given object by different factors along coordinate axes,
1358 * creating its copy before the scaling.
1359 * \param theObject The object to be scaled.
1360 * \param thePoint Center point for scaling.
1361 * \param theFactorX,theFactorY,theFactorZ Scaling factors along each axis.
1362 * \return New GEOM_Object, containing the scaled shape.
1364 GEOM_Object ScaleShapeAlongAxesCopy (in GEOM_Object theObject,
1365 in GEOM_Object thePoint,
1366 in double theFactorX,
1367 in double theFactorY,
1368 in double theFactorZ);
1371 * \brief Modify the Location of the given object by LCS.
1372 * \param theObject The object to be displaced.
1373 * \param theStartLCS Coordinate system to perform displacement from it.
1374 * If \a theStartLCS is NULL, displacement
1375 * will be performed from global CS.
1376 * If \a theObject itself is used as \a theStartLCS,
1377 * its location will be changed to \a theEndLCS.
1378 * \param theEndLCS Coordinate system to perform displacement to it.
1379 * \return theObject.
1381 GEOM_Object PositionShape (in GEOM_Object theObject,
1382 in GEOM_Object theStartLCS,
1383 in GEOM_Object theEndLCS);
1386 * \brief Modify the Location of the given object by LCS,
1387 * creating its copy before the setting.
1388 * \param theObject The object to be displaced.
1389 * \param theStartLCS Coordinate system to perform displacement from it.
1390 * If \a theStartLCS is NULL, displacement
1391 * will be performed from global CS.
1392 * If \a theObject itself is used as \a theStartLCS,
1393 * its location will be changed to \a theEndLCS.
1394 * \param theEndLCS Coordinate system to perform displacement to it.
1395 * \return New GEOM_Object, containing the displaced shape.
1397 GEOM_Object PositionShapeCopy (in GEOM_Object theObject,
1398 in GEOM_Object theStartLCS,
1399 in GEOM_Object theEndLCS);
1402 * \brief Modify the Location of the given object by Path,
1403 * \param theObject The object to be displaced.
1404 * \param thePath Wire or Edge along that the object will be translated.
1405 * \param theDistance progress of Path (0 = actual location, 1 = end of path location).
1406 * \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
1407 * \param theReverse is a true or false parameter. True is to reverse
1408 * direction, false is to move normal direction.
1409 * \return New GEOM_Object, containing the displaced shape.
1411 GEOM_Object PositionAlongPath (in GEOM_Object theObject,
1412 in GEOM_Object thePath,
1413 in double theDistance,
1415 in boolean theReverse);
1418 * \brief Recompute the shape from its arguments.
1419 * \param theObject The object to be recomputed.
1420 * \return theObject.
1422 GEOM_Object RecomputeObject (in GEOM_Object theObject);
1426 * \brief Interface for 3D primitives creation
1428 * Box, Cylinder, Cone, Sphere, Prism (extrusion),
1429 * Pipe (extrusion along contour), Revolution, Solid (from shell).
1431 interface GEOM_I3DPrimOperations : GEOM_IOperations
1434 * \brief Create a box with specified dimensions along the coordinate axes
1435 * and with edges, parallel to the coordinate axes.
1437 * Center of the box will be at point (DX/2, DY/2, DZ/2).
1438 * \param theDX Length of Box edges, parallel to OX axis.
1439 * \param theDY Length of Box edges, parallel to OY axis.
1440 * \param theDZ Length of Box edges, parallel to OZ axis.
1441 * \return New GEOM_Object, containing the created box.
1443 GEOM_Object MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ);
1446 * \brief Create a box with two specified opposite vertices,
1447 * and with edges, parallel to the coordinate axes
1448 * \param thePnt1 First of two opposite vertices.
1449 * \param thePnt2 Second of two opposite vertices.
1450 * \return New GEOM_Object, containing the created box.
1452 GEOM_Object MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1455 * \brief Create a face specified dimensions along OX-OY coordinate axes,
1456 * with edges parallel to the coordinate axes.
1458 * Center of the face will be at point (0, 0, 0).
1459 * \param theH Height of the Face.
1460 * \param theW Width of the Face.
1461 * \param theOrientation Orientation belong axis OXY OYZ OZX
1462 * \return New GEOM_Object, containing the created face.
1464 GEOM_Object MakeFaceHW (in double theH, in double theW, in short theOrientation);
1466 * \brief Create a face by normale vector or edge and two specified sizes,
1467 * vertical (H) and horisontal (W).
1468 * \param theObj defines plane.
1469 * \param theH vertical size (height).
1470 * \param theW horisontal size (width).
1471 * \return New GEOM_Object, containing the created face.
1473 GEOM_Object MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW);
1475 * \brief Create a Disk (circular face) with given center, normal vector and radius.
1476 * \param thePnt disk center.
1477 * \param theVec Vector, normal to the plane of the disk.
1478 * \param theR Disk radius.
1479 * \return New GEOM_Object, containing the created disk.
1481 GEOM_Object MakeDiskPntVecR (in GEOM_Object thePnt,
1482 in GEOM_Object theVec,
1485 * \brief Create a disk (circular face), passing through three given points
1486 * \param thePnt1, thePnt2, thePnt3 Points, defining the disk.
1487 * \return New GEOM_Object, containing the created disk.
1489 GEOM_Object MakeDiskThreePnt (in GEOM_Object thePnt1,
1490 in GEOM_Object thePnt2,
1491 in GEOM_Object thePnt3);
1494 * \brief Create a disk specified dimensions along OX-OY coordinate axes.
1496 * Center of the disk at point (0, 0, 0).
1497 * \param theR of the Disk.
1498 * \param theOrientation Orientation belong axis OXY OYZ OZX
1499 * \return New GEOM_Object, containing the created disk.
1501 GEOM_Object MakeDiskR (in double theR, in short theOrientation);
1504 * \brief Create a cylinder with given radius and height at
1505 * the origin of coordinate system.
1507 * Axis of the cylinder will be collinear to the OZ axis of the coordinate system.
1508 * \param theR Cylinder radius.
1509 * \param theH Cylinder height.
1510 * \return New GEOM_Object, containing the created cylinder.
1512 GEOM_Object MakeCylinderRH (in double theR, in double theH);
1515 * \brief Create a portion of cylinder with given radius, height and angle at
1516 * the origin of coordinate system.
1518 * Axis of the cylinder will be collinear to the OZ axis of the coordinate system.
1519 * \param theR Cylinder radius.
1520 * \param theH Cylinder height.
1521 * \param theA Cylinder angle.
1522 * \return New GEOM_Object, containing the created cylinder.
1524 GEOM_Object MakeCylinderRHA (in double theR, in double theH, in double theA);
1527 * \brief Create a cylinder with given base point, axis, radius and height.
1528 * \param thePnt Central point of cylinder base.
1529 * \param theAxis Cylinder axis.
1530 * \param theR Cylinder radius.
1531 * \param theH Cylinder height.
1532 * \return New GEOM_Object, containing the created cylinder.
1534 GEOM_Object MakeCylinderPntVecRH (in GEOM_Object thePnt,
1535 in GEOM_Object theAxis,
1539 * \brief Create a portion of cylinder with given base point, axis, radius, height and angle.
1540 * \param thePnt Central point of cylinder base.
1541 * \param theAxis Cylinder axis.
1542 * \param theR Cylinder radius.
1543 * \param theH Cylinder height.
1544 * \param theA Cylinder angle.
1545 * \return New GEOM_Object, containing the created cylinder.
1547 GEOM_Object MakeCylinderPntVecRHA (in GEOM_Object thePnt,
1548 in GEOM_Object theAxis,
1554 * \brief Create a cone with given height and radiuses at
1555 * the origin of coordinate system.
1557 * Axis of the cone will be collinear to the OZ axis of the coordinate system.
1558 * \param theR1 Radius of the first cone base.
1559 * \param theR2 Radius of the second cone base.
1560 * \note If both radiuses are non-zero, the cone will be truncated.
1561 * \note If the radiuses are equal, a cylinder will be created instead.
1562 * \param theH Cone height.
1563 * \return New GEOM_Object, containing the created cone.
1565 GEOM_Object MakeConeR1R2H (in double theR1, in double theR2, in double theH);
1568 * \brief Create a cone with given base point, axis, height and radiuses.
1569 * \param thePnt Central point of the first cone base.
1570 * \param theAxis Cone axis.
1571 * \param theR1 Radius of the first cone base.
1572 * \param theR2 Radius of the second cone base.
1573 * \note If both radiuses are non-zero, the cone will be truncated.
1574 * \note If the radiuses are equal, a cylinder will be created instead.
1575 * \param theH Cone height.
1576 * \return New GEOM_Object, containing the created cone.
1578 GEOM_Object MakeConePntVecR1R2H (in GEOM_Object thePnt,
1579 in GEOM_Object theAxis,
1585 * \brief Create a torus with given radiuses at the origin of coordinate system.
1586 * \param theRMajor Torus major radius.
1587 * \param theRMinor Torus minor radius.
1588 * \return New GEOM_Object, containing the created torus.
1590 GEOM_Object MakeTorusRR (in double theRMajor,
1591 in double theRMinor);
1594 * \brief Create a torus with given center, normal vector and radiuses.
1595 * \param thePnt Torus central point.
1596 * \param theVec Torus axis of symmetry.
1597 * \param theRMajor Torus major radius.
1598 * \param theRMinor Torus minor radius.
1599 * \return New GEOM_Object, containing the created torus.
1601 GEOM_Object MakeTorusPntVecRR (in GEOM_Object thePnt,
1602 in GEOM_Object theVec,
1603 in double theRMajor,
1604 in double theRMinor);
1607 * \brief Create a sphere with given radius at the origin of coordinate system.
1608 * \param theR Sphere radius.
1609 * \return New GEOM_Object, containing the created sphere.
1611 GEOM_Object MakeSphereR (in double theR);
1614 * \brief Create a sphere with given center and radius.
1615 * \param thePnt Sphere center.
1616 * \param theR Sphere radius.
1617 * \return New GEOM_Object, containing the created .
1619 GEOM_Object MakeSpherePntR (in GEOM_Object thePnt, in double theR);
1622 * \brief Create a shape by extrusion of the base shape along the vector
1624 * All the space, transfixed by the base shape during its translation
1625 * along the vector on the given distance.
1626 * \param theBase Base shape to be extruded.
1627 * \param theVec Direction of extrusion.
1628 * \param theH Prism dimension along theVec.
1629 * \return New GEOM_Object, containing the created prism.
1631 GEOM_Object MakePrismVecH (in GEOM_Object theBase,
1632 in GEOM_Object theVec,
1634 /* \brief The Same Prism but in 2 directions (forward&backward) */
1635 GEOM_Object MakePrismVecH2Ways (in GEOM_Object theBase,
1636 in GEOM_Object theVec,
1638 /* \brief The Same as MakePrismVecH but with scaling */
1639 GEOM_Object MakePrismVecHWithScaling (in GEOM_Object theBase,
1640 in GEOM_Object theVec,
1642 in double theScaleFactor);
1645 * \brief Create a shape by extrusion of the base shape along a vector, defined by two points.
1646 * \param theBase Base shape to be extruded.
1647 * \param thePoint1 First end of extrusion vector.
1648 * \param thePoint2 Second end of extrusion vector.
1649 * \return New GEOM_Object, containing the created prism.
1651 GEOM_Object MakePrismTwoPnt (in GEOM_Object theBase,
1652 in GEOM_Object thePoint1,
1653 in GEOM_Object thePoint2);
1654 /* \brief The same prism but in two directions forward&backward */
1655 GEOM_Object MakePrismTwoPnt2Ways (in GEOM_Object theBase,
1656 in GEOM_Object thePoint1,
1657 in GEOM_Object thePoint2);
1658 /* \brief The Same as MakePrismTwoPnt but with scaling */
1659 GEOM_Object MakePrismTwoPntWithScaling (in GEOM_Object theBase,
1660 in GEOM_Object thePoint1,
1661 in GEOM_Object thePoint2,
1662 in double theScaleFactor);
1665 * \brief Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
1666 * \param theBase Base shape to be extruded.
1667 * \param theDX, theDY, theDZ end of extrusion vector.
1668 * \return New GEOM_Object, containing the created prism.
1670 GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
1671 in double theDX, in double theDY, in double theDZ);
1672 /* \brief The same prism but in two directions forward&backward */
1673 GEOM_Object MakePrismDXDYDZ2Ways (in GEOM_Object theBase,
1674 in double theDX, in double theDY, in double theDZ);
1675 /* \brief The Same as MakePrismDXDYDZ but with scaling */
1676 GEOM_Object MakePrismDXDYDZWithScaling (in GEOM_Object theBase,
1677 in double theDX, in double theDY, in double theDZ,
1678 in double theScaleFactor);
1682 * \brief Add / Remove material to / from a solid by extrusion of the base shape on the given distance.
1683 * \param theInitShape Initial shape on which to perform the feature.It has to be a solid or
1684 * a compound made of a single solid
1685 * \param theBase Edge or wire defining the base shape to be extruded.
1686 * \param theHeight Prism dimension along the normal of the face.
1687 * \param theAngle Draft angel in degrees
1688 * \param theFuse If true material is added else material is removed
1689 * \return New GEOM_Object, containing the modified shape
1691 GEOM_Object MakeDraftPrism (in GEOM_Object theInitShape,
1692 in GEOM_Object theBase,
1693 in double theHeight,
1695 in boolean theFuse);
1698 * \brief Create a shape by extrusion of the base shape along
1699 * the path shape. The path shape can be a wire or an edge.
1700 * \param theBase Base shape to be extruded.
1701 * \param thePath Path shape to extrude the base shape along it.
1702 * \return New GEOM_Object, containing the created pipe.
1704 GEOM_Object MakePipe (in GEOM_Object theBase, in GEOM_Object thePath);
1707 * \brief Create a shape by revolution of the base shape around the axis
1708 * on the given angle.
1710 * All the space, transfixed by the base
1711 * shape during its rotation around the axis on the given angle.
1712 * \param theBase Base shape to be rotated.
1713 * \param theAxis Rotation axis.
1714 * \param theAngle Rotation angle in radians.
1715 * \return New GEOM_Object, containing the created revolution.
1717 GEOM_Object MakeRevolutionAxisAngle (in GEOM_Object theBase,
1718 in GEOM_Object theAxis,
1719 in double theAngle);
1720 /* The Same Revolution but in both ways forward&backward */
1721 GEOM_Object MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase,
1722 in GEOM_Object theAxis,
1723 in double theAngle);
1726 * \brief Create a face from a given set of contours.
1727 * \param theContours either a list or a compound of edges/wires.
1728 * \param theMinDeg a minimal degree of BSpline surface to create.
1729 * \param theMaxDeg a maximal degree of BSpline surface to create.
1730 * \param theTol2D a 2d tolerance to be reached.
1731 * \param theTol3D a 3d tolerance to be reached.
1732 * \param theNbIter a number of iteration of approximation algorithm.
1733 * \param theMethod Kind of method to perform filling operation.
1734 * \param theApprox Boolean indicating if result should be approximated.
1735 * \return New GEOM_Object (face), containing the created filling surface.
1737 GEOM_Object MakeFilling (in ListOfGO theContours,
1738 in long theMinDeg, in long theMaxDeg,
1739 in double theTol2D, in double theTol3D,
1741 in filling_oper_method theMethod,
1742 in boolean theApprox);
1745 * \brief Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.
1746 * \param theSeqSections - set of specified sections.
1747 * \param theModeSolid - mode defining building solid or shell
1748 * \param thePreci - precision 3D used for smoothing by default 1.e-6
1749 * \param theRuled - mode defining type of the result surfaces (ruled or smoothed).
1750 * \return New GEOM_Object, containing the created shell or solid.
1752 GEOM_Object MakeThruSections(in ListOfGO theSeqSections,
1753 in boolean theModeSolid,
1755 in boolean theRuled);
1758 * \brief Create a shape by extrusion of the profile shape along
1761 * The path shape can be a wire or an edge.
1762 * the several profiles can be specified in the several locations of path.
1763 * \param theSeqBases - list of Bases shape to be extruded.
1764 * \param theLocations - list of locations on the path corresponding
1765 * specified list of the Bases shapes. Number of locations
1766 * should be equal to number of bases or list of locations can be empty.
1767 * \param thePath - Path shape to extrude the base shape along it.
1768 * \param theWithContact - the mode defining that the section is translated to be in
1769 * contact with the spine.
1770 * \param theWithCorrection - defining that the section is rotated to be
1771 * orthogonal to the spine tangent in the correspondent point
1772 * \return New GEOM_Object, containing the created pipe.
1774 GEOM_Object MakePipeWithDifferentSections (in ListOfGO theSeqBases,
1775 in ListOfGO theLocations,
1776 in GEOM_Object thePath,
1777 in boolean theWithContact ,
1778 in boolean theWithCorrection );
1781 * \brief Create a shape by extrusion of the profile shape along
1784 * The path shape can be a shell or a face.
1785 * the several profiles can be specified in the several locations of path.
1786 * \param theSeqBases - list of Bases shape to be extruded.
1787 * \param theSeqSubBases - list of corresponding sub-shapes of section shapes.
1788 * \param theLocations - list of locations on the path corresponding
1789 * specified list of the Bases shapes. Number of locations
1790 * should be equal to number of bases.
1791 * \param thePath - Path shape to extrude the base shape along it.
1792 * \param theWithContact - the mode defining that the section is translated to be in
1793 * contact with the spine.
1794 * \param theWithCorrection - defining that the section is rotated to be
1795 * orthogonal to the spine tangent in the correspondent point
1796 * \return New GEOM_Object, containing the created pipe.
1798 GEOM_Object MakePipeWithShellSections (in ListOfGO theSeqBases,
1799 in ListOfGO theSeqSubBases,
1800 in ListOfGO theLocations,
1801 in GEOM_Object thePath,
1802 in boolean theWithContact ,
1803 in boolean theWithCorrection );
1806 * \brief Create solids between given sections
1807 * \param theSeqBases - list of sections (shell or face).
1808 * \param theLocations - list of corresponding vertexes
1809 * \return New GEOM_Object, containing the created solids.
1811 GEOM_Object MakePipeShellsWithoutPath (in ListOfGO theSeqBases,
1812 in ListOfGO theLocations);
1815 * \brief Create a shape by extrusion of the base shape along
1816 * the path shape with constant bi-normal direction along the given vector.
1818 * The path shape can be a wire or an edge.
1819 * \param theBase Base shape to be extruded.
1820 * \param thePath Path shape to extrude the base shape along it.
1821 * \param theVec Vector defines a constant binormal direction to keep the
1822 * same angle beetween the Direction and the sections
1823 * along the sweep surface.
1824 * \return New GEOM_Object, containing the created pipe.
1826 GEOM_Object MakePipeBiNormalAlongVector (in GEOM_Object theBase,
1827 in GEOM_Object thePath,
1828 in GEOM_Object theVec);
1832 * \brief Make a thick solid from a surface shape (face or shell)
1833 * \param theObject Surface from which the thick solid is made
1834 * \param theThickness Value of the thickness
1835 * \param isCopy To make a copy of \a theObject ot to modify \a theObject.
1836 * \return New GEOM_Object, containing the created pipe if isCopy = true
1837 * or the modified object if isCopy = false
1839 GEOM_Object MakeThickening (in GEOM_Object theObject,
1840 in double theThickness,
1845 * \brief Build a middle path of a pipe-like shape.
1847 * The path shape can be a wire or an edge.
1848 * \param theShape It can be closed or unclosed pipe-like shell
1849 * or a pipe-like solid.
1850 * \param theBase1, theBase2 Two bases of the supposed pipe. This
1851 * should be wires or faces of \a theShape.
1852 * \note It is not assumed that exact or approximate copy of \a theShape
1853 * can be obtained by applying existing Pipe operation on the
1854 * resulting "Path" wire taking \a theBase1 as the base - it is not
1855 * always possible; though in some particular cases it might work
1856 * it is not guaranteed. Thus, RestorePath function should not be
1857 * considered as an exact reverse operation of the Pipe.
1858 * \return New GEOM_Object, containing an edge or wire that represent
1859 * source pipe's "path".
1861 GEOM_Object RestorePath (in GEOM_Object theShape,
1862 in GEOM_Object theBase1,
1863 in GEOM_Object theBase2);
1866 * \brief Build a middle path of a pipe-like shape.
1868 * The path shape can be a wire or an edge.
1869 * \param theShape It can be closed or unclosed pipe-like shell
1870 * or a pipe-like solid.
1871 * \param theBase1, theBase2 Two bases of the supposed pipe. This
1872 * should be lists of edges of \a theShape.
1873 * \note It is not assumed that exact or approximate copy of \a theShape
1874 * can be obtained by applying existing Pipe operation on the
1875 * resulting "Path" wire taking \a theBase1 as the base - it is not
1876 * always possible; though in some particular cases it might work
1877 * it is not guaranteed. Thus, RestorePath function should not be
1878 * considered as an exact reverse operation of the Pipe.
1879 * \return New GEOM_Object, containing an edge or wire that represent
1880 * source pipe's "path".
1882 GEOM_Object RestorePathEdges (in GEOM_Object theShape,
1883 in ListOfGO theBase1,
1884 in ListOfGO theBase2);
1888 * \brief Interface for Shapes creation:
1890 * Edge from two points, Wire from edges, Face from wire,
1891 * Shell from faces, Solid from shells, Compound from shapes
1893 interface GEOM_IShapesOperations : GEOM_IOperations
1896 * \brief Create a linear edge with specified ends.
1897 * \param thePnt1 Point for the first end of edge.
1898 * \param thePnt2 Point for the second end of edge.
1899 * \return New GEOM_Object, containing the created edge.
1901 GEOM_Object MakeEdge (in GEOM_Object thePnt1, in GEOM_Object thePnt2);
1904 * \brief Create an edge on another edge, corresponding to the given length on the given edge.
1905 * \param theRefCurve The referenced edge.
1906 * \param theLength Length on the referenced edge. It can be
1907 * negative for extrapolation on base curve.
1908 * \param theStartPoint Any vertex close to one of edge's
1909 * ends to select start point among them.
1910 * If NULL, fist vertex is used.
1911 * \return New GEOM_Object, containing the created edge.
1913 GEOM_Object MakeEdgeOnCurveByLength (in GEOM_Object theRefCurve,
1914 in double theLength,
1915 in GEOM_Object theStartPoint);
1918 * \brief Create an edge from specified wire.
1919 * \param theWire source Wire.
1920 * \param theLinearTolerance linear tolerance value
1921 * \param theAngularTolerance angular tolerance value
1922 * \return New GEOM_Object, containing the created edge.
1924 GEOM_Object MakeEdgeWire (in GEOM_Object theWire,
1925 in double theLinearTolerance,
1926 in double theAngularTolerance);
1929 * \brief Create a wire from the set of edges and wires.
1930 * \param theEdgesAndWires List of edge and/or wires.
1931 * \param theTolerance Maximum distance between vertices, that will be merged.
1932 * Values less than 1e-07 are equivalent to 1e-07 (Precision::Confusion()).
1933 * \return New GEOM_Object, containing the created wire.
1935 GEOM_Object MakeWire (in ListOfGO theEdgesAndWires,
1936 in double theTolerance);
1939 * \brief Create a face on the given wire.
1940 * \param theWire closed Wire or Edge to build the face on.
1941 * \param isPlanarWanted If TRUE, only planar face will be built.
1942 * If impossible, NULL object will be returned.
1943 * \return New GEOM_Object, containing the created face.
1945 GEOM_Object MakeFace (in GEOM_Object theWire, in boolean isPlanarWanted);
1948 * \brief Create a face on the given wires set.
1949 * \param theWires List of closed wires or edges to build the face on.
1950 * \param isPlanarWanted If TRUE, only planar face will be built.
1951 * If impossible, NULL object will be returned.
1952 * \return New GEOM_Object, containing the created face.
1954 GEOM_Object MakeFaceWires (in ListOfGO theWires, in boolean isPlanarWanted);
1957 * \brief Create a face based on surface of theFace limited by theWire.
1958 * \param theFace the face whose surface is used to create a new face.
1959 * \param theWire closed Wire build the face.
1960 * \return New GEOM_Object, containing the created face.
1962 GEOM_Object MakeFaceFromSurface(in GEOM_Object theFace,
1963 in GEOM_Object theWire);
1966 * \brief Create a face from a set of edges with the given constraints.
1967 * \param theConstraints List of edges and constraint faces (as a sequence of a Edge + Face couples):
1968 * - edges should form a closed wire;
1969 * - for each edge, constraint face is optional: if a constraint face is missing
1970 * for some edge, this means that there no constraint associated with this edge.
1971 * \return New GEOM_Object, containing the created face.
1973 GEOM_Object MakeFaceWithConstraints(in ListOfGO theConstraints);
1976 * \brief Create a shell from the set of faces and shells.
1977 * \param theFacesAndShells List of faces and/or shells.
1978 * \return New GEOM_Object, containing the created shell.
1980 GEOM_Object MakeShell (in ListOfGO theFacesAndShells);
1983 * \brief Create a solid, bounded by the given shell.
1984 * \param theShell Bounding shell.
1985 * \return New GEOM_Object, containing the created solid.
1987 GEOM_Object MakeSolidShell (in GEOM_Object theShell);
1990 * \brief Create a solid, bounded by the given shells.
1991 * \param theShells Bounding shells.
1992 * \return New GEOM_Object, containing the created solid.
1994 GEOM_Object MakeSolidShells (in ListOfGO theShells);
1997 * \brief Create a compound of the given shapes.
1998 * \param theShapes List of shapes to put in compound.
1999 * \return New GEOM_Object, containing the created compound.
2001 GEOM_Object MakeCompound (in ListOfGO theShapes);
2004 * \brief Make a solid (or solids) from connected set of faces and/or shells.
2005 * \param theFacesOrShells List of faces and/or shells.
2006 * \param isIntersect If TRUE, forces performing intersections between arguments.
2008 * \return New GEOM_Object, containing the created solid (or compound of solids).
2010 GEOM_Object MakeSolidFromConnectedFaces (in ListOfGO theFacesOrShells, in boolean isIntersect);
2013 * \brief Replace coincident faces in \a theShapes by one face.
2014 * \param theShapes Initial shapes.
2015 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
2016 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
2017 * \return New GEOM_Object containing copies of theShapes without coincident faces.
2019 GEOM_Object MakeGlueFaces (in ListOfGO theShapes, in double theTolerance, in boolean doKeepNonSolids);
2022 * Find coincident faces in theShapes for possible gluing.
2023 * \param theShapes Initial shapes.
2024 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
2027 ListOfGO GetGlueFaces (in ListOfGO theShapes, in double theTolerance);
2030 * \brief Replace coincident faces in \a theShapes by one face
2031 * in compliance with given list of faces
2032 * \param theShapes Initial shapes.
2033 * \param theTolerance Maximum distance between faces, which can be considered as coincident.
2034 * \param theFaces List of faces for gluing.
2035 * \param doKeepNonSolids If FALSE, only solids will present in the result, otherwise all initial shapes.
2036 * \param doGlueAllEdges If TRUE, all coincident edges of <VAR>theShape</VAR>
2037 * will be glued, otherwise only the edges,
2038 * belonging to <VAR>theFaces</VAR>.
2039 * \return New GEOM_Object containing copies of theShapes without coincident faces.
2041 GEOM_Object MakeGlueFacesByList (in ListOfGO theShapes, in double theTolerance,
2042 in ListOfGO theFaces, in boolean doKeepNonSolids,
2043 in boolean doGlueAllEdges);
2046 * \brief Replace coincident edges in \a theShapes by one edge.
2047 * \param theShapes Initial shapes.
2048 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
2049 * \return New GEOM_Object containing copies of theShapes without coincident edges.
2051 GEOM_Object MakeGlueEdges (in ListOfGO theShapes, in double theTolerance);
2054 * Find coincident edges in \a theShapes for possible gluing.
2055 * \param theShapes Initial shapes.
2056 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
2059 ListOfGO GetGlueEdges (in ListOfGO theShapes, in double theTolerance);
2062 * \brief Replace coincident edges in \a theShapes by one edge
2063 * in compliance with given list of edges
2064 * \param theShapes Initial shapes.
2065 * \param theTolerance Maximum distance between edges, which can be considered as coincident.
2066 * \param theEdges List of edges for gluing.
2067 * \return New GEOM_Object containing copies of theShapes without some edges.
2069 GEOM_Object MakeGlueEdgesByList (in ListOfGO theShapes,
2070 in double theTolerance,
2071 in ListOfGO theEdges);
2074 * \brief Get all sub-shapes and groups of \a theShape,
2075 * that were created already by any other methods.
2076 * \param theShape Any shape.
2077 * \param theGroupsOnly If this parameter is TRUE, only groups will be
2078 * returned, else all found sub-shapes and groups.
2079 * \return List of existing sub-objects of \a theShape.
2081 ListOfGO GetExistingSubObjects (in GEOM_Object theShape,
2082 in boolean theGroupsOnly);
2085 * \brief Deprecated method.
2087 * Use MakeAllSubShapes() instead.
2089 ListOfGO MakeExplode (in GEOM_Object theShape,
2090 in long theShapeType,
2091 in boolean isSorted);
2094 * \brief Explode a shape on sub-shapes of a given type.
2096 * If the shape itself has the given type, it is also returned.
2097 * \param theShape Shape to be exploded.
2098 * \param theShapeType Type of sub-shapes to be retrieved.
2099 * \param isSorted If this parameter is TRUE, sub-shapes will be
2100 * sorted by coordinates of their gravity centers.
2101 * \return List of sub-shapes of type theShapeType, contained in theShape.
2103 ListOfGO MakeAllSubShapes (in GEOM_Object theShape,
2104 in long theShapeType,
2105 in boolean isSorted);
2108 * \brief Extract all sub-shapes of the given type from
2109 * the given shape, excluding the shape itself.
2110 * \param theShape Shape to be exploded.
2111 * \param theShapeType Type of sub-shapes to be retrieved.
2112 * \param isSorted If this parameter is TRUE, sub-shapes will be
2113 * sorted by coordinates of their gravity centers.
2114 * \return List of sub-shapes of type theShapeType, contained in theShape.
2116 ListOfGO ExtractSubShapes (in GEOM_Object theShape,
2117 in long theShapeType,
2118 in boolean isSorted);
2121 * \brief Deprecated method. Use GetAllSubShapesIDs() instead.
2123 ListOfLong SubShapeAllIDs (in GEOM_Object theShape,
2124 in long theShapeType,
2125 in boolean isSorted);
2128 * \brief Explode a shape on sub-shapes of a given type.
2130 * Does the same, as MakeAllSubShapes, but returns IDs of
2131 * sub-shapes, not GEOM_Object. It works faster.
2132 * \param theShape Shape to be exploded.
2133 * \param theShapeType Type of sub-shapes to be retrieved.
2134 * \param isSorted If this parameter is TRUE, sub-shapes will be
2135 * sorted by coordinates of their gravity centers.
2136 * \return List of IDs of sub-shapes of type theShapeType, contained in theShape.
2138 ListOfLong GetAllSubShapesIDs (in GEOM_Object theShape,
2139 in long theShapeType,
2140 in boolean isSorted);
2143 * \brief Get a sub-shape defined by its unique ID inside \a theMainShape
2144 * \param theMainShape Main shape.
2145 * \param theID Unique ID of sub-shape inside \a theMainShape.
2146 * \return GEOM_Object, corresponding to found sub-shape.
2147 * \note The sub-shape GEOM_Object can has ONLY ONE function.
2148 * Don't try to apply modification operations (without copy) on them.
2150 GEOM_Object GetSubShape (in GEOM_Object theMainShape,
2154 * \brief Get a set of sub-shapes defined by their unique IDs inside \a theMainShape
2155 * \param theMainShape Main shape.
2156 * \param theIndices List of unique IDs of sub-shapes inside \a theMainShape.
2157 * \return List of GEOM_Object, corresponding to found sub-shapes.
2158 * \note The sub-shape GEOM_Object can has ONLY ONE function.
2159 * Don't try to apply modification operations (without copy) on them.
2161 ListOfGO MakeSubShapes (in GEOM_Object theMainShape,
2162 in ListOfLong theIndices);
2165 * Get global index of \a theSubShape in \a theMainShape.
2166 * \param theMainShape Main shape.
2167 * \param theSubShape Sub-shape of the main shape.
2168 * \return global index of \a theSubShape in \a theMainShape.
2170 long GetSubShapeIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
2173 * Get global indices of \a theSubShapes in \a theMainShape.
2174 * \param theMainShape Main shape.
2175 * \param theSubShapes List of sub-shapes of the main shape.
2176 * \return list of global indices of \a theSubShapes in \a theMainShape.
2178 ListOfLong GetSubShapesIndices (in GEOM_Object theMainShape, in ListOfGO theSubShapes);
2181 * \brief Get index of \a theSubShape in \a theMainShape, unique among sub-shapes of the same type.
2183 * Together with method <VAR>GetShapeTypeString()</VAR> it can be used
2184 * to generate automatic names for sub-shapes, when publishing them in a study.
2185 * \param theMainShape Main shape.
2186 * \param theSubShape Sub-shape of the main shape.
2187 * \return index of \a theSubShape in a list of all sub-shapes of \a theMainShape of the same type.
2189 long GetTopologyIndex (in GEOM_Object theMainShape, in GEOM_Object theSubShape);
2192 * \brief Get name of type of \a theShape.
2194 * Use wide type notation, taking into consideration both topology and geometry of the shape.
2195 * Together with method <VAR>GetTopologyIndex()</VAR> it can be used
2196 * to generate automatic names for sub-shapes, when publishing them in a study.
2197 * \param theShape The shape to get a type of.
2198 * \return String, containing a type name of \a theShape.
2200 string GetShapeTypeString (in GEOM_Object theShape);
2203 * \brief Check if the object is a sub-object of another GEOM object.
2205 * \param theSubObject Checked sub-object (or its parent object, in case if
2206 * \a theSubObjectIndex is non-zero).
2207 * \param theSubObjectIndex When non-zero, specifies a sub-shape index that
2208 * identifies a sub-object within its parent specified via \a theSubObject.
2209 * \param theObject An object that is checked for ownership (or its parent object,
2210 * in case if \a theObjectIndex is non-zero).
2211 * \param theObjectIndex When non-zero, specifies a sub-shape index that
2212 * identifies an object within its parent specified via \a theObject.
2213 * \return TRUE, if the given object contains sub-object.
2215 boolean IsSubShapeBelongsTo( in GEOM_Object theSubObject,
2216 in long theSubObjectIndex,
2217 in GEOM_Object theObject,
2218 in long theObjectIndex);
2220 * \brief Count number of faces in the given shape.
2221 * \param theShape Shape to count faces in.
2222 * \return Number of faces in the given shape.
2224 long NumberOfFaces (in GEOM_Object theShape);
2227 * \brief Count number of edges in the given shape.
2228 * \param theShape Shape to count edges in.
2229 * \return Number of edges in theShape.
2231 long NumberOfEdges (in GEOM_Object theShape);
2234 * \brief Count number of sub-shapes of type \a theShapeType in the given shape.
2235 * \param theShape Shape to count sub-shapes in.
2236 * \param theShapeType The type of sub-shapes to count.
2237 * \return Number of sub-shapes of type \a theShapeType in \a theShape.
2239 long NumberOfSubShapes (in GEOM_Object theShape,
2240 in long theShapeType);
2243 * Reverses an orientation the given shape.
2244 * \param theShape Shape to be reversed.
2245 * \return The reversed copy of theShape.
2247 GEOM_Object ChangeOrientation (in GEOM_Object theShape);
2250 * \brief Retrieve all free faces from the given shape.
2252 * Free face is a face, which is not shared between two shells of the shape.
2253 * \param theShape Shape to find free faces in.
2254 * \return List of IDs of all free faces, contained in theShape.
2256 ListOfLong GetFreeFacesIDs (in GEOM_Object theShape);
2259 * \brief Get all sub-shapes of theShape1 of the given type, shared with theShape2.
2260 * \param theShape1 Shape to find sub-shapes in.
2261 * \param theShape2 Shape to find shared sub-shapes with.
2262 * \param theShapeType Type of sub-shapes to be retrieved.
2263 * \return List of sub-shapes of theShape1, shared with theShape2.
2265 ListOfGO GetSharedShapes (in GEOM_Object theShape1,
2266 in GEOM_Object theShape2,
2267 in long theShapeType);
2270 * \brief Get sub-shapes, shared by input shapes.
2271 * \param theShapes Shapes to find common sub-shapes of.
2272 * \param theShapeType Type of sub-shapes to be retrieved.
2273 * \param theMultiShare Specifies what type of shares should be checked:
2274 * - \c TRUE: search sub-shapes from 1st input shape shared with all other input shapes;
2275 * - \c FALSE: causes to search sub-shapes shared between couples of input shapes.
2276 * \note If \a theShapes contains single compound, the shares between all possible couples of
2277 * its top-level shapes are returned; otherwise, only shares between 1st input shape
2278 * and all rest input shapes are returned.
2280 * \return List of all found sub-shapes.
2282 ListOfGO GetSharedShapesMulti (in ListOfGO theShapes,
2283 in long theShapeType,
2284 in boolean theMultiShare);
2287 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2288 * the specified plane by the certain way, defined through \a theState parameter.
2289 * \param theShape Shape to find sub-shapes of.
2290 * \param theShapeType Type of sub-shapes to be retrieved.
2291 * \param theAx1 Vector (or line, or linear edge), specifying normal
2292 * direction and location of the plane to find shapes on.
2293 * \param theState The state of the sub-shapes to find.
2294 * \return List of all found sub-shapes.
2296 ListOfGO GetShapesOnPlane (in GEOM_Object theShape,
2297 in long theShapeType,
2298 in GEOM_Object theAx1,
2299 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 all found sub-shapes.
2311 ListOfGO GetShapesOnPlaneWithLocation (in GEOM_Object theShape,
2312 in long theShapeType,
2313 in GEOM_Object theAx1,
2314 in GEOM_Object thePnt,
2315 in shape_state theState);
2320 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2321 * the specified cylinder by the certain way, defined through \a theState parameter.
2322 * \param theShape Shape to find sub-shapes of.
2323 * \param theShapeType Type of sub-shapes to be retrieved.
2324 * \param theAxis Vector (or line, or linear edge), specifying
2325 * axis of the cylinder to find shapes on.
2326 * \param theRadius Radius of the cylinder to find shapes on.
2327 * \param theState The state of the sub-shapes to find.
2328 * \return List of all found sub-shapes.
2330 ListOfGO GetShapesOnCylinder (in GEOM_Object theShape,
2331 in long theShapeType,
2332 in GEOM_Object theAxis,
2333 in double theRadius,
2334 in shape_state theState);
2337 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2338 * the specified cylinder by the certain way, defined through \a theState parameter.
2339 * \param theShape Shape to find sub-shapes of.
2340 * \param theShapeType Type of sub-shapes to be retrieved.
2341 * \param theAxis Vector (or line, or linear edge), specifying
2342 * axis of the cylinder to find shapes on.
2343 * \param thePnt Point specifying location of the bottom of the cylinder.
2344 * \param theRadius Radius of the cylinder to find shapes on.
2345 * \param theState The state of the sub-shapes to find.
2346 * \return List of all found sub-shapes.
2348 ListOfGO GetShapesOnCylinderWithLocation (in GEOM_Object theShape,
2349 in long theShapeType,
2350 in GEOM_Object theAxis,
2351 in GEOM_Object thePnt,
2352 in double theRadius,
2353 in shape_state theState);
2356 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2357 * the specified sphere by the certain way, defined through \a theState parameter.
2358 * \param theShape Shape to find sub-shapes of.
2359 * \param theShapeType Type of sub-shapes to be retrieved.
2360 * \param theCenter Point, specifying center of the sphere to find shapes on.
2361 * \param theRadius Radius of the sphere to find shapes on.
2362 * \param theState The state of the sub-shapes to find.
2363 * \return List of all found sub-shapes.
2365 ListOfGO GetShapesOnSphere (in GEOM_Object theShape,
2366 in long theShapeType,
2367 in GEOM_Object theCenter,
2368 in double theRadius,
2369 in shape_state theState);
2372 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2373 * the specified quadrangle by the certain way, defined through \a theState parameter.
2374 * \param theShape Shape to find sub-shapes of.
2375 * \param theShapeType Type of sub-shapes to be retrieved.
2376 * \param theTopLeftPoint Top left quadrangle corner
2377 * \param theTopRigthPoint Top right quadrangle corner
2378 * \param theBottomLeftPoint Bottom left quadrangle corner
2379 * \param theBottomRigthPoint Bottom right quadrangle corner
2380 * \param theState The state of the sub-shapes to find.
2381 * \return List of all found sub-shapes.
2383 ListOfGO GetShapesOnQuadrangle (in GEOM_Object theShape,
2384 in long theShapeType,
2385 in GEOM_Object theTopLeftPoint,
2386 in GEOM_Object theTopRigthPoint,
2387 in GEOM_Object theBottomLeftPoint,
2388 in GEOM_Object theBottomRigthPoint,
2389 in shape_state theState);
2392 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2393 * the specified plane by the certain way, defined through \a theState parameter.
2394 * \param theShape Shape to find sub-shapes of.
2395 * \param theShapeType Type of sub-shapes to be retrieved.
2396 * \param theAx1 Vector (or line, or linear edge), specifying normal
2397 * direction and location of the plane to find shapes on.
2398 * \param theState The state of the sub-shapes to find.
2399 * \return List of IDs of all found sub-shapes.
2401 ListOfLong GetShapesOnPlaneIDs (in GEOM_Object theShape,
2402 in long theShapeType,
2403 in GEOM_Object theAx1,
2404 in shape_state theState);
2407 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2408 * the specified plane by the certain way, defined through \a theState parameter.
2409 * \param theShape Shape to find sub-shapes of.
2410 * \param theShapeType Type of sub-shapes to be retrieved.
2411 * \param theAx1 Vector (or line, or linear edge), specifying normal
2412 * direction of the plane to find shapes on.
2413 * \param thePnt Point specifying location of the plane to find shapes on.
2414 * \param theState The state of the sub-shapes to find.
2415 * \return List of IDs of all found sub-shapes.
2417 ListOfLong GetShapesOnPlaneWithLocationIDs (in GEOM_Object theShape,
2418 in long theShapeType,
2419 in GEOM_Object theAx1,
2420 in GEOM_Object thePnt,
2421 in shape_state theState);
2424 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2425 * the specified cylinder by the certain way, defined through \a theState parameter.
2426 * \param theShape Shape to find sub-shapes of.
2427 * \param theShapeType Type of sub-shapes to be retrieved.
2428 * \param theAxis Vector (or line, or linear edge), specifying
2429 * axis of the cylinder to find shapes on.
2430 * \param theRadius Radius of the cylinder to find shapes on.
2431 * \param theState The state of the sub-shapes to find.
2432 * \return List of IDs of all found sub-shapes.
2434 ListOfLong GetShapesOnCylinderIDs (in GEOM_Object theShape,
2435 in long theShapeType,
2436 in GEOM_Object theAxis,
2437 in double theRadius,
2438 in shape_state theState);
2441 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2442 * the specified cylinder by the certain way, defined through \a theState parameter.
2443 * \param theShape Shape to find sub-shapes of.
2444 * \param theShapeType Type of sub-shapes to be retrieved.
2445 * \param theAxis Vector (or line, or linear edge), specifying
2446 * axis of the cylinder to find shapes on.
2447 * \param thePnt Point specifying location of the bottom of the cylinder.
2448 * \param theRadius Radius of the cylinder to find shapes on.
2449 * \param theState The state of the sub-shapes to find.
2450 * \return List of IDs all found sub-shapes.
2452 ListOfLong GetShapesOnCylinderWithLocationIDs (in GEOM_Object theShape,
2453 in long theShapeType,
2454 in GEOM_Object theAxis,
2455 in GEOM_Object thePnt,
2456 in double theRadius,
2457 in shape_state theState);
2460 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2461 * the specified sphere by the certain way, defined through \a theState parameter.
2462 * \param theShape Shape to find sub-shapes of.
2463 * \param theShapeType Type of sub-shapes to be retrieved.
2464 * \param theCenter Point, specifying center of the sphere to find shapes on.
2465 * \param theRadius Radius of the sphere to find shapes on.
2466 * \param theState The state of the sub-shapes to find.
2467 * \return List of IDs of all found sub-shapes.
2469 ListOfLong GetShapesOnSphereIDs (in GEOM_Object theShape,
2470 in long theShapeType,
2471 in GEOM_Object theCenter,
2472 in double theRadius,
2473 in shape_state theState);
2476 * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
2477 * the specified quadrangle by the certain way, defined through \a theState parameter.
2478 * \param theShape Shape to find sub-shapes of.
2479 * \param theShapeType Type of sub-shapes to be retrieved.
2480 * \param theTopLeftPoint Top left quadrangle corner
2481 * \param theTopRigthPoint Top right quadrangle corner
2482 * \param theBottomLeftPoint Bottom left quadrangle corner
2483 * \param theBottomRigthPoint Bottom right quadrangle corner
2484 * \param theState The state of the sub-shapes to find.
2485 * \return List of IDs of all found sub-shapes.
2487 ListOfLong GetShapesOnQuadrangleIDs (in GEOM_Object theShape,
2488 in long theShapeType,
2489 in GEOM_Object theTopLeftPoint,
2490 in GEOM_Object theTopRigthPoint,
2491 in GEOM_Object theBottomLeftPoint,
2492 in GEOM_Object theBottomRigthPoint,
2493 in shape_state theState);
2496 * \brief Find sub-shapes complying with given status
2497 * \param theBox - the box to check state of sub-shapes against
2498 * \param theShape - the shape to explore
2499 * \param theShapeType - type of sub-shape of theShape
2500 * \param theState - required state
2501 * \return List of IDs of all found sub-shapes.
2503 ListOfLong GetShapesOnBoxIDs (in GEOM_Object theBox,
2504 in GEOM_Object theShape,
2505 in long theShapeType,
2506 in shape_state theState);
2509 * \brief Find sub-shapes complying with given status
2510 * \param theBox - the box to check state of sub-shapes against
2511 * \param theShape - the shape to explore
2512 * \param theShapeType - type of sub-shape of theShape
2513 * \param theState - required state
2514 * \return List of all found sub-shapes.
2516 ListOfGO GetShapesOnBox (in GEOM_Object theBox,
2517 in GEOM_Object theShape,
2518 in long theShapeType,
2519 in shape_state theState);
2522 * \brief Find sub-shapes complying with given status
2523 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2524 * \param theShape - the shape to explore
2525 * \param theShapeType - type of sub-shape of theShape
2526 * \param theState - required state
2527 * \return List of IDs of all found sub-shapes.
2529 ListOfLong GetShapesOnShapeIDs (in GEOM_Object theCheckShape,
2530 in GEOM_Object theShape,
2531 in short theShapeType,
2532 in shape_state theState);
2535 * \brief Find sub-shapes complying with given status
2536 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2537 * \param theShape - the shape to explore
2538 * \param theShapeType - type of sub-shape of theShape
2539 * \param theState - required state
2540 * \return List of all found sub-shapes.
2542 ListOfGO GetShapesOnShape (in GEOM_Object theCheckShape,
2543 in GEOM_Object theShape,
2544 in short theShapeType,
2545 in shape_state theState);
2548 * \brief Find sub-shapes complying with given status
2549 * \param theCheckShape - the shape to check state of sub-shapes against. It must be a solid.
2550 * \param theShape - the shape to explore
2551 * \param theShapeType - type of sub-shape of theShape
2552 * \param theState - required state
2553 * \return compound includes all found sub-shapes.
2555 GEOM_Object GetShapesOnShapeAsCompound (in GEOM_Object theCheckShape,
2556 in GEOM_Object theShape,
2557 in short theShapeType,
2558 in shape_state theState);
2561 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2562 * coincident with \a theShapeWhat or could be a part of it.
2563 * \param theShapeWhere Shape to find sub-shapes of.
2564 * \param theShapeWhat Shape, specifying what to find.
2565 * \return Group of all found sub-shapes or a single found sub-shape.
2567 GEOM_Object GetInPlace (in GEOM_Object theShapeWhere,
2568 in GEOM_Object theShapeWhat);
2571 * Old implementation of GetInPlace functionality, based on shape properties.
2573 GEOM_Object GetInPlaceOld (in GEOM_Object theShapeWhere,
2574 in GEOM_Object theShapeWhat);
2577 * \brief Get sub-shape(s) of \a theShapeWhere, which are
2578 * coincident with \a theShapeWhat or could be a part of it.
2580 * Implementation of this method is based on a saved history of an operation,
2581 * produced \a theShapeWhere. The \a theShapeWhat must be among this operation's
2582 * arguments (an argument shape or a sub-shape of an argument shape).
2583 * The operation could be the Partition or one of boolean operations,
2584 * performed on simple shapes (not on compounds).
2586 * \param theShapeWhere Shape to find sub-shapes of.
2587 * \param theShapeWhat Shape, specifying what to find.
2588 * \return Group of all found sub-shapes or a single found sub-shape.
2590 GEOM_Object GetInPlaceByHistory (in GEOM_Object theShapeWhere,
2591 in GEOM_Object theShapeWhat);
2594 * \brief Get sub-shape of theShapeWhere, which are
2595 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2596 * \param theShapeWhere Shape to find sub-shapes of.
2597 * \param theShapeWhat Shape, specifying what to find.
2598 * \return found sub-shape.
2600 GEOM_Object GetSame (in GEOM_Object theShapeWhere,
2601 in GEOM_Object theShapeWhat);
2604 * \brief Get sub-shape Ids of theShapeWhere, which are
2605 * coincident with \a theShapeWhat that can either SOLID, FACE, EDGE or VERTEX.
2606 * \param theShapeWhere Shape to find sub-shapes of.
2607 * \param theShapeWhat Shape, specifying what to find.
2608 * \return found sub-shape Ids.
2610 ListOfLong GetSameIDs (in GEOM_Object theShapeWhere,
2611 in GEOM_Object theShapeWhat);
2614 * \brief Resize the input edge with the new Min and Max parameters.
2615 * The input edge parameters range is [0, 1]. If theMin parameter is
2616 * negative, the input edge is extended, otherwise it is shrinked by
2617 * theMin parameter. If theMax is greater than 1, the edge is extended,
2618 * otherwise it is shrinked by theMax parameter.
2619 * \param theEdge the input edge to be resized.
2620 * \param theMin the minimal parameter value.
2621 * \param theMax the maximal parameter value.
2622 * \return a newly created edge.
2624 GEOM_Object ExtendEdge(in GEOM_Object theEdge,
2629 * \brief Resize the input face with the new UMin, UMax, VMin and VMax
2630 * parameters. The input face U and V parameters range is [0, 1]. If
2631 * theUMin parameter is negative, the input face is extended, otherwise
2632 * it is shrinked along U direction by theUMin parameter. If theUMax is
2633 * greater than 1, the face is extended, otherwise it is shrinked along
2634 * U direction by theUMax parameter. So as for theVMin, theVMax and
2635 * V direction of the input face.
2636 * \param theFace the input face to be resized.
2637 * \param theUMin the minimal U parameter value.
2638 * \param theUMax the maximal U parameter value.
2639 * \param theVMin the minimal V parameter value.
2640 * \param theVMax the maximal V parameter value.
2641 * \return a newly created face.
2643 GEOM_Object ExtendFace(in GEOM_Object theFace,
2650 * \brief Make a surface from a face. This function takes some face as
2651 * input parameter and creates new GEOM_Object, i.e. topological shape
2652 * by extracting underlying surface of the source face and limiting it
2653 * by the Umin, Umax, Vmin, Vmax parameters of the source face (in the
2654 * parametrical space).
2655 * \param theFace the input face.
2656 * \return a newly created face.
2658 GEOM_Object MakeSurfaceFromFace(in GEOM_Object theFace);
2662 // # GEOM_IBlocksOperations:
2664 * \brief Interface for Blocks construction
2665 * Face from points or edges, Block from faces,
2666 * Blocks multi-translation and multi-rotation
2668 interface GEOM_IBlocksOperations : GEOM_IOperations
2671 // # Creation of blocks
2674 * \brief Create a quadrangle face from four edges. Order of Edges is not
2675 * important. It is not necessary that edges share the same vertex.
2676 * \param theEdge1,theEdge2,theEdge3,theEdge4 Edges for the face bound.
2677 * \return New GEOM_Object, containing the created face.
2679 GEOM_Object MakeQuad (in GEOM_Object theEdge1,
2680 in GEOM_Object theEdge2,
2681 in GEOM_Object theEdge3,
2682 in GEOM_Object theEdge4);
2685 * \brief Create a quadrangle face on two edges.
2687 * The missing edges will be built by creating the shortest ones.
2688 * \param theEdge1,theEdge2 Two opposite edges for the face.
2689 * \return New GEOM_Object, containing the created face.
2691 GEOM_Object MakeQuad2Edges (in GEOM_Object theEdge1,
2692 in GEOM_Object theEdge2);
2695 * \brief Create a quadrangle face with specified corners.
2697 * The missing edges will be built by creating the shortest ones.
2698 * \param thePnt1,thePnt2,thePnt3,thePnt4 Corner vertices for the face.
2699 * \return New GEOM_Object, containing the created face.
2701 GEOM_Object MakeQuad4Vertices (in GEOM_Object thePnt1,
2702 in GEOM_Object thePnt2,
2703 in GEOM_Object thePnt3,
2704 in GEOM_Object thePnt4);
2707 * \brief Create a hexahedral solid, bounded by the six given faces. Order of
2708 * faces is not important.
2710 * It is not necessary that Faces share the same edge.
2711 * \param theFace1,theFace2,theFace3,theFace4,theFace5,theFace6 Faces for the hexahedral solid.
2712 * \return New GEOM_Object, containing the created solid.
2714 GEOM_Object MakeHexa (in GEOM_Object theFace1,
2715 in GEOM_Object theFace2,
2716 in GEOM_Object theFace3,
2717 in GEOM_Object theFace4,
2718 in GEOM_Object theFace5,
2719 in GEOM_Object theFace6);
2722 * \brief Create a hexahedral solid between two given faces.
2724 * The missing faces will be built by creating the smallest ones.
2725 * \param theFace1,theFace2 Two opposite faces for the hexahedral solid.
2726 * \return New GEOM_Object, containing the created solid.
2728 GEOM_Object MakeHexa2Faces (in GEOM_Object theFace1,
2729 in GEOM_Object theFace2);
2732 // # Extract elements of blocks and blocks compounds
2736 * \brief Get a vertex, found in the given shape by its coordinates.
2737 * \param theShape Block or a compound of blocks.
2738 * \param theX,theY,theZ Coordinates of the sought vertex.
2739 * \param theEpsilon Maximum allowed distance between the resulting
2740 * vertex and point with the given coordinates.
2741 * \return New GEOM_Object, containing the found vertex.
2743 GEOM_Object GetPoint (in GEOM_Object theShape,
2747 in double theEpsilon);
2750 * \brief Find a vertex of the given shape, which has minimal distance to the given point.
2751 * \param theShape Any shape.
2752 * \param thePoint Point, close to the desired vertex.
2753 * \return New GEOM_Object, containing the found vertex.
2755 GEOM_Object GetVertexNearPoint (in GEOM_Object theShape,
2756 in GEOM_Object thePoint);
2759 * \brief Get an edge, found in the given shape by two given vertices.
2760 * \param theShape Block or a compound of blocks.
2761 * \param thePoint1,thePoint2 Points, close to the ends of the desired edge.
2762 * \return New GEOM_Object, containing the found edge.
2764 GEOM_Object GetEdge (in GEOM_Object theShape,
2765 in GEOM_Object thePoint1,
2766 in GEOM_Object thePoint2);
2769 * \brief Find an edge of the given shape, which has minimal distance to the given point.
2770 * \param theShape Block or a compound of blocks.
2771 * \param thePoint Point, close to the desired edge.
2772 * \return New GEOM_Object, containing the found edge.
2774 GEOM_Object GetEdgeNearPoint (in GEOM_Object theShape,
2775 in GEOM_Object thePoint);
2778 * \brief Returns a face, found in the given shape by four given corner vertices.
2779 * \param theShape Block or a compound of blocks.
2780 * \param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
2781 * \return New GEOM_Object, containing the found face.
2783 GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
2784 in GEOM_Object thePoint1,
2785 in GEOM_Object thePoint2,
2786 in GEOM_Object thePoint3,
2787 in GEOM_Object thePoint4);
2790 * \brief Get a face of block, found in the given shape by two given edges.
2791 * \param theShape Block or a compound of blocks.
2792 * \param theEdge1,theEdge2 Edges, close to the edges of the desired face.
2793 * \return New GEOM_Object, containing the found face.
2795 GEOM_Object GetFaceByEdges (in GEOM_Object theShape,
2796 in GEOM_Object theEdge1,
2797 in GEOM_Object theEdge2);
2800 * \brief Find a face, opposite to the given one in the given block.
2801 * \param theBlock Must be a hexahedral solid.
2802 * \param theFace Face of \a theBlock, opposite to the desired face.
2803 * \return New GEOM_Object, containing the found face.
2805 GEOM_Object GetOppositeFace (in GEOM_Object theBlock,
2806 in GEOM_Object theFace);
2809 * \brief Find a face of the given shape, which has minimal distance to the given point.
2810 * \param theShape Block or a compound of blocks.
2811 * \param thePoint Point, close to the desired face.
2812 * \return New GEOM_Object, containing the found face.
2814 GEOM_Object GetFaceNearPoint (in GEOM_Object theShape,
2815 in GEOM_Object thePoint);
2818 * \brief Find a face of block, whose outside normale has minimal angle with the given vector.
2819 * \param theBlock Block or a compound of blocks.
2820 * \param theVector Vector, close to the normale of the desired face.
2821 * \return New GEOM_Object, containing the found face.
2823 GEOM_Object GetFaceByNormale (in GEOM_Object theBlock,
2824 in GEOM_Object theVector);
2827 * \brief Find all sub-shapes of type \a theShapeType of the given shape,
2828 * which have minimal distance to the given point.
2829 * \param theShape Any shape.
2830 * \param thePoint Point, close to the desired shape.
2831 * \param theShapeType Defines what kind of sub-shapes is searched.
2832 * \param theTolerance The tolerance for distances comparison. All shapes
2833 * with distances to the given point in interval
2834 * [minimal_distance, minimal_distance + theTolerance] will be gathered.
2835 * \return New GEOM_Object, containing a group of all found shapes.
2837 GEOM_Object GetShapesNearPoint (in GEOM_Object theShape,
2838 in GEOM_Object thePoint,
2839 in long theShapeType,
2840 in double theTolerance);
2842 // # Extract blocks from blocks compounds
2846 * \brief Check, if the compound contains only specified blocks.
2847 * \param theCompound The compound to check.
2848 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2849 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2850 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2851 * \param theNbBlocks Number of specified blocks in theCompound.
2852 * \return TRUE, if the given compound contains only blocks.
2854 boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
2855 in long theMinNbFaces,
2856 in long theMaxNbFaces,
2857 out long theNbBlocks);
2860 * \brief Enumeration of Blocks Compound defects.
2864 /* Each element of the compound should be a Block */
2867 /* An element is a potential block, but has degenerated and/or seam edge(s). */
2870 /* A connection between two Blocks should be an entire face or an entire edge */
2873 /* The compound should be connexe */
2876 /* The glue between two quadrangle faces should be applied */
2881 * \brief Description of Blocks Compound defect: type and incriminated sub-shapes.
2886 ListOfLong incriminated;
2890 * \brief Sequence of all Blocks Compound defects.
2892 typedef sequence<BCError> BCErrors;
2895 * \brief Check, if the compound of blocks is given.
2897 * To be considered as a compound of blocks, the
2898 * given shape must satisfy the following conditions:
2899 * - Each element of the compound should be a Block (6 faces and 12 edges).
2900 * - A connection between two Blocks should be an entire quadrangle face or an entire edge.
2901 * - The compound should be connexe.
2902 * - The glue between two quadrangle faces should be applied.
2903 * \note Single block is also accepted as a valid compound of blocks.
2904 * \param theCompound The compound to check.
2905 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
2906 * \return TRUE, if the given shape is a compound of blocks.
2908 boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
2909 out BCErrors theErrors);
2912 * \brief Convert sequence of Blocks Compound errors, returned by
2913 * <VAR>CheckCompoundOfBlocks()</VAR>, into string.
2914 * \param theCompound The bad compound.
2915 * \param theErrors The sequence of \a theCompound errors.
2916 * \return String, describing all the errors in form, suitable for printing.
2918 string PrintBCErrors (in GEOM_Object theCompound,
2919 in BCErrors theErrors);
2922 * \brief Retrieve all non blocks solids and faces from a shape.
2924 * \param theShape The shape to explore.
2925 * \param theNonQuads Output parameter. Group of all non quadrangular faces.
2927 * \return Group of all non block solids (= not 6 faces, or with 6
2928 * faces, but with the presence of non-quadrangular faces).
2930 GEOM_Object GetNonBlocks (in GEOM_Object theShape, out GEOM_Object theNonQuads);
2933 * \brief Remove all seam and degenerated edges from \a theShape.
2935 * Unite faces and edges, sharing one surface.
2936 * \param theShape The compound or single solid to remove irregular edges from.
2937 * \param theOptimumNbFaces If more than zero, unite faces only for those solids,
2938 * that have more than theOptimumNbFaces faces. If zero, unite faces always,
2939 * regardsless their quantity in the solid. If negative, do not unite faces at all.
2940 * For blocks repairing recommended value is 6.
2941 * \return Improved shape.
2943 GEOM_Object RemoveExtraEdges (in GEOM_Object theShape,
2944 in long theOptimumNbFaces);
2947 * \brief Performs union faces of \a theShape.
2949 * Unite faces sharing one surface.
2950 * \param theShape The compound or single solid that contains faces to perform union.
2951 * \return Improved shape.
2953 GEOM_Object UnionFaces (in GEOM_Object theShape);
2956 * \brief Check, if the given shape is a blocks compound.
2958 * Fix all detected errors.
2959 * \note Single block can be also fixed by this method.
2960 * \param theCompound The compound to check and improve.
2961 * \return Improved compound.
2963 GEOM_Object CheckAndImprove (in GEOM_Object theCompound);
2966 * \brief Get all the blocks, contained in the given compound.
2968 * \param theCompound The compound to explode.
2969 * \param theMinNbFaces If solid has lower number of faces, it is not a block.
2970 * \param theMaxNbFaces If solid has higher number of faces, it is not a block.
2971 * \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
2972 * \return List of GEOM_Object, containing the retrieved blocks.
2974 ListOfGO ExplodeCompoundOfBlocks (in GEOM_Object theCompound,
2975 in long theMinNbFaces,
2976 in long theMaxNbFaces);
2979 * \brief Find block, containing the given point inside its volume or on boundary.
2980 * \param theCompound Compound, to find block in.
2981 * \param thePoint Point, close to the desired block. If the point lays on
2982 * boundary between some blocks, we return block with nearest center.
2983 * \return New GEOM_Object, containing the found block.
2985 GEOM_Object GetBlockNearPoint (in GEOM_Object theCompound,
2986 in GEOM_Object thePoint);
2989 * \brief Find block, containing all the elements, passed as the parts, or maximum quantity of them.
2990 * \param theCompound Compound, to find block in.
2991 * \param theParts List of faces and/or edges and/or vertices to be parts of the found block.
2992 * \return New GEOM_Object, containing the found block.
2994 GEOM_Object GetBlockByParts (in GEOM_Object theCompound,
2995 in ListOfGO theParts);
2998 * \brief Return all blocks, containing all the elements, passed as the parts.
2999 * \param theCompound Compound, to find blocks in.
3000 * \param theParts List of faces and/or edges and/or vertices to be parts of the found blocks.
3001 * \return List of GEOM_Object, containing the found blocks.
3003 ListOfGO GetBlocksByParts (in GEOM_Object theCompound,
3004 in ListOfGO theParts);
3006 // # Operations on blocks with gluing of result
3009 * \brief Multi-transformate block and glue the result.
3011 * Transformation is defined so, as to superpose theDirFace1 with theDirFace2.
3012 * \param theBlock Hexahedral solid to be multi-transformed.
3013 * \param theDirFace1 First direction face global index.
3014 * \param theDirFace2 Second direction face global index.
3015 * \param theNbTimes Quantity of transformations to be done.
3016 * \note Global index of sub-shape can be obtained, using method
3017 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3018 * \return New GEOM_Object, containing the result shape.
3020 GEOM_Object MakeMultiTransformation1D (in GEOM_Object theBlock,
3021 in long theDirFace1,
3022 in long theDirFace2,
3023 in long theNbTimes);
3026 * \brief Multi-transformate block and glue the result.
3027 * \param theBlock Hexahedral solid to be multi-transformed.
3028 * \param theDirFace1U,theDirFace2U Direction faces for the first transformation.
3029 * \param theDirFace1V,theDirFace2V Direction faces for the second transformation.
3030 * \param theNbTimesU,theNbTimesV Quantity of transformations to be done.
3031 * \return New GEOM_Object, containing the result shape.
3033 GEOM_Object MakeMultiTransformation2D (in GEOM_Object theBlock,
3034 in long theDirFace1U,
3035 in long theDirFace2U,
3036 in long theNbTimesU,
3037 in long theDirFace1V,
3038 in long theDirFace2V,
3039 in long theNbTimesV);
3041 // # Special operation - propagation
3045 * \brief Build all possible propagation groups.
3047 * Propagation group is a set of all edges, opposite to one (main)
3048 * edge of this group directly or through other opposite edges.
3049 * Notion of Opposite Edge make sence only on quadrangle face.
3050 * \param theShape Shape to build propagation groups on.
3051 * \return List of GEOM_Object, each of them is a propagation group.
3053 ListOfGO Propagate (in GEOM_Object theShape);
3056 // # GEOM_IBooleanOperations
3058 * \brief Interface for boolean operations (Cut, Fuse, Common)
3060 interface GEOM_IBooleanOperations : GEOM_IOperations
3063 * \brief Perform one of boolean operations on two given shapes.
3064 * \param theShape1 First argument for boolean operation.
3065 * \param theShape2 Second argument for boolean operation.
3066 * \param theOperation Indicates the operation to be done:
3067 * 1 - Common, 2 - Cut, 3 - Fuse, 4 - Section.
3068 * \param IsCheckSelfInte If TRUE, perform check self intersection
3069 * of arguments before an operation.
3070 * \return New GEOM_Object, containing the result shape.
3072 GEOM_Object MakeBoolean (in GEOM_Object theShape1,
3073 in GEOM_Object theShape2,
3074 in long theOperation,
3075 in boolean IsCheckSelfInte);
3077 * \brief Perform fusion boolean operation on two given shapes.
3078 * \param theShape1 First argument for fuse operation.
3079 * \param theShape2 Second argument for fuse operation.
3080 * \param IsCheckSelfInte If TRUE, perform check self intersection
3081 * of arguments before an operation.
3082 * \param IsRmExtraEdges If TRUE, perform removal of extra edges
3083 * during an operation.
3084 * \return New GEOM_Object, containing the result shape.
3086 GEOM_Object MakeFuse (in GEOM_Object theShape1,
3087 in GEOM_Object theShape2,
3088 in boolean IsCheckSelfInte,
3089 in boolean IsRmExtraEdges);
3092 * \brief Perform fusion boolean operation on list of objects.
3093 * \param theShapes Shapes to be fused.
3094 * \param IsCheckSelfInte If TRUE, perform check self intersection
3095 * of arguments before an operation.
3096 * \param IsRmExtraEdges If TRUE, perform removal of extra edges
3097 * during an operation.
3098 * \return New GEOM_Object, containing the result shape.
3100 GEOM_Object MakeFuseList (in ListOfGO theShapes,
3101 in boolean IsCheckSelfInte,
3102 in boolean IsRmExtraEdges);
3105 * \brief Perform common boolean operation on list of objects.
3106 * \param theShapes Shapes for common operation.
3107 * \param IsCheckSelfInte If TRUE, perform check self intersection
3108 * of arguments before an operation.
3109 * \return New GEOM_Object, containing the result shape.
3111 GEOM_Object MakeCommonList (in ListOfGO theShapes,
3112 in boolean IsCheckSelfInte);
3115 * \brief Perform cutting of list of objects from theMainShape.
3116 * \param theMainShape the object for cut operation.
3117 * \param theShapes Shapes to be cut from theMainShape (tools).
3118 * \param IsCheckSelfInte If TRUE, perform check self intersection
3119 * of arguments before an operation.
3120 * \return New GEOM_Object, containing the result shape.
3122 GEOM_Object MakeCutList (in GEOM_Object theMainShape,
3123 in ListOfGO theShapes,
3124 in boolean IsCheckSelfInte);
3127 * \brief Perform partition operation.
3129 * \param theShapes Shapes to be intersected.
3130 * \param theTools Shapes to intersect theShapes.
3131 * \note Each compound from ListShapes and ListTools will be exploded in order
3132 * to avoid possible intersection between shapes from this compound.
3133 * \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
3134 * \param theKeepNonlimitShapes: if this parameter == 0, then only shapes of
3135 * target type (equal to Limit) are kept in the result,
3136 * else standalone shapes of lower dimension
3137 * are kept also (if they exist).
3139 * After implementation new version of PartitionAlgo (October 2006)
3140 * other parameters are ignored by current functionality. They are kept
3141 * in this function only for supporting old versions.
3142 * Ignored parameters:
3143 * \param theKeepInside Shapes, outside which the results will be deleted.
3144 * Each shape from theKeepInside must belong to theShapes also.
3145 * \param theRemoveInside Shapes, inside which the results will be deleted.
3146 * Each shape from theRemoveInside must belong to theShapes also.
3147 * \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
3148 * \param theMaterials Material indices for each shape. Make sence, only if theRemoveWebs is TRUE.
3150 * \return New GEOM_Object, containing the result shapes.
3152 GEOM_Object MakePartition (in ListOfGO theShapes,
3153 in ListOfGO theTools,
3154 in ListOfGO theKeepInside,
3155 in ListOfGO theRemoveInside,
3157 in boolean theRemoveWebs,
3158 in ListOfLong theMaterials,
3159 in short theKeepNonlimitShapes);
3162 * \brief Perform partition operation.
3164 * This method may be usefull if it is needed to make a partition for
3165 * a compound containing nonintersected shapes. Performance will be better
3166 * since intersection between shapes from compound is not performed.
3168 * Description of all parameters as in previous method MakePartition().
3169 * One additional parameter is provided:
3170 * \param IsCheckSelfInte If TRUE, perform check self intersection
3171 * of arguments before an operation.
3173 * \note Passed compounds (via ListShapes or via ListTools)
3174 * have to consist of nonintersecting shapes.
3176 * \return New GEOM_Object, containing the result shapes.
3178 GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,
3179 in ListOfGO theTools,
3180 in ListOfGO theKeepInside,
3181 in ListOfGO theRemoveInside,
3183 in boolean theRemoveWebs,
3184 in ListOfLong theMaterials,
3185 in short theKeepNonlimitShapes,
3186 in boolean IsCheckSelfInte);
3189 * \brief Perform partition of the Shape with the Plane
3190 * \param theShape Shape to be intersected.
3191 * \param thePlane Tool shape, to intersect theShape.
3192 * \return New GEOM_Object, containing the result shape.
3194 GEOM_Object MakeHalfPartition (in GEOM_Object theShape,
3195 in GEOM_Object thePlane);
3198 // # GEOM_ICurvesOperations:
3200 * \brief Interface for curves creation.
3202 * Polyline, Circle, Spline (Bezier and Interpolation)
3204 interface GEOM_ICurvesOperations : GEOM_IOperations
3207 * \brief Create a circle with given center, normal vector and radius.
3208 * \param thePnt Circle center.
3209 * \param theVec Vector, normal to the plane of the circle.
3210 * \param theR Circle radius.
3211 * \return New GEOM_Object, containing the created circle.
3213 GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt,
3214 in GEOM_Object theVec,
3217 * \brief Create a circle, passing through three given points
3218 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
3219 * \return New GEOM_Object, containing the created circle.
3221 GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1,
3222 in GEOM_Object thePnt2,
3223 in GEOM_Object thePnt3);
3225 * \brief Create a circle with given center, with a radius equals the distance from center to Point1
3226 * and on a plane defined by all of three points.
3227 * \param thePnt1,thePnt2,thePnt3 Points, defining the circle.
3228 * \return New GEOM_Object, containing the created circle.
3230 GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1,
3231 in GEOM_Object thePnt2,
3232 in GEOM_Object thePnt3);
3234 * \brief Create an ellipse with given center, normal vector and radiuses.
3235 * \param thePnt Ellipse center.
3236 * \param theVec Vector, normal to the plane of the ellipse.
3237 * \param theRMajor Major ellipse radius.
3238 * \param theRMinor Minor ellipse radius.
3239 * \return New GEOM_Object, containing the created ellipse.
3241 GEOM_Object MakeEllipse (in GEOM_Object thePnt,
3242 in GEOM_Object theVec,
3243 in double theRMajor,
3244 in double theRMinor);
3247 * \brief Create an ellipse with given center, normal vector, main axis vector and radiuses.
3248 * \param thePnt Ellipse center.
3249 * \param theVec Vector, normal to the plane of the ellipse.
3250 * \param theRMajor Major ellipse radius.
3251 * \param theRMinor Minor ellipse radius.
3252 * \param theVecMaj Vector, direction of the ellipse's main axis.
3253 * \return New GEOM_Object, containing the created ellipse.
3255 GEOM_Object MakeEllipseVec (in GEOM_Object thePnt,
3256 in GEOM_Object theVec,
3257 in double theRMajor,
3258 in double theRMinor,
3259 in GEOM_Object theVecMaj);
3262 * \brief Create an arc of circle, passing through three given points.
3263 * \param thePnt1 Start point of the arc.
3264 * \param thePnt2 Middle point of the arc.
3265 * \param thePnt3 End point of the arc.
3266 * \return New GEOM_Object, containing the created arc.
3268 GEOM_Object MakeArc (in GEOM_Object thePnt1,
3269 in GEOM_Object thePnt2,
3270 in GEOM_Object thePnt3);
3273 * \brief Create an arc of circle of center C from one point to another
3274 * \param theCenter Center point of the arc.
3275 * \param thePnt1 Start point of the arc.
3276 * \param thePnt2 End point of the arc.
3277 * \param theSense Orientation of the arc
3278 * \return New GEOM_Object, containing the created arc.
3280 GEOM_Object MakeArcCenter (in GEOM_Object theCenter,
3281 in GEOM_Object thePnt1,
3282 in GEOM_Object thePnt2,
3283 in boolean theSense);
3286 * \brief Create an arc of ellipse of center C and two points P1 P2.
3287 * \param theCenter Center point of the arc.
3288 * \param thePnt1 Major radius is distance from center to Pnt1.
3289 * \param thePnt2 define a plane and Minor radius as a shortest
3290 * distance from Pnt2 to vector Center->Pnt1.
3291 * \return New GEOM_Object, containing the created arc.
3293 GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter,
3294 in GEOM_Object thePnt1,
3295 in GEOM_Object thePnt2);
3299 * \brief Create a polyline on the set of points.
3300 * \param thePoints Sequence of points for the polyline.
3301 * \param theIsClosed If TRUE, build a closed wire.
3302 * \return New GEOM_Object, containing the created polyline.
3304 GEOM_Object MakePolyline (in ListOfGO thePoints,
3305 in boolean theIsClosed);
3308 * \brief Create bezier curve on the set of points.
3309 * \param thePoints Sequence of points for the bezier curve.
3310 * \param theIsClosed If TRUE, build a closed curve.
3311 * \return New GEOM_Object, containing the created bezier curve.
3313 GEOM_Object MakeSplineBezier (in ListOfGO thePoints,
3314 in boolean theIsClosed);
3317 * \brief Create B-Spline curve on the set of points.
3318 * \param thePoints Sequence of points for the B-Spline curve.
3319 * \param theIsClosed If TRUE, build a closed curve.
3320 * \param theDoReordering If TRUE, the algo does not follow the order of
3321 * \a thePoints but searches for the closest vertex.
3322 * \return New GEOM_Object, containing the created B-Spline curve.
3324 GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints,
3325 in boolean theIsClosed,
3326 in boolean theDoReordering);
3329 * \brief Create B-Spline curve on the set of points.
3330 * \param thePoints Sequence of points for the B-Spline curve.
3331 * \param theFirstVec Vector object, defining the curve direction at its first point.
3332 * \param theLastVec Vector object, defining the curve direction at its last point.
3333 * \return New GEOM_Object, containing the created B-Spline curve.
3335 GEOM_Object MakeSplineInterpolWithTangents (in ListOfGO thePoints,
3336 in GEOM_Object theFirstVec,
3337 in GEOM_Object theLastVec);
3340 * \brief Creates a curve using the parametric definition of the basic points.
3341 * \param thexExpr parametric equation of the coordinates X.
3342 * \param theyExpr parametric equation of the coordinates Y.
3343 * \param thezExpr parametric equation of the coordinates Z.
3344 * \param theParamMin the minimal value of the parameter.
3345 * \param theParamMax the maximum value of the parameter.
3346 * \param theParamStep the step of the parameter.
3347 * \param theCurveType the type of the curve.
3348 * \return New GEOM_Object, containing the created curve.
3350 GEOM_Object MakeCurveParametric(in string thexExpr,
3353 in double theParamMin,
3354 in double theParamMax,
3355 in double theParamStep,
3356 in curve_type theCurveType);
3359 * \brief Creates a curve using the parametric definition of the basic points.
3360 * \param thexExpr parametric equation of the coordinates X.
3361 * \param theyExpr parametric equation of the coordinates Y.
3362 * \param thezExpr parametric equation of the coordinates Z.
3363 * \param theParamMin the minimal value of the parameter.
3364 * \param theParamMax the maximum value of the parameter.
3365 * \param theParamNbStep the number of steps of the parameter discretization.
3366 * \param theCurveType the type of the curve.
3367 * \return New GEOM_Object, containing the created curve.
3369 GEOM_Object MakeCurveParametricNew(in string thexExpr,
3372 in double theParamMin,
3373 in double theParamMax,
3374 in long theParamNbStep,
3375 in curve_type theCurveType);
3378 * \brief Creates an isoline curve on a face.
3379 * \param theFace the face for which an isoline is created.
3380 * \param IsUIsoline True for U-isoline creation; False for V-isoline
3382 * \param theParameter the U parameter for U-isoline or V parameter
3384 * \return New GEOM_Object, containing the created isoline edge or a
3385 * compound of edges.
3387 GEOM_Object MakeIsoline(in GEOM_Object theFace,
3388 in boolean IsUIsoline,
3389 in double theParameter);
3392 * \brief Create a sketcher (wire or face), following the textual description,
3393 * passed through \a theCommand argument.
3395 * Edges of the resulting wire or face will be arcs of circles and/or linear segments. \n
3396 * Format of the description string has to be the following:
3398 * "Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"
3401 * - x1, y1 are coordinates of the first sketcher point (zero by default),
3403 * - "R angle" : Set the direction by angle
3404 * - "D dx dy" : Set the direction by DX & DY
3407 * - "TT x y" : Create segment by point at X & Y
3408 * - "T dx dy" : Create segment by point with DX & DY
3409 * - "L length" : Create segment by direction & Length
3410 * - "IX x" : Create segment by direction & Intersect. X
3411 * - "IY y" : Create segment by direction & Intersect. Y
3414 * - "C radius length" : Create arc by direction, radius and length(in degree)
3417 * - "WW" : Close Wire (to finish)
3418 * - "WF" : Close Wire and build face (to finish)
3420 * \param theCommand String, defining the sketcher in local
3421 * coordinates of the working plane.
3422 * \param theWorkingPlane Nine double values, defining origin,
3423 * OZ and OX directions of the working plane.
3424 * \return New GEOM_Object, containing the created wire or face.
3426 GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane);
3429 * \brief Create a sketcher (wire or face), following the textual description,
3430 * passed through \a theCommand argument.
3432 * For format of the description string see the previous method.\n
3434 * \param theCommand String, defining the sketcher in local
3435 * coordinates of the working plane.
3436 * \param theWorkingPlane Planar Face or LCS(Marker) of the working plane.
3437 * \return New GEOM_Object, containing the created wire or face.
3439 GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane);
3442 * \brief Create a 3D sketcher, following the textual description,
3443 * passed through \a theCommand argument.
3445 * Format of the description string has to be the following:
3447 * "3DSketcher:CMD[:CMD[:CMD...]]"
3449 * Where CMD is one of
3450 * - "TT x y z" : Create segment by point at X & Y or set the first point
3451 * - "T dx dy dz" : Create segment by point with DX & DY
3454 * - "OXY angleX angle2 length" : Create segment by two angles and length
3455 * - "OYZ angleY angle2 length" : Create segment by two angles and length
3456 * - "OXZ angleX angle2 length" : Create segment by two angles and length
3459 * - "WW" : Close Wire (to finish)
3461 * \param theCommand String, defining the sketcher in local
3462 * coordinates of the working plane.
3463 * \return New GEOM_Object, containing the created wire.
3465 GEOM_Object Make3DSketcherCommand (in string theCommand);
3468 * \brief Create a 3D sketcher, made of a straight segments, joining points
3469 * with coordinates passed through \a theCoordinates argument.
3471 * Order of coordinates has to be the following:
3472 * x1, y1, z1, x2, y2, z2, ..., xN, yN, zN
3474 * \param theCoordinates List of double values.
3475 * \return New GEOM_Object, containing the created wire.
3477 GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates);
3480 * \brief Create a 2D polyline (wire or a compound of wires).
3482 * The polyline can have several sections. Each section represents a set
3483 * of points in the form of list of coordinates of the following order:
3484 * x1, y1, x2, y2, ..., xN, yN
3485 * Each section has its own name, type of curve (can be either
3486 * GEOM::Polyline or GEOM::Interpolation) and Closed flag.
3487 * For each section a wire is created. It represents either a polyline or
3488 * interpolation BSpline either closed or not depending on the Closed flag.
3489 * The result represents a wire if there is only one section is defined.
3490 * Otherwise a compound of wires is returned.
3492 * \param theCoordsList the list of coordinates list. theCoordsList[0]
3493 * is the coordinates list of the first section. theCoordsList[1]
3494 * is for the second section etc.
3495 * \param theNamesList the list of names. The order corresponds to
3497 * \param theTypesList the list of curve types. The order corresponds to
3499 * \param theClosedList the list of Closed flags. The order corresponds to
3501 * \param theWorkingPlane 9 double values, defining origin,
3502 * OZ and OX directions of the working plane.
3503 * \return New GEOM_Object, containing the created wire or a compound
3506 GEOM_Object MakePolyline2D (in ListOfListOfDouble theCoordsList,
3507 in string_array theNamesList,
3508 in short_array theTypesList,
3509 in ListOfBool theClosedList,
3510 in ListOfDouble theWorkingPlane);
3513 * \brief Create a 2D polyline (wire or a compound of wires).
3515 * The polyline can have several sections. Each section represents a set
3516 * of points in the form of list of coordinates of the following order:
3517 * x1, y1, x2, y2, ..., xN, yN
3518 * Each section has its own name, type of curve (can be either
3519 * GEOM::Polyline or GEOM::Interpolation) and Closed flag.
3520 * For each section a wire is created. It represents either a polyline or
3521 * interpolation BSpline either closed or not depending on the Closed flag.
3522 * The result represents a wire if there is only one section is defined.
3523 * Otherwise a compound of wires is returned.
3525 * \param theCoordsList the list of coordinates list. theCoordsList[0]
3526 * is the coordinates list of the first section. theCoordsList[1]
3527 * is for the second section etc.
3528 * \param theNamesList the list of names. The order corresponds to
3530 * \param theTypesList the list of curve types. The order corresponds to
3532 * \param theClosedList the list of Closed flags. The order corresponds to
3534 * \param theWorkingPlane planar Face or LCS(Marker) of the working plane.
3535 * \return New GEOM_Object, containing the created wire or a compound
3538 GEOM_Object MakePolyline2DOnPlane (in ListOfListOfDouble theCoordsList,
3539 in string_array theNamesList,
3540 in short_array theTypesList,
3541 in ListOfBool theClosedList,
3542 in GEOM_Object theWorkingPlane);
3546 // # GEOM_ILocalOperations:
3548 * \brief Interface for fillet and chamfer creation.
3550 interface GEOM_ILocalOperations : GEOM_IOperations
3553 * \brief Perform a fillet on all edges of the given shape.
3554 * \param theShape Shape, to perform fillet on.
3555 * \param theR Fillet radius.
3556 * \return New GEOM_Object, containing the result shape.
3558 GEOM_Object MakeFilletAll (in GEOM_Object theShape,
3562 * \brief Perform a fillet on the specified edges of the given shape
3563 * \param theShape Shape, to perform fillet on.
3564 * \param theR Fillet radius.
3565 * \param theEdges Global indices of edges to perform fillet on.
3566 * \note Global index of sub-shape can be obtained, using method
3567 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3568 * \return New GEOM_Object, containing the result shape.
3570 GEOM_Object MakeFilletEdges (in GEOM_Object theShape,
3572 in ListOfLong theEdges);
3573 GEOM_Object MakeFilletEdgesR1R2 (in GEOM_Object theShape,
3576 in ListOfLong theEdges);
3579 * \brief Perform a fillet on all edges of the specified faces of the given shape.
3580 * \param theShape Shape, to perform fillet on.
3581 * \param theR Fillet radius.
3582 * \param theFaces Global indices of faces to perform fillet on.
3583 * \note Global index of sub-shape can be obtained, using method
3584 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3585 * \return New GEOM_Object, containing the result shape.
3587 GEOM_Object MakeFilletFaces (in GEOM_Object theShape,
3589 in ListOfLong theFaces);
3591 GEOM_Object MakeFilletFacesR1R2 (in GEOM_Object theShape,
3594 in ListOfLong theFaces);
3597 * \brief Perform a fillet on a face or a shell at the specified vertexes.
3598 * \param theShape Shape, to perform fillet on.
3599 * \param theR Fillet radius.
3600 * \param theVertexes Global indices of vertexes to perform fillet on.
3601 * \note Global index of sub-shape can be obtained, using method
3602 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3603 * \return New GEOM_Object, containing the result shape.
3605 GEOM_Object MakeFillet2D (in GEOM_Object theShape,
3607 in ListOfLong theVertexes);
3610 * \brief Perform a fillet on edges of the specified vertexes of the given wire.
3611 * \param theShape Shape, to perform fillet on.
3612 * \param theR Fillet radius.
3613 * \param theVertexes Global indices of vertexes to perform fillet on.
3614 * \note Global index of sub-shape can be obtained, using method
3615 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3616 * \note The list of vertices coudl be empty, in this case fillet fill be done
3617 * at all vertices in given wire
3618 * \param doIgnoreSecantVertices If FALSE, fillet radius is always limited
3619 * by the length of the edges, nearest to the fillet vertex.
3620 * But sometimes the next edge is C1 continuous with the one, nearest to
3621 * the fillet point, and such two (or more) edges can be united to allow
3622 * bigger radius. Set this flag to TRUE to allow collinear edges union,
3623 * thus ignoring the secant vertex (vertices).
3624 * \return New GEOM_Object, containing the result shape.
3626 GEOM_Object MakeFillet1D (in GEOM_Object theShape,
3628 in ListOfLong theVertexes,
3629 in boolean doIgnoreSecantVertices);
3632 * \brief Perform a symmetric chamfer on all edges of the given shape.
3633 * \param theShape Shape, to perform chamfer on.
3634 * \param theD Chamfer size along each face.
3635 * \return New GEOM_Object, containing the result shape.
3637 GEOM_Object MakeChamferAll (in GEOM_Object theShape,
3641 * \brief Perform a chamfer on edges, common to the specified faces.
3642 * with distance D1 on the Face1
3643 * \param theShape Shape, to perform chamfer on.
3644 * \param theD1 Chamfer size along \a theFace1.
3645 * \param theD2 Chamfer size along \a theFace2.
3646 * \param theFace1,theFace2 Global indices of two faces of \a theShape.
3647 * \note Global index of sub-shape can be obtained, using method
3648 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3649 * \return New GEOM_Object, containing the result shape.
3651 GEOM_Object MakeChamferEdge (in GEOM_Object theShape,
3652 in double theD1, in double theD2,
3653 in long theFace1, in long theFace2);
3655 * \brief The Same but with params theD = Chamfer Lenght
3656 * and theAngle = Chamfer Angle (Angle in radians)
3658 GEOM_Object MakeChamferEdgeAD (in GEOM_Object theShape,
3659 in double theD, in double theAngle,
3660 in long theFace1, in long theFace2);
3663 * \brief Perform a chamfer on all edges of the specified faces.
3664 * with distance D1 on the first specified face (if several for one edge)
3665 * \param theShape Shape, to perform chamfer on.
3666 * \param theD1 Chamfer size along face from \a theFaces. If both faces,
3667 * connected to the edge, are in \a theFaces, \a theD1
3668 * will be get along face, which is nearer to \a theFaces beginning.
3669 * \param theD2 Chamfer size along another of two faces, connected to the edge.
3670 * \param theFaces Sequence of global indices of faces of \a theShape.
3671 * \note Global index of sub-shape can be obtained, using method
3672 * <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3673 * \return New GEOM_Object, containing the result shape.
3675 GEOM_Object MakeChamferFaces (in GEOM_Object theShape,
3676 in double theD1, in double theD2,
3677 in ListOfLong theFaces);
3679 * The Same but with params theD = Chamfer Lenght
3680 * and theAngle = Chamfer Angle (Angle in radians)
3682 GEOM_Object MakeChamferFacesAD (in GEOM_Object theShape,
3683 in double theD, in double theAngle,
3684 in ListOfLong theFaces);
3687 * \brief Perform a chamfer on edges,
3688 * with distance D1 on the first specified face (if several for one edge)
3689 * \param theShape Shape, to perform chamfer on.
3690 * \param theD1,theD2 Chamfer size
3691 * \param theEdges Sequence of edges of \a theShape.
3692 * \return New GEOM_Object, containing the result shape.
3694 GEOM_Object MakeChamferEdges (in GEOM_Object theShape,
3695 in double theD1, in double theD2,
3696 in ListOfLong theEdges);
3698 * The Same but with params theD = Chamfer Lenght
3699 * and theAngle = Chamfer Angle (Angle in radians)
3701 GEOM_Object MakeChamferEdgesAD (in GEOM_Object theShape,
3702 in double theD, in double theAngle,
3703 in ListOfLong theEdges);
3706 * \brief Perform an Archimde operation on the given shape with given parameters.
3707 * The object presenting the resulting face is returned
3708 * \param theShape Shape to be put in water.
3709 * \param theWeight Weight og the shape.
3710 * \param theWaterDensity Density of the water.
3711 * \param theMeshDeflection Deflection od the mesh, using to compute the section.
3712 * \return New GEOM_Object, containing a section of \a theShape
3713 * by a plane, corresponding to water level.
3715 GEOM_Object MakeArchimede (in GEOM_Object theShape,
3716 in double theWeight,
3717 in double theWaterDensity,
3718 in double theMeshDeflection);
3721 * \brief Duplicates <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR>.
3723 * Present here only for compatibility.
3725 long GetSubShapeIndex (in GEOM_Object theShape, in GEOM_Object theSubShape);
3728 // # GEOM_IHealingOperations:
3730 * \brief Interface for shape healing operations
3732 * Shape Processing, SuppressFaces, etc.
3734 interface GEOM_IHealingOperations : GEOM_IOperations
3737 * \brief Apply a sequence of Shape Healing operators to the given object.
3738 * \param theShapes Shape to be processed.
3739 * \param theOperators List of names of operators ("FixShape", "SplitClosedFaces", etc.).
3740 * \param theParameters List of names of parameters
3741 * ("FixShape.Tolerance3d", "SplitClosedFaces.NbSplitPoints", etc.).
3742 * \param theValues List of values of parameters, in the same order
3743 * as parameters are listed in \a theParameters list.
3744 * \return New GEOM_Object, containing processed shape.
3746 GEOM_Object ProcessShape (in GEOM_Object theShapes,
3747 in string_array theOperators,
3748 in string_array theParameters,
3749 in string_array theValues);
3752 * \brief Get default sequence of operators, their parameters and parameters' values
3753 * of Shape Process operation.
3755 * In the current implementation the defaults are
3756 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3757 * \param theOperators Output. Default list of names of operators.
3758 * \param theParameters Output. Default list of names of parameters.
3759 * \param theValues Output. List of default values of parameters, in the same order
3760 * as parameters are listed in \a theParameters list.
3762 void GetShapeProcessParameters (out string_array theOperators,
3763 out string_array theParameters,
3764 out string_array theValues);
3766 * \brief Get parameters and parameters' values for the given Shape Process operation.
3768 * In the current implementation the defaults are
3769 * read from the file pointed by CSF_ShHealingDefaults environmental variable.
3770 * \param theOperator Input. The operator's name.
3771 * \param theParameters Output. Default list of names of parameters.
3772 * \param theValues Output. List of default values of parameters, in the same order
3773 * as parameters are listed in \a theParameters list.
3775 void GetOperatorParameters (in string theOperator,
3776 out string_array theParameters,
3777 out string_array theValues);
3780 * \brief Remove faces from the given object (shape).
3781 * \param theObject Shape to be processed.
3782 * \param theFaces Indices of faces to be removed, if EMPTY then the method
3783 * removes ALL faces of the given object.
3784 * \return New GEOM_Object, containing processed shape.
3786 GEOM_Object SuppressFaces (in GEOM_Object theObject, in short_array theFaces);
3789 * \brief Close an open wire.
3790 * \param theObject Shape to be processed.
3791 * \param theWires Indexes of edge(s) and wire(s) to be closed within <VAR>theObject</VAR>'s shape,
3792 * if -1, then theObject itself is a wire.
3793 * \param isCommonVertex If TRUE : closure by creation of a common vertex,
3794 * If FALS : closure by creation of an edge between ends.
3795 * \return New GEOM_Object, containing processed shape.
3797 GEOM_Object CloseContour (in GEOM_Object theObject, in short_array theWires,
3798 in boolean isCommonVertex);
3801 * \brief Remove internal wires and edges from the given object (face).
3802 * \param theObject Shape to be processed.
3803 * \param theWires Indices of wires to be removed, if EMPTY then the method
3804 * removes ALL internal wires of the given object.
3805 * \return New GEOM_Object, containing processed shape.
3807 GEOM_Object RemoveIntWires (in GEOM_Object theObject, in short_array theWires);
3810 * \brief Remove internal closed contours (holes) from the given object.
3811 * \param theObject Shape to be processed.
3812 * \param theWires Indices of wires to be removed, if EMPTY then the method
3813 * removes ALL internal holes of the given object
3814 * \return New GEOM_Object, containing processed shape.
3816 GEOM_Object FillHoles (in GEOM_Object theObject, in short_array theWires);
3819 * Sewing of the given object.
3820 * \param theObjects Shapes to be processed.
3821 * \param theTolerance Required tolerance value.
3822 * \return New GEOM_Object, containing processed shape.
3824 GEOM_Object Sew (in ListOfGO theObjects, in double theTolerance);
3827 * Sewing of the given object. Allows non-manifold sewing.
3828 * \param theObjects Shapes to be processed.
3829 * \param theTolerance Required tolerance value.
3830 * \return New GEOM_Object, containing processed shape.
3832 GEOM_Object SewAllowNonManifold(in ListOfGO theObjects, in double theTolerance);
3835 * Rebuild the topology of theSolids by removing
3836 * the faces that are shared by several solids.
3837 * \param theSolids A list of shapes containing solids to be processed.
3838 * \return New GEOM_Object, containing processed shape.
3840 GEOM_Object RemoveInternalFaces (in ListOfGO theSolids);
3843 * \brief Addition of a point to a given edge of \a theObject.
3844 * \param theObject Shape to be processed.
3845 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
3846 * if -1, then theObject itself is the edge.
3847 * \param theValue Value of parameter on edge or length parameter,
3848 * depending on \a isByParameter.
3849 * \param isByParameter If TRUE : \a theValue is treated as a curve parameter [0..1],
3850 * if FALSE : \a theValue is treated as a length parameter [0..1]
3851 * \return New GEOM_Object, containing the processed shape.
3853 GEOM_Object DivideEdge (in GEOM_Object theObject, in short theEdgeIndex,
3854 in double theValue, in boolean isByParameter);
3857 * \brief Addition of points to a given edge of \a theObject by projecting
3858 * other points to the given edge.
3859 * \param theObject Shape to be processed.
3860 * \param theEdgeIndex Index of edge to be divided within theObject's shape,
3861 * if -1, then theObject itself is the edge.
3862 * \param thePoints Points to project to theEdgeIndex-th edge.
3863 * \return New GEOM_Object, containing the processed shape.
3865 GEOM_Object DivideEdgeByPoint (in GEOM_Object theObject,
3866 in short theEdgeIndex,
3867 in ListOfGO thePoints);
3870 * \brief Suppress the vertices in the wire in case if adjacent edges are C1 continuous.
3871 * \param theWire Wire to minimize the number of C1 continuous edges in.
3872 * \param theVertices A list of vertices to suppress. If the list
3873 * is empty, all vertices in a wire will be assumed.
3874 * \return New GEOM_Object with modified wire.
3876 GEOM_Object FuseCollinearEdgesWithinWire (in GEOM_Object theWire,
3877 in ListOfGO theVertices);
3880 * \brief Get a list of wires (wrapped in GEOM_Object-s),
3881 * that constitute a free boundary of the given shapes.
3882 * \param theObjects Shapes to get free boundary of.
3883 * \param theClosedWires Output. Closed wires on the free boundary of the given shape.
3884 * \param theOpenWires Output. Open wires on the free boundary of the given shape.
3885 * \return FALSE, if an error(s) occured during the method execution.
3887 boolean GetFreeBoundary (in ListOfGO theObjects,
3888 out ListOfGO theClosedWires,
3889 out ListOfGO theOpenWires);
3892 * \brief Change orientation of the given object.
3893 * \param theObject Shape to be processed.
3894 * \return New GEOM_Object, containing processed shape.
3896 GEOM_Object ChangeOrientation (in GEOM_Object theObject);
3897 GEOM_Object ChangeOrientationCopy (in GEOM_Object theObject);
3900 * \brief Try to limit tolerance of the given object by value \a theTolerance.
3901 * \param theObject Shape to be processed.
3902 * \param theTolerance Required tolerance value.
3903 * \return New GEOM_Object, containing processed shape.
3905 GEOM_Object LimitTolerance (in GEOM_Object theObject, in double theTolerance);
3909 * \brief Return information on what has been done by the last called healing method.
3910 * \return ModifStatistics, information container.
3912 ModifStatistics GetStatistics();
3915 // # GEOM_IInsertOperations:
3917 * \brief Interface for shape insert operations (like copy, import).
3920 interface GEOM_IInsertOperations : GEOM_IOperations
3923 * \brief Create a copy of the given object
3925 GEOM_Object MakeCopy (in GEOM_Object theOriginal);
3928 * \brief Deprecated method. Use Export\<FormatName\> (from the
3929 * corresponding plugin) instead; here \<FormatName\> is a name of format.
3931 * \brief Export the given shape into a file with given name.
3932 * \param theObject Shape to be stored in the file.
3933 * \param theFileName Name of the file to store the given shape in.
3934 * \param theFormatName Specify format for the shape storage.
3936 void Export (in GEOM_Object theObject, in string theFileName, in string theFormatName);
3939 * \brief Deprecated method. Use Import\<FormatName\> (from the
3940 * corresponding plugin) instead; here \<FormatName\> is a name of format.
3942 * \brief Import a shape from the STL, BREP, IGES or STEP file
3943 * (depends on given format) with given name.
3944 * \param theFileName The file, containing the shape.
3945 * \param theFormatName Specify format for the file reading.
3946 * If format 'IGES_SCALE' is used instead of 'IGES' or
3947 * format 'STEP_SCALE' is used instead of 'STEP',
3948 * file length unit will be ignored (set to 'meter') and result model will be scaled.
3949 * \return List of GEOM_Object, containing the created shape and groups of materials.
3951 ListOfGBO ImportFile (in string theFileName, in string theFormatName);
3954 * \brief Deprecated method. Use ReadValue (from the corresponding plugin) instead.
3956 * \brief Read a value of parameter from a file, containing a shape.
3957 * \param theFileName The file, containing the shape.
3958 * \param theFormatName Specify format for the file reading.
3959 * \param theParameterName Specify the parameter. For example, pass "LEN_UNITS"
3960 * to obtain length units, in which the file is written.
3961 * \return Value of requested parameter in form of text string.
3963 string ReadValue (in string theFileName, in string theFormatName, in string theParameterName);
3966 * \brief Read a shape from the binary stream, containing its bounding representation (BRep).
3967 * \note GEOM_Object::GetShapeStream() method can be used to obtain the shape's BRep stream.
3968 * \param theStream The BRep binary stream.
3969 * \return New GEOM_Object, containing the shape, read from theStream.
3971 GEOM_Object RestoreShape (in SALOMEDS::TMPFile theStream);
3974 * \brief Load texture from file
3975 * \param theTextureFile texture file name
3976 * \return unique texture identifier
3978 long LoadTexture(in string theTextureFile);
3981 * \brief Add texture to the study
3982 * \param theWidth texture width in pixels
3983 * \param theHeight texture height in pixels
3984 * \param theTexture texture byte array
3985 * \return unique texture identifier
3987 long AddTexture(in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture);
3990 * \brief Get previously loaded texture data
3991 * \param theID texture identifier
3992 * \param theWidth texture width in pixels
3993 * \param theHeight texture height in pixels
3994 * \return texture byte array
3996 SALOMEDS::TMPFile GetTexture(in long theID, out long theWidth, out long theHeight);
3999 * \brief Get list of all avaiable texture IDs
4000 * \return list of all texture IDs avaiable for the current study
4002 ListOfLong GetAllTextures();
4005 * \brief Non-topological information transfer datum.
4007 struct TransferDatum
4015 * \brief Sequence of non-topological information tranfer data.
4017 typedef sequence<TransferDatum> ListOfTransferDatum;
4020 * \brief Transfer non-topological data from one object to another
4021 * \param theObjectFrom the source object of non-topological data
4022 * \param theObjectTo the destination object of non-topological data
4023 * \param theFindMethod method to search sub-shapes of theObjectFrom
4024 * in shape theObjectTo. Possible values are: GEOM::FSM_GetInPlace,
4025 * GEOM::FSM_GetInPlaceByHistory and GEOM::FSM_GetInPlace_Old.
4026 * Other values of GEOM::find_shape_method are not supported.
4027 * \param theResult statistics of the operation. Output parameter. It
4028 * represents a sequence of Transfer Datum. A datum has the type
4029 * (string code), the total number of items of this type and
4030 * the number of transfered items.
4031 * \return true in case of success; otherwise false.
4033 boolean TransferData(in GEOM_Object theObjectFrom,
4034 in GEOM_Object theObjectTo,
4035 in find_shape_method theFindMethod,
4036 out ListOfTransferDatum theResult);
4040 // # GEOM_IKindOfShape:
4042 * \brief Interface for shape_kind enumeration.
4044 interface GEOM_IKindOfShape
4058 /*! box with faces, parallel to global coordinate planes */
4066 /*! solid, bounded by polygons */
4071 /*! spherical face (closed) */
4073 /*! cylindrical face with defined height */
4075 /*! toroidal face (closed) */
4077 /*! conical face with defined height */
4079 /*! planar, bounded by circle */
4081 /*! planar, bounded by ellipse */
4083 /*! planar, bounded by segments */
4085 /*! infinite planar */
4094 /*! arc of circle */
4098 /*! arc of ellipse */
4100 /*! infinite segment */
4109 /*! all advanced shapes (temporary implementation) */
4114 // # GEOM_IMeasureOperations:
4116 * \brief Interface for measurement (distance, whatis) and
4117 * properties calculation (like Centre of Mass, Inertia, etc.).
4120 interface GEOM_IMeasureOperations : GEOM_IOperations
4123 * \brief Get kind of theShape.
4124 * \param theShape Shape to get a kind of.
4125 * \param theIntegers Output. Integer and enumerated shape's parameters
4126 * (kind of surface, closed/unclosed, number of edges, etc.)
4127 * \param theDoubles Output. Double shape's parameters (coordinates, dimensions, etc.)
4128 * \note Concrete meaning of each value, returned via \a theIntegers
4129 * or \a theDoubles list depends on the kind of the shape.
4130 * \return Returns a kind of shape in terms of <VAR>GEOM_IKindOfShape.shape_kind</VAR> enumeration.
4132 //short KindOfShape (in GEOM_Object theShape,
4133 GEOM_IKindOfShape::shape_kind KindOfShape (in GEOM_Object theShape,
4134 out ListOfLong theIntegers,
4135 out ListOfDouble theDoubles);
4138 * \brief Get position (LCS) of theShape.
4139 * \param theShape Shape to calculate position of.
4140 * \param Ox,Oy,Oz Output. Coordinates of shape's location origin.
4141 * Origin of the LCS is situated at the shape's center of mass.
4142 * \param Zx,Zy,Zz Output. Coordinates of shape's location normal(main) direction.
4143 * \param Xx,Xy,Xz Output. Coordinates of shape's location X direction.
4144 * Axes of the LCS are obtained from shape's location or,
4145 * if the shape is a planar face, from position of its plane.
4146 * \return Returns position of the shape through the last nine arguments.
4148 void GetPosition (in GEOM_Object theShape,
4149 out double Ox, out double Oy, out double Oz,
4150 out double Zx, out double Zy, out double Zz,
4151 out double Xx, out double Xy, out double Xz);
4154 * \brief Get summarized length of all wires,
4155 * area of surface and volume of the given shape.
4156 * \param theShape Shape to define properties of.
4157 * \param theLength Output. Summarized length of all wires of the given shape.
4158 * \param theSurfArea Output. Area of surface of the given shape.
4159 * \param theVolume Output. Volume of the given shape.
4160 * \return Returns shape properties through the last three arguments.
4162 void GetBasicProperties (in GEOM_Object theShape,
4163 out double theLength,
4164 out double theSurfArea,
4165 out double theVolume);
4168 * \brief Get a point, situated at the centre of mass of theShape.
4169 * \param theShape Shape to define centre of mass of.
4170 * \return New GEOM_Object, containing the created point.
4172 GEOM_Object GetCentreOfMass (in GEOM_Object theShape);
4175 * Get the vertex by index for 1D objects depends the edge/wire orientation
4176 * \param theShape Shape (wire or edge) to find the vertex on it
4177 * \param theIndex Index of vertex sub-shape
4178 * \return New GEOM_Object, vertex.
4180 GEOM_Object GetVertexByIndex( in GEOM_Object theShape, in long index );
4183 * \brief Get a vector, representing the normal of theFace.
4184 * If the face is not planar, theOptionalPoint is obligatory.
4185 * \param theFace Shape (face) to define the normal of.
4186 * \param theOptionalPoint Shape (point) to define the normal at.
4187 * Can be NULL in case of planar face.
4188 * \return New GEOM_Object, containing the created normal vector.
4190 GEOM_Object GetNormal (in GEOM_Object theFace,
4191 in GEOM_Object theOptionalPoint);
4194 * \brief Get inertia matrix and moments of inertia of theShape.
4195 * \param theShape Shape to calculate inertia of.
4196 * \param I11,I12,I13,I21,I22,I23,I31,I32,I33 Output. Components of the inertia matrix of the given shape.
4197 * \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
4198 * \return Returns inertia through the last twelve arguments.
4200 void GetInertia (in GEOM_Object theShape,
4201 out double I11, out double I12, out double I13,
4202 out double I21, out double I22, out double I23,
4203 out double I31, out double I32, out double I33,
4204 out double Ix , out double Iy , out double Iz);
4207 * \brief Get parameters of bounding box of the given shape
4208 * \param theShape Shape to obtain bounding box of.
4209 * \param precise TRUE for precise computation; FALSE for fast one.
4210 * \param Xmin,Xmax Output. Limits of shape along OX axis.
4211 * \param Ymin,Ymax Output. Limits of shape along OY axis.
4212 * \param Zmin,Zmax Output. Limits of shape along OZ axis.
4213 * \return Returns parameters of bounding box through the last six arguments.
4215 void GetBoundingBox (in GEOM_Object theShape,
4217 out double Xmin, out double Xmax,
4218 out double Ymin, out double Ymax,
4219 out double Zmin, out double Zmax);
4222 * \brief Get bounding box of the given shape
4223 * \param theShape Shape to obtain bounding box of.
4224 * \param precise TRUE for precise computation; FALSE for fast one.
4225 * \return New GEOM_Object, containing the created bounding box.
4227 GEOM_Object MakeBoundingBox (in GEOM_Object theShape,
4228 in boolean precise);
4231 * \brief Get min and max tolerances of sub-shapes of theShape
4232 * \param theShape Shape, to get tolerances of.
4233 * \param FaceMin,FaceMax Output. Min and max tolerances of the faces.
4234 * \param EdgeMin,EdgeMax Output. Min and max tolerances of the edges.
4235 * \param VertMin,VertMax Output. Min and max tolerances of the vertices.
4236 * \return Returns shape tolerances through the last six arguments.
4238 void GetTolerance (in GEOM_Object theShape,
4239 out double FaceMin, out double FaceMax,
4240 out double EdgeMin, out double EdgeMax,
4241 out double VertMin, out double VertMax);
4244 * \brief Enumeration of Shape defects coming from CheckShape algorithms.
4249 InvalidPointOnCurve,
4250 InvalidPointOnCurveOnSurface,
4251 InvalidPointOnSurface,
4258 InvalidCurveOnSurface,
4259 InvalidCurveOnClosedSurface,
4260 InvalidSameRangeFlag,
4261 InvalidSameParameterFlag,
4262 InvalidDegeneratedFlag,
4265 InvalidMultiConnexity,
4271 SelfIntersectingWire, /* on a face */
4278 InvalidImbricationOfWires,
4292 BadOrientationOfSubshape,
4294 InvalidToleranceValue,
4301 * \brief Description of a shape defect: type and incriminated sub-shapes.
4305 ShapeErrorType error;
4306 ListOfLong incriminated;
4310 * \brief Sequence of all shape defects.
4312 typedef sequence<ShapeError> ShapeErrors;
4315 * \brief Check a topology of the given shape.
4316 * \param theShape Shape to check validity of.
4317 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
4318 * \return TRUE, if the shape "seems to be valid" from the topological point of view.
4320 boolean CheckShape (in GEOM_Object theShape,
4321 out ShapeErrors theErrors);
4324 * \brief Check a topology and a geometry of the given shape.
4325 * \param theShape Shape to check validity of.
4326 * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
4327 * \return TRUE, if the shape "seems to be valid".
4329 boolean CheckShapeWithGeometry (in GEOM_Object theShape,
4330 out ShapeErrors theErrors);
4333 * \brief Convert sequence of shape errors, returned by
4334 * <VAR>CheckShape()</VAR> or <VAR>CheckShapeWithGeometry()</VAR>, into string.
4335 * \param theShape the invalid shape.
4336 * \param theErrors The sequence of \a theShape errors.
4337 * \return String, describing all the errors in form, suitable for printing.
4339 string PrintShapeErrors (in GEOM_Object theShape,
4340 in ShapeErrors theErrors);
4343 * \brief Check a topology of the given shape on self-intersections presence.
4344 * \param theShape Shape to check validity of.
4345 * \param theCheckLevel the level of self-interference check.
4346 * \param theIntersections Output. List of intersected sub-shapes IDs, it contains pairs of IDs.
4347 * \return TRUE, if the shape does not have any self-intersections.
4349 boolean CheckSelfIntersections (in GEOM_Object theShape,
4350 in long theCheckLevel,
4351 out ListOfLong theIntersections);
4354 * \brief Detect intersections of the given shapes with algorithm based on mesh intersections.
4355 * \param theShape1 First source object
4356 * \param theShape2 Second source object
4357 * \param theTolerance Specifies a distance between shapes used for detecting gaps:
4358 * - if \a theTolerance <= 0, algorithm detects intersections
4359 * - if \a theTolerance > 0, algorithm detects gaps
4360 * \param theDeflection Linear deflection coefficient that specifies quality of tesselation:
4361 * - if \a theDeflection <= 0, default deflection 0.001 is used
4362 * \param theIntersections1 Output: contains list of sub-shapes IDs from 1st shape that localize intersection
4363 * \param theIntersections2 Output: contains list of sub-shapes IDs from 2nd shape that localize intersection
4364 * \return TRUE, if the are intersections (gaps) between source shapes
4366 boolean FastIntersect (in GEOM_Object theShape1,
4367 in GEOM_Object theShape2,
4368 in double theTolerance,
4369 in float theDeflection,
4370 out ListOfLong theIntersections1,
4371 out ListOfLong theIntersections2);
4374 * \brief Check if the given shape can be an argument for MakeSolid operation
4375 * \param theShape Shape to be described.
4376 * \return Empty string if a solid can be made on this shape, error code otherwise.
4378 string IsGoodForSolid (in GEOM_Object theShape);
4381 * O\brief btain description of the given shape
4382 * \param theShape Shape to be described.
4383 * \return Description of the given shape.
4385 string WhatIs (in GEOM_Object theShape);
4388 * \brief Check if points defined by coords = [x1, y1, z1, x2, y2, z2, ...] are inside or on
4389 * the shape theShape.
4390 * \param theShape Shape to check.
4391 * \param coords list of coordinates.
4392 * \param tolerance tolerance.
4393 * \return list of boolean.
4395 ListOfBool AreCoordsInside(in GEOM_Object theShape, in ListOfDouble coords, in double tolerance);
4398 * \brief Get minimal distance between the given shapes.
4399 * \param theShape1,theShape2 Shapes to find minimal distance between.
4400 * \param X1,Y1,Z1 Output. Coordinates of point on theShape1, nearest to theShape2.
4401 * \param X2,Y2,Z2 Output. Coordinates of point on theShape2, nearest to theShape1.
4402 * \return Value of the minimal distance between the given shapes.
4404 double GetMinDistance (in GEOM_Object theShape1, in GEOM_Object theShape2,
4405 out double X1, out double Y1, out double Z1,
4406 out double X2, out double Y2, out double Z2);
4409 * \brief Get closest points of the given shapes.
4410 * \param theShape1,theShape2 Shapes to find closest points of.
4411 * \param theCoords Output. List of (X, Y, Z) coordinates for all couples of points.
4412 * \return The number of found solutions (-1 in case of infinite number of solutions).
4414 long ClosestPoints (in GEOM_Object theShape1,
4415 in GEOM_Object theShape2,
4416 out ListOfDouble theCoords);
4419 * \brief Get angle between the given lines or linear edges.
4420 * \param theShape1,theShape2 Shapes to find angle between. Lines or linear edges.
4421 * \return Value of the angle between the given shapes.
4423 double GetAngle (in GEOM_Object theShape1, in GEOM_Object theShape2);
4426 * \brief Get angle between the given vectors.
4427 * \param theShape1,theShape2 Vectors to find angle between.
4428 * \return Value of the angle between the given vectors.
4430 double GetAngleBtwVectors (in GEOM_Object theShape1, in GEOM_Object theShape2);
4433 * \brief Get point coordinates
4435 void PointCoordinates (in GEOM_Object theShape, out double X, out double Y, out double Z);
4438 * \brief Get radius of curvature of curve in the point determinated by param
4439 * \param theShape - curve.
4440 * \param theParam - parameter on curve
4441 * \return Value of curvature.
4443 double CurveCurvatureByParam (in GEOM_Object theShape, in double theParam);
4446 * \brief Get radius of curvature of curve in the given point
4447 * \param theShape - curve.
4448 * \param thePoint - point
4449 * \return Value of curvature.
4451 double CurveCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
4454 * \brief Get max radius of curvature of surface in the point determinated by params
4455 * \param theShape - surface.
4456 * \param theUParam - U-parameter on surface
4457 * \param theVParam - V-parameter on surface
4458 * \return Value of curvature.
4460 double MaxSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
4461 in double theVParam);
4464 * \brief Get max radius of curvature of surface in the given point
4465 * \param theShape - surface.
4466 * \param thePoint - point
4467 * \return Value of curvature.
4469 double MaxSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
4472 * \brief Get min radius of curvature of surface in the point determinated by params
4473 * \param theShape - surface.
4474 * \param theUParam - U-parameter on surface
4475 * \param theVParam - V-parameter on surface
4476 * \return Value of curvature.
4478 double MinSurfaceCurvatureByParam (in GEOM_Object theShape, in double theUParam,
4479 in double theVParam);
4482 * \brief Get min radius of curvature of surface in the given point
4483 * \param theShape - surface.
4484 * \param thePoint - point
4485 * \return Value of curvature.
4487 double MinSurfaceCurvatureByPoint (in GEOM_Object theShape, in GEOM_Object thePoint);
4491 // # GEOM_IGroupOperations:
4493 * \brief Interface for groups creation.
4495 interface GEOM_IGroupOperations : GEOM_IOperations
4498 * \brief Creates a new group which will store sub-shapes of theMainShape
4499 * \param theMainShape is a GEOM_Object on which the group is selected
4500 * \param theShapeType defines a shape type of the group
4501 * \return a newly created GEOM group
4503 GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType);
4506 * \brief Adds a sub-object with ID theSubShapeId to the group
4507 * \param theGroup is a GEOM group to which the new sub-shape is added
4508 * \param theSubShapeId is a sub-shape ID in the main object.
4509 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
4511 void AddObject (in GEOM_Object theGroup, in long theSubShapeId);
4514 * \brief Removes a sub-object with ID \a theSubShapeId from the group
4515 * \param theGroup is a GEOM group from which the sub-shape is removed.
4516 * \param theSubShapeId is a sub-shape ID in the main object.
4517 * \note Use method <VAR>GEOM_IShapesOperations.GetSubShapeIndex()</VAR> to get an ID by the sub-shape
4519 void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId);
4522 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
4523 * \param theGroup is a GEOM group to which the new sub-shapes are added.
4524 * \param theSubShapes is a list of sub-shapes to be added.
4526 void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
4529 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
4530 * \param theGroup is a GEOM group from which the sub-shapes are removed.
4531 * \param theSubShapes is a list of sub-shapes to be removed.
4533 void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes);
4536 * \brief Adds to the group all the given shapes. No errors, if some shapes are alredy included.
4537 * \param theGroup is a GEOM group to which the new sub-shapes are added.
4538 * \param theSubShapes is a list of IDs of sub-shapes to be added.
4540 void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
4543 * \brief Removes from the group all the given shapes. No errors, if some shapes are not included.
4544 * \param theGroup is a GEOM group from which the sub-shapes are removed.
4545 * \param theSubShapes is a list of IDs of sub-shapes to be removed.
4547 void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes);
4550 * \brief Union of two groups.
4551 * New group is created. It will contain all entities
4552 * which are present in groups theGroup1 and theGroup2.
4553 * \param theGroup1, theGroup2 are the initial GEOM groups
4554 * to create the united group from.
4555 * \return a newly created GEOM group.
4557 GEOM_Object UnionGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
4560 * \brief Intersection of two groups.
4561 * New group is created. It will contain only those entities
4562 * which are present in both groups theGroup1 and theGroup2.
4563 * \param theGroup1, theGroup2 are the initial GEOM groups to get common part of.
4564 * \return a newly created GEOM group.
4566 GEOM_Object IntersectGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
4569 * \brief Cut of two groups.
4570 * New group is created. It will contain entities which are
4571 * present in group theGroup1 but are not present in group theGroup2.
4572 * \param theGroup1 is a GEOM group to include elements of.
4573 * \param theGroup2 is a GEOM group to exclude elements of.
4574 * \return a newly created GEOM group.
4576 GEOM_Object CutGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2);
4579 * \brief Union of list of groups.
4580 * New group is created. It will contain all entities that are
4581 * present in groups listed in theGList.
4582 * \param theGList is a list of GEOM groups to create the united group from.
4583 * \return a newly created GEOM group.
4585 GEOM_Object UnionListOfGroups (in ListOfGO theGList);
4588 * \brief Intersection of list of groups.
4589 * New group is created. It will contain only entities
4590 * which are simultaneously present in the groups listed in theGList.
4591 * \param theGList is a list of GEOM groups to get common part of.
4592 * \return a newly created GEOM group.
4594 GEOM_Object IntersectListOfGroups (in ListOfGO theGList);
4597 * \brief Cut of lists of groups.
4598 * New group is created. It will contain only entities
4599 * which are present in groups listed in theGList1 but
4600 * are not present in groups from theGList2.
4601 * \param theGList1 is a list of GEOM groups to include elements of.
4602 * \param theGList2 is a list of GEOM groups to exclude elements of.
4603 * \return a newly created GEOM group.
4605 GEOM_Object CutListOfGroups (in ListOfGO theGList1,
4606 in ListOfGO theGList2);
4609 * \brief Returns a type of sub-objects stored in the group
4610 * \param theGroup is a GEOM group which type is returned.
4612 long GetType (in GEOM_Object theGroup);
4615 * \brief Returns a main shape associated with the group
4616 * \param theGroup is a GEOM group for which a main shape object is requested
4617 * \return a GEOM_Object which is a main shape for theGroup
4619 GEOM_Object GetMainShape (in GEOM_Object theGroup);
4622 * \brief Returns a list of sub-objects ID stored in the group
4623 * \param theGroup is a GEOM group for which a list of IDs is requested
4625 ListOfLong GetObjects (in GEOM_Object theGroup);
4628 // # GEOM_IFieldOperations:
4630 * \brief Interface for field operation.
4632 interface GEOM_IFieldOperations : GEOM_IOperations
4635 * \brief Creates a field
4637 GEOM_Field CreateField(in GEOM_Object shape,
4639 in field_data_type type,
4641 in string_array componentNames);
4643 * \brief Returns number of fields on a shape
4645 long CountFields(in GEOM_Object shape);
4648 * \brief Returns all fields on a shape
4650 ListOfFields GetFields(in GEOM_Object shape);
4653 * \brief Returns a field on a shape by its name
4655 GEOM_Field GetField(in GEOM_Object shape, in string name);
4658 * \brief Returns number of sub-shapes of given dimension
4660 long GetNbSubShapes(in GEOM_Object shape, in short fieldDim);
4665 * \brief Interface to access other GEOM interfaces.
4667 * Also contains some methods to access and manage GEOM_Object.
4669 interface GEOM_Gen : Engines::EngineComponent,SALOMEDS::Driver
4672 * \brief Undo/Redo Management
4675 void Undo (in long theStudyID);
4677 void Redo (in long theStudyID);
4680 * \brief Publishing management
4682 * Adds in theStudy a object theObject under with a name theName,
4683 * if theFather is not NULL the object is placed under thFather's SObject.
4684 * Returns a SObject where theObject is placed
4686 SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy,
4687 in GEOM_BaseObject theObject,
4689 in GEOM_BaseObject theFather);
4692 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4694 * To be used from python scripts out of geompy.addToStudy (non-default usage)
4695 * \param theStudy the study, in which theObject is published already,
4696 * and in which the arguments will be published
4697 * \param theObject published GEOM_Object, arguments of which will be published
4698 * \param theArgs list of GEOM_Object, operation arguments to be published.
4699 * If this list is empty, all operation arguments will be published
4700 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4701 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4702 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4703 * Do not publish sub-shapes in place of arguments, but only
4704 * in place of sub-shapes of the first argument,
4705 * because the whole shape corresponds to the first argument.
4706 * Mainly to be used after transformations, but it also can be
4707 * usefull after partition with one object shape, and some other
4708 * operations, where only the first argument has to be considered.
4709 * If theObject has only one argument shape, this flag is automatically
4710 * considered as True, not regarding really passed value.
4711 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4712 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4713 * \return list of published sub-shapes
4715 ListOfGO RestoreSubShapesO (in SALOMEDS::Study theStudy,
4716 in GEOM_Object theObject,
4717 in ListOfGO theArgs,
4718 in find_shape_method theFindMethod,
4719 in boolean theInheritFirstArg,
4720 in boolean theAddPrefix);
4723 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4725 * To be used from python scripts out of geompy.addToStudy (non-default usage)
4726 * \param theStudy the study, in which theObject is published already,
4727 * and in which the arguments will be published
4728 * \param theObject published GEOM_Object, arguments of which will be published
4729 * \param theArgs list of GEOM_Object, operation arguments to be published.
4730 * If this list is empty, all operation arguments will be published
4731 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4732 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4733 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4734 * Do not publish sub-shapes in place of arguments, but only
4735 * in place of sub-shapes of the first argument,
4736 * because the whole shape corresponds to the first argument.
4737 * Mainly to be used after transformations, but it also can be
4738 * usefull after partition with one object shape, and some other
4739 * operations, where only the first argument has to be considered.
4740 * If theObject has only one argument shape, this flag is automatically
4741 * considered as True, not regarding really passed value.
4742 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4743 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4744 * \return list of published sub-shapes
4746 ListOfGO RestoreGivenSubShapesO (in SALOMEDS::Study theStudy,
4747 in GEOM_Object theObject,
4748 in ListOfGO theArgs,
4749 in find_shape_method theFindMethod,
4750 in boolean theInheritFirstArg,
4751 in boolean theAddPrefix);
4754 * \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments
4756 * To be used from GUI and from geompy.addToStudy.
4757 * Work like the above method, but accepts study object theSObject instead of GEOM_Object.
4758 * \param theStudy the study, in which theObject is published already,
4759 * and in which the arguments will be published
4760 * \param theSObject study object, referencing GEOM_Object, arguments of which will be published
4761 * \param theArgs list of GEOM_Object, operation arguments to be published.
4762 * If this list is empty, all operation arguments will be published
4763 * \param theFindMethod method to search sub-shapes, corresponding to arguments and
4764 * their sub-shapes. Value from enumeration GEOM::find_shape_method.
4765 * \param theInheritFirstArg set properties of the first argument for \a theObject.
4766 * Do not publish sub-shapes in place of arguments, but only
4767 * in place of sub-shapes of the first argument,
4768 * because the whole shape corresponds to the first argument.
4769 * Mainly to be used after transformations, but it also can be
4770 * usefull after partition with one object shape, and some other
4771 * operations, where only the first argument has to be considered.
4772 * If theObject has only one argument shape, this flag is automatically
4773 * considered as True, not regarding really passed value.
4774 * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
4775 * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
4777 ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
4778 in SALOMEDS::SObject theSObject,
4779 in ListOfGO theArgs,
4780 in find_shape_method theFindMethod,
4781 in boolean theInheritFirstArg,
4782 in boolean theAddPrefix);
4784 // # Methods to access interfaces for objects creation and transformation
4786 GEOM_IBasicOperations GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4787 GEOM_ITransformOperations GetITransformOperations(in long theStudyID) raises (SALOME::SALOME_Exception);
4788 GEOM_I3DPrimOperations GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4789 GEOM_IShapesOperations GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4790 GEOM_IBooleanOperations GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4791 GEOM_ICurvesOperations GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4792 GEOM_ILocalOperations GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4793 GEOM_IHealingOperations GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4794 GEOM_IInsertOperations GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4795 GEOM_IMeasureOperations GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4796 GEOM_IBlocksOperations GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4797 GEOM_IGroupOperations GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4798 GEOM_IFieldOperations GetIFieldOperations (in long theStudyID) raises (SALOME::SALOME_Exception);
4800 GEOM_IOperations GetPluginOperations (in long theStudyID,
4801 in string theLibName) raises (SALOME::SALOME_Exception);
4803 // # Objects Management
4807 * \brief Removes the object from the GEOM component
4808 * \param theObject is a GEOM_Object to be removed
4810 void RemoveObject (in GEOM_BaseObject theObject);
4813 * \brief Returns an object defined by the study and its entry in the GEOM component
4814 * \param theStudyID is a SALOMEDS Study ID
4815 * \param theEntry is an entry of the requested GEOM_Object in the GEOM component
4816 * \note if the object has not previously been created a NULL GEOM_Object is returned
4818 GEOM_BaseObject GetObject (in long theStudyID, in string theEntry);
4821 * \brief Add a sub-shape defined by indices in \a theIndices
4822 * (contains unique IDs of sub-shapes inside \a theMainShape)
4823 * \note The sub-shape GEOM_Object can has ONLY ONE function.
4824 * Don't try to apply modification operations on them.
4825 * \note Internal method
4827 GEOM_Object AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices);
4829 // # GEOM_Objects IOR Management
4832 * \brief Returns a GEOM_Object defined by its IOR
4833 * \param theIOR a string containg an IOR of the requested GEOM_Object
4835 GEOM_Object GetIORFromString (in string theIOR);
4838 * \brief Returns a string which contains an IOR of the GEOM_Object
4839 * \param theObject is a GEOM_Object which IOR is requested
4841 string GetStringFromIOR (in GEOM_Object theObject);
4844 * \brief Returns a name with which a GEOM_Object was dumped into python script
4845 * \param theStudyEntry is an entry of the GEOM_Object in the study
4847 string GetDumpName (in string theStudyEntry);
4850 * \brief Returns all names with which a GEOM_Object was dumped
4851 * into python script to avoid the same names in SMESH script
4853 string_array GetAllDumpNames();
4856 * \brief Publishes the named sub-shapes of given object in the study.
4857 * \param theStudy The study in which the object is published
4858 * \param theObject The object which named sub-shapes are published
4860 ListOfGO PublishNamedShapesInStudy(in SALOMEDS::Study theStudy,
4861 //in SObject theSObject,
4862 in Object theObject);
4865 * \brief Creates a new folder
4867 * Creates a new container (folder) for any GEOM objects.
4868 * Folder will have name theName.
4869 * If theFather is not NULL, the folder is placed under theFather object.
4870 * Otherwise, the folder takes place under root 'Geometry' object.
4872 * \param theName name of the folder
4873 * \param theFather parent object
4874 * \return SObject represented the created folder.
4876 SALOMEDS::SObject CreateFolder (in string theName,
4877 in SALOMEDS::SObject theFather);
4880 * \brief Moves object to the specified folder
4882 * The moved object should be first published in the study.
4883 * \param theObject GEOM object to move
4884 * \param theFolder target folder
4886 void MoveToFolder (in GEOM_Object theObject,
4887 in SALOMEDS::SObject theFolder);
4890 * \brief Moves list of objects to the specified folder
4892 * The moved objects should be first published in the study.
4893 * \param theListOfGO list of GEOM objects to move
4894 * \param theFolder target folder
4896 void MoveListToFolder (in ListOfGO theListOfGO,
4897 in SALOMEDS::SObject theFolder);
4900 * \brief Moves objects to the specified position
4902 * This function is used in the drag-n-drop functionality.
4904 * \param what objects being moved
4905 * \param where parent object where objects are moved to
4906 * \param row position in the parent object's children list at which objects are moved
4908 void Move( in object_list what,
4909 in SALOMEDS::SObject where,
4913 * \brief Collects dependencies of the given objects from other ones
4914 * \param theStudy The study in which the object is published
4915 * \param theListOfEntries List of GEOM object entries in OCAF tree (not in study)
4916 * \return Struct of dependent entries and its links as a byte array
4917 * \note This method is supposed to be used by GUI only.
4919 SALOMEDS::TMPFile GetDependencyTree(in SALOMEDS::Study theStudy,
4920 in string_array theListOfEntries);
4923 * \brief Fills 3 lists that is used to reduce study of redundant objects:
4924 * - dependencies of the given objects from other ones;
4925 * - children of the given objects;
4926 * - all other objects in study.
4927 * \param theStudy The study in which the object was published
4928 * \param theSelectedEntries List of GEOM object entries in OCAF tree
4929 * \param theParentEntries List of GEOM object entries on which the given objects depend
4930 * \param theSubEntries Children entries list of the given objects
4931 * \param theOtherEntries List of GEOM object entries which are in the study, but not in parents and children lists
4932 * \note This method is supposed to be used by GUI only.
4934 void GetEntriesToReduceStudy(in SALOMEDS::Study theStudy,
4935 inout string_array theSelectedEntries,
4936 inout string_array theParentEntries,
4937 inout string_array theSubEntries,
4938 inout string_array theOtherEntries);