Base class for all Property types that can be attached by an Extension.

After an Extension is attached to a glTF Document, the Extension may be used to construct ExtensionProperty instances, to be referenced throughout the document as prescribed by the Extension. For example, the KHR_materials_clearcoat Extension defines a Clearcoat ExtensionProperty, which is referenced by Material Properties in the Document, and may contain references to Texture properties of its own.

For more information on available extensions and their usage, see Extensions.

Reference:

Type parameters

  • T: IProperty

Hierarchy

Properties

parentTypes: string[]

List of supported Property types.

propertyType: string

Property type.

Methods

  • 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.

  • Returns true if two properties are deeply equivalent, recursively comparing the attributes of the properties. For 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<T>
  • getExtras(): Record<string, unknown>
  • getName(): string
  • 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)
    
Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy TypeDoc documentation Copyright 2021 under MIT license