AutoMovie API
    Preparing search index...

    Interface IAutoMovieMaterial

    A physically-based (PBR) surface material: the "what it's made of and how it catches light" of a character or object surface.

    The base fields follow glTF's metallic-roughness model, and the optional transmission, volume, clearcoat, anisotropy, sheen and specular fields follow the corresponding glTF KHR_materials_* extensions; the viewer builds a MeshPhysicalMaterial from them, with optional subsurface, detail-normal and overlay shader approximations that have no glTF counterpart. Engine model admission owns coefficient domains, while direct viewer callers must supply admitted values.

    Texture images are referenced by id: an image the enclosing model carries, else a project asset. Their decoding and GPU lifetime belong to the renderer's texture resolver, rather than this authoring record.

    Reference: glTF 2.0 pbrMetallicRoughness (https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#materials); Khronos KHR_materials_anisotropy, KHR_materials_sheen, KHR_materials_specular and KHR_materials_volume.

    interface IAutoMovieMaterial {
        alphaCutoff?: number;
        alphaMode?: "opaque" | "mask" | "blend";
        anisotropy?: {
            rotationDeg: number;
            strength: number;
            texture: AutoMovieTextureBinding | null;
        };
        baseColor: IAutoMovieColor;
        baseColorTexture: AutoMovieTextureBinding
        | null;
        clearcoat?: number;
        detailNormalScale?: number;
        detailNormalTexture?: AutoMovieTextureBinding | null;
        doubleSided?: boolean;
        emissive: IAutoMovieColor | null;
        emissiveTexture?: AutoMovieTextureBinding | null;
        id: string;
        ior?: number;
        metallic: number;
        metallicRoughnessTexture?: AutoMovieTextureBinding | null;
        name: string | null;
        normalScale?: number;
        normalTexture?: AutoMovieTextureBinding | null;
        occlusionStrength?: number;
        occlusionTexture?: AutoMovieTextureBinding | null;
        opacity: number;
        overlays?: IAutoMovieMaterialOverlay[];
        roughness: number;
        sheen?: { color: IAutoMovieColor; roughness: number };
        specularIntensity?: number;
        subsurfaceRadius?: { b: number; g: number; r: number };
        thickness?: number;
        thicknessTexture?: AutoMovieTextureBinding | null;
        transmission?: number;
    }
    Index
    alphaCutoff?: number

    Alpha threshold used only by mask; defaults to 0.5.

    alphaMode?: "opaque" | "mask" | "blend"

    Explicit alpha handling. Omitted derives legacy blend behavior from opacity.

    anisotropy?: {
        rotationDeg: number;
        strength: number;
        texture: AutoMovieTextureBinding | null;
    }

    Anisotropic specular lobe, which stretches highlights along one surface direction. The direction lies in the tangent frame of texture coordinates UV0, so every part citing the material must be a mesh with UV0, which tessellated primitives do not emit; when a normal map is bound, the viewer derives that frame from the normal map's transformed coordinates. Omitted, the specular lobe is isotropic.

    Type Declaration

    • rotationDeg: number

      Finite direction in degrees, counterclockwise from the +u texture direction toward +v; 90 runs the highlight streak along +v.

    • strength: number

      Strength in [0, 1]; zero is isotropic.

    • texture: AutoMovieTextureBinding | null

      Linear texture whose red and green channels encode a tangent-space direction mapped from [0, 1] to [-1, 1] and then rotated by rotationDeg, and whose blue channel multiplies strength; null, the direction is rotationDeg everywhere.

    baseColor: IAutoMovieColor

    Diffuse / albedo base color (linear).

    baseColorTexture: AutoMovieTextureBinding | null

    Id of an optional base-color texture map. null = flat baseColor only. The image is an engine-resolved asset, never LLM-emitted pixels.

    clearcoat?: number

    Fractional clear-coat lobe strength, [0, 1].

    detailNormalScale?: number

    Strength of detailNormalTexture's slopes, a nonnegative finite factor; omitted, one.

    detailNormalTexture?: AutoMovieTextureBinding | null

    Optional second tangent-space normal map, blended over normalTexture (whiteout: the two maps' slopes add), usually a fine relief tiled with its own transform over a coarser map bound once across the surface. glTF has one normal slot, so this map has no glTF counterpart. Without a normalTexture it stands in as the normal map.

    doubleSided?: boolean

    Whether both sides of the surface are visible.

    emissive: IAutoMovieColor | null

    Emissive RGB multiplier, or null. The viewer uses white when null and an emissive image resolves, otherwise its non-emitting default; this adds surface radiance without creating a scene light.

    emissiveTexture?: AutoMovieTextureBinding | null

    Emissive texture multiplied by authored emissive RGB, or white when that field is null.

    id: string

    Stable id so meshes / scene nodes can cite this material.

    ior?: number

    Index of refraction, finite and >= 1.

    metallic: number

    Metalness, [0, 1]. 0 = dielectric, 1 = metal.

    metallicRoughnessTexture?: AutoMovieTextureBinding | null

    GlTF-style combined metallic (B) and roughness (G) texture id.

    name: string | null

    Human / LLM readable label (e.g. "glossy red plastic"). Null if unnamed.

    normalScale?: number

    Finite multiplier applied to the normal map's XY channels; negative flips them.

    normalTexture?: AutoMovieTextureBinding | null

    Tangent-space normal-map texture id.

    occlusionStrength?: number

    Occlusion strength in [0, 1].

    occlusionTexture?: AutoMovieTextureBinding | null

    Ambient-occlusion texture id.

    opacity: number

    Surface alpha in [0, 1], independent of baseColor.a in the viewer. Without alphaMode, values below one select alpha blending.

    At most four ordered surface layers, each sampling a colour image and optionally a normal image. Colour/roughness and replacement normals use image coverage; multiply normals follow the separate formula on IAutoMovieMaterialOverlay. glTF has no counterpart. Omitted or empty, no overlay shader is installed.

    roughness: number

    PBR microfacet roughness in [0, 1], from smooth to maximally rough; one does not remove the specular lobe.

    sheen?: { color: IAutoMovieColor; roughness: number }

    Sheen lobe: a microfibre layer that adds back-scattered light at grazing angles. Omitted, there is no sheen.

    Type Declaration

    • color: IAutoMovieColor

      Linear sheen tint at full intensity; alpha is ignored. Black is no sheen.

    • roughness: number

      Sheen roughness in [0, 1], from a narrow grazing rim to a broad soft glow.

    specularIntensity?: number

    Strength of the dielectric specular reflection in [0, 1], scaling the Fresnel reflectance that ior implies; omitted, one. Metals ignore it.

    subsurfaceRadius?: { b: number; g: number; r: number }

    Nonnegative finite RGB radius parameters in metres for the viewer's direct-diffuse subsurface approximation. Screen-space normal curvature and a shared Gaussian-response lookup modify diffuse lighting; this does not transport light through a measured medium or establish an observed appearance. Omission keeps the ordinary physical material response; glTF has no counterpart.

    Type Declaration

    • b: number

      Blue-channel scattering radius parameter, nonnegative metres.

    • g: number

      Green-channel scattering radius parameter, nonnegative metres.

    • r: number

      Red-channel scattering radius parameter, nonnegative metres.

    thickness?: number

    Non-negative transmission volume thickness in metres.

    thicknessTexture?: AutoMovieTextureBinding | null

    Linear texture whose green channel, [0, 1], multiplies thickness per texel, so one surface can vary in volume thickness. Like thickness, it changes the render only where transmission is above zero.

    transmission?: number

    Fraction of light transmitted through a physical dielectric, [0, 1].