3D Sketcher allows creating a closed or unclosed 3D wire from a list of points.
-To create a 3D Sketch, select in the main menu <em>New Entity -> 3D Sketch</em>.
+To create a 3D Sketch, select in the main menu <em>New Entity -> Basic -> 3D Sketch</em>.
\image html 3dsketch2.png
\page create_adv_obj_page Creating Advanced Geometrical Objects
-<b>New Entity -> Build </b> submenu allows to create topological
-entities:
-
-<ul>
-<li>\subpage create_edge_page</li>
-<li>\subpage create_wire_page</li>
-<li>\subpage create_face_page</li>
-<li>\subpage create_shell_page</li>
-<li>\subpage create_solid_page</li>
-<li>\subpage create_compound_page</li>
-</ul>
-
<b>New Entity -> Advanced </b> submenu allows to create additional complex topological objects.
<ul>
<li>\subpage create_ellipse_page</li>
<li>\subpage create_arc_page</li>
<li>\subpage create_curve_page</li>
+<li>\subpage create_sketcher_page</li>
+<li>\subpage create_3dsketcher_page</li>
<li>\subpage create_vector_page</li>
<li>\subpage create_plane_page</li>
<li>\subpage create_lcs_page</li>
</ul>
-*/
\ No newline at end of file
+*/
<li>create \subpage create_basic_geom_obj_page "Basic objects" - points,
lines, circles...</li>
<li>create \subpage create_primitives_page "Primitives" - cubes, spheres, cones...</li>
+<li>create \subpage create_adv_obj_page "Advanced geometrical objects" - Pipe TShape...</li>
<li>create \subpage create_complex_obj_page "Complex objects" by
extrusion, rotation, interpolation of other objects.</li>
<li>create and edit \subpage work_with_groups_page "Groups of objects" of
lower dimension, which belong to the objects of higher dimension.</li>
<li>\subpage build_by_blocks_page "Build by blocks" faces from
edges and solids from faces.</li>
-<li>create line segments and arcs using \subpage create_sketcher_page
-"Sketcher".</li>
-<li>create a closed or unclosed 3D wire from a list of points using
-\subpage create_3dsketcher_page "3D Sketcher".</li>
<li>\subpage create_explode_page "Explode" objects of higher dimension
into sub-objects of lower dimension.</li>
-<li>create \subpage create_adv_obj_page "Advanced geometrical objects" - edges, wires, shells...</li>
+<li>create \subpage create_topological_obj_page "Topological objects" - edges, wires, shells...</li>
</ul>
\note It is possible to use the variables defined in the SALOME \b NoteBook
\page create_pipetshape_page PipeTShape
-To create a \b PipeTShape in the <b>Main Menu</b> select <b>New Entity - >
-Advanced - > PipeTShape </b>
+To create a \b PipeTShape in the <b>Main Menu</b> select <b>New Entity -> Primitives -> PipeTShape</b>
Specify the parameters of the PipeTShape object in the opened dialog
box and press "Apply" or "Apply & Close" button.
\page create_primitives_page Creating Primitives
-<b>New Entity -> Primitives </b> submenu allows to create voluminal
+<b>New Entity -> Primitives </b> submenu allows to create volumical
geometrical objects, such as:
<ul>
/*!
-\page create_sketcher_page Sketcher
+\page create_sketcher_page 2D Sketcher
-The sketcher allows you to create a profile made of curves of 2 types: line segments and arcs.
+The 2D Sketcher allows you to create a profile made of curves of 2 types: line segments and arcs.
<b>Example:</b>
\image html sketch_example.png
-To create a \b Sketch:
+To create a \b 2D Sketch:
<ol>
-<li>In the main menu select <em>New Entity / Sketch</em> or click on \image html sketch.png </li>
+<li>In the main menu select <em>New Entity -> Basic -> 2D Sketch</em> or click on \image html sketch.png </li>
<li> Select the plane or the planar face on which to create the sketch. By default the sketch is created on the XOY plane of the global coordinate system.
If Local Coordinate systems have been created in the study they appear in the combobox and can be selected as reference coordinate system.</li>
\page tui_advanced_geom_objs_page Advanced Geometrical Objects
-\anchor tui_creation_edge
-<br><h2>Creation of an Edge</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-#
-# create edge by two points
-#
-
-# create vertices
-p0 = geompy.MakeVertex(0. , 0. , 0. )
-pxyz = geompy.MakeVertex(100., 100., 100.)
-
-# create an edge
-edge = geompy.MakeEdge(p0, pxyz)
-
-# add object in the study
-id_edge = geompy.addToStudy(edge,"Edge_1")
-
-# display an edge
-gg.createAndDisplayGO(id_edge)
-
-#
-# create edge from wire
-#
-
-# create a circle
-c = geompy.MakeCircle(None, None, 100)
-
-# create a wire
-w = geompy.MakeWire([c], 1e-07)
-
-# create an edge from wire
-edge = geompy.MakeEdgeWire(w)
-
-# add object in the study
-id_edge = geompy.addToStudy(edge,"Edge_2")
-
-# display an edge
-gg.createAndDisplayGO(id_edge)
-
-#
-# create edge from existing curve and a length
-#
-
-# create a circle
-c = geompy.MakeCircle(None, None, 100)
-
-# create an edge of length 25.0 from the circle
-edge = geompy.MakeEdgeOnCurveByLength(c, 25.0)
-
-# add object in the study
-id_edge = geompy.addToStudy(edge,"Edge_3")
-
-# display an edge
-gg.createAndDisplayGO(id_edge)
-
-\endcode
-
-\anchor tui_creation_wire
-<br><h2>Creation of a Wire</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-# create vertices
-px = geompy.MakeVertex(100., 0. , 0. )
-py = geompy.MakeVertex(0. , 100., 0. )
-pz = geompy.MakeVertex(0. , 0. , 100.)
-
-# create a vector from two points
-vxy = geompy.MakeVector(px, py)
-
-# create an arc from three points
-arc = geompy.MakeArc(py, pz, px)
-
-# create a wire
-wire = geompy.MakeWire([vxy, arc])
-
-# add an object in the study
-id_wire = geompy.addToStudy(wire,"Wire")
-
-# display the wire
-gg.createAndDisplayGO(id_wire)
-\endcode
-
-\anchor tui_creation_face
-<br><h2>Creation of a Face</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-# create vertices
-p0 = geompy.MakeVertex(0. , 0. , 0. )
-px = geompy.MakeVertex(100., 0. , 0. )
-py = geompy.MakeVertex(0. , 100., 0. )
-pz = geompy.MakeVertex(0. , 0. , 100.)
-pxyz = geompy.MakeVertex(100., 100., 100.)
-
-# create a vector from two points
-vxy = geompy.MakeVector(px, py)
-
-# create an arc from three points
-arc = geompy.MakeArc(py, pz, px)
-
-# create a wire
-wire = geompy.MakeWire([vxy, arc])
-
-# create sketchers
-sketcher1 = geompy.MakeSketcher("Sketcher:F -100 -100:TT 250 -100:R 0:C 100 150:R 0:L 300:WW",
- [100,0,0, 1,1,1, -1,1,0])
-sketcher2 = geompy.MakeSketcher("Sketcher:F 0 0:TT 70 0:TT 70 70:TT 0 70:WW")
-sketcher3 = geompy.MakeSketcher("Sketcher:F 20 20:TT 50 20:TT 50 50:TT 20 50:WW")
-isPlanarFace = 1
-
-# create a face from the wire
-face1 = geompy.MakeFace(wire, isPlanarFace)
-
-# create faces from two wires
-face2 = geompy.MakeFaceWires([wire, sketcher1],isPlanarFace)
-face3 = geompy.MakeFaces([sketcher2, sketcher3],isPlanarFace)
-
-# add objects in the study
-id_face1 = geompy.addToStudy(face1,"Face1")
-id_face2 = geompy.addToStudy(face2,"Face2")
-id_face3 = geompy.addToStudy(face3,"Face3")
-
-# display the faces
-gg.createAndDisplayGO(id_face1)
-gg.setDisplayMode(id_face1,1)
-gg.setTransparency(id_face1,0.2)
-gg.createAndDisplayGO(id_face2)
-gg.setDisplayMode(id_face2,1)
-gg.setTransparency(id_face2,0.2)
-gg.createAndDisplayGO(id_face3)
-gg.setDisplayMode(id_face3,1)
-gg.setTransparency(id_face3,0.2)
-\endcode
-
-\anchor tui_creation_shell
-<br><h2>Creation of a Shell</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-#create vertices
-p0 = geompy.MakeVertex( 0., 0., 0.)
-pxyz = geompy.MakeVertex( 5., 5., 40.)
-
-# create sketchers
-sketcher1 = geompy.MakeSketcher("Sketcher:F 0 0:TT 70 0:TT 70 70:TT 0 70:WW")
-sketcher2 = geompy.MakeSketcher("Sketcher:F 20 20:TT 50 20:TT 50 50:TT 20 50:WW")
-isPlanarFace = 1
-
-# create a face from two wires
-face = geompy.MakeFaces([sketcher1, sketcher2],isPlanarFace)
-
-# create a prism
-prism = geompy.MakePrism(face, p0, pxyz)
-
-# explode the prism into faces
-prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
-
-# create a shell from a set of faces
-shell = geompy.MakeShell([prism_faces[0], prism_faces[2], prism_faces[3],
- prism_faces[7], prism_faces[9]])
-
-# add objects in the study
-id_shell = geompy.addToStudy(shell,"Shell")
-
-# display the shell
-gg.createAndDisplayGO(id_shell)
-gg.setDisplayMode(id_shell,1)
-\endcode
-
-\anchor tui_creation_solid
-<br><h2>Creation of a Solid</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-#create vertices
-p0 = geompy.MakeVertex( 0., 0., 0.)
-pz = geompy.MakeVertex( 0., 0., 40.)
-
-# create sketchers
-sketcher = geompy.MakeSketcher("Sketcher:F -50 -50:TT 100 -50:R 0:C 50 70:R 0:L 100:WW")
-
-# create faces from two wires
-face = geompy.MakeFace(sketcher,1)
-
-# create a prism
-prism = geompy.MakePrism(face, p0, pz)
-
-# explode the prism into faces
-prism_faces = geompy.SubShapeAllSortedCentres(prism, geompy.ShapeType["FACE"])
-
-# create a shell from a set of faces
-shell = geompy.MakeShell([prism_faces[0], prism_faces[1],
- prism_faces[3], prism_faces[4],
- prism_faces[5], prism_faces[2]])
-
-# create a solid, bounded by the given shells
-solid = geompy.MakeSolid([shell])
-
-# add objects in the study
-id_solid = geompy.addToStudy(solid,"Solid")
-
-# display the solid
-gg.createAndDisplayGO(id_solid)
-gg.setDisplayMode(id_solid,1)
-\endcode
-
-\anchor tui_creation_compound
-<br><h2>Creation of a Compound</h2>
-
-\code
-import geompy
-import salome
-gg = salome.ImportComponentGUI("GEOM")
-
-# create a vertex and a vector
-p1 = geompy.MakeVertex( -30., -30., 50.)
-p2 = geompy.MakeVertex( -60., -60., 30.)
-p3 = geompy.MakeVertex( -30., -30., 10.)
-
-# create an arc from three points
-arc = geompy.MakeArc(p1, p2, p3)
-ShapeListCompound = []
-i = 0
-while i <= 3 :
- S = geompy.MakeTranslation(arc, i * 50., 0., 0.)
- ShapeListCompound.append(S)
- i = i + 1
-
-# create a compund of the given shapes
-compound = geompy.MakeCompound(ShapeListCompound)
-
-# add object in the study
-id_compound = geompy.addToStudy(compound,"Compound")
-
-# display the compound
-gg.createAndDisplayGO(id_compound)
-\endcode
-
\anchor tui_creation_pipetshape
<br><h2>Creation of PipeTShape</h2>
<ul>
<li>\subpage tui_basic_geom_objs_page</li>
<li>\subpage tui_primitives_page</li>
+<li>\subpage tui_advanced_geom_objs_page</li>
<li>\subpage tui_complex_objs_page</li>
<li>\subpage tui_working_with_groups_page</li>
<li>\subpage tui_building_by_blocks_page</li>
<li>\subpage tui_sketcher_page</li>
<li>\subpage tui_3dsketcher_page</li>
-<li>\subpage tui_advanced_geom_objs_page</li>
+<li>\subpage tui_topological_geom_objs_page</li>
</ul>
*/
\ No newline at end of file
/*!
-\page tui_sketcher_page Sketcher
+\page tui_sketcher_page 2D Sketcher
\code
import geompy
gg.createAndDisplayGO(id_sketcher2)
\endcode
-*/
\ No newline at end of file
+*/
\anchor swig_MakeVertexOnSurface
\until p_on_face
+\anchor swig_MakeVertexOnSurfaceByCoord
+\until p_on_face2
+
\until S = geompy.MakeRotation
\anchor swig_MakeLineTwoFaces
\anchor swig_all_advanced
\until MakeSewing
+\anchor swig_MakeCopy
+\until MakeCopy
+
\anchor swig_all_trsf
\until RotatPnt
\anchor swig_ChangeOrientation
\until ChangeOrientation
+\anchor swig_ExtractShapes
+\until prism_edges
+
\anchor swig_FilletChamfer
\until End of Local operations
\anchor swig_all_addtostudy
\until id_Partition1
+\anchor swig_all_addtostudyInFather
+\until id_SubFace
+
+\anchor swig_SubShapeName
+\until nameS
+
\anchor swig_all_decompose
\until print "DONE"
echo "===========================================" ; \
echo "Replacing geompyDC by geompy" ; \
echo "===========================================" ; \
- sed -e "/class geompyDC/d" -e "s/^ *#/#/g" -e "s/^ *def /def /g" \
- -e "s/geompyDC/geompy/g" $(top_srcdir)/src/GEOM_SWIG/geompyDC.py > \
- ./geompy.py ; \
+ $(KERNEL_ROOT_DIR)/bin/salome/prepare_generating_doc.py geompy.py $(top_srcdir)/src/GEOM_SWIG/geompyDC.py geompy ; \
echo "===========================================" ; \
echo "Generating TUI documentation" ; \
echo "===========================================" ; \
/*!
* Toggle auto color mode on the object.
- * \param theAtoColor is a flag which toggles auto color mode.
+ * \param theAutoColor is a flag which toggles auto color mode.
*/
void SetAutoColor(in boolean theAutoColor);
*/
GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve,
in double theXParameter,
- in double theYarameter,
- in double theZPameter);
+ in double theYParameter,
+ in double theZParameter);
/*!
* \brief Create a point, corresponding to the given parameters on the
*/
GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf,
in double theXParameter,
- in double theYarameter,
- in double theZPameter);
+ in double theYParameter,
+ in double theZParameter);
/*!
* \brief Create a vector, corresponding to tangent to the given parameter on the given curve.
* \param theRefCurve The referenced curve.
* \param theParameter Value of parameter on the referenced curve.This value should be have value
- * \between 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds
- * \last parameter of curve.
+ * between 0. and 1.. Value of 0. corresponds first parameter of curve; value
+ * 1. corresponds last parameter of curve.
* \return New GEOM_Object, containing the created point.
*/
GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve,
/*!
* \brief Create a plane, by two vectors.
* \param theVec1 Vector1, the plane has to pass through first point of this vector.
- * \param theVec Vector2, defining the plane normal direction.
+ * \param theVec2 Vector2, defining the plane normal direction.
* \param theTrimSize Half size of a side of quadrangle face, representing the plane.
* \return New GEOM_Object, containing the created plane.
*/
* \param theObject The object to be translated.
* \param theVector Translation vector, giving a direction.
* \param theDistance Translation distance, giving a distance.
- * \param theCope Translation copy, creating its copy if true.
+ * \param theCopy Translation copy, creating its copy if true.
* \return New GEOM_Object, containing the translated object.
*/
GEOM_Object TranslateVectorDistance (in GEOM_Object theObject,
* \brief Rotate given object around vector perpendicular to plane containing three points.
* \param theObject The object to be rotated.
* \param theCentPoint central point - the axis is the vector perpendicular to the plane
- * containing the three points.
- * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
+ * containing the three points.
+ * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
* \return theObject.
*/
GEOM_Object RotateThreePoints (in GEOM_Object theObject,
* \param theObject The object to be rotated.
* \param theCentPoint central point - the axis is the vector perpendicular to the plane
* containing the three points.
- * \param thePoint1 and thePoint2 - in a perpendicular plan of the axis.
+ * \param thePoint1,thePoint2 - in a perpendicular plan of the axis.
* \return New GEOM_Object, containing the rotated object.
*/
GEOM_Object RotateThreePointsCopy (in GEOM_Object theObject,
* \param thePath Wire or Edge along that the object will be translated.
* \param theDistance progress of Path (0 = actual location, 1 = end of path location).
* \param theCopy is a true or false parameter. true is to create a copy, false to move the object.
- * \param theCopy is a true or false parameter. true is to reverse direction, false is to move normal direction.
+ * \param theReverse is a true or false parameter. true is to reverse direction, false is to move normal direction.
* \return New GEOM_Object, containing the displaced shape.
*/
GEOM_Object PositionAlongPath (in GEOM_Object theObject,
/*!
* \brief Create a face by normale vector or edge and two specified sizes,
* vertical (H) and horisontal (W).
- * \param theVec defines plane.
+ * \param theObj defines plane.
* \param theH vertical size (height).
* \param theW horisontal size (width).
* \return New GEOM_Object, containing the created face.
/*!
* \brief Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.
* \param theBase Base shape to be extruded.
- * \param DX, DY, DZ end of extrusion vector.
+ * \param theDX, theDY, theDZ end of extrusion vector.
* \return New GEOM_Object, containing the created prism.
*/
GEOM_Object MakePrismDXDYDZ (in GEOM_Object theBase,
/*!
* \brief Create a filling from the given compound of contours.
+ * \param theShape Initial shape on which to perform the feature.
* \param theMinDeg a minimal degree of BSpline surface to create
* \param theMaxDeg a maximal degree of BSpline surface to create
* \param theTol2D a 2d tolerance to be reached
* \param theTol3D a 3d tolerance to be reached
* \param theNbIter a number of iteration of approximation algorithm
* \param theMethod Kind of method to perform filling operation.
+ * \param theApprox Boolean indicating if result should be approximated
* \return New GEOM_Object, containing the created filling surface.
*/
GEOM_Object MakeFilling (in GEOM_Object theShape,
* \param thePath - Path shape to extrude the base shape along it.
* \param theWithContact - the mode defining that the section is translated to be in
* contact with the spine.
- * \param - WithCorrection - defining that the section is rotated to be
+ * \param theWithCorrection - defining that the section is rotated to be
* orthogonal to the spine tangent in the correspondent point
* \return New GEOM_Object, containing the created pipe.
*/
* \param thePath - Path shape to extrude the base shape along it.
* \param theWithContact - the mode defining that the section is translated to be in
* contact with the spine.
- * \param - WithCorrection - defining that the section is rotated to be
+ * \param theWithCorrection - defining that the section is rotated to be
* orthogonal to the spine tangent in the correspondent point
* \return New GEOM_Object, containing the created pipe.
*/
* in compliance with given list of edges
* \param theShape Initial shape.
* \param theTolerance Maximum distance between edges, which can be considered as coincident.
- * \param theFaces List of edges for gluing.
+ * \param theEdges List of edges for gluing.
* \return New GEOM_Object, containing a copy of theShape without some edges.
*/
GEOM_Object MakeGlueEdgesByList (in GEOM_Object theShape,
in GEOM_Object theAx1,
in shape_state theState);
/*!
- * \briefFind in \a theShape all sub-shapes of type \a theShapeType, situated relatively
+ * \brief Find in \a theShape all sub-shapes of type \a theShapeType, situated relatively
* the specified plane by the certain way, defined through \a theState parameter.
* \param theShape Shape to find sub-shapes of.
* \param theShapeType Type of sub-shapes to be retrieved.
* faces is not important.
*
* It is not necessary that Faces share the same edge.
- * \param theFace1-theFace6 Faces for the hexahedral solid.
+ * \param theFace1,theFace2,theFace3,theFace4,theFace5,theFace6 Faces for the hexahedral solid.
* \return New GEOM_Object, containing the created solid.
*/
GEOM_Object MakeHexa (in GEOM_Object theFace1,
/*!
* \brief Returns a face, found in the given shape by four given corner vertices.
* \param theShape Block or a compound of blocks.
- * \param thePoint1-thePoint4 Points, close to the corners of the desired face.
+ * \param thePoint1,thePoint2,thePoint3,thePoint4 Points, close to the corners of the desired face.
* \return New GEOM_Object, containing the found face.
*/
GEOM_Object GetFaceByPoints (in GEOM_Object theShape,
/*!
* \brief Find a face of block, whose outside normale has minimal angle with the given vector.
- * \param theShape Block or a compound of blocks.
+ * \param theBlock Block or a compound of blocks.
* \param theVector Vector, close to the normale of the desired face.
* \return New GEOM_Object, containing the found face.
*/
* \param theMinNbFaces If solid has lower number of faces, it is not a block.
* \param theMaxNbFaces If solid has higher number of faces, it is not a block.
* \note If theMaxNbFaces = 0, the maximum number of faces is not restricted.
+ * \param theNbBlocks Number of specified blocks in theCompound.
* \return TRUE, if the given compound contains only blocks.
- * \return theNbBlocks Number of specified blocks in theCompound.
*/
boolean IsCompoundOfBlocks (in GEOM_Object theCompound,
in long theMinNbFaces,
* - The glue between two quadrangle faces should be applied.
* \note Single block is also accepted as a valid compound of blocks.
* \param theCompound The compound to check.
+ * \param theErrors Structure, containing discovered errors and incriminated sub-shapes.
* \return TRUE, if the given shape is a compound of blocks.
- * \return theErrors Structure, containing discovered errors and incriminated sub-shapes.
*/
boolean CheckCompoundOfBlocks (in GEOM_Object theCompound,
out BCErrors theErrors);
* \note Each compound from ListShapes and ListTools will be exploded in order
* to avoid possible intersection between shapes from this compound.
* \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
- * \param KeepNonlimitShapes: if this parameter == 0, then only shapes of
+ * \param theKeepNonlimitShapes: if this parameter == 0, then only shapes of
* target type (equal to Limit) are kept in the result,
* else standalone shapes of lower dimension
* are kept also (if they exist).
* \param thezExpr parametric equation of the coordinates Z.
* \param theParamMin the minimal value of the parameter.
* \param theParamMax the maximum value of the parameter.
- * \param theParamStep the number of steps of the parameter discretization.
+ * \param theParamNbStep the number of steps of the parameter discretization.
* \param theCurveType the type of the curve.
* \return New GEOM_Object, containing the created curve.
*/
* \brief Perform a chamfer on edges,
* with distance D1 on the first specified face (if several for one edge)
* \param theShape Shape, to perform chamfer on.
- * \param theD1 theD2 Chamfer size
+ * \param theD1,theD2 Chamfer size
* \param theEdges Sequence of edges of \a theShape.
* \return New GEOM_Object, containing the result shape.
*/
/*!
* \brief Get inertia matrix and moments of inertia of theShape.
* \param theShape Shape to calculate inertia of.
- * \param I(1-3)(1-3) Output. Components of the inertia matrix of the given shape.
+ * \param I11,I12,I13,I21,I22,I23,I31,I32,I33 Output. Components of the inertia matrix of the given shape.
* \param Ix,Iy,Iz Output. Moments of inertia of the given shape.
* \return Returns inertia through the last twelve arguments.
*/
*
* To be used from GUI and from geompy.addToStudy.
* Work like the above method, but accepts study object theSObject instead of GEOM_Object.
+ * \param theStudy the study, in which theObject is published already,
+ * and in which the arguments will be published
* \param theSObject study object, referencing GEOM_Object, arguments of which will be published
+ * \param theArgs list of GEOM_Object, operation arguments to be published.
+ * If this list is empty, all operation arguments will be published
+ * \param theFindMethod method to search sub-shapes, corresponding to arguments and
+ * their sub-shapes. Value from enumeration GEOM::find_shape_method.
+ * \param theInheritFirstArg set properties of the first argument for \a theObject.
+ * Do not publish sub-shapes in place of arguments, but only
+ * in place of sub-shapes of the first argument,
+ * because the whole shape corresponds to the first argument.
+ * Mainly to be used after transformations, but it also can be
+ * usefull after partition with one object shape, and some other
+ * operations, where only the first argument has to be considered.
+ * If theObject has only one argument shape, this flag is automatically
+ * considered as True, not regarding really passed value.
+ * \param theAddPrefix add prefix "from_" to names of restored sub-shapes,
+ * and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
*/
ListOfGO RestoreSubShapesSO (in SALOMEDS::Study theStudy,
in SALOMEDS::SObject theSObject,
<source>STB_BOX</source>
<translation>Create a box</translation>
</message>
+ <message>
+ <source>STB_FEATURE_DETECTION</source>
+ <translation>Shape recognition</translation>
+ </message>
+ <message>
+ <source>STB_PICTURE_IMPORT</source>
+ <translation>Import picture in viewer</translation>
+ </message>
<message>
<source>STB_CHAMFER</source>
<translation>Create a chamfer</translation>
<source>STB_EXTRUSION</source>
<translation>Create an extrusion</translation>
</message>
+ <message>
+ <source>STB_EXTRUDED_CUT</source>
+ <translation>Extruded cut</translation>
+ </message>
+ <message>
+ <source>STB_EXTRUDED_BOSS</source>
+ <translation>Extruded boss</translation>
+ </message>
<message>
<source>STB_FACE</source>
<translation>Build a face</translation>
<source>STB_BOX</source>
<translation>Créer une boîte</translation>
</message>
+ <message>
+ <source>STB_FEATURE_DETECTION</source>
+ <translation>Reconnaisance de formes</translation>
+ </message>
+ <message>
+ <source>STB_PICTURE_IMPORT</source>
+ <translation>Importer une image dans la vue</translation>
+ </message>
<message>
<source>STB_CHAMFER</source>
<translation>Créer un chanfrein</translation>
<source>STB_EXTRUSION</source>
<translation>Créer une extrusion</translation>
</message>
+ <message>
+ <source>STB_EXTRUDED_CUT</source>
+ <translation>Enlèvement de matière extrudé</translation>
+ </message>
+ <message>
+ <source>STB_EXTRUDED_BOSS</source>
+ <translation>Bossage extrudé</translation>
+ </message>
<message>
<source>STB_FACE</source>
<translation>Construire une face</translation>
This method can be re-implemented in the subclasses.
Return true in case if object isn't reference or component (module root).
- \param id column id
+ \param entry column id
\return \c true if the item can be renamed by the user in place (e.g. in the Object browser)
*/
bool GeometryGUI::renameAllowed( const QString& entry) const {
Standard_EXPORT BRepTools_Modifier_21423();
//! Creates a modifier on the shape <S>. <br>
Standard_EXPORT BRepTools_Modifier_21423(const TopoDS_Shape& S);
- //! Creates a modifier on the shape <S>, and performs <br>
+ //! Creates a modifier on the shape <S>, and performs <br>
//! the modifications described by <M>. <br>
Standard_EXPORT BRepTools_Modifier_21423(const TopoDS_Shape& S,const Handle(BRepTools_Modification)& M);
//! Initializes the modifier with the shape <S>. <br>
/*!
* Build a face, bound by the given wire.
* \param theWire The initial wire to build the face on.
- * \param isPlanarWanted. If true, try to build a planar face.
+ * \param isPlanarWanted If true, try to build a planar face.
* \note If isPlanarWanted is true, but planar face cannot be built
* with acceptable tolerance, any face will be built.
+ * \param theResult The resulting shape.
* \return Error or warning description. Empty string in case of success.
*/
static TCollection_AsciiString MakeFace (const TopoDS_Wire& theWire,
/*!
* Build a face, bound by the given wire.
* \param theWire The initial wire to build the face on.
+ * \param theResult The resulting shape.
* \return Error or warning description. Empty string in case of success.
*/
static TCollection_AsciiString MakeAnyFace (const TopoDS_Wire& theWire,
//=============================================================================
/*!
* MakePipeTShape
- * Create a T-shape object with specified caracteristics for the main and
- * the incident pipes (radius, width, half-length).
- * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
+ * \brief Create a T-shape object with specified caracteristics for the main and
+ * the incident pipes (radius, width, half-length).
+ * Center of the shape is (0,0,0). The main plane of the T-shape is XOY.
* \param theR1 Internal radius of main pipe
* \param theW1 Width of main pipe
* \param theL1 Half-length of main pipe
*/
//=============================================================================
Handle(TColStd_HSequenceOfTransient)
-GEOMImpl_IAdvancedOperations::MakePipeTShape(double theR1, double theW1, double theL1,
- double theR2, double theW2, double theL2,
- bool theHexMesh)
+ GEOMImpl_IAdvancedOperations::MakePipeTShape(double theR1, double theW1, double theL1,
+ double theR2, double theW2, double theL2,
+ bool theHexMesh)
{
MESSAGE("GEOMImpl_IAdvancedOperations::MakePipeTShape");
SetErrorCode(KO);
//=============================================================================
/*!
* MakePipeTShapeFilletWithPosition
- * Create a T-shape object with specified caracteristics for the main and
+ * \brief Create a T-shape object with specified caracteristics for the main and
* the incident pipes (radius, width, half-length). A fillet is created
* on the junction of the pipes.
* The extremities of the main pipe are located on junctions points P1 and P2.
/*!
\brief Constructor.
\param parent parent widget
+ \param objects map of objects names/objects
+ \param deleteAll if True, delete all objects
*/
GEOMToolsGUI_DeleteDlg::GEOMToolsGUI_DeleteDlg( QWidget* parent,
const QMap<QString, QString>& objects,
/*!
\brief Process key press event
+ \param o sender
\param e key event
*/
bool GEOMToolsGUI_MaterialPropertiesDlg::eventFilter( QObject* o, QEvent* e )
## Get name for sub-shape aSubObj of shape aMainObj
#
- # @ref swig_SubShapeAllSorted "Example"
+ # @ref swig_SubShapeName "Example"
def SubShapeName(self,aSubObj, aMainObj):
"""
Get name for sub-shape aSubObj of shape aMainObj
# these arguments description
# \return study entry of the published shape in form of string
#
- # @ref swig_MakeQuad4Vertices "Example"
+ # @ref swig_all_addtostudy "Example"
def addToStudy(self, aShape, aName, doRestoreSubShapes=False,
theArgs=[], theFindMethod=GEOM.FSM_GetInPlace, theInheritFirstArg=False):
"""
# \param aName the name for the shape
#
# \return study entry of the published shape in form of string
- # @ref swig_SubShapeAllSorted "Example"
+ # @ref swig_all_addtostudyInFather "Example"
def addToStudyInFather(self, aFather, aShape, aName):
"""
Publish in study aShape with name aName as sub-object of previously published aFather
## Unpublish object in study
#
- # \param aobj the object to be unpublished
- def hideInStudy(self, obj):
+ # \param obj the object to be unpublished
+ def hideInStudy(self, obj):
"""
Unpublish object in study
Parameters:
obj the object to be unpublished
"""
- ior = salome.orb.object_to_string(obj)
- aSObject = self.myStudy.FindObjectIOR(ior)
- if aSObject is not None:
- genericAttribute = self.myBuilder.FindOrCreateAttribute(aSObject, "AttributeDrawable")
+ ior = salome.orb.object_to_string(obj)
+ aSObject = self.myStudy.FindObjectIOR(ior)
+ if aSObject is not None:
+ genericAttribute = self.myBuilder.FindOrCreateAttribute(aSObject, "AttributeDrawable")
drwAttribute = genericAttribute._narrow(SALOMEDS.AttributeDrawable)
- drwAttribute.SetDrawable(False)
- pass
-
+ drwAttribute.SetDrawable(False)
+ pass
+
# end of l1_geompy_auxiliary
## @}
# selected by they indices in list of all sub-shapes of type <VAR>aType</VAR>.
# Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
# @param aShape Shape to get sub-shape of.
- # @param aListOfInd List of sub-shapes indices.
+ # @param ListOfInd List of sub-shapes indices.
# @param aType Type of sub-shapes to be retrieved (see ShapeType())
# @return A compound of sub-shapes of aShape.
#
# selected by they indices in sorted list of all sub-shapes of type <VAR>aType</VAR>.
# Each index is in range [1, Nb_Sub-Shapes_Of_Given_Type]
# @param aShape Shape to get sub-shape of.
- # @param aListOfInd List of sub-shapes indices.
+ # @param ListOfInd List of sub-shapes indices.
# @param aType Type of sub-shapes to be retrieved (see ShapeType())
# @return A compound of sub-shapes of aShape.
#
RaiseIfFailed("ExtractSubShapes", self.ShapesOp)
return ListObj
- ## Get a set of sub-shapes defined by their unique IDs inside <VAR>theMainShape</VAR>
- # @param theMainShape Main shape.
- # @param theIndices List of unique IDs of sub-shapes inside <VAR>theMainShape</VAR>.
+ ## Get a set of sub-shapes defined by their unique IDs inside <VAR>aShape</VAR>
+ # @param aShape Main shape.
+ # @param anIDs List of unique IDs of sub-shapes inside <VAR>aShape</VAR>.
# @return List of GEOM.GEOM_Object, corresponding to found sub-shapes.
#
# @ref swig_all_decompose "Example"
Get a set of sub-shapes defined by their unique IDs inside theMainShape
Parameters:
- theMainShape Main shape.
- theIndices List of unique IDs of sub-shapes inside theMainShape.
+ aShape Main shape.
+ anIDs List of unique IDs of sub-shapes inside theMainShape.
Returns:
List of GEOM.GEOM_Object, corresponding to found sub-shapes.
# @param theShape Initial shape.
# @param theTolerance Maximum distance between edges,
# which can be considered as coincident.
- # @param theFaces List of edges for gluing.
+ # @param theEdges List of edges for gluing.
# @return New GEOM.GEOM_Object, containing a copy of theShape
# without some edges.
#
theShape Initial shape.
theTolerance Maximum distance between edges,
which can be considered as coincident.
- theFaces List of edges for gluing.
+ theEdges List of edges for gluing.
Returns:
New GEOM.GEOM_Object, containing a copy of theShape
#
# @ref tui_common "Example 1"
# \n @ref swig_MakeCommon "Example 2"
- def MakeCommon(self, s1, s2):
+ def MakeCommon(self, theShape1, theShape2):
"""
Perform Common boolean operation on two given shapes.
New GEOM.GEOM_Object, containing the result shape.
"""
# Example: see GEOM_TestOthers.py
- return self.MakeBoolean(s1, s2, 1)
+ return self.MakeBoolean(theShape1, theShape2, 1)
## Perform Cut boolean operation on two given shapes.
# @param theShape1 First argument for boolean operation.
#
# @ref tui_cut "Example 1"
# \n @ref swig_MakeCommon "Example 2"
- def MakeCut(self, s1, s2):
+ def MakeCut(self, theShape1, theShape2):
"""
Perform Cut boolean operation on two given shapes.
"""
# Example: see GEOM_TestOthers.py
- return self.MakeBoolean(s1, s2, 2)
+ return self.MakeBoolean(theShape1, theShape2, 2)
## Perform Fuse boolean operation on two given shapes.
# @param theShape1 First argument for boolean operation.
#
# @ref tui_fuse "Example 1"
# \n @ref swig_MakeCommon "Example 2"
- def MakeFuse(self, s1, s2):
+ def MakeFuse(self, theShape1, theShape2):
"""
Perform Fuse boolean operation on two given shapes.
"""
# Example: see GEOM_TestOthers.py
- return self.MakeBoolean(s1, s2, 3)
+ return self.MakeBoolean(theShape1, theShape2, 3)
## Perform Section boolean operation on two given shapes.
# @param theShape1 First argument for boolean operation.
#
# @ref tui_section "Example 1"
# \n @ref swig_MakeCommon "Example 2"
- def MakeSection(self, s1, s2):
+ def MakeSection(self, theShape1, theShape2):
"""
Perform Section boolean operation on two given shapes.
"""
# Example: see GEOM_TestOthers.py
- return self.MakeBoolean(s1, s2, 4)
+ return self.MakeBoolean(theShape1, theShape2, 4)
# end of l3_boolean
## @}
# @param theOriginal geometry object for copy
# @return unique object identifier
# @ingroup l1_geompy_auxiliary
- # @ref swig_all_advanced "Example"
+ # @ref swig_MakeCopy "Example"
def MakeCopy(self,theOriginal):
"""
Create a copy of the given object
\param theResMgr resources manager
\param theResSection resources section name
+ \param theIsFront if True, it is front material, else it is back material
\sa save()
*/
void Material_Model::fromResources( QtxResourceMgr* theResMgr,
\param theResMgr resources manager
\param theResSection resources section name
+ \param theIsFront if True, it is front material, else it is back material
\sa fromResources()
*/
void Material_Model::save( QtxResourceMgr* theResMgr,
/*!
Performs contours detection and store them in contours
- \param src - src image to find contours of
+ \param binaryImg - src image to find contours of
*/
-void ShapeRec_FeatureDetector::_detectAndRetrieveContours( Mat src )
+void ShapeRec_FeatureDetector::_detectAndRetrieveContours( Mat binaryImg )
{
- src = src > 1;
+ binaryImg = binaryImg > 1;
int method = CV_CHAIN_APPROX_NONE;
- findContours( src, contours, hierarchy,CV_RETR_CCOMP, method);
+ findContours( binaryImg, contours, hierarchy,CV_RETR_CCOMP, method);
// Other possible approximations CV_CHAIN_APPROX_TC89_KCOS, CV_CHAIN_APPROX_TC89_L1, CV_CHAIN_APPROX_SIMPLE cf. OpenCV documentation
// for precise information
}
