Class Model

Readonlyname

boundingBox

• get boundingBox(): number[]

• Returns number[]

materialNames

• get materialNames(): string[]

• Get list of all material names in this model used by all parts

  Returns string[]

  • List of material names

partList

• get partList(): string[]

• Get list of parts in this model, names are the material names

  Returns string[]

  • List of part material names

partsCount

• get partsCount(): number

• Get number of parts in this model

  Returns number

triangleCount

• get triangleCount(): number

• Simple getter for the number of triangles in the model

  Returns number

getNamedMaterial

• getNamedMaterial(name: string): Material

• Get a named material

  Parameters

  • name: string

    Name of the material to get

  Returns Material

render

• render(
      gl: WebGL2RenderingContext,
      uniforms: UniformSet,
      materialOverride?: Material,
      programOverride?: ProgramInfo,
  ): void

• Render is used draw this model, this is called from the Instance that wraps this renderable.

  Parameters

  • gl: WebGL2RenderingContext
  • uniforms: UniformSet
  • OptionalmaterialOverride: Material
  • OptionalprogramOverride: ProgramInfo

  Returns void

setNamedMaterial

• setNamedMaterial(name: string, material: Material): void

• Can modify & override an existing named material

  Parameters

  • name: string

    Name of the material to modify
  • material: Material

    New material to use

  Returns void

Staticparse

• parse(
      path?: string,
      objFilename: string,
      filterTextures?: boolean,
      flipTextureY?: boolean,
      flipUV?: boolean,
  ): Promise<Model>

• Parse an OBJ file & MTL material libraries, returns a new Model

  Parameters

  • path: string = '.'

    The path to the OBJ file
  • objFilename: string

    The name of the OBJ file
  • filterTextures: boolean = true

    Apply texture filtering to textures, default: true
  • flipTextureY: boolean = false

    Flip the Y axis of textures as they are loaded, default: false
  • flipUV: boolean = false

    Flip the UV coords of the model in the vertex/mesh data, default: true

  Returns Promise<Model>

StaticparseFromBuilder

• parseFromBuilder(builder: ModelBuilder, name: string): Model

• Parse a custom model from a ModelBuilder, this is used to build models in code

  Parameters

  • builder: ModelBuilder

    The ModelBuilder to parse
  • name: string

    The name of the model

  Returns Model