-.. |plus.icon| image:: images/add.png
-.. |minus.icon| image:: images/reverce.png
+.. |plus.icon| image:: images/add.png
+.. |minus.icon| image:: images/reverce.png
.. |delete.icon| image:: images/delete.png
.. _filtersPlugin:
-Filters Plugin
-==============
+Filters plug-in
+===============
Filters plug-in provides a collection of filters used Filters property panel (for example see :ref:`groupPage` feature).
Selection by filters panel looks like following:
-.. image:: images/selection_by_filters.png
+.. figure:: images/selection_by_filters.png
:align: center
-.. centered::
Selection by filters property panel
In this panel:
- **Add new filter** combo box. It contains accessible filters according to the selection mode. When user selects an item from this combo box a filter item appears in **Filters** panel like in the following example:
-.. image:: images/selection_by_filters_added.png
+.. figure:: images/selection_by_filters_added.png
:align: center
-.. centered::
Filters **Horizontal faces** and **On plane** added to the property panel.
+If filter is implemented as "Multiple", several instances of this filter may be added in one selection. Otherwise the added filter is removed from the "Add new filter..." list.
+
Each filter item can be deleted with help of |delete.icon| button. A filter can be reverced with help of toggle button |plus.icon|/|minus.icon|. Also a filter could have input fields in case
if the filter has arguments.
- **Select** button traverces all objects of a current document and selects entities acceptable by currently defined set of filters. All selected entities will be shown in viewer 3d with
-blue semi-transparent color. Any modification in filters clears current selection.
+ blue semi-transparent color. Any modification in filters clears current selection.
- **Number of selected objects** shows number currently selected entities.
- **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
- **Result type:** Any
- **Argument:** Any Shape, multiple OR selection accepted
-- **Algorithm:** Returns the shapes which have the similar underlying geometry of the given Shape. Like all faces laying of the same geometrical surface or edges laying of the same geometrical surface or edges laying on the line.
+- **Algorithm:** Returns the shapes which have the similar underlying geometry of the given Shape. Like all faces laying of the same geometrical surface or edges laying on the line.
**On plane side**
- **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.
- **Arguments:** A point, an edge or a face. A “propagation” flag (check-box).
- **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.
\ No newline at end of file
+ - 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.
