Salome HOME
[EDF] (2023-T1) Filters on group
[modules/shaper.git] / src / FiltersPlugin / doc / FiltersPlugin.rst
index 81b67a1dac2bf5debdb1c124ef9cc961daf5d8a6..0057248a124bfd8cccf089ab17a1a0298983eb6a 100644 (file)
@@ -57,6 +57,39 @@ By default, the result of Selection feature all selectable entities from all Sha
 - **Argument:** Any result object, multiple OR selection accepted
 - **Algorithm:** Returns only shapes that belong to selected results.
 
+**Edge size**
+
+- **Result type:** Edge
+- **Argument:** 
+    - **Comparator:** <, <=, >, >=, is between, is strictly between
+    - **Size** or  **Min size** and **Max size**
+- **Algorithm:** Returns all edges whose length respect comparator rules.
+
+**Face size**
+
+- **Result type:** Face
+- **Argument:** 
+    - **Comparator:** <, <=, >, >=, is between, is strictly between
+    - **Size** or  **Min size** and **Max size**
+- **Algorithm:** Returns all faces whose area respect comparator rules.
+
+**Volume size**
+
+- **Result type:** Solid
+- **Argument:** 
+    - **Comparator:** <, <=, >, >=, is between, is strictly between
+    - **Size** or  **Min size** and **Max size**
+- **Algorithm:** Returns all solids whose volume respect comparator rules.
+
+**Feature edges**
+
+This algorithm identifies edges between two faces discontinuous with an angular tolerance.
+
+- **Result type:** Edge
+- **Argument:** 
+    - **Angle** an angular tolerance used by G1 continuity criterion for comparing the angle between the normals 
+- **Algorithm:** Returns all edges between two discontinuous faces.
+
 **On a plane**
 
 - **Result type:** Vertex, Edge, Face
@@ -89,6 +122,16 @@ This algorithm is based on the Propagate geompy function. It works on a model pa
 - **Argument:** An edge belonging to a quadrangular face
 - **Algorithm:** Returns all Edges opposite to the given Edge on all quadrangular faces connected to this Edge. The algorithm is recursive: after an edge is found on one face, it adds edges opposite to this new one.
 
+**Continuous Faces**
+
+This algorithm identifies continuous faces with an angular tolerance given by topological propagation.
+
+- **Result type:** Face
+- **Argument:** 
+    - **Angle:** an angular tolerance used by G1 continuity criterion for comparing the angle between the normals. 
+    - **Faces:** Faces to start the propagation.    
+- **Algorithm:** Returns continuous faces.
+
 **On/In/Out a Solid**
 
 This algorithm reproduces the GetShapesOnShape function of geompy.
@@ -136,3 +179,26 @@ 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.
+
+**Shape name**
+
+- **Result type:** Any
+- **Arguments:** A regular expression value, representing a pattern for searching by result name. The search pattern must comply with the rules of regular expressions.
+- **Algorithm:**
+    - Returns objects or subobjects of results where their name matches the given search pattern (regular expression).
+    - 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 objects containing "cube" in their name.
+    - The filter searches not only for complete matches but for any pattern inclusions.
+
+- **Examples:**
+    - Selecting all edges belonging to objects from the result with a name starting with "Cyl".
+    .. figure:: images/selection_byShapeName1.png
+      :align: center
+
+    - Selecting all vertices belonging to objects from the result with a name containing pattern "Cube".
+    .. figure:: images/selection_byShapeName2.png
+      :align: center
+
+    - Selecting all results with names containing "Poutre", followed by a space and a digit.
+    .. figure:: images/selection_byShapeName3.png
+      :align: center
+