Filters a set of individual points, groups, and/or clouds to a set of surface faces, just like the manual “Auto Filter to Faces” command.
Input Arguments
0 |
Point Name Ref List |
Points |
A list of individual points to filter. |
1 |
Collection Object Name Ref List |
Groups |
A list of groups to filter. |
2 |
Collection Object Name Ref List |
Clouds |
A list of clouds to filter. |
3 |
Double |
Surface Offset |
A distance from the surface beyond which points are excluded from the filter. |
4 |
Double |
Edge Offset |
A distance from surface edges inside of which points are excluded from the filter. |
5 |
Offset Direction Type |
Offset Direction |
Specifies the side(s) of the surfaces to include in the filter. |
6 |
Boolean |
Enforce Max Pts per Face in Output? |
Indicates whether an upper limit should be placed on the number of points allowed to be associated with a given surface. |
7 |
Integer |
Max Pts per Face |
The maximum number of points to include on a single face (applies if argument 6 is true). |
8 |
Collection Object Name Ref List |
Surfaces |
A list of surfaces to include in the filter. |
9 |
Cloud Thinning Options |
Cloud Thinning Settings |
Settings for cloud thinning, if clouds are provided as the source points. |
10 |
String |
Output Cloud Base Name |
The Name of the output cloud |
11 |
Boolean |
Use Face IDs for Suffix |
Whether to use the Face IDs for the suffix of the output cloud names. |
Return Arguments
None.
Returned Status
SUCCESS |
The points were filtered successfully. |
FAILURE |
The points or surfaces were not found. |
Remarks
Auto Filter Points/Groups/Clouds to Surface Faces can take some time to process but should be used when edges are of concern.
Filter Clouds to Surfaces is an alternative that offers the ability to use an asymmetric distance such as +.1 to +.5 and is much faster, but it ignores edges entirely. This means points beyond an edge are also picked up as long as they are within the specified proximity.