AutoMovie API
    Preparing search index...

    Interface IArchetypeProps<Id, Dimension, Physical>

    What a producer built: the archetype at rest, which Archetype reads as Archetype.IProps.

    interface IArchetypeProps<
        Id extends string,
        Dimension extends string,
        Physical extends IProperties | null = IProperties,
    > {
        affordances: (IAutoMovieAffordance & { id: Id })[];
        archetype: string;
        cells?: Table;
        contact: IAutoMovieBodyContact | null;
        dimensions: Readonly<Partial<Record<Dimension, number>>>;
        drag: IAutoMovieBodyDrag | null;
        fractures: readonly ISet[];
        friction: number | null;
        id: string;
        kineticFriction: number | null;
        masses: Readonly<Record<string, number>>;
        material: ArchetypeMaterial.Kind | null;
        materials: IAutoMovieMaterial[];
        name: string;
        parts: IAutoMovieModelPart[];
        properties: Physical;
        provenance: IProvenance<Dimension>;
        restitution: number | null;
        spans: readonly ArchetypeSpan.ISpan[];
        surfaces: Readonly<Record<string, Material>>;
    }

    Type Parameters

    • Id extends string

      The archetype's affordance ids, a closed union the producer declares.

    • Dimension extends string

      The archetype's free dimensions, a closed union the producer declares.

    • Physical extends IProperties | null = IProperties

      Mass properties of a solid or null for a visual-only archetype.

    Index
    affordances: (IAutoMovieAffordance & { id: Id })[]

    The affordances at rest, each id one of Id.

    archetype: string

    The producer's name, such as chair.

    cells?: Table

    Explicit actual convex wall cells by part id; absent for legacy primitive-only records. Cell points remain local and follow each part's current rigid transform.

    contact: IAutoMovieBodyContact | null

    How the body ends a flight against what it strikes; null when it declares none.

    dimensions: Readonly<Partial<Record<Dimension, number>>>

    The value of each free dimension the variant has.

    drag: IAutoMovieBodyDrag | null

    The air's drag on the body in flight; null when no source measured it.

    fractures: readonly ISet[]

    The sets of parts a hit breaks off, each a fragment; empty for an archetype that does not break.

    friction: number | null

    Static Coulomb friction coefficient of what the model rests on against its ground, 0 to 1; null when its producer has not declared what it rests on.

    id: string

    Model id.

    kineticFriction: number | null

    Kinetic Coulomb friction coefficient of the same pair, 0 to 1; null when no measured pair gives it.

    masses: Readonly<Record<string, number>>

    Each part's own mass, kilograms, by part id, the shares its mass properties were built from.

    material: ArchetypeMaterial.Kind | null

    The body's declared physical reference material; null for a heterogeneous assembly without one common material.

    materials: IAutoMovieMaterial[]

    The materials the parts cite.

    name: string

    Readable name.

    The parts at rest, with unit scale.

    properties: Physical

    Mass, centre of mass and inertia, or null for a visual-only archetype.

    provenance: IProvenance<Dimension>

    Where each dimension came from: the band of each drawn one and the model picked on each axis.

    restitution: number | null

    Explicit authored or calibrated normal restitution, 0 to 1; null when no coefficient was declared.

    spans: readonly ArchetypeSpan.ISpan[]

    The spans laid between moving frames after every pose; empty for most archetypes.

    surfaces: Readonly<Record<string, Material>>

    What each part's surface is made of, by part id, for the parts whose producer declared it.