PolyfaceQuery Class
PolyfaceQuery is a static class whose methods implement queries on a polyface or polyface visitor provided as a parameter to each method.
Methods
| Name | Description | |
|---|---|---|
| constructor(): PolyfaceQuery | ||
| announceBoundaryChainsAsLineString3d(mesh: PolyfaceVisitor | Polyface, announceLoop: (points: LineString3d) => void): void Static | Search for edges with only 1 incident facet. | |
| announceBoundaryEdges(source: undefined | PolyfaceVisitor | Polyface, announceEdge: (pointA: Point3d, pointB: Point3d, indexA: number, indexB: number, facetIndex: number) => void, includeTypical: boolean = true, includeMismatch: boolean = true, includeNull: boolean = true): void Static | Test if the facets in source occur in perfectly mated pairs, as is required for a closed manifold volume. |
|
| announceDuplicateFacetIndices(polyface: Polyface, announceCluster: (clusterFacetIndices: number[]) => void): void Static | * Return an array of arrays describing facet duplication. | |
| announceSweepLinestringToConvexPolyfaceXY(linestringPoints: GrowableXYZArray, polyface: Polyface, announce: AnnounceDrapePanel): any Static | Find segments (within the linestring) which project to facets. | |
| asyncSweepLinestringToFacetsXYReturnChains(linestringPoints: GrowableXYZArray, polyface: Polyface): Promise<LineString3d[]> Static | Find segments (within the linestring) which project to facets. | |
| boundaryEdges(source: undefined | PolyfaceVisitor | Polyface, includeDanglers: boolean = true, includeMismatch: boolean = true, includeNull: boolean = true): undefined | CurveCollection Static | construct a CurveCollection containing boundary edges. | |
| boundaryOfVisibleSubset(polyface: IndexedPolyface, visibilitySelect: | "1" | "2", vectorToEye: Vector3d, sideAngleTolerance: Angle = ...): undefined | CurveCollection Static | Return the boundary of facets that are facing the eye. | |
| buildAverageNormals(polyface: IndexedPolyface, toleranceAngle: Angle = ...): void Static | * At each vertex of the mesh | |
| buildPerFaceNormals(polyface: IndexedPolyface): void Static | Set up indexed normals with one normal in the plane of each facet of the mesh. | |
| cloneByFacetDuplication(source: Polyface, includeSingletons: boolean, clusterSelector: DuplicateFacetClusterSelector): Polyface Static | Return a new facet set with a subset of facets in source | |
| cloneFiltered(source: PolyfaceVisitor | Polyface, filter: (visitor: PolyfaceVisitor) => boolean): IndexedPolyface Static | Clone facets that pass a filter function | |
| cloneOffset(source: IndexedPolyface, signedOffsetDistance: number, offsetOptions: OffsetMeshOptions = ...): IndexedPolyface Static | Offset the faces of the mesh. | |
| clonePartitions(polyface: PolyfaceVisitor | Polyface, partitions: number[][]): Polyface[] Static | Clone the facets in each partition to a separate polyface. | |
| cloneWithColinearEdgeFixup(polyface: Polyface): Polyface Static | Clone the facets, inserting removing points that are simply within colinear edges. | |
| cloneWithDanglingEdgesRemoved(source: PolyfaceVisitor | Polyface): IndexedPolyface Static | Clone the facets with in-facet dangling edges removed. | |
| cloneWithMaximalPlanarFacets(mesh: PolyfaceVisitor | Polyface, maxSmoothEdgeAngle?: Angle): undefined | IndexedPolyface Static | Return a mesh with | |
| cloneWithTVertexFixup(polyface: Polyface): IndexedPolyface Static | Clone the facets, inserting vertices (within edges) where points not part of each facet's vertex indices impinge within edges. | |
| collectDuplicateFacetIndices(polyface: Polyface, includeSingletons: boolean = false): number[][] Static | * Return an array of arrays describing facet duplication. | |
| collectEdgesByDihedralAngle(mesh: PolyfaceVisitor | Polyface, maxSmoothEdgeAngle?: Angle, sharpEdges: boolean = false): SortableEdgeCluster[] Static | Return manifold edge pairs whose dihedral angle is bounded by the given angle. | |
| collectRangeLengthData(polyface: PolyfaceVisitor | Polyface): RangeLengthData Static | * Examine ranges of facets. | |
| computeFacetUnitNormal(visitor: PolyfaceVisitor, facetIndex: number, result?: Vector3d): undefined | Vector3d Static | Try to compute a unit normal for a facet accessible through a visitor. | |
| computePrincipalAreaMoments(source: Polyface): undefined | MomentData Static | Compute area moments for the mesh. | |
| computePrincipalVolumeMoments(source: Polyface): undefined | MomentData Static | Compute area moments for the mesh. | |
| createIndexedEdges(polyface: PolyfaceVisitor | Polyface): IndexedEdgeMatcher Static | Load all half edges from a mesh to an IndexedEdgeMatcher. | |
| dihedralAngleSummary(source: Polyface, ignoreBoundaries: boolean = false): number Static | Compute a number summarizing the dihedral angles in the mesh. | |
| fillSimpleHoles(mesh: PolyfaceVisitor | Polyface, options: HoleFillOptions, unfilledChains?: LineString3d[]): undefined | IndexedPolyface Static | Return a mesh with "some" holes filled in with new facets. | |
| getSingleEdgeVisibility(polyface: IndexedPolyface, facetIndex: number, vertexIndex: number): undefined | boolean Static | Get the visibility of a particular edge of a particular facet. | |
| indexedPolyfaceToLoops(polyface: Polyface): BagOfCurves Static | Create a linestring loop for each facet of the polyface. | |
| intersectRay3d(visitor: PolyfaceVisitor | Polyface, ray: Ray3d, options?: FacetIntersectOptions): undefined | FacetLocationDetail Static | Search facets for the first one that intersects the infinite line. | |
| isConvexByDihedralAngleCount(source: Polyface, ignoreBoundaries: boolean = false): boolean Static | Test for convex volume by dihedral angle tests on all edges. | |
| isPolyfaceClosedByEdgePairing(source: Polyface): boolean Static | Test if the facets in source occur in perfectly mated pairs, as is required for a closed manifold volume. |
|
| isPolyfaceManifold(source: Polyface, allowSimpleBoundaries: boolean = false): boolean Static | Test edges pairing in source mesh. |
|
| markAllEdgeVisibility(mesh: IndexedPolyface, value: boolean): void Static | * Mark all edge visibilities in the IndexedPolyface | |
| markPairedEdgesInvisible(mesh: IndexedPolyface, sharpEdgeAngle?: Angle): void Static | * Find mated pairs among facet edges. | |
| partitionFacetIndicesByEdgeConnectedComponent(polyface: PolyfaceVisitor | Polyface, stopAtVisibleEdges: boolean = false): number[][] Static | Partition the facet set into connected components. | |
| partitionFacetIndicesByVertexConnectedComponent(polyface: PolyfaceVisitor | Polyface): number[][] Static | Search the facets for facet subsets that are connected with at least vertex contact. | |
| partitionFacetIndicesByVisibilityVector(polyface: PolyfaceVisitor | Polyface, vectorToEye: Vector3d, sideAngleTolerance: Angle): number[][] Static | * Examine the normal orientation for each faces. | |
| reorientVertexOrderAroundFacetsForConsistentOrientation(mesh: IndexedPolyface): boolean Static | * Examine adjacent facet orientations throughout the mesh | |
| setSingleEdgeVisibility(polyface: IndexedPolyface, facetIndex: number, vertexIndex: number, value: boolean): void Static | Set the visibility of a particular edge of a particular facet. | |
| sumFacetAreas(source: undefined | PolyfaceVisitor | Polyface, vectorToEye?: Vector3d): number Static | Return the sum of all facet areas. | |
| sumFacetSecondAreaMomentProducts(source: PolyfaceVisitor | Polyface, origin: Point3d): Matrix4d Static | Return the inertia products [xx,xy,xz,xw, yw, etc] integrated over all all facets, as viewed from origin. | |
| sumFacetSecondVolumeMomentProducts(source: PolyfaceVisitor | Polyface, origin: Point3d): Matrix4d Static | Return the inertia products [xx,xy,xz,xw, yw, etc] integrated over all tetrahedral volumes from origin | |
| sumTetrahedralVolumes(source: PolyfaceVisitor | Polyface, origin?: Point3d): number Static | sum volumes of tetrahedra from origin to all facets. | |
| sumVolumeBetweenFacetsAndPlane(source: PolyfaceVisitor | Polyface, plane: Plane3dByOriginAndUnitNormal): FacetProjectedVolumeSums Static | sum (signed) volumes between facets and a plane. | |
| sweepLineStringToFacets(linestringPoints: GrowableXYZArray, polyfaceOrVisitor: PolyfaceVisitor | Polyface, options?: SweepLineStringToFacetsOptions): LinearCurvePrimitive[] Static | Sweep the line string to intersections with a mesh. | |
| sweepLineStringToFacetsXY(lineStringPoints: Point3d[] | GrowableXYZArray, polyfaceOrVisitor: PolyfaceVisitor | Polyface, searchByReadIndex: Range2dSearchInterface<number>): LineString3d[] Static | Sweep the line string in the z-direction to intersections with a mesh, using a search object for speedup. | |
| sweepLineStringToFacetsXYReturnSweptFacets(lineStringPoints: GrowableXYZArray, polyface: Polyface): Polyface Static | Find segments (within the line string) which project to facets. | |
| sweepLinestringToFacetsXYReturnChains(linestringPoints: GrowableXYZArray, polyface: Polyface): LineString3d[] Static | Find segments (within the linestring) which project to facets. | Deprecated |
| sweepLinestringToFacetsXYReturnLines(linestringPoints: GrowableXYZArray, polyface: Polyface): LineSegment3d[] Static | Find segments (within the linestring) which project to facets. | Deprecated |
| sweepLinestringToFacetsXYreturnSweptFacets(linestringPoints: GrowableXYZArray, polyface: Polyface): Polyface Static | Deprecated | |
| visitorClientFacetCount(visitor: PolyfaceVisitor): number Static | If the visitor's client is a polyface, simply return its facet count. | |
| visitorClientPointCount(visitor: PolyfaceVisitor): number Static | If the visitor's client is a polyface, simply return its point array length. | |
| visitorToLoop(visitor: PolyfaceVisitor): Loop Static | copy the points from a visitor into a Linestring3d in a Loop object |
Defined in
- polyface/PolyfaceQuery.ts Line 236
Last Updated: 04 December, 2023