Class AP214MaterialCache

constructor

• new AP214MaterialCache(): AP214MaterialCache

• Returns AP214MaterialCache

defaultMaterialLocalID

ReadonlymaterialDefinitionsMap

ReadonlyrelMaterialsMap

ReadonlystyledItemMap

size

• get size(): number

• Get the number of materials in this.

  Returns number

  The number of materials in this.

[iterator]

• [iterator](): IterableIterator<[number, CanonicalMaterial], any, any>

• Get the materials in the cache.

  Returns IterableIterator<[number, CanonicalMaterial], any, any>

  The iterator for the local IDs and their respective materials.

add

• add(localID, material): void

• Add a material to the cache

  Parameters

  • localID: number

    The local ID of the source material object
  • material: CanonicalMaterial

    The canonical material version of the material to add

  Returns void

addDefaultGeometryMapping

• addDefaultGeometryMapping(geometryLocalID): void

• Map the current geometry to the current default material, if one is set.

  Parameters

  • geometryLocalID: number

    The geometry ID to add.

  Returns void

addGeometryMapping

• addGeometryMapping(geometryLocalID, materialLocalID): void

• Assign a particular geometry to a particular material

  Parameters

  • geometryLocalID: number

    The geometry
  • materialLocalID: number

    The material

  Returns void

get

• get(localID): undefined | CanonicalMaterial

• Get a material by its local ID.

  Parameters

  • localID: number

    The local ID to fetch a material for.

  Returns undefined | CanonicalMaterial

  The material for the matching local ID

getMaterialByGeometryID

• getMaterialByGeometryID(geometryLocalID): undefined | [CanonicalMaterial, number]

• Get a material by its local geometry ID.

  Parameters

  • geometryLocalID: number

    The local ID of the geometry to get the associated material for.

  Returns undefined | [CanonicalMaterial, number]

  A tuple containing the material and its id, or undefined if it is not found.

getMaterialFromGeometryNode

• getMaterialFromGeometryNode(node): undefined | CanonicalMaterial

• Get the material for a geometry scene node from the scene with these materials.

  Parameters

  • node: SceneNodeGeometry

    The scene geometry node.

  Returns undefined | CanonicalMaterial

  The canonical material associated with the geometry or undefined if none is available.

getMaterialIDByGeometryID

• getMaterialIDByGeometryID(geometryLocalID): undefined | number

• Get a material by its local ID.

  Parameters

  • geometryLocalID: number

    The local ID of the geometry to fetch

  Returns undefined | number

  A tuple containing the material and its id, or undefined if it is not found.

materials

• materials(): IterableIterator<CanonicalMaterial, any, any>

• Get the materials in the cache (values only).

  Returns IterableIterator<CanonicalMaterial, any, any>

  The iterator for the respective materials.