FaceFinder
With a FaceFinder you can apply a set of filters to find specific faces within a shape.
Hierarchy
Finder3d<Face>↳
FaceFinder
Constructors
constructor
• new FaceFinder()
Inherited from
Finder3d<Face>.constructor
Defined in
Filter Methods
atAngleWith
▸ atAngleWith(direction?, angle?): FaceFinder
Filter to find elements that are at a specified angle (in degrees) with a direction.
The element direction corresponds to its normal in the case of a face.
Parameters
| Name | Type | Default value |
|---|---|---|
direction | Point | Direction | "Z" |
angle | number | 0 |
Returns
Inherited from
Finder3d.atAngleWith
Defined in
atDistance
▸ atDistance(distance, point?): FaceFinder
Filter to find elements that are at a specified distance from a point.
Parameters
| Name | Type |
|---|---|
distance | number |
point | Point |
Returns
Inherited from
Finder3d.atDistance
Defined in
containsPoint
▸ containsPoint(point): FaceFinder
Filter to find elements that contain a certain point
Parameters
| Name | Type |
|---|---|
point | Point |
Returns
Inherited from
Finder3d.containsPoint
Defined in
inBox
▸ inBox(corner1, corner2): FaceFinder
Filter to find elements that are within a box
The elements that are not fully contained in the box are also found.
Parameters
| Name | Type |
|---|---|
corner1 | Point |
corner2 | Point |
Returns
Inherited from
Finder3d.inBox
Defined in
finders/generic3dfinder.ts:123
inList
▸ inList(elementList): FaceFinder
Filter to find elements that are in the list.
This deletes the elements in the list as the filter deletion.
Parameters
| Name | Type |
|---|---|
elementList | Face[] |
Returns
Inherited from
Finder3d.inList
Defined in
inPlane
▸ inPlane(inputPlane, origin?): FaceFinder
Filter to find faces that are contained in a plane.
Note that this will work only in planar faces (but the method does not check this assumption).
Parameters
| Name | Type |
|---|---|
inputPlane | Plane | PlaneName |
origin? | number | Point |
Returns
Defined in
inShape
▸ inShape(shape): FaceFinder
Filter to find elements that are within a generic shape
The elements that are not fully contained in the shape are also found.
Parameters
| Name | Type |
|---|---|
shape | AnyShape |
Returns
Inherited from
Finder3d.inShape
Defined in
finders/generic3dfinder.ts:135
ofSurfaceType
▸ ofSurfaceType(surfaceType): FaceFinder
Filter to find faces that are of a cetain surface type.
Parameters
| Name | Type |
|---|---|
surfaceType | SurfaceType |
Returns
Defined in
parallelTo
▸ parallelTo(plane): FaceFinder
Filter to find faces that are parallel to plane or another face
Note that this will work only in planar faces (but the method does not check this assumption).
Parameters
| Name | Type |
|---|---|
plane | Plane | StandardPlane | Face |
Returns
Defined in
when
▸ when(filter): FaceFinder
Filter to find elements following a custom function.
Parameters
| Name | Type |
|---|---|
filter | (filter: FilterFcn<Face>) => boolean |
Returns
Inherited from
Finder3d.when
Defined in
withinDistance
▸ withinDistance(distance, point?): FaceFinder
Filter to find elements that are within a certain distance from a point.
Parameters
| Name | Type |
|---|---|
distance | number |
point | Point |
Returns
Inherited from
Finder3d.withinDistance
Defined in
finders/generic3dfinder.ts:104
Filter Combination Methods
and
▸ and(findersList): FaceFinder
Combine logically a set of filter with an AND operation.
You need to pass an array of functions that take a finder as a argument and return the same finder with some filters applied to it.
Note that by default filters are applied with and AND operation, but in some case you might want to create them dynamically and use this method.
Parameters
| Name | Type |
|---|---|
findersList | (f: FaceFinder) => FaceFinder[] |
Returns
Inherited from
Finder3d.and
Defined in
either
▸ either(findersList): FaceFinder
Combine logically a set of filter with an OR operation.
You need to pass an array of functions that take a finder as a argument and return the same finder with some filters applied to it.
Parameters
| Name | Type |
|---|---|
findersList | (f: FaceFinder) => FaceFinder[] |
Returns
Inherited from
Finder3d.either
Defined in
not
▸ not(finderFun): FaceFinder
Invert the result of a particular finder
You need to pass a function that take a finder as a argument and return the same finder with some filters applied to it.
Parameters
| Name | Type |
|---|---|
finderFun | (f: FaceFinder) => FaceFinder |
Returns
Inherited from
Finder3d.not
Defined in
Other Methods
clone
▸ clone(): FaceFinder
Returns
Defined in
delete
▸ delete(): void
Returns
void
Inherited from
Finder3d.delete
Defined in
find
▸ find(shape, options): Face
Returns all the elements that fit the set of filters defined on this finder
If unique is configured as an option it will either return the unique element found or throw an error.
Parameters
| Name | Type |
|---|---|
shape | AnyShape |
options | Object |
options.unique | true |
Returns
Inherited from
Finder3d.find
Defined in
▸ find(shape): Face[]
Parameters
| Name | Type |
|---|---|
shape | AnyShape |
Returns
Face[]
Inherited from
Finder3d.find
Defined in
▸ find(shape, options): Face[]
Parameters
| Name | Type |
|---|---|
shape | AnyShape |
options | Object |
options.unique? | false |
Returns
Face[]
Inherited from
Finder3d.find
Defined in
shouldKeep
▸ shouldKeep(element): boolean
Parameters
| Name | Type |
|---|---|
element | Face |
Returns
boolean
Overrides
Finder3d.shouldKeep