@3dsource/metabox-front-api
    Preparing search index...

    Interface ConfiguratorEnvelope

    Represents a basic configurator object with its configuration, selected materials, product identifier, and associated environment with its materials.

    Main data envelope received from MetaBox on every state change. Contains the full configurator definition, currently selected product, environment, and all material selections.

    Delivered as the payload of the configuratorDataUpdated event. Use it to build and update custom UI: read configurator for available options, productId/environmentId for current selections, and productMaterialsIds/environmentMaterialsIds for active materials.

    Subscribe to configuratorDataUpdated to receive this on every state change. Key fields: configurator (full definition — parse once for menu building), productId (active product), productMaterialsIds (active materials), environmentId (active scene), environmentMaterialsIds (scene materials). Rebuild affected UI sections on each update.

    interface ConfiguratorEnvelope {
        configurator: UniversalConfigurator;
        environmentId: string;
        environmentMaterialsIds: SelectedIds;
        productId: string;
        productMaterialsIds: SelectedIds;
    }
    Index

    Properties

    configurator: UniversalConfigurator

    A reference to the universal configurator.

    environmentId: string

    The unique environment identifier.

    environmentMaterialsIds: SelectedIds

    A record mapping environment material selections.

    productId: string

    The unique product identifier.

    productMaterialsIds: SelectedIds

    A record mapping product material selections.