API Reference › core-backend› ExportGraphics › ExportGraphicsMeshSubsetVisitor

ExportGraphicsMeshSubsetVisitor Class

An ExportGraphicsMeshSubsetVisitor is an ExportGraphicsMeshVisitor which only visits a subset of the facets.

  • The subset is defined by an array of facet indices provided when this visitor is created.
  • Input indices (e.g., for moveToReadIndex) are understood to be indices into the subset array.

Extends

Methods

Name Description
getVisitableFacetCount(): number Return the number of facets this visitor is able to visit.  
moveToNextFacet(): boolean Advance the iterator to the next facet in the subset of client polyface facets.  
moveToReadIndex(subsetIndex: number): boolean Advance the iterator to a particular facet in the subset of client polyface facets.  
parentFacetIndex(subsetIndex?: number): undefined | number Return the client polyface facet index (aka "readIndex") for the given subset index.  
reset(): void Restart the visitor at the first facet.  
createSubsetVisitor(polyface: ExportGraphicsMesh, facetIndices: number[], numWrap: number0): ExportGraphicsMeshSubsetVisitor Static Create a visitor for iterating a subset of the facets of polyface.  

Inherited methods

Name Inherited from Description
clearArrays(): void Inherited ExportGraphicsMeshVisitor clear the contents of all arrays.
clientAuxIndex(_i: number): number Inherited ExportGraphicsMeshVisitor Always returns -1 since we never have auxiliary data.
clientColorIndex(_i: number): number Inherited ExportGraphicsMeshVisitor Always returns -1 since we never have colors.
clientNormalIndex(i: number): number Inherited ExportGraphicsMeshVisitor Return the normal index of vertex i within the currently loaded facet.
clientParamIndex(i: number): number Inherited ExportGraphicsMeshVisitor Return the param index of vertex i within the currently loaded facet.
clientPointIndex(i: number): number Inherited ExportGraphicsMeshVisitor Return the point index of vertex i within the currently loaded facet
clientPolyface(): undefined | Polyface Inherited ExportGraphicsMeshVisitor return the client polyface
createSubsetVisitor(facetIndices: number[], numWrap: number0): ExportGraphicsMeshSubsetVisitor Inherited ExportGraphicsMeshVisitor Create a visitor for a subset of the facets visitable by the instance.
currentReadIndex(): number Inherited ExportGraphicsMeshVisitor Return the index (in the client polyface) of the current facet
pushDataFrom(other: PolyfaceVisitor, index: number): void Inherited ExportGraphicsMeshVisitor transfer data from a specified index of the other visitor as new data in this visitor.
pushInterpolatedDataFrom(other: PolyfaceVisitor, index0: number, fraction: number, index1: number): void Inherited ExportGraphicsMeshVisitor transfer interpolated data from the other visitor.
setNumWrap(numWrap: number): void Inherited ExportGraphicsMeshVisitor Set the number of vertices to replicate in visitor arrays.
create(polyface: ExportGraphicsMesh, numWrap: number0): ExportGraphicsMeshVisitor Static Inherited ExportGraphicsMeshVisitor Create a visitor for iterating the facets of polyface, with indicated number of points to be added to each facet to produce closed point arrays

Defined in

Last Updated: 27 June, 2025