Class: FaceFinder

Hierarchy

• Finder<Face>

  ↳ FaceFinder

Constructors

constructor

• new FaceFinder()

Inherited from

Finder<Face>.constructor

Defined in

finders.ts:42

Filter Methods

atAngleWith

▸ atAngleWith(direction?, angle?): FaceFinder

Parameters

Name	Type	Default value
direction	Point | Direction	"Z"
angle	number	0

Returns

FaceFinder

Inherited from

Finder.atAngleWith

Defined in

finders.ts:73

---

atDistance

▸ atDistance(distance, point?): FaceFinder

Parameters

Name	Type
distance	number
point	Point

Returns

FaceFinder

Inherited from

Finder.atDistance

Defined in

finders.ts:99

---

containsPoint

▸ containsPoint(point): FaceFinder

Parameters

Name	Type
point	Point

Returns

FaceFinder

Inherited from

Finder.containsPoint

Defined in

finders.ts:128

---

inBox

▸ inBox(corner1, corner2): FaceFinder

Parameters

Name	Type
corner1	Point
corner2	Point

Returns

FaceFinder

Inherited from

Finder.inBox

Defined in

finders.ts:139

---

inList

▸ inList(elementList): FaceFinder

Parameters

Name	Type
elementList	Face[]

Returns

FaceFinder

Inherited from

Finder.inList

Defined in

finders.ts:57

---

inPlane

▸ inPlane(inputPlane, origin?): FaceFinder

Parameters

Name	Type
inputPlane	Plane | PlaneName
origin?	number | Point

Returns

FaceFinder

Defined in

finders.ts:303

---

ofSurfaceType

▸ ofSurfaceType(surfaceType): FaceFinder

Parameters

Name	Type
surfaceType	SurfaceType

Returns

FaceFinder

Defined in

finders.ts:288

---

parallelTo

▸ parallelTo(plane): FaceFinder

Parameters

Name	Type
plane	Plane | Face | StandardPlane

Returns

FaceFinder

Defined in

finders.ts:270

---

Filter Combination Methods

and

▸ and(findersList): FaceFinder

Parameters

Name	Type
findersList	(f: FaceFinder) => FaceFinder[]

Returns

FaceFinder

Inherited from

Finder.and

Defined in

finders.ts:201

---

either

▸ either(findersList): FaceFinder

Parameters

Name	Type
findersList	(f: FaceFinder) => FaceFinder[]

Returns

FaceFinder

Inherited from

Finder.either

Defined in

finders.ts:176

---

not

▸ not(finderFun): FaceFinder

Parameters

Name	Type
finderFun	(f: FaceFinder) => FaceFinder

Returns

FaceFinder

Inherited from

Finder.not

Defined in

finders.ts:214

---

Other Methods

clone

▸ clone(): FaceFinder

Returns

FaceFinder

Defined in

finders.ts:257

---

delete

▸ delete(): void

Returns

void

Inherited from

Finder.delete

Defined in

finders.ts:46

---

find

▸ find(shape, options): Face

Parameters

Name	Type
shape	AnyShape
options	Object
options.unique	true

Returns

Face

Inherited from

Finder.find

Defined in

finders.ts:232

▸ find(shape): Face[]

Parameters

Name	Type
shape	AnyShape

Returns

Face[]

Inherited from

Finder.find

Defined in

finders.ts:233

▸ find(shape, options): Face[]

Parameters

Name	Type
shape	AnyShape
options	Object
options.unique?	false

Returns

Face[]

Inherited from

Finder.find

Defined in

finders.ts:234

---

shouldKeep

▸ shouldKeep(element): boolean

Parameters

Name	Type
element	Face

Returns

boolean

Overrides

Finder.shouldKeep

Defined in

finders.ts:323