Class G3dSubset

Represents a subset of a complete scene definition. Allows for further filtering or to get offsets needed to build the scene.

Hierarchy

G3dSubset

Constructors

constructor

new G3dSubset(source: G3d | G3dScene, instances?: number[]): G3dSubset
Parameters
- source: G3d | G3dScene
  
  Underlying data source for the subset
- Optional instances: number[]
  
  source-based instance indices of included instances.
Returns G3dSubset
- Defined in src/vim-loader/progressive/g3dSubset.ts:27

Methods

except

except(mode: FilterMode, filter: number[] | Set<number>): G3dSubset
Returns a new subset with instances not included in given filter.
Parameters
- mode: FilterMode
  
  Defines which field the filter will be applied to.
- filter: number[] | Set<number>
  
  Array of all values to match for.
Returns G3dSubset
- Defined in src/vim-loader/progressive/g3dSubset.ts:254

filter

filter(mode: FilterMode, filter: number[] | Set<number>): G3dSubset
Returns a new subset with instances matching given filter.
Parameters
- mode: FilterMode
  
  Defines which field the filter will be applied to.
- filter: number[] | Set<number>
  
  Array of all values to match for.
Returns G3dSubset
- Defined in src/vim-loader/progressive/g3dSubset.ts:263

filterLargests

filterLargests(count: number): G3dSubset
Returns a new subset that contains only the N largest meshes sorted by largest
Parameters
- count: number
Returns G3dSubset
- Defined in src/vim-loader/progressive/g3dSubset.ts:172

filterNonUniqueMeshes

filterNonUniqueMeshes(): G3dSubset
Returns a new subset that only contains non-unique meshes.

Returns G3dSubset
- Defined in src/vim-loader/progressive/g3dSubset.ts:200

filterUniqueMeshes

filterUniqueMeshes(): G3dSubset
Returns a new subset that only contains unique meshes.

Returns G3dSubset
- Defined in src/vim-loader/progressive/g3dSubset.ts:165

getAttributeCounts

getAttributeCounts(section?: MeshSection): G3dMeshCounts
Returns the count of each mesh attribute.
Parameters
- section: MeshSection = 'all'
Returns G3dMeshCounts
- Defined in src/vim-loader/progressive/g3dSubset.ts:228

getBoundingBox

getBoundingBox(): Box3
Return the bounding box of the current subset or undefined if subset is empty.

Returns Box3
- Defined in src/vim-loader/progressive/g3dSubset.ts:318

getInstanceCount

getInstanceCount(): number
Returns total instance count in subset.

Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:71

getMeshCount

getMeshCount(): number
Returns total mesh count in subset.

Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:105

getMeshIndexCount

getMeshIndexCount(mesh: number, section: MeshSection): number
Returns total index count for given mesh and section.
Parameters
- mesh: number
  
  subset-based mesh index
- section: MeshSection
  
  sections to include based on opacity
Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:114

getMeshInstance

getMeshInstance(mesh: number, index: number): number
Returns the source-based instance index for given mesh and index.
Parameters
- mesh: number
  
  subset-based mesh index.
- index: number
  
  mesh-based instance index
Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:158

getMeshInstanceCount

getMeshInstanceCount(mesh: number): number
Returns instance count for given mesh.
Parameters
- mesh: number
  
  subset-based mesh index.
Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:141

getMeshInstances

getMeshInstances(mesh: number): number[]
Returns a list of source-based instance indices for given mesh.
Parameters
- mesh: number
  
  subset-based mesh index.
Returns number[]
- Defined in src/vim-loader/progressive/g3dSubset.ts:149

getMeshVertexCount

getMeshVertexCount(mesh: number, section: MeshSection): number
Returns total vertex count for given mesh and section.
Parameters
- mesh: number
  
  subset-based mesh index
- section: MeshSection
  
  sections to include based on opacity
Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:128

getOffsets

getOffsets(section: MeshSection): G3dMeshOffsets
Returns offsets needed to build geometry.
Parameters
- section: MeshSection
Returns G3dMeshOffsets
- Defined in src/vim-loader/progressive/g3dSubset.ts:221

getSourceMesh

getSourceMesh(index: number): number
Returns source-based mesh index.
Parameters
- index: number
  
  subset-based mesh index
Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:98

getVimInstance

getVimInstance(subsetIndex: number): number
Returns the vim-based instance (node) for given subset-based instance.
Parameters
- subsetIndex: number
Returns number
- Defined in src/vim-loader/progressive/g3dSubset.ts:78

getVimInstances

getVimInstances(): number[]
Returns the vim-based instances (nodes) for current subset.

Returns number[]
- Defined in src/vim-loader/progressive/g3dSubset.ts:86

reverse

reverse(): G3dSubset
Returns a new subset where the order of meshes is inverted.

Returns G3dSubset
- Defined in src/vim-loader/progressive/g3dSubset.ts:244

Generated using TypeDoc