Reusable collection of keyframes affecting particular property of an object.

Each AnimationSampler refers to an input and an output Accessor. Input contains times (in seconds) for each keyframe. Output contains values (of any Accessor.Type) for the animated property at each keyframe. Samplers using CUBICSPLINE interpolation will also contain in/out tangents in the output, with the layout:

in1, value1, out1, in2, value2, out2, in3, value3, out3, ...

Usage:

// Create accessor containing input times, in seconds.
const input = doc.createAccessor('bounceTimes')
    .setArray(new Float32Array([0, 1, 2]))
    .setType('SCALAR');

// Create accessor containing output values, in local units.
const output = doc.createAccessor('bounceValues')
    .setArray(new Float32Array([
        0, 0, 0, // y = 0
        0, 1, 0, // y = 1
        0, 0, 0, // y = 0
    ]))
    .setType('VEC3');

// Create sampler.
const sampler = doc.createAnimationSampler('bounce')
    .setInput(input)
    .setOutput(output)
    .setInterpolation('LINEAR');

Reference

Hierarchy

Properties

propertyType: string

Property type.

Methods

  • clone(): this
  • copy(other: this, resolve: PropertyResolver<Property>): this
  • Copies all data from another property to this one. Child properties are copied by reference, unless a 'resolve' function is given to override that.

  • detach(): this
  • Removes all inbound references to this object. At the end of the process the object is considered 'detached': it may hold references to child resources, but nothing holds references to it. A detached object may be re-attached.

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

  • getExtras(): object
  • 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.

  • getInterpolation(): AnimationSamplerInterpolation
  • 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.

  • isDisposed(): boolean
  • 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: object): this
  • Updates the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

  • setInterpolation(interpolation: AnimationSamplerInterpolation): this
  • setName(name: string): this
  • 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 2020 under MIT license