Documentation
    Preparing search index...

    Interface GltfInstance

    One instantiation of a parsed glTF asset: fresh nodes over shared geometry, textures, and clips. See the module header for exactly what is shared.

    interface GltfInstance {
        animations: readonly AnimationClip[];
        materials: readonly StandardMaterial[];
        nodes: readonly Node[];
        scene: Group | null;
        scenes: readonly Group[];
    }
    Index
    animations materials nodes scene scenes
    animations: readonly AnimationClip[]

    The asset's clips, in file order — shared across instantiations (see the module header), playable onto this instance: new AnimationMixer(instance).play(instance.animations[0]).

    materials: readonly StandardMaterial[]

    This instantiation's materials, index-aligned with the file's.

    nodes: readonly Node[]

    The instantiated nodes, index-aligned with the file's nodes array — the array every loaded clip's track paths index, and therefore the object to hand an AnimationMixer as its target.

    scene: Group | null

    The file's default scene as a Group, or null when the file declares none — glTF says a viewer may then display nothing, and inventing a default would hide an authoring decision.

    scenes: readonly Group[]

    Every scene, in file order, each a Group over its root nodes.

    Settings
    Member Visibility

    On This Page
    Properties