Salome HOME
[EDF] (2023-T1) Filters on group
[modules/shaper.git] / src / FiltersPlugin / doc / FiltersPlugin.rst
index 3d9bbb4920e93119e76e41ea0bcae801fceb07f6..00c0c2791b939ea4b644e3a4688f6e0ee81e0933 100644 (file)
@@ -179,3 +179,22 @@ This algorithm finds all the faces topologically connected the argument selected
 - **Algorithm:**
     - If a point of an edge is selected as an argument, the result is all faces that contain this argument.If a face is selected, the result is all faces that have shared edges or vertices with this selection.
     - If “propagation” flag is enabled (it is disabled by default), the algorithm becomes recursive: all connected faces are added to the results. So, for the solid shape there will be all faces except internal-volumes faces, not connected to any external faces.
+
+**On shape name**
+
+- **Result type:** Any
+- **Arguments:** A string value, representing a pattern for searching by result name. The pattern can be the full name of result or its part. Pattern is case sensitive. There are several options for the pattern input:
+
+    - **Pattern*** to search for results with names matching from the beginning strictly. 
+    - ***Pattern** to search for results with names matching from the ending strictly. 
+    - **Pattern** to search for results with names containing this regular expression. 
+    - ***Pattern*** to search for results with names containing this regular expression. 
+- **Algorithm:**
+    - Returns objects that contain a pattern in their names or subobjects of these objects.
+    - For example, if we have in the result a shape with the name “cube” and we want to select all the edges according to the pattern "cube", then we will get all the edges of the object with name "cube".
+    - There are two examples: selecting all edges belonging to objects from the result with a name starting with "Cyl" and selecting all vertices belonging to objects from the result with a name containing pattern "Cube":
+.. figure:: images/selection_byShapeName1.png
+  :align: center
+
+.. figure:: images/selection_byShapeName2.png
+  :align: center