src/FiltersPlugin/doc/FiltersPlugin.rst

   1 .. |plus.icon|    image:: images/add.png
   2 .. |minus.icon|   image:: images/reverce.png
   3 .. |delete.icon|  image:: images/delete.png
   4
   5
   6 .. _filtersPlugin:
   7
   8 Filters Plugin
   9 ==============
  10
  11 Filters plug-in provides a collection of filters used Filters property panel (for example see :ref:`groupPage` feature).
  12
  13
  14 **Selection filters**
  15
  16 Selection by filters panel looks like following:
  17
  18 .. figure:: images/selection_by_filters.png
  19   :align: center
  20
  21   Selection by filters property panel
  22
  23 In this panel:
  24
  25 - **Filters** a panel for added filters.
  26
  27 - **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:
  28
  29 .. figure:: images/selection_by_filters_added.png
  30   :align: center
  31
  32   Filters **Horizontal faces** and **On plane** added to the property panel.
  33
  34 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.
  35
  36 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
  37 if the filter has arguments.
  38
  39 - **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
  40   blue semi-transparent color. Any modification in filters clears current selection.
  41
  42 - **Number of selected objects** shows number currently selected entities.
  43
  44 - **Show only** check box hides all non-selected objects.
  45
  46 **Accept** button in the **Selection filters** property panel reopens a property panel where the **selection filters** was called and transfers all selected entities to the corresponded list.
  47
  48
  49 Filters
  50 -------
  51
  52 **Belongs to**
  53
  54 By default, the result of Selection feature all selectable entities from all Shapes registered in the “Results” folder. This filter provides a way to explicit (restrict) the results in which looking for selectable entities.
  55
  56 - **Result type:** Any
  57 - **Argument:** Any result object, multiple OR selection accepted
  58 - **Algorithm:** Returns only shapes that belong to selected results.
  59
  60 **On a plane**
  61
  62 - **Result type:** Vertex, Edge, Face
  63 - **Argument:** Planar face or Construction plane, multiple OR selection accepted
  64 - **Algorithm:** Returns all vertices, edges or planar faces geometrically located on (co-planar) the given plane.
  65
  66 **On a Line**
  67
  68 - **Result type:** Vertex, Edge
  69 - **Argument:** Straight Edge or Construction axis, multiple OR selection accepted
  70 - **Algorithm:** Returns all vertices coincident or all edges collinear to the given line.
  71
  72 **On geometry**
  73
  74 - **Result type:** Any
  75 - **Argument:** Any Shape, multiple OR selection accepted
  76 - **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.
  77
  78 **On plane side**
  79
  80 - **Result type:** Any
  81 - **Argument:** Planar face or Construction plane
  82 - **Algorithm:** By default, the side is in direction of normal of the given plane. For getting the other side, simply invert the filter by clicking on the Check button.
  83
  84 **Opposite to an edge**
  85
  86 This algorithm is based on the Propagate geompy function. It works on a model partitioned into quadrangular faces blocks for the purpose of hexahedral meshing.
  87
  88 - **Result type:** Edge
  89 - **Argument:** An edge belonging to a quadrangular face
  90 - **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.
  91
  92 **On/In/Out a Solid**
  93
  94 This algorithm reproduces the GetShapesOnShape function of geompy.
  95
  96 - **Result type:** Vertex, Edge or Face
  97 - **Arguments:** Solid. Location according to the given Solid, as described below
  98 - **Algorithm:**
  99     - **In:** strictly inside the solid.
 100     - **Not In:** strictly outside the solid.
 101     - **On:** confused with the boundary of the solid
 102     - **Not On:** strictly inside or outside the solid
 103     - **In & On:** i.e. inside or confused with the boundary of the solid
 104     - **Not In & On:** outside or confused with the boundary of the solid.
 105
 106 **External Faces**
 107
 108 This algorithm finds all not-shared faces.
 109
 110 - **Result type:** Face
 111 - **Arguments:** None
 112 - **Algorithm:** Returns all faces which are not shared between higher level shapes of the connected compound of the connected compound of compsolid. For an example, if there is a compsolid of two boxes with one shared face between them, the filter returns all faces except the shared.
 113
 114 **Horizontal Faces**
 115
 116 This algorithm finds all the horizontal faces of the model.
 117
 118 - **Result type:** Face
 119 - **Arguments:** None
 120 - **Algorithm:** Returns only planar faces with normal of the plane perpendicular to OZ.
 121
 122 **Vertical Faces**
 123
 124 This algorithm finds all the vertical faces of the model.
 125
 126 - **Result type:** Face
 127 - **Arguments:** None
 128 - **Algorithm:** Returns only planar faces with normal of the plane parallel to OZ or cylindrical faces with axis parallel to OZ.
 129
 130 **Topologically connected Faces**
 131
 132 This algorithm finds all the faces topologically connected the argument selected by the user.
 133
 134 - **Result type:** Face
 135 - **Arguments:** A point, an edge or a face. A “propagation” flag (check-box).
 136 - **Algorithm:**
 137     - 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.
 138     - 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.