@3dsource/metabox-modular-configurator-api
    Preparing search index...

    Interface ModularConfiguratorEnvelope

    Represents a modular configurator envelope with an initial configurator, configuration tree, all components by active component type, component selected materials, and associated environment.

    Main data envelope interface that comes from MetaBox. Contains all configurator data including components, materials, variants, and state information.

    Delivered as the payload of the configuratorDataUpdated event. Contains: configurator (full definition of all options), configurationTree (current assembly hierarchy), componentsByComponentType (active selection per category), componentMaterialsIds (material selections), environmentId (current scene), environmentMaterialsIds. This is the single source of truth for building your entire custom UI.

    Subscribe to configuratorDataUpdated to receive this on EVERY state change. Key fields: configurator (all available options — parse once for menu building), configurationTree (current hierarchy), componentsByComponentType (what's selected per type), componentMaterialsIds (active materials), environmentId (current scene). Rebuild affected UI sections on each update.

    interface ModularConfiguratorEnvelope {
        componentMaterialsIds: SelectedIds;
        componentsByComponentType: Record<string, string>;
        configurationTree: ComponentWithParent[];
        configurator: InitialModularConfigurator;
        environmentId: string;
        environmentMaterialsIds: SelectedIds;
    }
    Index

    Properties

    componentMaterialsIds: SelectedIds

    A record mapping component material selection

    componentsByComponentType: Record<string, string>

    A record mapping all components by current component type

    configurationTree: ComponentWithParent[]

    The unique tree of components and parent and component type id

    Represents the modular configurator api with its components, component types, and environments

    environmentId: string

    The unique environment identifier

    environmentMaterialsIds: SelectedIds

    A record mapping environment material selections