Salome HOME
projects
/
modules
/
shaper.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git]
/
src
/
FeaturesPlugin
/
doc
/
unionFeature.rst
diff --git
a/src/FeaturesPlugin/doc/unionFeature.rst
b/src/FeaturesPlugin/doc/unionFeature.rst
index 9a3cef4cda70d62d96c75efa4da788567e6a972e..989e9368477b16828be907694cf6a4171f46bf79 100644
(file)
--- a/
src/FeaturesPlugin/doc/unionFeature.rst
+++ b/
src/FeaturesPlugin/doc/unionFeature.rst
@@
-1,3
+1,4
@@
+.. |union_btn.icon| image:: images/union_btn.png
Union
=====
Union
=====
@@
-7,20
+8,13
@@
Union feature implements a Boolean operation for creation of a union of selected
To create a Union in the active part:
#. select in the Main Menu *Features - > Union* item or
To create a Union in the active part:
#. select in the Main Menu *Features - > Union* item or
-#. click **Union** button in the toolbar
-
-.. image:: images/union_btn.png
- :align: center
-
-.. centered::
- **Union** button
+#. click |union_btn.icon| **Union** button in the toolbar
The following property panel will be opened:
The following property panel will be opened:
-..
imag
e:: images/Union.png
- :align: center
+..
figur
e:: images/Union.png
+
:align: center
-.. centered::
**Union operation**
Here it is necessary to select some objects. Only faces with shared edges or solids with shared faces are allowed for selection.
**Union operation**
Here it is necessary to select some objects. Only faces with shared edges or solids with shared faces are allowed for selection.
@@
-29,19
+23,22
@@
Here it is necessary to select some objects. Only faces with shared edges or sol
**Cancel** button cancels the operation.
**Cancel** button cancels the operation.
-**TUI Command**: *model.addUnion(Part_doc, objects)*
+**TUI Command**:
+
+.. py:function:: model.addUnion(Part_doc, objects)
-**Arguments**: Part + list of objects.
+ :param part: The current part object.
+ :param objects: A list of objects.
+ :return: Result object.
Result
""""""
The Result of the operation will be a shape which is a union of selected objects:
Result
""""""
The Result of the operation will be a shape which is a union of selected objects:
-..
imag
e:: images/CreatedUnion.png
-
:align: center
+..
figur
e:: images/CreatedUnion.png
+ :align: center
-.. centered::
**Union created**
**See Also** a sample TUI Script of :ref:`tui_create_union` operation.
**Union created**
**See Also** a sample TUI Script of :ref:`tui_create_union` operation.