glTF-Transform GitHub stars
Options
Menu

Unlit

Converts a PBR Material to an unlit shading model. See KHRMaterialsUnlit.

Hierarchy

  • ExtensionProperty
    • Unlit

Properties

parentTypes: [MATERIAL]
propertyType: "Unlit"

Methods

  • Makes a copy of this property, with the same resources (by reference) as the original.

  • copy(other: Unlit, resolve?: PropertyResolver<Property<IProperty>>): Unlit

  • Copies all data from another property to this one. Child properties are copied by reference, unless a 'resolve' function is given to override that.

  • dispatchEvent(event: BaseEvent): Unlit

  • Events.

  • dispose(): void

  • Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

  • equals(other: Unlit, skip?: Set<string>): boolean

  • Returns true if two properties are deeply equivalent, recursively comparing the attributes of the properties. Optionally, a 'skip' set may be included, specifying attributes whose values should not be considered in the comparison.

    Example: Two Primitives are equivalent if they have accessors and materials with equivalent content — but not necessarily the same specific accessors and materials.

  • getDefaults(): Nullable<IProperty>

  • Returns default attributes for the property. Empty lists and maps should be initialized to empty arrays and objects. Always invoke super.getDefaults() and extend the result.

  • getExtras(): Record<string, unknown>

  • Returns a reference to the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • getName(): string

  • Returns the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

  • init(): void
  • isDisposed(): boolean

  • Returns true if the node has been permanently removed from the graph.

  • listParents(): Property<IProperty>[]

  • Returns a list of all properties that hold a reference to this property. For example, a material may hold references to various textures, but a texture does not hold references to the materials that use it.

    It is often necessary to filter the results for a particular type: some resources, like Accessors, may be referenced by different types of properties. Most properties include the Root as a parent, which is usually not of interest.

    Usage:

    const materials = texture
    .listParents()
    .filter((p) => p instanceof Material)
  • setExtras(extras: Record<string, unknown>): Unlit

  • Updates the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • setName(name: string): Unlit

  • Sets the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy • TypeDoc documentation • Copyright 2023, MIT license