following conditions:
<ul>
<li>Each element of the compound should be a Block (6 faces and 12 edges);</li>
-<li>A connection between two Blocks should be an entire quadrangle face or an entire edge;</li>
+<li>Blocks can be connected only via an entire quadrangle face or an entire edge;</li>
<li>The compound should be connected;</li>
-<li>Two quadrangle faces should be glued.</li>
+<li>Each couple of connecting quadrangle faces should be glued.</li>
</ul>
\n Informs of the following possible errors:
\image html 3dsketch_dlg.png
-The first sketcher point can be defined by \b Absolute coordinates X, Y and Z.
+The first point of a sketch can be defined by \b Absolute coordinates X, Y and Z.
When the first point is defined, it is possible to add straight segments.
-Each segment will start at the end point of previous segment or at the
-sketcher first point, if there are no validated segments.
+Each segment will start at the end point of the previous segment or at the
+first point of the sketch, if there are no validated segments.
The way of segment construction can be selected by the <b>Coordinates Type</b>
radio buttons.
-To validate the segment and to proceed with the definition of the next
-segment, click <b>Apply</b> button. \b Undo and \b Redo buttons,
+To validate a segment and to proceed with the definition of the next
+one, click <b>Apply</b> button. \b Undo and \b Redo buttons,
respectively, remove or restore the last segment in the wire.
\n <b>"Sketch Validation"</b> button applies the wire, built by the
\n <b>"Sketch Closure"</b> closes the Sketch by a straight line from
the start to the end point and applies it.
-Segment can be defined by:
-- <b>Cartesian coordinates</b> of its second end, it can be either:
- - \b Absolute coordinates X, Y and Z,
+A segment can be defined by:
+- <b>Cartesian coordinates</b> of its second end, which can be either:
+ - \b Absolute coordinates X, Y and Z, or
- \b Relative coordinates DX, DY and DZ with
respect to the previous applied point,
-- <b>Angular coordinates</b> of its second end, which is specified by:
+- <b>Angular coordinates</b> of its second end specified by:
<ul>
<li> the \b Length of the segment and an \b Angle in the chosen plane (OXY for example) in \b Relative mode.
- The angle is then relative to a local coordinate system with the last point of the sketch as origin </li>
+ The angle is then relative to a local coordinate system with the last point of the sketch as origin. </li>
\image html 3dsketch_angle_rel.png
- <li> a \b Radius (i.e. the distance from the origin) and an \b Angle in the chosen plane in \b Absolute mode </li>
+ <li> the \b Radius (i.e. the distance from the origin) and an \b Angle in the chosen plane in \b Absolute mode </li>
\image html 3dsketch_angle_abs.png
- In both angular modes you can additionally specify either:
+ In both angular modes you can additionally specify the following:
- <li> a second \b Angle (latitude) </li>
+ <li> the second \b Angle (latitude) </li>
\image html 3dsketch_2angles_rel.png
or
- <li> a \b Height </li>
+ <li> the \b Height </li>
\image html 3dsketch_angle_height_rel.png
+++ /dev/null
-/*!
-
-\page create_adv_obj_page Creating Advanced Geometrical Objects
-
-<b>New Entity -> Advanced </b> submenu allows to create additional complex topological objects.
-
-<ul>
-<li>\subpage create_pipetshape_page</li>
-<li>\subpage create_divideddisk_page</li>
-<li>\subpage create_dividedcylinder_page</li>
-<!--@@ insert new functions before this line @@ do not remove this line @@-->
-</ul>
-<!--WRNING : In order to let this page appear in the documentation please remove this file from the EXCLUDE_PATTERNS field of the doxyfile.in file in ../ -->
-*/
\page create_dividedcylinder_page DividedCylinder
-The <b>Divided cylinder</b> object is a cylinder divided into \b blocks for easy hexaedral meshing.Two division patterns are available :
+The <b>Divided cylinder</b> object is a cylinder divided into \b blocks for easy hexahedral meshing. Two division patterns are available :
<ul>
-<li> A square pattern which is frequently used </li>
-<li> An hexagonal pattern which ensures a better mesh quality and especially less acute or obtuse angles </li>
+<li> A square pattern, which is frequently used; </li>
+<li> A hexagonal pattern, which ensures a better mesh quality and especially less acute or obtuse angles. </li>
</ul>
\image html dividedcylinder.png
\page create_divideddisk_page DividedDisk
-The <b>Divided disk</b> object is a disk divided into \b blocks. It means that it's a shape <b>prepared for hexaedral meshing</b>. Two division patterns are available :
+The <b>Divided disk</b> object is a disk divided into \b blocks for easy hexahedral meshing. Two division patterns are available :
<ul>
-<li> A square pattern which is frequently used </li>
-<li> An hexagonal pattern which ensures a better mesh quality and especially less acute or obtuse angles </li>
+<li> A square pattern, which is frequently used; </li>
+<li> A hexagonal pattern, which ensures a better mesh quality and especially less acute or obtuse angles. </li>
</ul>
-\n Moreover this shape can be used as a basis in an \ref create_extrusion_alongpath_page "Extrusion along a path" operation in order to obtain any <b>tube shape</b> prepared for hexaedral meshing
+\n Moreover, this shape can be used as a basis in an \ref create_extrusion_alongpath_page "Extrusion along a path" operation in order to obtain any <b>tube shape</b> prepared for hexahedral meshing
(see example below). (Another alternative is to create a 2D mesh on the divided disk and create a 3D mesh by extrusion in the SMESH module.)
To create a <b> Divided Disk </b> in the <b>Main Menu</b> select <b>New Entity - >
Advanced - > DividedDisk </b>
-\n Then there are 2 ways to create a <b> Divided Disk</b> in 3D space.
+\n There are 2 ways to create a <b> Divided Disk</b> in 3D space.
\n For both operations :
Specify the parameters of the DividedDisk object creation in the opened dialog
box and press "Apply" or "Apply & Close" button.
The result of each operation will be a GEOM_Object.
-\n First way : by radius and orientation (plane "OXY", "OYZ" or "OZX"). The resulting disk is located at the origin of coordinates
+\n At first it is possible to define a disk by its radius and orientation (plane "OXY", "OYZ" or "OZX"). The resulting disk is located at the origin of coordinates
<b>TUI Command:</b> <em>geompy.MakeDividedDisk(Radius, Orientation, Pattern)</em>
\image html divided_disk_dlg.png
-\n Second way : by giving its center, normal and radius.
+\n At second the disk can be defined by its center, normal and radius.
<b>TUI Command:</b> <em>geompy.MakeDividedDiskPntVecR(Center, Vector,
Radius, Pattern)</em>
\page create_hexa_solid_page Hexaedral solid
-\n <b>Description:</b> Builds a hexahedral solid. either of the below
-mentioned arguments. This operation allows to build a solid bypassing
-the intermediate stage of building a shell and 4 faces (in the case of
-building by 2 faces) or just a shell (in the case of building by 6
+This operation allows to build a hexahedral solid bypassing
+the intermediate stage of building a shell and 4 faces (in case of
+building by 2 faces) or just a shell (in case of building by 6
faces).
+There are 2 algorithms to create a hexahedral solid in the 3D space.
\n The \b Result of the operation will be a \b GEOM_Object (solid).
-\n <b>TUI Command:</b>
-<ul>
-<li><em>geompy.MakeHexa2Faces(F1, F2),</em> where F1 and F2 are faces
-from which the hexahedron is constructed, other four faces are created
-automatically.</li>
-<li><em>geompy.MakeHexa(F1, F2, F3, F4, F5, F6),</em> where F1 — F6 are six faces from which the hexahedron is constructed.</li>
-</ul>
+Firstly, you can define a Hexahedral Solid by two faces, other four faces are created automatically.
-\n <b>Arguments:</b>
-<ul>
-<li>Name + 2 Faces, or</li>
-<li>Name + 6 Faces.</li>
-</ul>
-
-\n <b>Dialog Box:</b>
+<b>TUI Command:</b> <em>geompy.MakeHexa2Faces(F1, F2),</em>
+<b>Arguments: Name + 2 Faces.
\image html block4.png
+\n <b>Example:</b>
+
+\image html image181.png
+<center>Hexahedral Solid built on the base of two Faces</center>
+Secondly, you can define a Hexahedral Solid by all six faces.
+
+<b>TUI Command:</b> <em>geompy.MakeHexa(F1, F2, F3, F4, F5, F6),</em>
+<b>Arguments:</b> Name + 6 Faces.
\image html block5.png
\image html image180.png
<center>Hexahedral Solid built on the base of six Faces</center>
-\image html image181.png
-<center>Hexahedral Solid built on the base of two Faces</center>
-
The created blocks can be processed with \ref blocks_operations_page "Operations on Blocks".
\image html pipe_path_dlg.png
-\n To obtain a \b Path of a pipe-like shape, you should define the
-<b>Pipe-like shell or solid</b> and two pipe \b Bases, each of them can
-be set as a wire, a face or a list of edges.<br>
+\n To obtain the \b Path of a pipe-like shape, you should define the
+<b>Pipe-like shell or solid</b> and two pipe \b Bases, which can
+be defined by a wire, a face or a list of edges.<br>
\n <b>Select unpublished edges</b> checkbox - if checked, allows
-selection of edges in the viewer, that are not published in the Object
+selecting in the viewer the edges, that are not published in the Object
Browser.<br>
\n The \b Result of the operation will be a GEOM_Object (edge or wire).<br>
<li>\ref preview_anchor "Preview"</li>
</ul><br>
-\note It is not assumed that exact or approximate copy of the Shape
- can be obtained by applying existing Pipe operation on the
- resulting "Path" wire taking the first Base as the base - it is
- not always possible; though in some particular cases it might
- work it is not guaranteed. Thus, RestorePath function should not
+\note It is not always possible to obtain an exact or approximate
+ copy of the Shape by applying the \b Pipe operation to the
+ resulting "Path" wire with the first Base as the base;
+ though in some particular cases it might
+ work. Thus, Restore Path function should not
be considered as an exact reverse operation of the Pipe.<br>
\n <b>Example:</b>
\page create_quadrangle_face_page Quadrangle face
-\n <b>Description:</b> Builds a face using the below mentioned
-arguments. This operation allows to build a face bypassing the
-intermediate stage of building edges and wires (in the case of
-building by 4 points) or wires (in the case of building by 4 or 2
+This operation allows to build a face bypassing the
+intermediate stage of building edges and wires (in case of
+building by 4 points) or wires (in case of building by 4 or 2
edges).
-\n The \b Result of the operation will be a \b GEOM_Object (face).
-
-\n <b>TUI Command:</b>
-<ul>
-<li><em>geompy.MakeQuad4Vertices(V1, V2, V3, V4),</em> where V1, V2,
-V3, V4 are four vertices from which a face is constructed. Edges are
-created automatically.</li>
-<li><em>geompy.MakeQuad2Edges(E1, E2),</em> where E1, E2 are edges from
-which the face is constructed, two other edges are created
-automatically.</li>
-<li><em>geompy.MakeQuad(E1, E2, E3, E4),</em> where E1, E2, E3, E4 are
-four edges from which the face is constructed.</li>
-</ul>
-
-<b>Arguments:</b>
-<ul>
-<li>Name + 4 Points, or</li>
-<li>Name + 2 Edges, or</li>
-<li>Name + 4 Edges.</li>
-</ul>
-
-\n <b>Dialog Box:</b>
+There are 3 algorithms to create a Quadrangle Face in the 3D space.
+\n The \b Result of each op
+
+The created blocks can be processed with \ref blocks_operations_page "Operations on Blocks".
+
+Our <b>TUI Scripts</b> provide you with useful examples of
+\ref tui_building_by_blocks_p
+
+The created blocks can be processed with \ref blocks_operations_page "Operations on Blocks".
+
+Our <b>TUI Scripts</b> provide you with useful examples of
+\ref tui_building_by_blocks_page "Building by Blocks".
+age "Building by Blocks".
+eration will be a \b GEOM_Object (face).
+
+Firstly you can define a Quadrangle Face by four vertices. Edges are
+created automatically.
+
+<b>TUI Command:</b> <em>geompy.MakeQuad4Vertices(V1, V2, V3, V4),</em>
+<b>Arguments:</b> Name + 4 Points.
\image html block1.png
+Secondly, you can define a Quadrangle Face by two edges, while the other two edges are created automatically.
+<b>TUI Command:</b> <em>geompy.MakeQuad2Edges(E1, E2)
+<b>Arguments:</b> Name + 2 Edges.
+
\image html block2.png
+Finally, you can define a Quadrangle Face by four edges.
+
+<b>TUI Command:</b> <em>geompy.MakeQuad(E1, E2, E3, E4),</em>.
+<b>Arguments:</b> Name + 4 Edges.
+
\image html block3.png
\n <b>Example:</b>
<li> Select the \b plane or the <b>planar face</b> on which to create the sketch.
\note 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 a reference coordinate system.</li>
+in the combo-box and can be selected as a reference coordinate system.</li>
<li> Choose a \b segment or an \b arc element to start a \b profile or choose \b rectangle to draw a rectangle.
<li> You can define the segment by either its <b>end point</b> or \b direction and \b length. The direction is defined relatively to the tangent at the last point of the sketch. It can be:
<ul>
- <li> Tangent (colinear to the tangent at the last point)</li>
+ <li> Tangent (collinear to the tangent at the last point)</li>
<li> Perpendicular</li>
<li> Defined by an angle</li>
<li> Defined by a vector (Vx, Vy)</li>
Our <b>TUI Scripts</b> provide you with useful examples of the use of
\ref tui_sketcher_page "Sketcher".
-A wrapper also exists to help in the construction of a sketcher using simple commands.
+There is also a wrapper that can help in the construction of a sketcher using simple commands.
The description of this wrapper can be found in the <a class="el" target="_new" href="../../tui/GEOM/docutils/docapi.html#module-salome.geom.sketcher">
dedicated page</a> of the <a class="el" target="_new" href="../../tui/GEOM/docutils/index.html">salome.geom python package</a>.
\page faq FAQ ("Frequently Asked Questions")
-You can find here some the answer to some frequentlyasked questions:
+Here you can find the answers to some frequently asked questions:
<ul>
-<li>\subpage partition_explanation "What's the difference between partition, compounds and fuse operation ?" </li>
+<li>\subpage partition_explanation "What is the difference between partition, compounds and fuse operation ?" </li>
</ul>
<b> More details </b>
<ul>
- <li>For detail description of the Boolean operations please refer to
+ <li>For a detailed description of the Boolean operations please refer to
<a href="SALOME_BOA_PA.pdf">this document</a>.
It provides a general review of the Partition and Boolean
-operations algorithms, describes the usage methodology and highlighs
+operations algorithms, describes the usage methodology and highlights
major limitations of these operations.</li>
- <li>Also perhaps you ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"</li>
+ <li>Perhaps you also ask yourself : \ref partition_explanation "What is the difference between partition, compounds and fuse operation ?"</li>
</ul>
*/
\image html measures2.png
-Retrieve all non blocks solids and faces from the given shape.
-Collect them in two groups: solids and faces separately.
+This operation retrieves all non block solids and faces from the given
+shape in two groups: solids and faces separately.
-\n <b>Result:</b> Two or less groups are published in the Object
- Browser under the processed object. Reports error if
- no bad sub-shapes (solids and faces) have been found.
+Two or less groups are published in the Object
+Browser under the processed object. An error is raised if
+no bad sub-shapes (solids and faces) have been found.
\n <b>TUI Command:</b>
<em>geompy.GetNonBlocks(Compound).</em> Returns a tuple of two
GEOM_Objects. The first object is a group of all non block solids
- (= not 6 faces, or with 6 faces, but with the presence of
- non-quadrangular faces). The second object is a group of all non
+ (not having 6 faces, or having 6 faces, but some of them
+ are not quadrangular). The second object is a group of all non
quadrangular faces.
See also a \ref tui_get_non_blocks_page "TUI example".
the module and its contents (geometrical object) will be displayed in
the <b>Object Browser</b>.
-\note If the selected file is in IGES or in STEP format and the length
-is not expressed in meters, it will be asked to take or not these
+\note If the selected file is in IGES or STEP format and the length
+is not expressed in meters, it will be asked whether to take or not these
units into account (see the picture below). This feature can be
-helpful if some wrong units have been written to the IGES file by a
+helpful if some wrong units have been written to the IGES or STEP file by a
3rd-party software.
\image html iges_unit.png
\page partition_page Partition
<ul>
-<li>For detail description of the Partition operation please refer to
+<li>For a detailed description of the Partition operation please refer to
<a href="SALOME_BOA_PA.pdf">this document</a>.
It provides a general review of the Partition and Boolean
-operations algorithms, describes the usage methodology and highlighs
+operations algorithms, describes the usage methodology and highlights
major limitations of these operations.</li>
-<li>Also perhaps you ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"</li>
+<li>Perhaps you also ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"</li>
</ul>
To produce a \b Partition in the <b>Main Menu</b> select <b>Operations - > Partition</b>
\tableofcontents
-It is frequently asked about the difference between the above mentioned operations. It's indeed simple. Lets take the example of a cylinder and a box that you want to join together.
+It is frequently asked about the difference between the above mentioned operations. It is indeed simple. Let us take the example of a cylinder and a box that you want to join together.
\section sec1 Fuse
-The \b fuse operation will make a <b>single solid</b> from the two given solids. It allows you to build complex models by putting simple shapes together.
+The \b fuse operation will make a <b>single solid</b> from two given solids. It allows you to build complex models by putting simple shapes together.
\image html fuse.png
\section sec2 Partition
-The \b partition operation will also connect the two solids but it will <b>keep a face at the frontier</b> (in brown on the picture below). The resulting shape will consist in <b>two connected solids</b> that share
+The \b partition operation will also connect the solids but it will <b>keep a face at the frontier</b> (in brown in the picture below). The resulting shape will consist of <b>two connected solids</b> that share
a face at their frontier. It means that this face is present only one time in the resulting shape and is a sub-shape of both the box and the cylinder.
\n This operation allows you to identify different areas in a shape (e.g. different materials) and to ensure a <b>conformal mesh</b> when meshing it later. Indeed the face at the frontier is meshed only once.
\section sec3 Compound
-When you build a \b compound by using the build -> compound operation you just make <b>an object that contains the two separate solids</b> like in a "bag".
+When you build a \b compound by using the Build -> Compound operation you just make <b>an object that contains two separate solids</b> like in a "bag".
The two solids remain unconnected. The compound is just a set of shapes, no more.
-\n The compound Allows applying operations to a collection of shapes.
+\n The compound allows applying operations to a collection of shapes.
\image html compound2.png
<li> \b Partition
<ul>
<li>\a Result : Two <b>connected solids</b> sharing faces.</li>
-<li>\a Purpose : Useful to ensure a conformal mesh of separated areas of your model (fluid / solid , concrete / steel ...)</li>
+<li>\a Purpose : Useful to ensure a conformal mesh of separate areas of your model (fluid / solid , concrete / steel ...).</li>
</ul>
<li> \b Compound
<ul>
\page work_with_groups_page Working with groups
Creation and editing groups of sub-shapes of a geometrical object makes
-handling sub-shapes much easier. Also some Boolean operations on
-groups are available.
+handling sub-shapes much easier. Boolean operations on
+groups are also available.
<ul>
<li>\ref create_groups_anchor "Create a Group"</li>
\image html groups_union_dlg.png
In this dialog box you should specify the name of the resulting group
-and set of groups which will be united.
+and select the groups, which will be united.
</li>
<li>Click the \b Apply or <b>Apply and Close</b> button to confirm creation of the group.</li>
</ol>
<h2>Intersection of groups</h2>
This operation allows to create a new group in such a way that only
-sub-shapes that are present in all initial groups together are added to the
+the sub-shapes that are present in all initial groups are added to the
new one.
<em>To intersect groups:</em>
\image html groups_intersect_dlg.png
In this dialog box you should specify the name of the resulting group
-and set of groups which will be intersected.
+and select the groups, which will be intersected.
</li>
<li>Click the \b Apply or <b>Apply and Close</b> button to confirm creation of the group.</li>
</ol>
\image html groups_cut_dlg.png
In this dialog box you should specify the name of the resulting group
-and groups which will be cut.
+and the groups which will be cut.
</li>
-<li>Click the \b Apply or <b>Apply and Close</b> button to confirm creation of the
-group.</li>
+<li>Click the \b Apply or <b>Apply and Close</b> button to confirm creation of the group.</li>
</ol>
Our <b>TUI Scripts</b> provide you with useful examples of
