mirror of
https://git.salome-platform.org/gitpub/modules/geom.git
synced 2024-12-29 10:50:35 +05:00
Update GEOM documentation
This commit is contained in:
parent
a6bdfbd985
commit
bbf5ec60ee
@ -26,8 +26,8 @@ of the LCS are calculated automatically basing on the selected object.
|
|||||||
coordinates of origin by a point and axes directions by a line or a
|
coordinates of origin by a point and axes directions by a line or a
|
||||||
vector.
|
vector.
|
||||||
\n <b>TUI command:</b> <em>geompy.MakeMarkerPntTwoVec(Center, VectorX,
|
\n <b>TUI command:</b> <em>geompy.MakeMarkerPntTwoVec(Center, VectorX,
|
||||||
VectorY)</em> where Center is a point specified the coordinate system location,
|
VectorY)</em> where Center is the origin of the coordinate system,
|
||||||
VectorX is a derection of OX axis and VectorY direction of OY axis.
|
VectorX is the direction of OX axis and VectorY is the direction of OY axis.
|
||||||
\n <b>Arguments:</b> Name + 1 point of origin + X axis direction, Y axis direction.
|
\n <b>Arguments:</b> Name + 1 point of origin + X axis direction, Y axis direction.
|
||||||
|
|
||||||
\image html neo-localcs3.png
|
\image html neo-localcs3.png
|
||||||
@ -40,6 +40,6 @@ and in 3D viewer.
|
|||||||
|
|
||||||
\image html image145.png "Local Coordinate System"
|
\image html image145.png "Local Coordinate System"
|
||||||
|
|
||||||
<b>TUI Script</b> provide you with useful example of creation of
|
<b>TUI Script</b> provides you with a useful example of
|
||||||
\ref tui_creation_lcs "Local Coordinate System".
|
\ref tui_creation_lcs "Local Coordinate System" creation.
|
||||||
*/
|
*/
|
||||||
|
@ -5,23 +5,23 @@
|
|||||||
To create a \b PipeTShape in the <b>Main Menu</b> select <b>New Entity - >
|
To create a \b PipeTShape in the <b>Main Menu</b> select <b>New Entity - >
|
||||||
Advanced - > PipeTShape </b>
|
Advanced - > PipeTShape </b>
|
||||||
|
|
||||||
Specify the parameters of the PipeTShape object creation in the opened dialog
|
Specify the parameters of the PipeTShape object in the opened dialog
|
||||||
box and press "Apply" or "Apply & Close" button.
|
box and press "Apply" or "Apply & Close" button.
|
||||||
Result of each operation will be a GEOM_Object.
|
The <b>result</b> of the operation will be a <b>GEOM_Object</b>.
|
||||||
|
|
||||||
<b>TUI Command:</b> <em>geompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None)</em>
|
<b>TUI Command:</b> <em>geompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None)</em>
|
||||||
|
|
||||||
<b>Arguments:</b>
|
<b>Arguments:</b>
|
||||||
- \b R1 - Radius of main T-shape pipe.
|
- \b R1 - Radius of the main T-shape pipe.
|
||||||
- \b W1 - Thickness of main T-shape pipe.
|
- \b W1 - Thickness of the main T-shape pipe.
|
||||||
- \b L1 - Length of main T-shape pipe.
|
- \b L1 - Length of the main T-shape pipe.
|
||||||
- \b R2 - Radius of incident T-shape pipe.
|
- \b R2 - Radius of the incident T-shape pipe.
|
||||||
- \b W2 - Thickness of incident T-shape pipe.
|
- \b W2 - Thickness of the incident T-shape pipe.
|
||||||
- \b L2 - Length of incident T-shape pipe.
|
- \b L2 - Length of the incident T-shape pipe.
|
||||||
- \b HexMesh - If True, the shape is splitted in blocks (suitable for hexaedral mesh).
|
- \b HexMesh - If True, the shape is splitted into blocks (suitable for hexaedral mesh).
|
||||||
- \b P1 - First junction point of main pipe (GEOM Vertex).
|
- \b P1 - First junction point of the main pipe (GEOM Vertex).
|
||||||
- \b P2 - Second junction point of main pipe (GEOM Vertex).
|
- \b P2 - Second junction point of the main pipe (GEOM Vertex).
|
||||||
- \b P3 - Junction point of incident pipe (GEOM Vertex).
|
- \b P3 - Junction point of the incident pipe (GEOM Vertex).
|
||||||
|
|
||||||
\image html pipetshape_dlg.png
|
\image html pipetshape_dlg.png
|
||||||
|
|
||||||
@ -33,8 +33,8 @@ A Pipe T-Shape can be created with a chamfer at the junction of the main and the
|
|||||||
|
|
||||||
<b>TUI Command:</b> <em>geompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None)</em>
|
<b>TUI Command:</b> <em>geompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None)</em>
|
||||||
|
|
||||||
<b>Arguments are the same as normal Pipe T-Shape plus:</b>
|
<b>The arguments are the same as of the normal Pipe T-Shape plus:</b>
|
||||||
- \b H - Height of the chamfer along incident pipe.
|
- \b H - Height of the chamfer along the incident pipe.
|
||||||
- \b W - Width of the chamfer along the main pipe.
|
- \b W - Width of the chamfer along the main pipe.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
@ -45,7 +45,7 @@ A Pipe T-Shape can be created with a fillet at the junction of the main and the
|
|||||||
|
|
||||||
<b>TUI Command:</b> <em>geompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None)</em>
|
<b>TUI Command:</b> <em>geompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None)</em>
|
||||||
|
|
||||||
<b>Arguments are the same as normal Pipe T-Shape plus:</b>
|
<b>The arguments are the same as of the normal Pipe T-Shape plus:</b>
|
||||||
- \b RF - Radius of the fillet.
|
- \b RF - Radius of the fillet.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
@ -2,8 +2,8 @@
|
|||||||
|
|
||||||
\page deflection_page Deflection
|
\page deflection_page Deflection
|
||||||
|
|
||||||
\n In this menu you can change the deviation coefficient of the
|
\n In this menu you can change the deflection coefficient of the
|
||||||
shape. Smaller coefficient provides better quality of the shape in the
|
shape. The less is the coefficient the better is the quality of the shape in the
|
||||||
viewer.
|
viewer.
|
||||||
|
|
||||||
\n <b>Arguments: </b>1 floating point value (deviation coefficient).
|
\n <b>Arguments: </b>1 floating point value (deviation coefficient).
|
||||||
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
The <b>Type</b> property of the geometrical object specifies the
|
The <b>Type</b> property of the geometrical object specifies the
|
||||||
way the object has been created. It is an integer identifier that
|
way the object has been created. It is an integer identifier that
|
||||||
has predefined value depending on the function type used for the
|
has a predefined value depending on the function type used for the
|
||||||
object creation. The type of the object can be retrieved using the
|
object creation. The type of the object can be retrieved using the
|
||||||
\b %GetType() function of the \b GEOM_Object interface.
|
\b %GetType() function of the \b GEOM_Object interface.
|
||||||
|
|
||||||
@ -70,10 +70,9 @@ The possible values of the geometrical objects are listed in the table below:
|
|||||||
</table>
|
</table>
|
||||||
|
|
||||||
Also geompy.py module provides a helper function ShapeIdToType()
|
Also geompy.py module provides a helper function ShapeIdToType()
|
||||||
that allows converting of the geometrical object type id value
|
that allows converting the geometrical object id value to its string representation.
|
||||||
to its string representation.
|
|
||||||
|
|
||||||
For example:
|
For example, the output of the following code:
|
||||||
\code
|
\code
|
||||||
import geompy
|
import geompy
|
||||||
box = geompy.MakeBoxDXDYDZ(10,10,10)
|
box = geompy.MakeBoxDXDYDZ(10,10,10)
|
||||||
@ -81,12 +80,12 @@ type = geompy.ShapeIdToType(box.GetType())
|
|||||||
print type
|
print type
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
The above code prints "BOX" value.
|
will be the "BOX" value.
|
||||||
|
|
||||||
<b>GetShapeType function:</b>
|
<b>GetShapeType function:</b>
|
||||||
|
|
||||||
The ShapeType property specifies the geometrical object in terms of
|
The ShapeType property specifies the geometrical object in terms of
|
||||||
its topology nature.
|
its topologic nature.
|
||||||
|
|
||||||
The possible values are defined in the GEOM namespace: { COMPOUND, COMPSOLID,
|
The possible values are defined in the GEOM namespace: { COMPOUND, COMPSOLID,
|
||||||
SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE }<br>
|
SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE }<br>
|
||||||
@ -94,7 +93,7 @@ SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE }<br>
|
|||||||
This type can be retrieved using the \b %GetShapeType() function
|
This type can be retrieved using the \b %GetShapeType() function
|
||||||
of the \b GEOM_Object interface.
|
of the \b GEOM_Object interface.
|
||||||
|
|
||||||
Example code:
|
For example:
|
||||||
\code
|
\code
|
||||||
import geompy
|
import geompy
|
||||||
import GEOM
|
import GEOM
|
||||||
@ -103,6 +102,6 @@ type = box.GetShapeType()
|
|||||||
print type == GEOM.SOLID
|
print type == GEOM.SOLID
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
This code prints "True".
|
The result is "True".
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
@ -13,9 +13,11 @@ using a wide range of functions;</li>
|
|||||||
<li>\subpage transform_geom_obj_page "transformation of geometrical objects" using
|
<li>\subpage transform_geom_obj_page "transformation of geometrical objects" using
|
||||||
various algorithms;</li>
|
various algorithms;</li>
|
||||||
<li>\subpage repairing_operations_page "optimization of geometrical objects";</li>
|
<li>\subpage repairing_operations_page "optimization of geometrical objects";</li>
|
||||||
<li>\subpage geometrical_obj_prop_page "Geometrical object properties".</li>
|
<li>viewing \subpage geometrical_obj_prop_page "geometrical object properties".</li>
|
||||||
<li>\subpage using_measurement_tools_page "provision of information about geometrical objects".</li>
|
<li>and other information about geometrical objects using
|
||||||
<li>\subpage using_notebook_geom_page.</li>
|
\subpage using_measurement_tools_page "measurement tools".</li>
|
||||||
|
<li>easily setting parameters via the variables predefined in
|
||||||
|
\subpage using_notebook_geom_page "Salome notebook".</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
Almost all geometry module functionalities are accessible via
|
Almost all geometry module functionalities are accessible via
|
||||||
|
@ -1,8 +1,10 @@
|
|||||||
/*!
|
/*!
|
||||||
|
|
||||||
\page restore_presentation_parameters_page Restore presentation parameters and a tree of subshapes
|
\page restore_presentation_parameters_page Advanced Transformation Options
|
||||||
|
|
||||||
\n This functionality allows the operation result to inherit colour
|
<br><center><b>Set presentation parameters and subshapes from arguments</b></center>
|
||||||
|
|
||||||
|
\n This option allows the operation result to inherit colour
|
||||||
and subshapes from its arguments.
|
and subshapes from its arguments.
|
||||||
|
|
||||||
\n To activate this functionality, check in "Set
|
\n To activate this functionality, check in "Set
|
||||||
@ -38,7 +40,7 @@ operation arguments and their published subshapes. The resulting shape
|
|||||||
has a default colour, but its subshapes inherit colors corresponding
|
has a default colour, but its subshapes inherit colors corresponding
|
||||||
to arguments and their subshapes.
|
to arguments and their subshapes.
|
||||||
|
|
||||||
\image html restore-ss-viewer-after.png "Thev resulting shape"
|
\image html restore-ss-viewer-after.png "The resulting shape"
|
||||||
|
|
||||||
|
|
||||||
Please, note that when the resulting shape corresponds to one
|
Please, note that when the resulting shape corresponds to one
|
||||||
@ -51,12 +53,13 @@ inherited subshapes depend on the arguments.
|
|||||||
|
|
||||||
\image html restore-ss-OB.png
|
\image html restore-ss-OB.png
|
||||||
|
|
||||||
<br><center><b>Add prefix to names of restored subshapes</b></center>
|
|
||||||
Add prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored subshapes.
|
|
||||||
By default this option is On.
|
|
||||||
|
|
||||||
|
|
||||||
\n You can also call this functionality from your python scripts.
|
\n You can also call this functionality from your python scripts.
|
||||||
See our <b>TUI Scripts</b> for \ref tui_restore_prs_params "example".
|
See our <b>TUI Scripts</b> for \ref tui_restore_prs_params "example".
|
||||||
|
|
||||||
|
<br><center><b>Add prefix to names of restored subshapes</b></center>
|
||||||
|
This option allows adding the prefix "from_" to the names of
|
||||||
|
restored sub-shapes, and the prefix "from_subshapes_of_" to the names of partially restored subshapes.
|
||||||
|
By default this option is On.
|
||||||
|
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
@ -28,7 +28,7 @@ transparency of geometrical objects.</li>
|
|||||||
<li>\subpage isolines_page "Isos" - allows to change the number of
|
<li>\subpage isolines_page "Isos" - allows to change the number of
|
||||||
isolines displayed within a shape.</li>
|
isolines displayed within a shape.</li>
|
||||||
<li>\subpage deflection_page "Deflection" - allows to change the
|
<li>\subpage deflection_page "Deflection" - allows to change the
|
||||||
deviation coefficient of a shape.</li>
|
deflection coefficient of a shape.</li>
|
||||||
<li>\subpage point_marker_page "Point Marker" - allows to change the
|
<li>\subpage point_marker_page "Point Marker" - allows to change the
|
||||||
representation of geometrical vertices.</li>
|
representation of geometrical vertices.</li>
|
||||||
<li><b>Auto color</b> / <b>Disable auto color</b> - activates the auto color
|
<li><b>Auto color</b> / <b>Disable auto color</b> - activates the auto color
|
||||||
|
Loading…
Reference in New Issue
Block a user