Class: FaceFinder
Hierarchy
Finder
<Face
>↳
FaceFinder
Constructors
constructor
• new FaceFinder()
Inherited from
Finder<Face>.constructor
Defined in
Filter Methods
atAngleWith
▸ atAngleWith(direction?
, angle?
): FaceFinder
Parameters
Name | Type | Default value |
---|---|---|
direction | Point | Direction | "Z" |
angle | number | 0 |
Returns
Inherited from
Finder.atAngleWith
Defined in
atDistance
▸ atDistance(distance
, point?
): FaceFinder
Parameters
Name | Type |
---|---|
distance | number |
point | Point |
Returns
Inherited from
Finder.atDistance
Defined in
containsPoint
▸ containsPoint(point
): FaceFinder
Parameters
Name | Type |
---|---|
point | Point |
Returns
Inherited from
Finder.containsPoint
Defined in
inBox
▸ inBox(corner1
, corner2
): FaceFinder
Parameters
Name | Type |
---|---|
corner1 | Point |
corner2 | Point |
Returns
Inherited from
Finder.inBox
Defined in
inList
▸ inList(elementList
): FaceFinder
Parameters
Name | Type |
---|---|
elementList | Face [] |
Returns
Inherited from
Finder.inList
Defined in
inPlane
▸ inPlane(inputPlane
, origin?
): FaceFinder
Parameters
Name | Type |
---|---|
inputPlane | Plane | PlaneName |
origin? | number | Point |
Returns
Defined in
ofSurfaceType
▸ ofSurfaceType(surfaceType
): FaceFinder
Parameters
Name | Type |
---|---|
surfaceType | SurfaceType |
Returns
Defined in
parallelTo
▸ parallelTo(plane
): FaceFinder
Parameters
Name | Type |
---|---|
plane | Plane | Face | StandardPlane |
Returns
Defined in
Filter Combination Methods
and
▸ and(findersList
): FaceFinder
Parameters
Name | Type |
---|---|
findersList | (f : FaceFinder ) => FaceFinder [] |
Returns
Inherited from
Finder.and
Defined in
either
▸ either(findersList
): FaceFinder
Parameters
Name | Type |
---|---|
findersList | (f : FaceFinder ) => FaceFinder [] |
Returns
Inherited from
Finder.either
Defined in
not
▸ not(finderFun
): FaceFinder
Parameters
Name | Type |
---|---|
finderFun | (f : FaceFinder ) => FaceFinder |
Returns
Inherited from
Finder.not
Defined in
Other Methods
clone
▸ clone(): FaceFinder
Returns
Defined in
delete
▸ delete(): void
Returns
void
Inherited from
Finder.delete
Defined in
find
▸ find(shape
, options
): Face
Parameters
Name | Type |
---|---|
shape | AnyShape |
options | Object |
options.unique | true |
Returns
Inherited from
Finder.find
Defined in
▸ find(shape
): Face
[]
Parameters
Name | Type |
---|---|
shape | AnyShape |
Returns
Face
[]
Inherited from
Finder.find
Defined in
▸ find(shape
, options
): Face
[]
Parameters
Name | Type |
---|---|
shape | AnyShape |
options | Object |
options.unique? | false |
Returns
Face
[]
Inherited from
Finder.find
Defined in
shouldKeep
▸ shouldKeep(element
): boolean
Parameters
Name | Type |
---|---|
element | Face |
Returns
boolean
Overrides
Finder.shouldKeep