Skip to main content

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

NameTypeDefault value
directionPoint | Direction"Z"
anglenumber0

Returns

FaceFinder

Inherited from

Finder.atAngleWith

Defined in

finders.ts:73


atDistance

atDistance(distance, point?): FaceFinder

Parameters

NameType
distancenumber
pointPoint

Returns

FaceFinder

Inherited from

Finder.atDistance

Defined in

finders.ts:99


containsPoint

containsPoint(point): FaceFinder

Parameters

NameType
pointPoint

Returns

FaceFinder

Inherited from

Finder.containsPoint

Defined in

finders.ts:130


inBox

inBox(corner1, corner2): FaceFinder

Parameters

NameType
corner1Point
corner2Point

Returns

FaceFinder

Inherited from

Finder.inBox

Defined in

finders.ts:141


inList

inList(elementList): FaceFinder

Parameters

NameType
elementListFace[]

Returns

FaceFinder

Inherited from

Finder.inList

Defined in

finders.ts:57


inPlane

inPlane(inputPlane, origin?): FaceFinder

Parameters

NameType
inputPlanePlane | PlaneName
origin?number | Point

Returns

FaceFinder

Defined in

finders.ts:307


ofSurfaceType

ofSurfaceType(surfaceType): FaceFinder

Parameters

NameType
surfaceTypeSurfaceType

Returns

FaceFinder

Defined in

finders.ts:292


parallelTo

parallelTo(plane): FaceFinder

Parameters

NameType
planePlane | Face | StandardPlane

Returns

FaceFinder

Defined in

finders.ts:274


Filter Combination Methods

and

and(findersList): FaceFinder

Parameters

NameType
findersList(f: FaceFinder) => FaceFinder[]

Returns

FaceFinder

Inherited from

Finder.and

Defined in

finders.ts:205


either

either(findersList): FaceFinder

Parameters

NameType
findersList(f: FaceFinder) => FaceFinder[]

Returns

FaceFinder

Inherited from

Finder.either

Defined in

finders.ts:180


not

not(finderFun): FaceFinder

Parameters

NameType
finderFun(f: FaceFinder) => FaceFinder

Returns

FaceFinder

Inherited from

Finder.not

Defined in

finders.ts:218


Other Methods

clone

clone(): FaceFinder

Returns

FaceFinder

Defined in

finders.ts:261


delete

delete(): void

Returns

void

Inherited from

Finder.delete

Defined in

finders.ts:46


find

find(shape, options): Face

Parameters

NameType
shapeAnyShape
optionsObject
options.uniquetrue

Returns

Face

Inherited from

Finder.find

Defined in

finders.ts:236

find(shape): Face[]

Parameters

NameType
shapeAnyShape

Returns

Face[]

Inherited from

Finder.find

Defined in

finders.ts:237

find(shape, options): Face[]

Parameters

NameType
shapeAnyShape
optionsObject
options.unique?false

Returns

Face[]

Inherited from

Finder.find

Defined in

finders.ts:238


shouldKeep

shouldKeep(element): boolean

Parameters

NameType
elementFace

Returns

boolean

Overrides

Finder.shouldKeep

Defined in

finders.ts:327