Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KHR_materials_variants

Hierarchy

  • KHR_materials_variants

Implements

Index

Properties

enabledSearch playground for enabled

enabled: boolean

Defines whether this extension is enabled.

Readonly nameSearch playground for name

name: "KHR_materials_variants" = "KHR_materials_variants"

The name of this extension.

Methods

getAvailableVariantsSearch playground for getAvailableVariants

  • getAvailableVariants(rootMesh: Mesh): string[]
  • Gets the list of available variant names for this asset.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    Returns string[]

    the list of all the variant names for this model

getLastSelectedVariantSearch playground for getLastSelectedVariant

  • getLastSelectedVariant(rootMesh: Mesh): Nullable<string | string[]>
  • Gets the last selected variant name(s) or null if original.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    Returns Nullable<string | string[]>

    The selected variant name(s).

resetSearch playground for reset

  • reset(rootMesh: Mesh): void
  • Reset back to the original before selecting a variant.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    Returns void

selectVariantSearch playground for selectVariant

  • selectVariant(rootMesh: Mesh, variantName: string | string[]): void
  • Select a variant given a variant name or a list of variant names.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    • variantName: string | string[]

      The variant name(s) to select.

    Returns void

Static GetAvailableVariantsSearch playground for GetAvailableVariants

  • GetAvailableVariants(rootMesh: Mesh): string[]
  • Gets the list of available variant names for this asset.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    Returns string[]

    the list of all the variant names for this model

Static GetLastSelectedVariantSearch playground for GetLastSelectedVariant

  • GetLastSelectedVariant(rootMesh: Mesh): Nullable<string | string[]>
  • Gets the last selected variant name(s) or null if original.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    Returns Nullable<string | string[]>

    The selected variant name(s).

Static ResetSearch playground for Reset

  • Reset(rootMesh: Mesh): void
  • Reset back to the original before selecting a variant.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    Returns void

Static SelectVariantSearch playground for SelectVariant

  • SelectVariant(rootMesh: Mesh, variantName: string | string[]): void
  • Select a variant given a variant name or a list of variant names.

    Parameters

    • rootMesh: Mesh

      The glTF root mesh

    • variantName: string | string[]

      The variant name(s) to select.

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method