mirror of
https://git.salome-platform.org/gitpub/modules/geom.git
synced 2024-12-26 17:30:35 +05:00
Update documentation
This commit is contained in:
vsr
parent
1c886272b4
commit
4dea5a1c19
BIN
doc/salome/gui/GEOM/images/isos.png
Normal file
BIN
doc/salome/gui/GEOM/images/isos.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
@ -2,29 +2,38 @@
|
||||
|
||||
\page common_operation_page Common
|
||||
|
||||
To produce a \b Common operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Common</b>
|
||||
\b Common operation cuts the common part of a list of shapes and transforms it into an independent geometrical object.
|
||||
|
||||
This operation cuts the common part of a list of shapes and transforms it into an independent geometrical object.
|
||||
|
||||
The \b Result will be a \b GEOM_Object.
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeCommonList(theShapesList, checkSelfInte)</em>\n
|
||||
<b>Arguments:</b> Name + a list of shapes + an optional flag for self-intersection check.\n
|
||||
<b>Advanced option:</b>
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
To produce it, select in the main menu <b>Operations - > Boolean - > Common</b>.
|
||||
|
||||
\image html bool2.png "Common dialog"
|
||||
|
||||
\note This algorithm doesn't find all types of self-intersections. It is tuned
|
||||
In this dialog:
|
||||
- Input or accept the default \b Name of the resulting shape.
|
||||
- Click the arrow button and select in the Object Browser or in the Viewer the <b>Objects</b> the common part which of should be found.
|
||||
- Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>
|
||||
- Activate \ref restore_presentation_parameters_page "Advanced options" if required.
|
||||
- Press "Apply" or "Apply & Close" button to get the result (GEOM_Object).
|
||||
|
||||
|
||||
\note This algorithm does not find all types of self-intersections. It is tuned
|
||||
to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
|
||||
intersections. Face/face intersections detection is switched off as it
|
||||
is a time-consuming operation that gives an impact on performance. To find
|
||||
all self-intersections please use \ref check_self_intersections_page
|
||||
all self-intersections use \ref check_self_intersections_page
|
||||
"Detect Self-intersection tool".
|
||||
|
||||
For a particular case with two shapes for the Common operation there is the following TUI command:
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeCommon(s1, s2, checkSelfInte)</em>\n
|
||||
This operation can be performed using a <b>TUI Command:</b>
|
||||
|
||||
<em>geompy.MakeCommonList(theShapesList, checkSelfInte)</em>
|
||||
|
||||
<b>Arguments:</b> Name + a list of shapes + an optional flag for self-intersection check.
|
||||
|
||||
There is also a special <b>TUI Command</b> for the Common operation on two shapes :
|
||||
|
||||
<em>geompy.MakeCommon(s1, s2, checkSelfInte)</em>
|
||||
|
||||
<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.
|
||||
|
||||
<b>Example:</b>
|
||||
@ -38,8 +47,7 @@ Our <b>TUI Scripts</b> provide you with useful examples of the use of
|
||||
|
||||
<b> More details </b>
|
||||
|
||||
For a detailed description of the Boolean operations please refer to
|
||||
<a href="SALOME_BOA_PA.pdf">this document</a>.
|
||||
Please, refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
|
||||
It provides a general review of the Partition and Boolean
|
||||
operations algorithms, describes the usage methodology and highlights
|
||||
major limitations of these operations.
|
||||
|
||||
@ -54,32 +54,30 @@ BiNormal direction to perform the extrusion.
|
||||
|
||||
\image html pipebinormalsn.png "Extrusion of a face with BiNormal parameter"
|
||||
|
||||
\n Third, to create a shape by extrusion of the profile shapes along the path shape,
|
||||
you can define the <b>Base Object</b>s (edges, planar wires, faces or shells), which will be extruded,
|
||||
the <b>Locations</b> (vertices that specify locations on the <b>Path Object</b> corresponding to the
|
||||
specified <b>Base Object</b>s; list of the <b>Locations</b> should be either empty or of the same
|
||||
length as list of <b>Base Object</b>s) and the <b>Path Object</b> (edge or wire) along which the
|
||||
<b>Base Object</b> will be extruded.
|
||||
\n Thirdly, it is possible to additionally select profiles of the pipe object to be built. For this, you can define the following parameters:
|
||||
- <b>Base Object</b> or a list of objects (edges, planar wires, faces or shells), which will be extruded;
|
||||
- <b>Locations</b> - a vertex or a list of vertices that specify the locations of extruded <b>Base Objects</b> on the resulting <b>Path Object</b>. The number of Base Objects should be equal to the number of <b>Locations</b>.
|
||||
- <b>Path Object</b> (edge or wire), along which the <b>Base Object</b> will be extruded.
|
||||
|
||||
Additional controls:
|
||||
- <b>With contact</b> checkbox - if checked, the section is translated to be in contact with the spine.
|
||||
- <b>With correction</b> checkbox - if checked, the section is rotated to be orthogonal to the spine
|
||||
- If <b>With contact</b> is checked, the section is translated in contact with the spine.
|
||||
- If <b>With correction</b> is checked, the section is rotated to be orthogonal to the spine
|
||||
tangent in the corresponding point.
|
||||
|
||||
\n The \b Result of the operation will be a GEOM_Object (shell or solid).
|
||||
\n The \b Result of the operation will be a shell or a solid.
|
||||
|
||||
\n <b>TUI Command:</b> <em>geompy.MakePipeWithDifferentSections(baseShape, locations, pathShape, withContact, withCorrection)</em>
|
||||
\n <b>Arguments:</b> Name + list of shapes (edges, planar wires, faces or shells) serving as base object +
|
||||
list of locations (vertices) on the path corresponding specified list of the shapes +
|
||||
1 shape (edge or wire) for definition of the path +
|
||||
2 bool parameters (withContact, withCorrection).
|
||||
2 Boolean parameters (withContact, withCorrection).
|
||||
\n <b>Advanced options</b> \ref preview_anchor "Preview"
|
||||
|
||||
\image html pipe3.png
|
||||
|
||||
<b>Example:</b>
|
||||
|
||||
\image html pipe3_init.png "Initial objects"
|
||||
\image html pipe3_init.png "Base objects and Location vertices"
|
||||
|
||||
\image html pipe3_res.png "Extrusion of the profile shapes along the path shape"
|
||||
|
||||
|
||||
@ -2,21 +2,30 @@
|
||||
|
||||
\page create_isoline_page Isoline
|
||||
|
||||
To create an \b Isoline in the <b>Main Menu</b> select <b>New Entity - >
|
||||
Basic - > Isoline</b>
|
||||
\b Isoline is a 3D curve built on a bounded face limited by <em> [Umin, Umax] </em> and <em> [Vmin, Vmax] </em>
|
||||
values of U and V parameters. For all points of the isoline U or V parameter value is constant.
|
||||
|
||||
\n The \b Result of this operation will be a GEOM_Object.
|
||||
It may be either an edge or a compound of several edges.
|
||||
|
||||
\n You can define an Isoline by a \b Face, \b Type and \b Parameter.
|
||||
\n <b>TUI Command:</b> <em>geompy.MakeIsoline(theFace, IsUIsoline, theParameter)</em>
|
||||
\n <b>Arguments:</b> Name + Face + Type (True for U-Isoline; False for V-Isoline) + Parameter.
|
||||
To create an \b Isoline of a face in the <b>Main Menu</b> select <b>New Entity - > Basic - > Isoline</b>.
|
||||
|
||||
\image html isoline1.png
|
||||
|
||||
In this dialog:
|
||||
- Input or accept the default \b Name of the resulting shape.
|
||||
- Click the arrow button and select in the Object Browser or in the Viewer the \b Face, for which the Isoline is built.
|
||||
- Select along which coordinate: \b U-Isoline or \b V-Isoline the Isoline is built;
|
||||
- Set \b Parameter (ranging from 0 to 1), which defines the proportion, at which a face is divided by the isoline.
|
||||
If Parameter=0.5, the isoline is a median.
|
||||
- Press "Apply" or "Apply & Close" button to get the result (an edge or a compound of several edges).
|
||||
|
||||
This operation can be performed using a <b>TUI Command:</b>
|
||||
|
||||
<em>geompy.MakeIsoline(theFace, IsUIsoline, theParameter)</em>
|
||||
|
||||
<b>Arguments:</b> Name + Face + Type (True for U-Isoline; False for V-Isoline) + Parameter.
|
||||
|
||||
<b>Example:</b>
|
||||
|
||||
\image html isoline2.png "Isoline on face"
|
||||
\image html isoline2.png "Isoline on a rectangle face"
|
||||
|
||||
Our <b>TUI Scripts</b> provide you with useful examples of creation of
|
||||
\ref tui_creation_curve "Basic Geometric Objects".
|
||||
|
||||
@ -1,18 +1,15 @@
|
||||
/*!
|
||||
|
||||
\page create_smoothingsurface_page SmoothingSurface
|
||||
\page create_smoothingsurface_page Smoothing Surface
|
||||
|
||||
To create a \b SmoothingSurface in the <b>Main Menu</b> select <b>New Entity - >
|
||||
To create a <b> Smoothing Surface</b> in the <b>Main Menu</b> select <b>New Entity - >
|
||||
Advanced - > SmoothingSurface </b>
|
||||
|
||||
Specify the parameters of the SmoothingSurface object creation in the opened dialog
|
||||
box and press "Apply" or "Apply & Close" button.
|
||||
Result of each operation will be a GEOM_Object.
|
||||
Specify the \b Name of the surface and the list of \b Points, from which it is approximated and press "Apply" or "Apply & Close" button.
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeSmoothingSurface(lPoints)</em>
|
||||
The result of the operation will be a GEOM_Object(Surface).
|
||||
|
||||
<b>Arguments:</b>
|
||||
- \b Points - list of points
|
||||
<b>TUI Command:</b> <em>geompy.MakeSmoothingSurface(Points)</em>
|
||||
|
||||
\image html smoothingsurface_dlg.png
|
||||
|
||||
|
||||
@ -2,29 +2,37 @@
|
||||
|
||||
\page cut_operation_page Cut
|
||||
|
||||
To produce a \b Cut operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Cut</b>
|
||||
\b Cut operation cuts a shape with a list of other shapes.
|
||||
|
||||
This operation cuts a shape with a list of other shapes.
|
||||
|
||||
The \b Result will be a \b GEOM_Object.
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte)</em>\n
|
||||
<b>Arguments:</b> Name + a main shape + a list of other shapes + an optional flag for self-intersection check.\n
|
||||
<b>Advanced option:</b>
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
To produce it, select in the main menu <b>Operations - > Boolean - > Cut</b>
|
||||
|
||||
\image html bool3.png "Cut dialog"
|
||||
|
||||
\note This algorithm doesn't find all types of self-intersections. It is tuned
|
||||
In this dialog:
|
||||
- Input or accept the default \b Name of the resulting shape.
|
||||
- Click the arrow button and select in the Object Browser or in the Viewer the <b>Main Object</b>, which will be cut by tool objects.
|
||||
- Select the <b>Tool objects</b>, which will cut the main object.
|
||||
- Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>.
|
||||
- Activate \ref restore_presentation_parameters_page "Advanced options" if required.
|
||||
- Press "Apply" or "Apply & Close" button to get the result (GEOM_Object).
|
||||
|
||||
\note This algorithm does not find all types of self-intersections. It is tuned
|
||||
to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
|
||||
intersections. Face/face intersections detection is switched off as it
|
||||
is a time-consuming operation that gives an impact on performance. To find
|
||||
all self-intersections please use \ref check_self_intersections_page
|
||||
all self-intersections use \ref check_self_intersections_page
|
||||
"Detect Self-intersection tool".
|
||||
|
||||
For a particular case with two shapes (object and tool) for the Cut operation there is the following TUI command:
|
||||
This operation can be performed using a <b>TUI Command:</b>
|
||||
|
||||
<em>geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte)</em>
|
||||
|
||||
<b>Arguments:</b> Name + a main shape + a list of other shapes + an optional flag for self-intersection check.
|
||||
|
||||
There is also a special <b>TUI Command:</b> for the Cut operation on two shapes (object and tool) :
|
||||
|
||||
<em>geompy.MakeCut(s1, s2, checkSelfInte)</em>
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeCut(s1, s2, checkSelfInte)</em>\n
|
||||
<b>Arguments:</b> Name + the object + the tool + an optional flag for self-intersection check.
|
||||
|
||||
<b>Example:</b>
|
||||
@ -38,8 +46,7 @@ Our <b>TUI Scripts</b> provide you with useful examples of the use of
|
||||
|
||||
<b> More details </b>
|
||||
|
||||
For a detailed description of the Boolean operations please refer to
|
||||
<a href="SALOME_BOA_PA.pdf">this document</a>.
|
||||
Please refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
|
||||
It provides a general review of the Partition and Boolean
|
||||
operations algorithms, describes the usage methodology and highlights
|
||||
major limitations of these operations.
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
/*!
|
||||
|
||||
\page export_xao_page Export XAO
|
||||
|
||||
To export a shape in the \b XAO format, in the <b>Main Menu</b> select <b>New Entity ->
|
||||
Import / Export -> Export XAO </b>
|
||||
|
||||
Specify the parameters of the Export XAO dialog box and press "Apply" or "Apply & Close" button.
|
||||
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeExportXAO(Shape, FileName, Groups, Fields)</em>
|
||||
|
||||
<b>Arguments:</b>
|
||||
- \b Shape - The shape to export
|
||||
- \b FileName - The name of the file to create
|
||||
- \b Groups - The list of groups to export
|
||||
- \b Fields - The list of fields to export
|
||||
|
||||
\image html exportxao_dlg.png
|
||||
|
||||
*/
|
||||
@ -2,30 +2,36 @@
|
||||
|
||||
\page fuse_operation_page Fuse
|
||||
|
||||
To produce a \b Fuse operation in the <b>Main Menu</b> select
|
||||
<b>Operations - > Boolean - > Fuse</b>.
|
||||
\b Fuse operation creates one shape from a list of shapes.
|
||||
|
||||
This operation creates one shape from a list of shapes.
|
||||
|
||||
The \b Result will be a \b GEOM_Object.
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeFuseList(theShapesList, checkSelfInte)</em>\n
|
||||
<b>Arguments:</b> Name + a list of shapes + an optional flag for self-intersection check.\n
|
||||
<b>Advanced option:</b>
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
To produce it, select in the Main Menu <b>Operations - > Boolean - > Fuse</b>.
|
||||
|
||||
\image html bool1.png "Fuse dialog"
|
||||
|
||||
\note This algorithm doesn't find all types of self-intersections. It is tuned
|
||||
In this dialog:
|
||||
- Input or accept the default \b Name of the resulting shape.
|
||||
- Click the arrow button and select in the Object Browser or in the Viewer the <b>Objects</b> to be fused.
|
||||
- Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>.
|
||||
- Activate \ref restore_presentation_parameters_page "Advanced options" if required.
|
||||
- Press "Apply" or "Apply & Close" button to get the result (GEOM_Object).
|
||||
|
||||
\note This algorithm does not find all types of self-intersections. It is tuned
|
||||
to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
|
||||
intersections. Face/face intersections detection is switched off as it
|
||||
is a time-consuming operation that gives an impact on performance. To find
|
||||
all self-intersections please use \ref check_self_intersections_page
|
||||
all self-intersections use \ref check_self_intersections_page
|
||||
"Detect Self-intersection tool".
|
||||
|
||||
For a particular case with two shapes to be fused there is the following TUI command:
|
||||
This operation can be performed using a <b>TUI Command:</b>
|
||||
|
||||
<em>geompy.MakeFuseList(theShapesList, checkSelfInte)</em>
|
||||
|
||||
<b>Arguments:</b> Name + a list of shapes + an optional flag for self-intersection check.
|
||||
|
||||
There is also a special <b>TUI Command</b> for \b Fuse operation on two shapes :
|
||||
|
||||
<em>geompy.MakeFuse(s1, s2, checkSelfInte)</em>
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeFuse(s1, s2, checkSelfInte)</em>\n
|
||||
<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.
|
||||
|
||||
<b>Example:</b>
|
||||
@ -38,13 +44,13 @@ Our <b>TUI Scripts</b> provide you with useful examples of the use of
|
||||
\ref tui_fuse "Boolean Operations".
|
||||
|
||||
<b> More details </b>
|
||||
<ul>
|
||||
<li>For a detailed description of the Boolean operations please refer to
|
||||
<a href="SALOME_BOA_PA.pdf">this document</a>.
|
||||
|
||||
Please, refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
|
||||
|
||||
It provides a general review of the Partition and Boolean
|
||||
operations algorithms, describes the usage methodology and highlights
|
||||
major limitations of these operations.</li>
|
||||
<li>Perhaps you also ask yourself : \ref partition_explanation "What is the difference between partition, compounds and fuse operation ?"</li>
|
||||
</ul>
|
||||
major limitations of these operations.
|
||||
|
||||
Perhaps you also ask yourself : \ref partition_explanation "What is the difference between partition, compounds and fuse operation ?"
|
||||
|
||||
*/
|
||||
|
||||
@ -44,32 +44,32 @@ predefined materials.</li>
|
||||
<li><b>Isolines width</b> - allows to define default width of the isolines.</li>
|
||||
<li><b>Preview edges width</b> - allows to define width of the edges for preview.</li>
|
||||
<li><b>Measures line width</b> - allows to define lines width of measurements tools.</li>
|
||||
<li><b>Automatic bring to front</b> - when option is ON: the objects selected by the user will be automatically
|
||||
made "top-level".</li>
|
||||
<li><b>Automatic bring to front</b> - when the option is on, the objects selected by the user automatically become "top-level".</li>
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><b>Number of isolines</b></li> - this submenu allows to specify the
|
||||
number of isolines along the axes of coordinates:
|
||||
<ul>
|
||||
<li><b>Along U</b>
|
||||
<li><b>Along V</b>
|
||||
</ul>
|
||||
<li><b>Number of isolines</b> - allows to specify the number of isolines along <b>Along U</b> and <b>Along V</b> coordinate axes. They are shown on each selected face. For example:
|
||||
|
||||
\image html isos.png
|
||||
|
||||
This preference is not related with <b>Create Isoline</b> operation.
|
||||
By default <b>Along U</b> and <b>Along V</b> are null and isolines are not drawn. </li>
|
||||
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><b>Input fields precision</b></li>
|
||||
<ul>
|
||||
<li><b>Length precision</b> - allows to ajust input precision of coordinates and dimensions.</li>
|
||||
<li><b>Angular precision</b> - allows to ajust input precision of angles.</li>
|
||||
<li><b>Length tolerance precision</b> - allows to ajust input precision of tolerance of coordinates and dimensions.</li>
|
||||
<li><b>Angular tolerance precision</b> - allows to ajust input precision of tolerance of angles.</li>
|
||||
<li><b>Weight precision</b> - allows to ajust input precision of weight and mass.</li>
|
||||
<li><b>Density precision</b> - allows to ajust input precision of density.</li>
|
||||
<li><b>Parametric precision</b> - allows to ajust input precision of parametric values.</li>
|
||||
<li><b>Parametric tolerance precision</b> - allows to ajust input precision of tolerance in parametric space.</li>
|
||||
<li><b>Length precision</b> - allows to adjust input precision of coordinates and dimensions.</li>
|
||||
<li><b>Angular precision</b> - allows to adjust input precision of angles.</li>
|
||||
<li><b>Length tolerance precision</b> - allows to adjust input precision of tolerance of coordinates and dimensions.</li>
|
||||
<li><b>Angular tolerance precision</b> - allows to adjust input precision of tolerance of angles.</li>
|
||||
<li><b>Weight precision</b> - allows to adjust input precision of weight and mass.</li>
|
||||
<li><b>Density precision</b> - allows to a just input precision of density.</li>
|
||||
<li><b>Parametric precision</b> - allows to adjust input precision of parametric values.</li>
|
||||
<li><b>Parametric tolerance precision</b> - allows to adjust input precision of tolerance in parametric space.</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -8,6 +8,8 @@ are implemented via plug-ins, which gives the opportunity to
|
||||
expand the range of available formats by adding more plug-ins (for
|
||||
example, CATIA 5).
|
||||
|
||||
The \subpage xao_format_page "import and export of shapes in XAO format" is implemented differently.
|
||||
|
||||
<em>To import geometrical objects from a BREP, IGES, STEP, ACIS or STL file:</em>
|
||||
|
||||
\par
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
/*!
|
||||
|
||||
\page import_xao_page Import XAO
|
||||
|
||||
To import a shape in the \b XAO format, in the <b>Main Menu</b> select <b>New Entity ->
|
||||
Import / Export -> Import XAO </b>
|
||||
|
||||
*/
|
||||
@ -14,17 +14,14 @@
|
||||
- \subpage transform_geom_obj_page "transformation of geometrical objects"
|
||||
using various algorithms;
|
||||
- \subpage repairing_operations_page "optimization of geometrical objects";
|
||||
- viewing \subpage geometrical_obj_prop_page "geometrical object properties"
|
||||
and other information about geometrical objects using
|
||||
- viewing information about geometrical objects using
|
||||
\subpage using_measurement_tools_page "measurement tools";
|
||||
- \subpage pictures_page "designing shapes from pictures";
|
||||
- easily setting parameters via the variables predefined in
|
||||
|
||||
It is possible to easily set parameters via the variables predefined in
|
||||
\subpage using_notebook_geom_page "SALOME notebook".
|
||||
|
||||
The possibility to classify the created geometrical objects by moving it into early created container (folder) is detailed on
|
||||
\subpage arranging_study_objects_page section.
|
||||
|
||||
XAO format describing a shape with its topology, groups and fields is detailed on \subpage xao_format_page section.
|
||||
Also, there is a possibility to customize an
|
||||
\subpage arranging_study_objects_page "arrangement of the geometrical objects in the SALOME study."
|
||||
|
||||
Geometry module preferences are described in the
|
||||
\subpage geometry_preferences_page section of SALOME Geometry Help.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/*!
|
||||
|
||||
\page material_page Material properties
|
||||
\page material_page Material
|
||||
|
||||
<ul>
|
||||
<li>\ref material_general_description_anchor "General Description"</li>
|
||||
@ -16,12 +16,11 @@
|
||||
be changed in the future versions of SALOME Geometry module.
|
||||
|
||||
You can change the material properties of the selected shape(s) in
|
||||
the dedicated dialog box. This dialog box can be invoked from the
|
||||
context popup menu. The layout of context menu can be customized via
|
||||
the context menu dialog. The layout of context menu can be customized via
|
||||
"Show predefined materials in popup menu" preferences option.
|
||||
If this option is switched off, only "Material properties" item will
|
||||
be shown in the popup menu. If this option is on (by default), "Material
|
||||
properties" item in the popup menu will open a submenu with list of predefined
|
||||
properties" item in the popup menu will open a sub-menu with a list of predefined
|
||||
materials:
|
||||
|
||||
\image html hide_predef_material.png
|
||||
@ -44,9 +43,9 @@ the materials is different:
|
||||
- shape presentation in OCC and VTK viewers is not fully identical;
|
||||
- some material attributes can affect the presentation in a different way.
|
||||
|
||||
\anchor material_opengl_model_anchor <h2>OpenGL ligthing model</h2>
|
||||
\anchor material_opengl_model_anchor <h2>OpenGL lighting model</h2>
|
||||
|
||||
The material is specifed by several attributes of the lighting
|
||||
The material is specified by several attributes of the lighting
|
||||
model. More details can be found in the documentation related to the
|
||||
OpenGL programming, for example, here: http://www.glprogramming.com/red/chapter05.html.
|
||||
|
||||
@ -54,7 +53,7 @@ In the OpenGL lighting model, the light in a scene comes from several
|
||||
light sources; the light sources have an effect only when there are
|
||||
surfaces that absorb and reflect light. Each surface is assumed to be
|
||||
composed of a material with various properties. A material might emit
|
||||
its own light (like headlights on an automobile), it might scatter
|
||||
its own light (like headlights of a vehicle), it might scatter
|
||||
some incoming light in all directions, and it might reflect a
|
||||
portion of the incoming light in a preferential direction like a
|
||||
mirror or other shiny surface.
|
||||
@ -120,7 +119,7 @@ predefined and custom.
|
||||
models are specified by the user and can be modified at any moment.
|
||||
</li>
|
||||
|
||||
<li>The widgets to the right allow modifyng different properties of the material model:
|
||||
<li>The widgets to the right allow modifying different properties of the material model:
|
||||
- \b Ambient color and coefficient (floating point value between 0 and 1)
|
||||
- \b Diffuse color and coefficient (floating point value between 0 and 1)
|
||||
- \b Specular color and coefficient (floating point value between 0 and 1)
|
||||
@ -143,7 +142,7 @@ to change the name of material model.</li>
|
||||
\image html material.png
|
||||
|
||||
In addition to the functionality of <b>Materials library</b>, this
|
||||
dialog provides objects selection mechanizm and \b Color property.
|
||||
dialog provides objects selection mechanism and \b Color property.
|
||||
|
||||
If the material model is specified as a \em physical (\em Gold,
|
||||
for example), the shape color (more precisely its \em ambient color)
|
||||
@ -151,7 +150,7 @@ cannot be modified. If you assign a physical material model to the
|
||||
shape, the "Color" menu item will not be available in the popup menu.
|
||||
|
||||
If the model is non-physical (\em artificial), the color can be changed
|
||||
to any appopriate one, only other attributes will be constant. In the
|
||||
to any appropriate one, only other attributes will be constant. In the
|
||||
dialog box you will be able to modify the color of the shape via the
|
||||
"Color" button. "Ambient color" button will be disabled to signalize
|
||||
that this attribute of the model is ignored. Also, it will be possible
|
||||
|
||||
@ -2,15 +2,11 @@
|
||||
|
||||
\page partition_page Partition
|
||||
|
||||
<ul>
|
||||
<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 highlights
|
||||
major limitations of these operations.</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 highlights
|
||||
major limitations of these operations.
|
||||
|
||||
<li>Perhaps you also ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"</li>
|
||||
</ul>
|
||||
Perhaps you also ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"
|
||||
|
||||
To produce a \b Partition in the <b>Main Menu</b> select <b>Operations - > Partition</b>
|
||||
|
||||
@ -28,7 +24,7 @@ Resulting Type of shape.
|
||||
|
||||
As far as the intersection of two objects can produce any type of
|
||||
geometrical objects, <b>Resulting type</b> box allows choosing the
|
||||
preferrable result, i.e. a solid, a shell, a list of faces, etc.
|
||||
preferable result, i.e. a solid, a shell, a list of faces, etc.
|
||||
|
||||
The <b>Resulting type</b> has to be equal or lower than the type of the
|
||||
\em Objects. In other words, if the \em Objects don't contain any
|
||||
@ -47,28 +43,27 @@ face (there will be a hole in the resulting face, where the original
|
||||
face intersects with the box, see the corresponding \ref partition_picture_3 "picture" below).
|
||||
|
||||
<b>No sub-shapes intersection (Compounds only)</b> check box affects
|
||||
only input shapes of the Compound type. If this option is switched off (default
|
||||
behavior) each input compound will be automatically exploded into
|
||||
sub-shapes and the intersection between these shapes will be also
|
||||
computed. If this option is switched on, the intersection between
|
||||
sub-shapes will not be performed. In this case the Partition algorithm
|
||||
will work faster, but the result might differ from the default behavior.
|
||||
only input shapes of the Compound type.
|
||||
- If this option is switched off (default behavior) each input compound will be automatically
|
||||
exploded into sub-shapes and the intersection between these shapes will be also computed.
|
||||
- If this option is switched on, the intersection between sub-shapes will not be performed.
|
||||
In this case the Partition algorithm will work faster, but the result might differ from the
|
||||
default behavior.
|
||||
|
||||
<b>Detect Self-intersections</b> check box is used to check arguments
|
||||
self-intersections. If this option is switched on (default behavior)
|
||||
each input shape is checked for self-intersection. In case of its detection
|
||||
the operation is aborted. If this option is switched off, the partition
|
||||
algorithm is performed without self-intersection checks.
|
||||
<b>Detect Self-intersections</b> check box is used to check self-intersection of arguments.
|
||||
- If this option is switched on (by default), each input shape is checked for self-intersection.
|
||||
If self-intersection is detected, the operation is aborted.
|
||||
- If this option is switched off, the partition algorithm is performed without self-intersection
|
||||
checks.
|
||||
|
||||
\note This algorithm doesn't find all types of self-intersections. It is tuned
|
||||
\note This algorithm does not find all types of self-intersections. It is tuned
|
||||
to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
|
||||
intersections. Face/face intersections detection is switched off as it
|
||||
is a time-consuming operation that gives an impact on performance. To find
|
||||
all self-intersections please use \ref check_self_intersections_page
|
||||
"Detect Self-intersection tool".
|
||||
|
||||
<b>Advanced option:</b>
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
- Activate \ref restore_presentation_parameters_page "Advanced options" if required.
|
||||
|
||||
\note Partition is a complex operation, so its result of it depends
|
||||
on the quality of the initial shapes. Sometimes, if partition fails,
|
||||
@ -95,7 +90,7 @@ Here,
|
||||
- \em Limit is a Type of resulting shapes
|
||||
- \em KeepNonlimitShapes is a flag that allows to preserve standalone
|
||||
shapes of low dimension (than \em Limit) in the result.
|
||||
- \em checkSelfInte is a flag that tells if the arguments should
|
||||
- \em checkSelfInte is a flag that indicates if the arguments should
|
||||
be checked for self-intersection prior to the operation.
|
||||
- Other parameters are obsolete and kept only for compatibility with
|
||||
previous versions of SALOME.
|
||||
@ -106,15 +101,14 @@ previous versions of SALOME.
|
||||
|
||||
<b>Arguments:</b> Name + 1 shape to be intersected + 1 cutting plane.
|
||||
|
||||
<b>Advanced option:</b>
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
Activate \ref restore_presentation_parameters_page "Advanced options" if required.
|
||||
|
||||
<b>TUI Command:</b>
|
||||
|
||||
<em>geompy.MakeHalfPartition(Shape, Plane, checkSelfInte)</em>, where:
|
||||
- \em Shape is a source shape to be intersected by the \em Plane
|
||||
- \em Plane is a tool shape, to intersect the \em Shape.
|
||||
- \em checkSelfInte is a flag that tells if the arguments should
|
||||
- \em checkSelfInte is a flag that indicates if the arguments should
|
||||
be checked for self-intersection prior to the operation.
|
||||
|
||||
<b>Examples:</b>
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
<b>Repair - > Remove internal faces</b>.
|
||||
|
||||
\n This operation removes all shared faces from a compound to obtain
|
||||
one or more bigger solids from the set of smaller solids.
|
||||
one or more bigger solids from a set of smaller solids.
|
||||
|
||||
\image html remove_webs.png
|
||||
|
||||
@ -15,8 +15,8 @@ one or more bigger solids from the set of smaller solids.
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
|
||||
\note Only shared faces will be removed. Coincident but not shared
|
||||
faces will stay as is, use GlueFaces or MakePartition before
|
||||
RemoveInternalFaces if you need to remove them.
|
||||
faces will stay as is, use Glue Faces or Partition before
|
||||
Remove Internal Faces if you need to remove them.
|
||||
|
||||
\n <b>TUI Command:</b> <em>geompy.RemoveInternalFaces(theCompound)</em>,
|
||||
where <em>theCompound</em> is a compound of solids.
|
||||
|
||||
@ -26,15 +26,15 @@ splits an edge in two.</li>
|
||||
<li>\subpage change_orientation_operation_page "Change orientation" -
|
||||
reverses the normals of the selected faces.</li>
|
||||
<li>\subpage remove_webs_operation_page "Remove internal faces" -
|
||||
rebuilds the topology of a compound of solids by removing of the faces
|
||||
that are shared by several solids.</li>
|
||||
rebuilds the topology of a compound of solids by removing the faces
|
||||
are shared by several solids.</li>
|
||||
<li>\subpage remove_extra_edges_operation_page "Remove extra edges" -
|
||||
removes seam and degenerated edges from the given shape.</li>
|
||||
<li>\subpage fuse_edges_operation_page "Fuse Collinear Edges within a Wire" -
|
||||
removes selected vertices from a given wire in case if adjacent edges
|
||||
are C1 continuous.</li>
|
||||
<li>\subpage union_faces_operation_page "Union faces" -
|
||||
unites all faces sharing one surface on a given shape.</li>
|
||||
unites on a given shape all faces sharing the same surface.</li>
|
||||
</ul>
|
||||
|
||||
*/
|
||||
|
||||
@ -2,27 +2,32 @@
|
||||
|
||||
\page section_opeartion_page Section
|
||||
|
||||
To produce a \b Section operation in the <b>Main Menu</b> select
|
||||
<b>Operations - > Boolean - > Section</b>
|
||||
\b Section operation creates an edge or a wire representing the intersection of surfaces of two shapes.
|
||||
|
||||
This operation creates the section between 2 shapes.
|
||||
|
||||
The \b Result will be any \b GEOM_Object (EDGE or WIRE).
|
||||
|
||||
<b>TUI Command:</b> <em>geompy.MakeSection(s1, s2, checkSelfInte)</em>\n
|
||||
<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.\n
|
||||
<b>Advanced option:</b>
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
To produce it, select in the main menu <b>Operations - > Boolean - > Section</b>
|
||||
|
||||
\image html neo-section.png "Section dialog"
|
||||
|
||||
\note This algorithm doesn't find all types of self-intersections. It is tuned
|
||||
In this dialog:
|
||||
- Input or accept the default \b Name of the resulting shape.
|
||||
- Click the arrow button and select in the Object Browser or in the Viewer the intersecting <b>Objects</b>.
|
||||
- Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>.
|
||||
- Activate \ref restore_presentation_parameters_page "Advanced options" if required.
|
||||
- Press "Apply" or "Apply & Close" button to get the result (EDGE or WIRE).
|
||||
|
||||
\note This algorithm does not find all types of self-intersections. It is tuned
|
||||
to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
|
||||
intersections. Face/face intersections detection is switched off as it
|
||||
is a time-consuming operation that gives an impact on performance. To find
|
||||
all self-intersections please use \ref check_self_intersections_page
|
||||
all self-intersections use \ref check_self_intersections_page
|
||||
"Detect Self-intersection tool".
|
||||
|
||||
This operation can be performed using a <b>TUI Command:</b>
|
||||
|
||||
<em>geompy.MakeSection(s1, s2, checkSelfInte)</em>
|
||||
|
||||
<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.
|
||||
|
||||
<b>Example:</b>
|
||||
|
||||
\image html fusesn1.png "The initial shapes"
|
||||
@ -34,8 +39,7 @@ Our <b>TUI Scripts</b> provide you with useful examples of the use of
|
||||
|
||||
<b> More details </b>
|
||||
|
||||
For a detailed description of the Boolean operations please refer to
|
||||
<a href="SALOME_BOA_PA.pdf">this document</a>.
|
||||
Please refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
|
||||
It provides a general review of the Partition and Boolean
|
||||
operations algorithms, describes the usage methodology and highlights
|
||||
major limitations of these operations.
|
||||
|
||||
@ -2,26 +2,28 @@
|
||||
|
||||
\page sewing_operation_page Sewing
|
||||
|
||||
\n To produce a \b Sewing operation in the <b>Main Menu</b> select <b>Repair - > Sewing</b>.
|
||||
To produce a \b Sewing operation in the <b>Main Menu</b> select <b>Repair - > Sewing</b>.
|
||||
|
||||
\n It is possible to sew only compounds of faces or shells.
|
||||
|
||||
\n The \b Result will be a \b GEOM_Object.
|
||||
|
||||
\n <b>TUI Command:</b> <em>geompy.MakeSewing(ListOfShape, Precision, AllowNonManifold=False),</em>
|
||||
where \em ListOfShape is list of faces or shells to be sewed, \em Precision is a
|
||||
precision for sewing, \em AllowNonManifold flag that allows non-manifold sewing.
|
||||
The \b Result will be a \b GEOM_Object.
|
||||
|
||||
\image html repair6.png
|
||||
|
||||
\n <b>Arguments:</b> Name + 1 or more shapes + 1 value (sew
|
||||
precision).
|
||||
\n \b Detect button allows to display the number of free boundaries in
|
||||
your shape:
|
||||
|
||||
In this dialog:
|
||||
- Click on the "Arrow" button and select in the Object Browser or in the viewer one or more \b Shapes (faces or shells) to be sewn.
|
||||
- Activate <b>Allow Non Manifold </b> check-box to produce non-manifold sewing, if required.
|
||||
- Define precision for sewing in \b Tolerance field.
|
||||
- Activate <b> Detect Free boundaries</b> button to display the number of free boundaries in the shape:
|
||||
\image html neo-detect2.png
|
||||
- Click \b Apply or <b>Apply and Close</b> button.
|
||||
|
||||
\n <b>Example:</b>
|
||||
This operation can be also launched using a <b>TUI Command:</b>
|
||||
|
||||
<em>geompy.MakeSewing(ListOfShape, Precision, AllowNonManifold=False),</em>
|
||||
|
||||
where \em ListOfShape is a list of faces or shells to be sewn, \em Precision is a
|
||||
precision for sewing, \em AllowNonManifold is a flag that allows non-manifold sewing.
|
||||
|
||||
<b>Example:</b>
|
||||
|
||||
\image html image112.png "The initial faces"
|
||||
|
||||
|
||||
@ -2,20 +2,21 @@
|
||||
|
||||
\page union_faces_operation_page Union Faces
|
||||
|
||||
\n To <b>Union Faces</b> in the <b>Main Menu</b> select
|
||||
<b>Repair - > Union Faces</b>.
|
||||
\n This operation unites all faces sharing one surface on a given
|
||||
shape.
|
||||
This operation unites on a given shape all faces sharing the same surface.
|
||||
|
||||
\n <b>TUI Command:</b> <em>geompy.UnionFaces(theShape)</em>,
|
||||
where <em>theShape</em> is a compound or a single solid.
|
||||
\n <b>Arguments:</b> Name + one shape + a flag.
|
||||
\n <b>Advanced option:</b>
|
||||
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
|
||||
To <b>Union Faces</b> in the <b>Main Menu</b> select <b>Repair - > Union Faces</b>.
|
||||
|
||||
\image html union_faces.png
|
||||
|
||||
\n <b>Example:</b>
|
||||
In this dialog:
|
||||
- Click on the "Arrow" button and select in the Object Browser or in the viewer one or more \b Shapes (compounds or single solids).
|
||||
- If necessary, activate \ref restore_presentation_parameters_page "Advanced Transformation Options".
|
||||
- Click \b Apply or <b>Apply and Close</b> button.
|
||||
|
||||
This operation can be also launched using a <b>TUI Command:</b> <em>geompy.UnionFaces(theShape)</em>,
|
||||
where <em>theShape</em> is a compound or a single solid.
|
||||
|
||||
<b>Example:</b>
|
||||
|
||||
\image html union_faces1.png
|
||||
<center><em>Shape with not united faces</em></center>
|
||||
|
||||
@ -2,10 +2,10 @@
|
||||
|
||||
\page using_boolean_operations_page Boolean Operations
|
||||
|
||||
For detail description of the Boolean operations please refer to
|
||||
For a detailed description of Boolean operations 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.
|
||||
|
||||
You can use the following boolean operations for construction of more
|
||||
@ -44,7 +44,7 @@ operation.
|
||||
\par
|
||||
<em>geompy.MakeBoolean(Shape1, Shape2, Operation, checkSelfInte),</em> where \em
|
||||
Shape1 is the first argument and \em Shape2 is the second argument of
|
||||
Boolean operation, \em Operation is a type of the Boolean operation (1
|
||||
a Boolean operation, \em Operation is the type of a Boolean operation (1
|
||||
— Common, 2 — Cut, 3 — Fuse, 4 — Section).
|
||||
|
||||
|
||||
@ -60,17 +60,17 @@ argument and \em Shape2 is the second argument of Common operation;
|
||||
<em>geompy.MakeCut(Shape1, Shape2, checkSelfInte)</em>, where \em Shape1 is the first
|
||||
argument and \em Shape2 is the second argument of Cut operation;
|
||||
|
||||
The flag \em checkSelfInte tells whether arguments should be checked for
|
||||
self-intersection prior to an operation. Its default value is \em False which
|
||||
The flag \em checkSelfInte indicates whether the arguments should be checked for
|
||||
self-intersection prior to an operation. Its default value is \em False, which
|
||||
means that there is no need to check it. This option is provided to ensure that
|
||||
an operation is performed on not self-intersected shapes as these shapes are
|
||||
an operation is performed on not self-intersected shapes as they are
|
||||
not valid for boolean operations.
|
||||
|
||||
\note This algorithm doesn't find all types of self-intersections. It is tuned
|
||||
\note This algorithm does not find all types of self-intersections. It is tuned
|
||||
to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
|
||||
intersections. Face/face intersections detection is switched off as it
|
||||
is a time-consuming operation that gives an impact on performance. To find
|
||||
all self-intersections please use \ref check_self_intersections_page
|
||||
all self-intersections use \ref check_self_intersections_page
|
||||
"Detect Self-intersection tool".
|
||||
|
||||
Our <b>TUI Scripts</b> provide you with useful examples of the use of
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
/*!
|
||||
|
||||
\page using_measurement_tools_page Measuring objects properties
|
||||
\page using_measurement_tools_page Object properties
|
||||
|
||||
\n Measurement tools in GEOM are necessary for getting different data
|
||||
concerning created or imported geometrical objects :
|
||||
\n The key property of an object is its \subpage geometrical_obj_prop_page "Geometrical Type"
|
||||
|
||||
\n There are also various <b> Measurement tools </b> for getting data about created or imported geometrical objects :
|
||||
|
||||
<ul>
|
||||
<li>\subpage point_coordinates_page "Point coordinates"</li>
|
||||
|
||||
@ -101,10 +101,9 @@ and then displays only the children of the selected object(s).
|
||||
Switch the checkbox near the appropriate object and
|
||||
click <b>Publish</b> or <b>Publish And Close</b> button.
|
||||
|
||||
"Eye" icons in this dialog box allow previewing unpublished objects in the viewer. All
|
||||
unpublished objects are by default sorted by the name in ascending order. It is possible
|
||||
to change order of sorting (ascending / descending) by clicking the corresponding title
|
||||
bar of the objects list.
|
||||
"Eye" icons in this dialog box allow previewing unpublished objects in the viewer. By default all
|
||||
unpublished objects are sorted by name in ascending order. It is possible
|
||||
to change the order (ascending / descending) by clicking the corresponding title bar of the objects list.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -115,8 +114,7 @@ window providing some information on a selected geometric object:
|
||||
|
||||
- <b>Creation operation</b> shows a name of the operation
|
||||
used to create the selected object.
|
||||
- In a table under <b>Creation operation</b>, \b Parameter and \b
|
||||
Value are a name and a value of a parameter used to create the
|
||||
selected object.
|
||||
- The table below lists \b Parameters used to create the
|
||||
selected object and their \b Values.
|
||||
|
||||
*/
|
||||
|
||||
@ -1,10 +1,24 @@
|
||||
/*!
|
||||
|
||||
\page xao_format_page The XAO format
|
||||
\page xao_format_page Import and export of shapes in XAO format
|
||||
|
||||
XAO is a file format which describes a shape with its topology, groups and fields.
|
||||
|
||||
- \subpage export_xao_page "Export"
|
||||
- \subpage import_xao_page "Import"
|
||||
To import a shape in the \b XAO format, in the <b>Main Menu</b> select <b>New Entity ->
|
||||
Import / Export -> Import XAO. </b>
|
||||
|
||||
To export a shape in the \b XAO format, in the <b>Main Menu</b> select <b>New Entity ->
|
||||
Import / Export -> Export XAO. </b>
|
||||
|
||||
\image html exportxao_dlg.png
|
||||
|
||||
In this dialog:
|
||||
- Click the arrow button and select in the Object Browser or in the Viewer the <b>Shape</b> to be exported.
|
||||
- Input the <b>File name</b> to create a new file or click browse button to save in an existing file.
|
||||
- Select the \b Groups of the chosen shape to be exported.
|
||||
- Select the \b Fields of the chosen shape to be exported.
|
||||
- Press "Apply" or "Apply & Close" button to get the result.
|
||||
|
||||
It also possible to export a shape using the TUI Command: <em>geompy.MakeExportXAO(Shape, FileName, Groups, Fields)</em>
|
||||
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user